Alpha API ReferenceCrm dashboard
Get company overview
Returns consolidated CRM company overview for the given date range
AuthorizationBearer <token>
In: header
Query Parameters
start*string
Format
date-timeend*string
Format
date-timesubsidiaryId?string
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X GET "http://localhost:18080/api/v1/crm/dashboard/company-overview?start=2019-08-24T14%3A15%3A22Z&end=2019-08-24T14%3A15%3A22Z"{
"bookings": [
{
"city": "string",
"email": "string",
"firstName": "string",
"lastName": "string",
"startTime": "2019-08-24T14:15:22Z",
"status": "string"
}
],
"brochures": [
{
"brochureName": "string",
"city": "string",
"email": "string",
"firstName": "string",
"lastName": "string",
"requestedAt": "2019-08-24T14:15:22Z"
}
],
"contactForms": [
{
"email": "string",
"firstName": "string",
"lastName": "string",
"message": "string",
"submittedAt": "2019-08-24T14:15:22Z"
}
],
"estimatesAccepted": [
{
"clientName": "string",
"estimateDate": "2019-08-24T14:15:22Z",
"estimateNumber": "string",
"totalWithTax": 0.1
}
],
"estimatesSent": [
{
"clientName": "string",
"estimateDate": "2019-08-24T14:15:22Z",
"estimateNumber": "string",
"totalWithTax": 0.1
}
],
"leadStats": {
"bySource": {
"property1": 0,
"property2": 0
},
"contacted": 0,
"conversionRate": 0.1,
"new": 0,
"opened": 0,
"qualified": 0,
"total": 0,
"unqualified": 0
},
"pipeline": {
"acceptedValue": 0.1,
"opportunityValueByStatus": {
"property1": 0.1,
"property2": 0.1
},
"paidValue": 0.1,
"quotedValue": 0.1
},
"revenue": {
"totalInvoiced": 0.1,
"totalOutstanding": 0.1,
"totalPaid": 0.1
},
"ticketStats": {
"avgResolutionDays": 0.1,
"open": 0,
"overdue": 0,
"total": 0,
"urgent": 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"
}