Log

Access detailed activity logs for campaigns and lists. Logs track individual email events (sends, opens, clicks, bounces, unsubscribes). Log data can be exported to CSV files.

Show list logs

GET

https://api.cakemail.dev

/logs/lists/{list_id}

Get activity logs for a list, including subscription and unsubscription events.

Required scope(s): logs:read

Show list logs › path Parameters

list_id

integer · min: 1 · required

Show list logs › query Parameters

start_time

integer · min: 1 · max: 2147483647

end_time

integer · min: 1 · max: 2147483647

account_id

integer · min: 1

Optional Account ID to be used for the request

page

integer · min: 1

Default: 1

per_page

integer · min: 1

Default: 50

with_count

boolean

Include count in the response

Default: false

filter

string

Valid Terms:

additional_info
contact_id
email
uniques
group_by_contact
track_id
log_id
start_id
end_id
totals
type

Valid Operators:

==

Query separator:

Valid Terms:

additional_info
contact_id
email
uniques
group_by_contact
track_id
log_id
start_id
end_id
totals
type

Valid Operators:

==

Query separator:

Show list logs › Responses

Successful Response

ListLogsResponse

object · required

Pagination details

ListLogResponse[] · required

List of contact list log entries

GET/logs/lists/{list_id}

curl https://api.cakemail.dev/logs/lists/:list_id \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "pagination": {
    "page": 1,
    "per_page": 0,
    "count": 0
  },
  "data": [
    {
      "id": 0,
      "contact_id": 0,
      "email": "email",
      "type": "clickthru",
      "timestamp": 0,
      "occurrences": 0,
      "user_agent": {
        "ip": "ip",
        "os": {
          "family": "family",
          "version": "version"
        },
        "browser": {
          "family": "family",
          "version": "version"
        },
        "device": {
          "family": "pc",
          "brand": "brand",
          "model": "model"
        },
        "is_bot": true,
        "raw": "raw"
      },
      "campaign_id": 0,
      "clickthru_url": "clickthru_url",
      "dsn_message": "dsn_message",
      "unsub_reason": "unsub_reason",
      "subscription_type": "resubscribe"
    }
  ]
}

json

application/json

Show campaign logs

GET

https://api.cakemail.dev

/logs/campaigns/{campaign_id}

Get activity logs for a campaign, including sends, opens, clicks, and bounces.

Required scope(s): logs:read

Show campaign logs › path Parameters

campaign_id

integer · min: 1 · required

Show campaign logs › query Parameters

start_time

integer · min: 1 · max: 2147483647

end_time

integer · min: 1 · max: 2147483647

cursor

string

account_id

integer · min: 1

Optional Account ID to be used for the request

page

integer · min: 1

Default: 1

per_page

integer · min: 1

Default: 50

with_count

boolean

Include count in the response

Default: false

filter

string

Valid Terms:

additional_info
link_id
contact_id
email
uniques
group_by_contact
log_id
totals
type

Valid Operators:

==

Query separator:

Valid Terms:

additional_info
link_id
contact_id
email
uniques
group_by_contact
log_id
totals
type

Valid Operators:

==

Query separator:

sort

string · pattern: [-|+]?.*

Sort term and direction, using syntax [-|+]term.

Valid terms:

time
log_id

Sort term and direction, using syntax [-|+]term.

Valid terms:

time
log_id

Show campaign logs › Responses

Successful Response

CampaignLogsResponse

object · required

Pagination details

CampaignLogResponse[] · required

List of campaign log entries

GET/logs/campaigns/{campaign_id}

curl https://api.cakemail.dev/logs/campaigns/:campaign_id \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "pagination": {
    "page": 1,
    "per_page": 0,
    "count": 0,
    "cursor": {
      "previous": "previous",
      "next": "next"
    }
  },
  "data": [
    {
      "id": 0,
      "contact_id": 0,
      "email": "email",
      "type": "clickthru",
      "timestamp": 0,
      "occurrences": 0,
      "clickthru_url": "clickthru_url",
      "user_agent": {
        "ip": "ip",
        "os": {
          "family": "family",
          "version": "version"
        },
        "browser": {
          "family": "family",
          "version": "version"
        },
        "device": {
          "family": "pc",
          "brand": "brand",
          "model": "model"
        },
        "is_bot": true,
        "raw": "raw"
      }
    }
  ]
}

json

application/json

Show action logs

GET

https://api.cakemail.dev

/logs/workflows/{workflow_id}/actions/{action_id}

Required scope(s): logs:read

Show action logs › path Parameters

workflow_id

string · required

action_id

string · required

Show action logs › query Parameters

start_time

integer · min: 1 · max: 2147483647

end_time

integer · min: 1 · max: 2147483647

account_id

integer · min: 1

Optional Account ID to be used for the request

page

integer · min: 1

Default: 1

per_page

integer · min: 1

Default: 50

with_count

boolean

Include count in the response

Default: false

filter

string

Valid Terms:

additional_info
link_id
contact_id
email
log_id
track_id
type
group_by_contact

Valid Operators:

==

Query separator:

Valid Terms:

additional_info
link_id
contact_id
email
log_id
track_id
type
group_by_contact

Valid Operators:

==

Query separator:

sort

string · pattern: [-|+]?.*

Sort term and direction, using syntax [-|+]term.

Valid terms:

time
log_id

Sort term and direction, using syntax [-|+]term.

Valid terms:

time
log_id

Show action logs › Responses

Successful Response

ActionLogsResponse

Pagination · required

ActionLogResponse[] · required

GET/logs/workflows/{workflow_id}/actions/{action_id}

curl https://api.cakemail.dev/logs/workflows/:workflow_id/actions/:action_id \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "pagination": {
    "page": 1,
    "per_page": 0,
    "count": 0
  },
  "data": [
    {
      "id": 0,
      "contact_id": 0,
      "email": "email",
      "type": "clickthru",
      "timestamp": 0,
      "occurrences": 0,
      "user_agent": {
        "ip": "ip",
        "os": {
          "family": "family",
          "version": "version"
        },
        "browser": {
          "family": "family",
          "version": "version"
        },
        "device": {
          "family": "pc",
          "brand": "brand",
          "model": "model"
        },
        "is_bot": true,
        "raw": "raw"
      }
    }
  ]
}

json

application/json

Show all campaign log exports

GET

https://api.cakemail.dev

/logs/campaigns/{campaign_id}/exports

Show all campaign log exports

Required scope(s): logs:export

Show all campaign log exports › path Parameters

campaign_id

integer · required

Show all campaign log exports › query Parameters

account_id

integer · min: 1

Optional Account ID to be used for the request

page

integer · min: 1

Default: 1

per_page

integer · min: 1

Default: 50

with_count

boolean

Include count in the response

Default: false

Show all campaign log exports › Responses

Successful Response

CampaignLogExportsResponse

object · required

Pagination details

CampaignLogExportFullResponse[] · required

List of campaign log exports

Create a campaign log export

POST

https://api.cakemail.dev

/logs/campaigns/{campaign_id}/exports

Export to CSV a campaign log.

Required scope(s): logs:export

Create a campaign log export › path Parameters

campaign_id

integer · required

Create a campaign log export › query Parameters

description

string

account_id

integer · min: 1

Optional Account ID to be used for the request

filter

string

Valid Terms:

additional_info
link_id
contact_id
email
uniques
group_by_contact
log_id
totals
type

Valid Operators:

==

Query separator:

Valid Terms:

additional_info
link_id
contact_id
email
uniques
group_by_contact
log_id
totals
type

Valid Operators:

==

Query separator:

Create a campaign log export › Request Body

CreateCampaignLogExportRequest

description

string

filter

string

Valid Terms:

additional_info
link_id
contact_id
email
uniques
group_by_contact
log_id
totals
type

Valid Operators:

==

Query separator:

Create a campaign log export › Responses

Successful Response

CreateCampaignLogExportResponse

id

string · required

Export task id

object · required

Created export details

object

string

Object type

Default: task

created

boolean

Whether the export was created

Default: true

Download a campaign log export

GET

https://api.cakemail.dev

/logs/campaigns/{campaign_id}/exports/{campaign_log_export_id}/download

Returns the URL to download the exported CSV file.

Required scope(s): logs:export

Download a campaign log export › path Parameters

campaign_log_export_id

string · required

campaign_id

integer · required

Download a campaign log export › query Parameters

account_id

integer · min: 1

Optional Account ID to be used for the request

Download a campaign log export › Responses

Successful Response

DownloadCampaignLogExportResponse

object · required

Download details

Show all list logs exports

GET

https://api.cakemail.dev

/logs/lists/{list_id}/exports

Show all list logs exports

Required scope(s): logs:export

Show all list logs exports › path Parameters

list_id

integer · min: 1 · required

Show all list logs exports › query Parameters

account_id

integer · min: 1

Optional Account ID to be used for the request

page

integer · min: 1

Default: 1

per_page

integer · min: 1

Default: 50

with_count

boolean

Include count in the response

Default: false

Show all list logs exports › Responses

Successful Response

ListLogsExportsResponse

object · required

Pagination details

ListLogsExportFullResponse[] · required

List of list log exports

Create a list log export

POST

https://api.cakemail.dev

/logs/lists/{list_id}/exports

Export List Activity Logs to CSV.

Required scope(s): logs:export

Create a list log export › path Parameters

list_id

integer · required

Create a list log export › query Parameters

account_id

integer · min: 1

Optional Account ID to be used for the request

Create a list log export › Request Body

CreateListLogsExportRequest

description

string

filter

string

Valid Terms:

additional_info
contact_id
email
uniques
group_by_contact
track_id
log_id
start_id
end_id
totals
type

Valid Operators:

==

Query separator:

Create a list log export › Responses

Successful Response

CreateListLogsExportResponse

id

string · required

Export task id

object · required

Created export details

object

string

Object type

Default: task

created

boolean

Whether the export was created

Default: true

Download a list logs export

GET

https://api.cakemail.dev

/logs/lists/{list_id}/exports/{list_logs_export_id}/download

Returns the URL to download the exported CSV file.

Required scope(s): logs:export

Download a list logs export › path Parameters

list_logs_export_id

string · required

list_id

integer · required

Download a list logs export › query Parameters

account_id

integer · min: 1

Optional Account ID to be used for the request

Download a list logs export › Responses

Successful Response

DownloadListLogsExportResponse

object · required

Download details

Report Links