Get communications digest

Retrieves a concise financial summary for communications including revenue, expenses, profit, margin, cash balance, and largest expense category

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

entityIdstringRequired
The ID of the entity to get the digest for
start_datestringOptionalformat: "date"

Start date for the report period (YYYY-MM-DD format)

end_datestringOptionalformat: "date"

End date for the report period (YYYY-MM-DD format)

Response

Communications digest retrieved successfully
periodobject
metricsobject
metadataobject

Errors

400
Bad Request Error
404
Not Found Error
500
Internal Server Error