AlphaAlpha Docs
API Reference

C R M Dashboard

API calls for CRM dashboard

Get CRM dashboard

GET
/crm/dashboard

Authorization

AuthorizationBearer <token>

In: header

Response Body

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",
        "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": [
          {
            "amount": 0.1,
            "category": "string",
            "createdAt": "2019-08-24T14:15:22Z",
            "createdBy": "string",
            "date": "2019-08-24T14:15:22Z",
            "description": "string",
            "id": "string"
          }
        ],
        "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",
        "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"
          }
        ],
        "probability": 0,
        "productIds": [
          "string"
        ],
        "scheduledEndDate": "2019-08-24",
        "scheduledStartDate": "2019-08-24",
        "source": "string",
        "status": "NEW",
        "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",
        "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",
        "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": [
          {
            "amount": 0.1,
            "category": "string",
            "createdAt": "2019-08-24T14:15:22Z",
            "createdBy": "string",
            "date": "2019-08-24T14:15:22Z",
            "description": "string",
            "id": "string"
          }
        ],
        "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",
        "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"
          }
        ],
        "probability": 0,
        "productIds": [
          "string"
        ],
        "scheduledEndDate": "2019-08-24",
        "scheduledStartDate": "2019-08-24",
        "source": "string",
        "status": "NEW",
        "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",
        "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": [
          {
            "amount": 0.1,
            "category": "string",
            "createdAt": "2019-08-24T14:15:22Z",
            "createdBy": "string",
            "date": "2019-08-24T14:15:22Z",
            "description": "string",
            "id": "string"
          }
        ],
        "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",
        "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"
          }
        ],
        "probability": 0,
        "productIds": [
          "string"
        ],
        "scheduledEndDate": "2019-08-24",
        "scheduledStartDate": "2019-08-24",
        "source": "string",
        "status": "NEW",
        "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",
        "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
  },
  "pipeline": {
    "countByStatus": {
      "property1": 0,
      "property2": 0
    },
    "totalCount": 0,
    "totalValue": 0.1,
    "valueByStatus": {
      "property1": 0.1,
      "property2": 0.1
    },
    "weightedValue": 0.1
  }
}
{
  "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"
}

Get actions dashboard

GET
/crm/dashboard/actions

Authorization

AuthorizationBearer <token>

In: header

Response Body

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",
      "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": [
        {
          "amount": 0.1,
          "category": "string",
          "createdAt": "2019-08-24T14:15:22Z",
          "createdBy": "string",
          "date": "2019-08-24T14:15:22Z",
          "description": "string",
          "id": "string"
        }
      ],
      "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",
      "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"
        }
      ],
      "probability": 0,
      "productIds": [
        "string"
      ],
      "scheduledEndDate": "2019-08-24",
      "scheduledStartDate": "2019-08-24",
      "source": "string",
      "status": "NEW",
      "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",
      "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",
      "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": [
        {
          "amount": 0.1,
          "category": "string",
          "createdAt": "2019-08-24T14:15:22Z",
          "createdBy": "string",
          "date": "2019-08-24T14:15:22Z",
          "description": "string",
          "id": "string"
        }
      ],
      "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",
      "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"
        }
      ],
      "probability": 0,
      "productIds": [
        "string"
      ],
      "scheduledEndDate": "2019-08-24",
      "scheduledStartDate": "2019-08-24",
      "source": "string",
      "status": "NEW",
      "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",
      "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": [
        {
          "amount": 0.1,
          "category": "string",
          "createdAt": "2019-08-24T14:15:22Z",
          "createdBy": "string",
          "date": "2019-08-24T14:15:22Z",
          "description": "string",
          "id": "string"
        }
      ],
      "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",
      "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"
        }
      ],
      "probability": 0,
      "productIds": [
        "string"
      ],
      "scheduledEndDate": "2019-08-24",
      "scheduledStartDate": "2019-08-24",
      "source": "string",
      "status": "NEW",
      "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",
      "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"
    }
  ]
}
{
  "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"
}

Get customer timeline

GET
/crm/dashboard/customer/{customerId}/timeline

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

customerId*string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/crm/dashboard/customer/string/timeline"
{
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "metadata": {
        "property1": null,
        "property2": null
      },
      "title": "string",
      "type": "ACTIVITY"
    }
  ]
}
{
  "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"
}

Get my dashboard

GET
/crm/dashboard/my

Authorization

AuthorizationBearer <token>

In: header

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/crm/dashboard/my"
{
  "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",
      "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": [
        {
          "amount": 0.1,
          "category": "string",
          "createdAt": "2019-08-24T14:15:22Z",
          "createdBy": "string",
          "date": "2019-08-24T14:15:22Z",
          "description": "string",
          "id": "string"
        }
      ],
      "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",
      "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"
        }
      ],
      "probability": 0,
      "productIds": [
        "string"
      ],
      "scheduledEndDate": "2019-08-24",
      "scheduledStartDate": "2019-08-24",
      "source": "string",
      "status": "NEW",
      "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",
      "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",
      "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": [
        {
          "amount": 0.1,
          "category": "string",
          "createdAt": "2019-08-24T14:15:22Z",
          "createdBy": "string",
          "date": "2019-08-24T14:15:22Z",
          "description": "string",
          "id": "string"
        }
      ],
      "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",
      "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"
        }
      ],
      "probability": 0,
      "productIds": [
        "string"
      ],
      "scheduledEndDate": "2019-08-24",
      "scheduledStartDate": "2019-08-24",
      "source": "string",
      "status": "NEW",
      "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",
      "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": [
        {
          "amount": 0.1,
          "category": "string",
          "createdAt": "2019-08-24T14:15:22Z",
          "createdBy": "string",
          "date": "2019-08-24T14:15:22Z",
          "description": "string",
          "id": "string"
        }
      ],
      "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",
      "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"
        }
      ],
      "probability": 0,
      "productIds": [
        "string"
      ],
      "scheduledEndDate": "2019-08-24",
      "scheduledStartDate": "2019-08-24",
      "source": "string",
      "status": "NEW",
      "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",
      "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"
    }
  ]
}
{
  "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"
}

Get pipeline summary

GET
/crm/dashboard/pipeline

Authorization

AuthorizationBearer <token>

In: header

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/crm/dashboard/pipeline"
{
  "countByStatus": {
    "property1": 0,
    "property2": 0
  },
  "totalCount": 0,
  "totalValue": 0.1,
  "valueByStatus": {
    "property1": 0.1,
    "property2": 0.1
  },
  "weightedValue": 0.1
}
{
  "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"
}

C R M Customer

Previous Page

C R M Lead

Next Page