API ReferenceCrm dashboard
Get CRM dashboard
Returns complete CRM dashboard data
AuthorizationBearer <token>
In: header
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X GET "http://localhost:18080/api/v1/crm/dashboard"{
"actions": {
"overdueActivities": [
{
"attendees": [
"string"
],
"completed": true,
"completedAt": "2019-08-24T14:15:22Z",
"contactEmail": "string",
"contactName": "string",
"contactPhone": "string",
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"customerId": "string",
"description": "string",
"dueDate": "2019-08-24T14:15:22Z",
"dueNotifiedAt": "2019-08-24T14:15:22Z",
"durationMinutes": 0,
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"id": "string",
"isCompleted": true,
"location": "string",
"number": "string",
"opportunityId": "string",
"outcome": "string",
"ownerId": "string",
"priority": "LOW",
"scheduledAt": "2019-08-24T14:15:22Z",
"subject": "string",
"tenantId": "string",
"type": "CALL",
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string"
}
],
"overdueOpportunityActions": [
{
"changeOrders": [
{
"accessTokenHash": "string",
"amount": 0.1,
"approvedAt": "2019-08-24T14:15:22Z",
"approvedBy": "string",
"category": "string",
"createdAt": "2019-08-24T14:15:22Z",
"createdBy": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"rejectedAt": "2019-08-24T14:15:22Z",
"rejectionReason": "string",
"sentAt": "2019-08-24T14:15:22Z",
"sentBy": "string",
"status": "DRAFT"
}
],
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"customerId": "string",
"description": "string",
"estimateIds": [
"string"
],
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"expectedCloseDate": "2019-08-24T14:15:22Z",
"fulfillmentDate": "2019-08-24T14:15:22Z",
"id": "string",
"invoiceIds": [
"string"
],
"leadId": "string",
"name": "string",
"nextAction": "string",
"nextActionDueDate": "2019-08-24T14:15:22Z",
"notes": "string",
"number": "string",
"orderDate": "2019-08-24T14:15:22Z",
"orderId": "string",
"ownerId": "string",
"paymentSchedule": [
{
"id": "string",
"includeChangeOrders": true,
"invoiceId": "string",
"label": "string",
"paymentDueDays": 0,
"percentage": 0.1,
"relativeDays": 0,
"status": "PENDING",
"triggerStatus": "NEW",
"triggerType": "STATUS_CHANGE",
"triggeredAt": "2019-08-24T14:15:22Z"
}
],
"planningBlocks": [
{
"endDate": "2019-08-24",
"id": "string",
"notes": "string",
"startDate": "2019-08-24",
"status": "PLANNED",
"teamId": "string"
}
],
"probability": 0,
"productIds": [
"string"
],
"questionnaire": [
{
"id": "string",
"label": "string",
"numberValue": 0.1,
"options": [
"string"
],
"photoFileIds": [
"string"
],
"questionId": "string",
"required": true,
"selectedOption": "string",
"sortOrder": 0,
"textValue": "string",
"type": "TEXT"
}
],
"scheduledEndDate": "2019-08-24",
"scheduledStartDate": "2019-08-24",
"source": "string",
"status": "NEW",
"subsidiaryId": "string",
"tags": [
"string"
],
"teamId": "string",
"tenantId": "string",
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"value": 0.1
}
],
"overdueTasks": [
{
"attendees": [
"string"
],
"completed": true,
"completedAt": "2019-08-24T14:15:22Z",
"contactEmail": "string",
"contactName": "string",
"contactPhone": "string",
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"customerId": "string",
"description": "string",
"dueDate": "2019-08-24T14:15:22Z",
"dueNotifiedAt": "2019-08-24T14:15:22Z",
"durationMinutes": 0,
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"id": "string",
"isCompleted": true,
"location": "string",
"number": "string",
"opportunityId": "string",
"outcome": "string",
"ownerId": "string",
"priority": "LOW",
"scheduledAt": "2019-08-24T14:15:22Z",
"subject": "string",
"tenantId": "string",
"type": "CALL",
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string"
}
],
"plannedActivities": [
{
"attendees": [
"string"
],
"completed": true,
"completedAt": "2019-08-24T14:15:22Z",
"contactEmail": "string",
"contactName": "string",
"contactPhone": "string",
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"customerId": "string",
"description": "string",
"dueDate": "2019-08-24T14:15:22Z",
"dueNotifiedAt": "2019-08-24T14:15:22Z",
"durationMinutes": 0,
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"id": "string",
"isCompleted": true,
"location": "string",
"number": "string",
"opportunityId": "string",
"outcome": "string",
"ownerId": "string",
"priority": "LOW",
"scheduledAt": "2019-08-24T14:15:22Z",
"subject": "string",
"tenantId": "string",
"type": "CALL",
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string"
}
],
"plannedOpportunityActions": [
{
"changeOrders": [
{
"accessTokenHash": "string",
"amount": 0.1,
"approvedAt": "2019-08-24T14:15:22Z",
"approvedBy": "string",
"category": "string",
"createdAt": "2019-08-24T14:15:22Z",
"createdBy": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"rejectedAt": "2019-08-24T14:15:22Z",
"rejectionReason": "string",
"sentAt": "2019-08-24T14:15:22Z",
"sentBy": "string",
"status": "DRAFT"
}
],
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"customerId": "string",
"description": "string",
"estimateIds": [
"string"
],
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"expectedCloseDate": "2019-08-24T14:15:22Z",
"fulfillmentDate": "2019-08-24T14:15:22Z",
"id": "string",
"invoiceIds": [
"string"
],
"leadId": "string",
"name": "string",
"nextAction": "string",
"nextActionDueDate": "2019-08-24T14:15:22Z",
"notes": "string",
"number": "string",
"orderDate": "2019-08-24T14:15:22Z",
"orderId": "string",
"ownerId": "string",
"paymentSchedule": [
{
"id": "string",
"includeChangeOrders": true,
"invoiceId": "string",
"label": "string",
"paymentDueDays": 0,
"percentage": 0.1,
"relativeDays": 0,
"status": "PENDING",
"triggerStatus": "NEW",
"triggerType": "STATUS_CHANGE",
"triggeredAt": "2019-08-24T14:15:22Z"
}
],
"planningBlocks": [
{
"endDate": "2019-08-24",
"id": "string",
"notes": "string",
"startDate": "2019-08-24",
"status": "PLANNED",
"teamId": "string"
}
],
"probability": 0,
"productIds": [
"string"
],
"questionnaire": [
{
"id": "string",
"label": "string",
"numberValue": 0.1,
"options": [
"string"
],
"photoFileIds": [
"string"
],
"questionId": "string",
"required": true,
"selectedOption": "string",
"sortOrder": 0,
"textValue": "string",
"type": "TEXT"
}
],
"scheduledEndDate": "2019-08-24",
"scheduledStartDate": "2019-08-24",
"source": "string",
"status": "NEW",
"subsidiaryId": "string",
"tags": [
"string"
],
"teamId": "string",
"tenantId": "string",
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"value": 0.1
}
],
"todaysActivities": [
{
"attendees": [
"string"
],
"completed": true,
"completedAt": "2019-08-24T14:15:22Z",
"contactEmail": "string",
"contactName": "string",
"contactPhone": "string",
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"customerId": "string",
"description": "string",
"dueDate": "2019-08-24T14:15:22Z",
"dueNotifiedAt": "2019-08-24T14:15:22Z",
"durationMinutes": 0,
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"id": "string",
"isCompleted": true,
"location": "string",
"number": "string",
"opportunityId": "string",
"outcome": "string",
"ownerId": "string",
"priority": "LOW",
"scheduledAt": "2019-08-24T14:15:22Z",
"subject": "string",
"tenantId": "string",
"type": "CALL",
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string"
}
],
"todaysOpportunityActions": [
{
"changeOrders": [
{
"accessTokenHash": "string",
"amount": 0.1,
"approvedAt": "2019-08-24T14:15:22Z",
"approvedBy": "string",
"category": "string",
"createdAt": "2019-08-24T14:15:22Z",
"createdBy": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"rejectedAt": "2019-08-24T14:15:22Z",
"rejectionReason": "string",
"sentAt": "2019-08-24T14:15:22Z",
"sentBy": "string",
"status": "DRAFT"
}
],
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"customerId": "string",
"description": "string",
"estimateIds": [
"string"
],
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"expectedCloseDate": "2019-08-24T14:15:22Z",
"fulfillmentDate": "2019-08-24T14:15:22Z",
"id": "string",
"invoiceIds": [
"string"
],
"leadId": "string",
"name": "string",
"nextAction": "string",
"nextActionDueDate": "2019-08-24T14:15:22Z",
"notes": "string",
"number": "string",
"orderDate": "2019-08-24T14:15:22Z",
"orderId": "string",
"ownerId": "string",
"paymentSchedule": [
{
"id": "string",
"includeChangeOrders": true,
"invoiceId": "string",
"label": "string",
"paymentDueDays": 0,
"percentage": 0.1,
"relativeDays": 0,
"status": "PENDING",
"triggerStatus": "NEW",
"triggerType": "STATUS_CHANGE",
"triggeredAt": "2019-08-24T14:15:22Z"
}
],
"planningBlocks": [
{
"endDate": "2019-08-24",
"id": "string",
"notes": "string",
"startDate": "2019-08-24",
"status": "PLANNED",
"teamId": "string"
}
],
"probability": 0,
"productIds": [
"string"
],
"questionnaire": [
{
"id": "string",
"label": "string",
"numberValue": 0.1,
"options": [
"string"
],
"photoFileIds": [
"string"
],
"questionId": "string",
"required": true,
"selectedOption": "string",
"sortOrder": 0,
"textValue": "string",
"type": "TEXT"
}
],
"scheduledEndDate": "2019-08-24",
"scheduledStartDate": "2019-08-24",
"source": "string",
"status": "NEW",
"subsidiaryId": "string",
"tags": [
"string"
],
"teamId": "string",
"tenantId": "string",
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"value": 0.1
}
],
"unscheduledActivities": [
{
"attendees": [
"string"
],
"completed": true,
"completedAt": "2019-08-24T14:15:22Z",
"contactEmail": "string",
"contactName": "string",
"contactPhone": "string",
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"customerId": "string",
"description": "string",
"dueDate": "2019-08-24T14:15:22Z",
"dueNotifiedAt": "2019-08-24T14:15:22Z",
"durationMinutes": 0,
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"id": "string",
"isCompleted": true,
"location": "string",
"number": "string",
"opportunityId": "string",
"outcome": "string",
"ownerId": "string",
"priority": "LOW",
"scheduledAt": "2019-08-24T14:15:22Z",
"subject": "string",
"tenantId": "string",
"type": "CALL",
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string"
}
]
},
"activityStats": {
"property1": 0,
"property2": 0
},
"cancellations": {
"cancelledWithLead": [
{
"allDay": true,
"attendees": [
{
"email": "string",
"name": "string",
"status": "PENDING",
"userId": "string"
}
],
"cancellationNote": "string",
"cancellationReason": "RESCHEDULED",
"cancelledAt": "2019-08-24T14:15:22Z",
"cancelledBy": "string",
"category": "DEFAULT",
"color": "string",
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"customer": {
"email": "string",
"id": "string",
"name": "string",
"phone": "string"
},
"customerId": "string",
"description": "string",
"endTime": "2019-08-24T14:15:22Z",
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"googleEventId": "string",
"id": "string",
"lastSyncedAt": "2019-08-24T14:15:22Z",
"lead": {
"email": "string",
"firstName": "string",
"id": "string",
"instagramHandle": "string",
"lastName": "string",
"phone": "string"
},
"leadId": "string",
"location": "string",
"onlineMeetingUrl": "string",
"opportunity": {
"id": "string",
"name": "string",
"status": "string"
},
"opportunityId": "string",
"outlookEventId": "string",
"owner": {
"displayName": "string",
"id": "string",
"username": "string"
},
"ownerId": "string",
"reminders": [
{
"minutesBefore": 0,
"type": "NOTIFICATION"
}
],
"startTime": "2019-08-24T14:15:22Z",
"status": "SCHEDULED",
"subsidiary": {
"color": "string",
"id": "string",
"name": "string"
},
"subsidiaryId": "string",
"syncSource": "GOOGLE",
"tenantId": "string",
"title": "string",
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"visibility": "PRIVATE"
}
],
"countByReason": {
"property1": 0,
"property2": 0
},
"rangeEnd": "2019-08-24T14:15:22Z",
"rangeStart": "2019-08-24T14:15:22Z",
"totalCancelled": 0
},
"pipeline": {
"countByStatus": {
"property1": 0,
"property2": 0
},
"totalCount": 0,
"totalValue": 0.1,
"valueByStatus": {
"property1": 0.1,
"property2": 0.1
},
"weightedValue": 0.1
},
"rejectedLeads": {
"rangeEnd": "2019-08-24T14:15:22Z",
"rangeStart": "2019-08-24T14:15:22Z",
"recent": [
{
"displayName": "string",
"email": "string",
"id": "string",
"reason": "string",
"rejectedAt": "2019-08-24T14:15:22Z"
}
],
"rejectedInRange": 0,
"totalRejected": 0
}
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}