Insights
Insights provide analytics dashboards for your CRM data — contact growth, activity trends, project revenue, and more. Query by date range with automatic period-over-period comparison.
Get insights overview with summary and trends
Section titled “Get insights overview with summary and trends”Endpoint: insights-overview
| Field | Type | Required | Description |
|---|---|---|---|
start_date | string | Yes | Start of the date range in ISO 8601 (YYYY-MM-DD) format (required) |
end_date | string | Yes | End of the date range in ISO 8601 (YYYY-MM-DD) format, inclusive (required) |
compare_start_date | string | No | Start of an optional comparison date range in ISO 8601 (YYYY-MM-DD) format; provide with compare_end_date to include comparison data |
compare_end_date | string | No | End of an optional comparison date range in ISO 8601 (YYYY-MM-DD) format, inclusive |
curl -X POST https://api.driftwoodapp.com/api/insights-overview \ -H "Authorization: Bearer YOUR_TOKEN" \ -H "Content-Type: application/json" \ -d '{"start_date": "...", "end_date": "..."}'Get project insights with summary and breakdowns
Section titled “Get project insights with summary and breakdowns”Endpoint: insights-projects
| Field | Type | Required | Description |
|---|---|---|---|
start_date | string | Yes | Start of the date range in ISO 8601 (YYYY-MM-DD) format (required) |
end_date | string | Yes | End of the date range in ISO 8601 (YYYY-MM-DD) format, inclusive (required) |
compare_start_date | string | No | Start of an optional comparison date range in ISO 8601 (YYYY-MM-DD) format; provide with compare_end_date to include comparison data |
compare_end_date | string | No | End of an optional comparison date range in ISO 8601 (YYYY-MM-DD) format, inclusive |
curl -X POST https://api.driftwoodapp.com/api/insights-projects \ -H "Authorization: Bearer YOUR_TOKEN" \ -H "Content-Type: application/json" \ -d '{"start_date": "...", "end_date": "..."}'Error Codes
Section titled “Error Codes”| Code | Description |
|---|---|
insights.dates_required | Dates required |
insights.invalid_start_date | Invalid start date |
insights.invalid_end_date | Invalid end date |
insights.invalid_compare_start_date | Invalid compare start date |
insights.invalid_compare_end_date | Invalid compare end date |