Cakemail Logo
Cakemail API

Log (1.18.25)

Endpoint:https://api.cakemail.dev

Show list logs

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

Show list logspath Parameters

  • list_idinteger · min: 1 · required

Show list logsquery Parameters

  • start_timeinteger · min: 1 · max: 2147483647
  • end_timeinteger · min: 1 · max: 2147483647
  • account_idinteger · min: 1
  • pageinteger · min: 1
    Default: 1
  • per_pageinteger · min: 1
    Default: 50
  • with_countboolean
  • filterstring

Show list logsResponses

    • paginationobject · required
    • dataobject[] · required

Show campaign logs

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

Show campaign logspath Parameters

  • campaign_idinteger · min: 1 · required

Show campaign logsquery Parameters

  • start_timeinteger · min: 1 · max: 2147483647
  • end_timeinteger · min: 1 · max: 2147483647
  • cursorstring
  • account_idinteger · min: 1
  • pageinteger · min: 1
    Default: 1
  • per_pageinteger · min: 1
    Default: 50
  • with_countboolean
  • filterstring
  • sortstring · pattern: [-|+]?.*

Show campaign logsResponses

    • paginationobject · required
    • dataobject[] · required

Show action logs

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

Show action logspath Parameters

  • workflow_idstring · required
  • action_idstring · required

Show action logsquery Parameters

  • start_timeinteger · min: 1 · max: 2147483647
  • end_timeinteger · min: 1 · max: 2147483647
  • account_idinteger · min: 1
  • pageinteger · min: 1
    Default: 1
  • per_pageinteger · min: 1
    Default: 50
  • with_countboolean
  • filterstring
  • sortstring · pattern: [-|+]?.*

Show action logsResponses

    • paginationobject · required
    • dataobject[] · required

Show all campaign log exports

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

Show all campaign log exportspath Parameters

  • campaign_idinteger · required

Show all campaign log exportsquery Parameters

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

Show all campaign log exportsResponses

    • paginationobject · required
    • dataobject[] · required

Create a campaign log export

POST
https://api.cakemail.dev
/logs/campaigns/{campaign_id}/exports

Create a campaign log exportpath Parameters

  • campaign_idinteger · required

Create a campaign log exportquery Parameters

  • descriptionstring
  • account_idinteger · min: 1
  • filterstring

Create a campaign log exportRequest Body

  • descriptionstring
  • filterstring

Create a campaign log exportResponses

    • idstring · required
    • dataobject · required
    • objectstring
      Default: task
    • createdboolean
      Default: true

Download a campaign log export

GET
https://api.cakemail.dev
/logs/campaigns/{campaign_id}/exports/{campaign_log_export_id}/download

Download a campaign log exportpath Parameters

  • campaign_log_export_idstring · required
  • campaign_idinteger · required

Download a campaign log exportquery Parameters

  • account_idinteger · min: 1

Download a campaign log exportResponses

    • dataobject · required

Show all list logs exports

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

Show all list logs exportspath Parameters

  • list_idinteger · min: 1 · required

Show all list logs exportsquery Parameters

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

Show all list logs exportsResponses

    • paginationobject · required
    • dataobject[] · required

Create a list log export

POST
https://api.cakemail.dev
/logs/lists/{list_id}/exports

Create a list log exportpath Parameters

  • list_idinteger · required

Create a list log exportquery Parameters

  • account_idinteger · min: 1

Create a list log exportRequest Body

  • descriptionstring
  • filterstring

Create a list log exportResponses

    • idstring · required
    • dataobject · required
    • objectstring
      Default: task
    • createdboolean
      Default: true

Download a list logs export

GET
https://api.cakemail.dev
/logs/lists/{list_id}/exports/{list_logs_export_id}/download

Download a list logs exportpath Parameters

  • list_logs_export_idstring · required
  • list_idinteger · required

Download a list logs exportquery Parameters

  • account_idinteger · min: 1

Download a list logs exportResponses

    • dataobject · required