Skip to content

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.

Section titled “Get insights overview with summary and trends”

Endpoint: insights-overview

FieldTypeRequiredDescription
start_datestringYesStart of the date range in ISO 8601 (YYYY-MM-DD) format (required)
end_datestringYesEnd of the date range in ISO 8601 (YYYY-MM-DD) format, inclusive (required)
compare_start_datestringNoStart of an optional comparison date range in ISO 8601 (YYYY-MM-DD) format; provide with compare_end_date to include comparison data
compare_end_datestringNoEnd of an optional comparison date range in ISO 8601 (YYYY-MM-DD) format, inclusive
Terminal window
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

FieldTypeRequiredDescription
start_datestringYesStart of the date range in ISO 8601 (YYYY-MM-DD) format (required)
end_datestringYesEnd of the date range in ISO 8601 (YYYY-MM-DD) format, inclusive (required)
compare_start_datestringNoStart of an optional comparison date range in ISO 8601 (YYYY-MM-DD) format; provide with compare_end_date to include comparison data
compare_end_datestringNoEnd of an optional comparison date range in ISO 8601 (YYYY-MM-DD) format, inclusive
Terminal window
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": "..."}'
CodeDescription
insights.dates_requiredDates required
insights.invalid_start_dateInvalid start date
insights.invalid_end_dateInvalid end date
insights.invalid_compare_start_dateInvalid compare start date
insights.invalid_compare_end_dateInvalid compare end date