ApexDevelopers
Swagger Docs

Analytics

Track engagement metrics and credit usage.

GET
/analytics

Get engagement analytics for a time period

Query Parameters

NameTypeRequiredDescription
startDate
string
Required
Start date in ISO 8601 format
endDate
string
Required
End date in ISO 8601 format

Response

200Analytics data

Field Descriptions

  • automated — Metrics from keyword/list-based automated replies
  • extension — Metrics from Chrome extension manual replies

Error Response

400Invalid date range

Get engagement analytics for January 2024:

GET
/usage

Get current credit balance and usage

Response

200Usage data

Field Descriptions

  • credits — Total credits for current billing cycle
  • consumed — Credits used so far
  • autoReplies — Replies via automation engine
  • extensionReplies — Replies via Chrome extension
  • lastReset — When credit counter last reset (billing cycle start)

Check your current credit balance: