Campaign tracking

Get campaign statistics

Global and per step statistics of a multichannel campaign. Computed on demand (can take several seconds) and then cached; Cache-Control: max-age=300 is set when detailed is not true. Errors are unusual here: an unknown campaign or ANY error (including an invalid parameter) returns 401, and a failure of the statistics engine can return HTTP 200 with {"error": "Error"}. For a few accounts a 503 STATS_COMPUTING with Retry-After: 30 is returned while a computation is in progress.

get/stats/advanced

Request

  • Base URL: https://api.emelia.io
  • URL: https://api.emelia.io/stats/advanced
  • Auth: API key in header Authorization

Query parameters

campaignIdstring required

MongoDB ObjectId: 24 hexadecimal characters.

Example:6650f1a2b839d80011c5a0f1
detailedboolean

For multichannel campaigns the shape is always {global, steps}.

startstring date-time
endstring date-time
providerIdstring

MongoDB ObjectId: 24 hexadecimal characters.

Example:6650f1a2b839d80011c5a0f1

Restrict to one email provider.

Response

Success.

OR

Changes

No recorded changes to this operation across all 1 revision of this API.