Campaigns

Get campaign stats detail

Changed on

Returns statistics for a specific campaign with each subscriber and their individual events.

get/campaigns/{id}/stats-detail

Request

  • Base URL
    https://api2.ecomailapp.cz
  • URL
    https://api2.ecomailapp.cz/campaigns/{id}/stats-detail
  • Auth
    API key in header key

Path parameters

idinteger required

Campaign ID.

Query parameters

eventstring

Filter by event type: open, send, unsub, soft_bounce, click, hard_bounce, out_of_band, spam.

emailstring

Filter by subscriber email.

from_datestring

Filter events from this date onwards (YYYY-MM-DD in UTC). Cannot be more than one year in the past.

to_datestring

Filter events up to this date (YYYY-MM-DD in UTC). Must be after from_date.

detailstring

Set to true to return each individual event per subscriber (with event, url and occured_at) instead of aggregated per-event counts.

per_pageinteger

Results per page. Maximum and default is 100.

pageinteger

Page number.

Response

OK

next_page_urlunknown
totalinteger
per_pageinteger

Changes

    • breaking

      the response's property type changed from string to no type for status

    • breaking

      the / response's property type changed from object to array for status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • info

      added the new optional query request parameter detail

    • info

      added the new optional query request parameter to_date