Cakemail Logo
Cakemail API

​Report (1.18.25)

Endpoint:https://api.cakemail.dev

​Show list report

GET
https://api.cakemail.dev
/reports/lists/{list_id}

​Show list report › path Parameters

  • list_idinteger · min: 1 · required

​Show list report › query Parameters

  • account_idinteger · min: 1

​Show list report › Responses

    • dataobject · required

​Show campaign report

GET
https://api.cakemail.dev
/reports/campaigns/{campaign_id}

​Show campaign report › path Parameters

  • campaign_idinteger · min: 1 · required

​Show campaign report › query Parameters

  • account_idinteger · min: 1

​Show campaign report › Responses

    • dataobject · required

​Show campaign links report

GET
https://api.cakemail.dev
/reports/campaigns/{campaign_id}/links

​Show campaign links report › path Parameters

  • campaign_idinteger · min: 1 · required

​Show campaign links report › query Parameters

  • start_timeinteger
  • end_timeinteger
  • account_idinteger · min: 1
  • pageinteger · min: 1
    Default: 1
  • per_pageinteger · min: 1
    Default: 50
  • with_countboolean
  • sortstring

​Show campaign links report › Responses

    • paginationobject · required
    • dataobject[] · required

​Show my account report

GET
https://api.cakemail.dev
/reports/accounts/self

​Show my account report › query Parameters

  • start_timeinteger · min: 1 · max: 2147483647
  • end_timeinteger · min: 1 · max: 2147483647

​Show my account report › Responses

    • dataobject · required

​Show account report

GET
https://api.cakemail.dev
/reports/accounts/{account_id}

​Show account report › path Parameters

  • account_idinteger · min: 1 · required

​Show account report › query Parameters

  • start_timeinteger · min: 1 · max: 2147483647
  • end_timeinteger · min: 1 · max: 2147483647

​Show account report › Responses

    • dataobject · required

​Show action report

GET
https://api.cakemail.dev
/reports/workflows/{workflow_id}/actions/{action_id}

​Show action report › path Parameters

  • workflow_idstring · required
  • action_idstring · required

​Show action report › query Parameters

  • account_idinteger · min: 1

​Show action report › Responses

    • dataobject · required

​List campaigns reports exports

GET
https://api.cakemail.dev
/reports/campaigns-exports

​List campaigns reports exports › query Parameters

  • account_idinteger · min: 1
  • pageinteger · min: 1
    Default: 1
  • per_pageinteger · min: 1
    Default: 50
  • with_countboolean
  • filterstring

​List campaigns reports exports › Responses

    • paginationobject · required
    • dataobject[] · required

​Create a campaigns reports export

POST
https://api.cakemail.dev
/reports/campaigns-exports

​Create a campaigns reports export › query Parameters

  • account_idinteger · min: 1

​Create a campaigns reports export › Request Body

  • descriptionstring

​Create a campaigns reports export › Responses

    • dataobject · required

​Get a campaigns reports export

GET
https://api.cakemail.dev
/reports/campaigns-exports/{export_id}

​Get a campaigns reports export › path Parameters

  • export_idstring · required

​Get a campaigns reports export › query Parameters

  • account_idinteger · min: 1

​Get a campaigns reports export › Responses

    • dataobject · required

​Delete a campaigns report export

DELETE
https://api.cakemail.dev
/reports/campaigns-exports/{export_id}

​Delete a campaigns report export › path Parameters

  • export_idstring · required

​Delete a campaigns report export › query Parameters

  • account_idinteger · min: 1

​Delete a campaigns report export › Responses

    • dataobject · required

​Download a campaigns reports export

GET
https://api.cakemail.dev
/reports/campaigns-exports/{export_id}/download

​Download a campaigns reports export › path Parameters

  • export_idstring · required

​Download a campaigns reports export › query Parameters

  • account_idinteger · min: 1

​Download a campaigns reports export › Responses

    • dataobject · required
TemplateSuppressed Email