Cakemail API

Report

Endpointhttps://api.cakemail.dev

Access campaign, list, and account performance statistics. Includes open rates, click rates, bounce rates, and other delivery metrics. Campaign report data can be exported to CSV files.

Show list report

GET

https://api.cakemail.dev

/reports/lists/{list_id}

Get performance statistics for a list over a time period.

Required scope(s): reports:read

Show list report › path Parameters

list_id

integer · min: 1 · required

Show list report › query Parameters

account_id

integer · min: 1

Optional Account ID to be used for the request

Show list report › Responses

Successful Response

object · required

GET/reports/lists/{list_id}

curl --request GET \
  --url https://api.cakemail.dev/reports/lists/:list_id

shell

Example Responses

{
  "data": {
    "active_contacts": 0,
    "pending_contacts": 0,
    "invalid_contacts": 0,
    "unsubscribed_contacts": 0,
    "flagged_contacts": 0,
    "deleted_contacts": 0,
    "sent_emails": 0,
    "open_rate": 0,
    "bounce_rate": 0,
    "click_rate": 0,
    "clickthru_rate": 0,
    "unsubscribe_rate": 0,
    "spam_rate": 0
  }
}

json

application/json

Show campaign report

GET

https://api.cakemail.dev

/reports/campaigns/{campaign_id}

Get detailed delivery and engagement statistics for a campaign.

Required scope(s): reports:read

Show campaign report › path Parameters

campaign_id

integer · min: 1 · required

Show campaign report › query Parameters

account_id

integer · min: 1

Optional Account ID to be used for the request

Show campaign report › Responses

Successful Response

object · required

GET/reports/campaigns/{campaign_id}

curl --request GET \
  --url https://api.cakemail.dev/reports/campaigns/:campaign_id

shell

Example Responses

{
  "data": {
    "active_emails": 0,
    "bounces": 0,
    "bounce_rate": 0,
    "bounces_address_changed": 0,
    "bounces_challenge_response": 0,
    "bounces_dns_failure": 0,
    "bounces_full_mailbox": 0,
    "bounces_hard": 0,
    "bounces_mail_blocked": 0,
    "bounces_soft": 0,
    "bounces_transient": 0,
    "clicks": 0,
    "click_rate": 0,
    "clickthru_rate": 0,
    "forwards": 0,
    "implied_opens": 0,
    "opens": 0,
    "open_rate": 0,
    "spams": 0,
    "unique_clicks": 0,
    "unique_opens": 0,
    "unopens": 0,
    "unopen_rate": 0,
    "unsubscribes": 0,
    "unsubscribe_rate": 0,
    "spam_rate": 0,
    "sent_emails": 0,
    "sent_rate": 0
  }
}

json

application/json

Show campaign links report

GET

https://api.cakemail.dev

/reports/campaigns/{campaign_id}/links

Get click statistics for each tracked link in a campaign.

Required scope(s): reports:read

Show campaign links report › path Parameters

campaign_id

integer · min: 1 · required

Show campaign links report › query Parameters

start_time

integer

end_time

integer

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

sort

string

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

Valid terms:

unique
total
link

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

Valid terms:

unique
total
link

Show campaign links report › Responses

Successful Response

object · required

object[] · required

Link click statistics

GET/reports/campaigns/{campaign_id}/links

curl --request GET \
  --url https://api.cakemail.dev/reports/campaigns/:campaign_id/links

shell

Example Responses

{
  "pagination": {
    "page": 0,
    "per_page": 0,
    "count": 0
  },
  "data": [
    {
      "id": 0,
      "link": "link",
      "unique": 0,
      "total": 0,
      "unique_rate": 0,
      "total_rate": 0
    }
  ]
}

json

application/json

Show my account report

GET

https://api.cakemail.dev

/reports/accounts/self

Get performance statistics for your own account.

Required scope(s): reports:read

Show my account report › query Parameters

start_time

integer · min: 1 · max: 2147483647

end_time

integer · min: 1 · max: 2147483647

Show my account report › Responses

Successful Response

object · required

GET/reports/accounts/self

curl --request GET \
  --url https://api.cakemail.dev/reports/accounts/self

shell

Example Responses

{
  "data": {
    "active_contacts": 0,
    "sent_emails": 0,
    "sent_campaign_emails": 0,
    "sent_action_emails": 0,
    "sent_email_emails": 0,
    "open_rate": 0,
    "bounce_rate": 0,
    "click_rate": 0,
    "spam_rate": 0,
    "unsubscribe_rate": 0,
    "emails_usage": 0,
    "contacts_usage": 0,
    "bounces_hard": 0,
    "bounce_hard_rate": 0,
    "spams": 0,
    "current_lists": 0,
    "email_api": {
      "submitted": 0,
      "delivered": 0
    }
  }
}

json

application/json

Show account report

GET

https://api.cakemail.dev

/reports/accounts/{account_id}

Get performance statistics for a sub-account.

Required scope(s): reports:read

Show account report › path Parameters

account_id

integer · min: 1 · required

Show account report › query Parameters

start_time

integer · min: 1 · max: 2147483647

end_time

integer · min: 1 · max: 2147483647

Show account report › Responses

Successful Response

object · required

GET/reports/accounts/{account_id}

curl --request GET \
  --url https://api.cakemail.dev/reports/accounts/:account_id

shell

Example Responses

{
  "data": {
    "active_contacts": 0,
    "sent_emails": 0,
    "sent_campaign_emails": 0,
    "sent_action_emails": 0,
    "sent_email_emails": 0,
    "open_rate": 0,
    "bounce_rate": 0,
    "click_rate": 0,
    "spam_rate": 0,
    "unsubscribe_rate": 0,
    "emails_usage": 0,
    "contacts_usage": 0,
    "bounces_hard": 0,
    "bounce_hard_rate": 0,
    "spams": 0,
    "current_lists": 0,
    "email_api": {
      "submitted": 0,
      "delivered": 0
    }
  }
}

json

application/json

Show action report

GET

https://api.cakemail.dev

/reports/workflows/{workflow_id}/actions/{action_id}

Required scope(s): reports:read

Show action report › path Parameters

workflow_id

string · required

action_id

string · required

Show action report › query Parameters

account_id

integer · min: 1

Optional Account ID to be used for the request

Show action report › Responses

Successful Response

object · required

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

curl --request GET \
  --url https://api.cakemail.dev/reports/workflows/:workflow_id/actions/:action_id

shell

Example Responses

{
  "data": {
    "bounces": 0,
    "bounces_address_changed": 0,
    "bounces_challenge_response": 0,
    "bounces_dns_failure": 0,
    "bounces_full_mailbox": 0,
    "bounces_hard": 0,
    "bounces_mail_blocked": 0,
    "bounces_soft": 0,
    "bounces_transient": 0,
    "unique_clicks": 0,
    "forwards": 0,
    "implied_opens": 0,
    "unique_opens": 0,
    "unopens": 0,
    "clicks": 0,
    "opens": 0,
    "spams": 0,
    "spam_rate": 0,
    "unsubscribes": 0,
    "sent_emails": 0
  }
}

json

application/json

List campaigns reports exports

GET

https://api.cakemail.dev

/reports/campaigns-exports

List all campaign report export tasks.

Required scope(s): reports:read

List campaigns reports 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

filter

string

Valid Terms:

status
progress

Valid Operators:

==

Query separator:

Valid Terms:

status
progress

Valid Operators:

==

Query separator:

List campaigns reports exports › Responses

Successful Response

object · required

object[] · required

List of campaign report exports

GET/reports/campaigns-exports

curl --request GET \
  --url https://api.cakemail.dev/reports/campaigns-exports

shell

Example Responses

{
  "pagination": {
    "page": 0,
    "per_page": 0,
    "count": 0
  },
  "data": [
    {
      "id": "id",
      "status": "pending",
      "created_on": 0,
      "expires_on": 0,
      "progress": 0,
      "requested_by": {
        "email": "test@example.com",
        "id": 0
      },
      "type": "contactsexport",
      "description": "description",
      "payload": {}
    }
  ]
}

json

application/json

Create a campaigns reports export

POST

https://api.cakemail.dev

/reports/campaigns-exports

Create a new campaign report export to CSV.

Required scope(s): reports:read

Create a campaigns reports export › query Parameters

account_id

integer · min: 1

Optional Account ID to be used for the request

Create a campaigns reports export › Request Body

description

string

Create a campaigns reports export › Responses

Successful Response

object · required

POST/reports/campaigns-exports

curl --request POST \
  --url https://api.cakemail.dev/reports/campaigns-exports \
  --header 'Content-Type: application/json' \
  --data '
{
  "description": "description"
}
'

shell

Example Request Body

{
  "description": "description"
}

json

Example Responses

{
  "data": {
    "id": "id",
    "status": "pending",
    "created_on": 0,
    "expires_on": 0,
    "progress": 0,
    "requested_by": {
      "email": "test@example.com",
      "id": 0
    },
    "type": "contactsexport",
    "description": "description",
    "payload": {}
  }
}

json

application/json

Get a campaigns reports export

GET

https://api.cakemail.dev

/reports/campaigns-exports/{export_id}

Retrieve the details and status of a campaign report export task.

Required scope(s): reports:read

Get a campaigns reports export › path Parameters

export_id

string · required

Get a campaigns reports export › query Parameters

account_id

integer · min: 1

Optional Account ID to be used for the request

Get a campaigns reports export › Responses

Successful Response

object · required

GET/reports/campaigns-exports/{export_id}

curl --request GET \
  --url https://api.cakemail.dev/reports/campaigns-exports/:export_id

shell

Example Responses

{
  "data": {
    "id": "id",
    "status": "pending",
    "created_on": 0,
    "expires_on": 0,
    "progress": 0,
    "requested_by": {
      "email": "test@example.com",
      "id": 0
    },
    "type": "contactsexport",
    "description": "description",
    "payload": {}
  }
}

json

application/json

Delete a campaigns report export

DELETE

https://api.cakemail.dev

/reports/campaigns-exports/{export_id}

Delete a campaign report export.

Required scope(s): reports:read

Delete a campaigns report export › path Parameters

export_id

string · required

Delete a campaigns report export › query Parameters

account_id

integer · min: 1

Optional Account ID to be used for the request

Delete a campaigns report export › Responses

Successful Response

object · required

DELETE/reports/campaigns-exports/{export_id}

curl --request DELETE \
  --url https://api.cakemail.dev/reports/campaigns-exports/:export_id

shell

Example Responses

{
  "data": {
    "id": "id",
    "status": "pending",
    "created_on": 0,
    "expires_on": 0,
    "progress": 0,
    "requested_by": {
      "email": "test@example.com",
      "id": 0
    },
    "type": "contactsexport",
    "description": "description",
    "payload": {}
  }
}

json

application/json

Download a campaigns reports export

GET

https://api.cakemail.dev

/reports/campaigns-exports/{export_id}/download

Get a download link for a completed campaign report export.

Required scope(s): reports:read

Download a campaigns reports export › path Parameters

export_id

string · required

Download a campaigns reports export › query Parameters

account_id

integer · min: 1

Optional Account ID to be used for the request

Download a campaigns reports export › Responses

Successful Response

object · required

GET/reports/campaigns-exports/{export_id}/download

curl --request GET \
  --url https://api.cakemail.dev/reports/campaigns-exports/:export_id/download

shell

Example Responses

{
  "data": {
    "expires_on": 0,
    "url": "https://www.example.com/path/to/resource"
  }
}

json

application/json

Tags Log

Cakemail API

Report

Endpointhttps://api.cakemail.dev

Access campaign, list, and account performance statistics. Includes open rates, click rates, bounce rates, and other delivery metrics. Campaign report data can be exported to CSV files.

Show list report

GET

https://api.cakemail.dev

/reports/lists/{list_id}

Get performance statistics for a list over a time period.

Required scope(s): reports:read

Show list report › path Parameters

list_id

integer · min: 1 · required

Show list report › query Parameters

account_id

integer · min: 1

Optional Account ID to be used for the request

Show list report › Responses

Successful Response

object · required

GET/reports/lists/{list_id}

curl --request GET \
  --url https://api.cakemail.dev/reports/lists/:list_id

shell

Example Responses

{
  "data": {
    "active_contacts": 0,
    "pending_contacts": 0,
    "invalid_contacts": 0,
    "unsubscribed_contacts": 0,
    "flagged_contacts": 0,
    "deleted_contacts": 0,
    "sent_emails": 0,
    "open_rate": 0,
    "bounce_rate": 0,
    "click_rate": 0,
    "clickthru_rate": 0,
    "unsubscribe_rate": 0,
    "spam_rate": 0
  }
}

json

application/json

Show campaign report

GET

https://api.cakemail.dev

/reports/campaigns/{campaign_id}

Get detailed delivery and engagement statistics for a campaign.

Required scope(s): reports:read

Show campaign report › path Parameters

campaign_id

integer · min: 1 · required

Show campaign report › query Parameters

account_id

integer · min: 1

Optional Account ID to be used for the request

Show campaign report › Responses

Successful Response

object · required

GET/reports/campaigns/{campaign_id}

curl --request GET \
  --url https://api.cakemail.dev/reports/campaigns/:campaign_id

shell

Example Responses

{
  "data": {
    "active_emails": 0,
    "bounces": 0,
    "bounce_rate": 0,
    "bounces_address_changed": 0,
    "bounces_challenge_response": 0,
    "bounces_dns_failure": 0,
    "bounces_full_mailbox": 0,
    "bounces_hard": 0,
    "bounces_mail_blocked": 0,
    "bounces_soft": 0,
    "bounces_transient": 0,
    "clicks": 0,
    "click_rate": 0,
    "clickthru_rate": 0,
    "forwards": 0,
    "implied_opens": 0,
    "opens": 0,
    "open_rate": 0,
    "spams": 0,
    "unique_clicks": 0,
    "unique_opens": 0,
    "unopens": 0,
    "unopen_rate": 0,
    "unsubscribes": 0,
    "unsubscribe_rate": 0,
    "spam_rate": 0,
    "sent_emails": 0,
    "sent_rate": 0
  }
}

json

application/json

Show campaign links report

GET

https://api.cakemail.dev

/reports/campaigns/{campaign_id}/links

Get click statistics for each tracked link in a campaign.

Required scope(s): reports:read

Show campaign links report › path Parameters

campaign_id

integer · min: 1 · required

Show campaign links report › query Parameters

start_time

integer

end_time

integer

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

sort

string

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

Valid terms:

unique
total
link

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

Valid terms:

unique
total
link

Show campaign links report › Responses

Successful Response

object · required

object[] · required

Link click statistics

GET/reports/campaigns/{campaign_id}/links

curl --request GET \
  --url https://api.cakemail.dev/reports/campaigns/:campaign_id/links

shell

Example Responses

{
  "pagination": {
    "page": 0,
    "per_page": 0,
    "count": 0
  },
  "data": [
    {
      "id": 0,
      "link": "link",
      "unique": 0,
      "total": 0,
      "unique_rate": 0,
      "total_rate": 0
    }
  ]
}

json

application/json

Show my account report

GET

https://api.cakemail.dev

/reports/accounts/self

Get performance statistics for your own account.

Required scope(s): reports:read

Show my account report › query Parameters

start_time

integer · min: 1 · max: 2147483647

end_time

integer · min: 1 · max: 2147483647

Show my account report › Responses

Successful Response

object · required

GET/reports/accounts/self

curl --request GET \
  --url https://api.cakemail.dev/reports/accounts/self

shell

Example Responses

{
  "data": {
    "active_contacts": 0,
    "sent_emails": 0,
    "sent_campaign_emails": 0,
    "sent_action_emails": 0,
    "sent_email_emails": 0,
    "open_rate": 0,
    "bounce_rate": 0,
    "click_rate": 0,
    "spam_rate": 0,
    "unsubscribe_rate": 0,
    "emails_usage": 0,
    "contacts_usage": 0,
    "bounces_hard": 0,
    "bounce_hard_rate": 0,
    "spams": 0,
    "current_lists": 0,
    "email_api": {
      "submitted": 0,
      "delivered": 0
    }
  }
}

json

application/json

Show account report

GET

https://api.cakemail.dev

/reports/accounts/{account_id}

Get performance statistics for a sub-account.

Required scope(s): reports:read

Show account report › path Parameters

account_id

integer · min: 1 · required

Show account report › query Parameters

start_time

integer · min: 1 · max: 2147483647

end_time

integer · min: 1 · max: 2147483647

Show account report › Responses

Successful Response

object · required

GET/reports/accounts/{account_id}

curl --request GET \
  --url https://api.cakemail.dev/reports/accounts/:account_id

shell

Example Responses

{
  "data": {
    "active_contacts": 0,
    "sent_emails": 0,
    "sent_campaign_emails": 0,
    "sent_action_emails": 0,
    "sent_email_emails": 0,
    "open_rate": 0,
    "bounce_rate": 0,
    "click_rate": 0,
    "spam_rate": 0,
    "unsubscribe_rate": 0,
    "emails_usage": 0,
    "contacts_usage": 0,
    "bounces_hard": 0,
    "bounce_hard_rate": 0,
    "spams": 0,
    "current_lists": 0,
    "email_api": {
      "submitted": 0,
      "delivered": 0
    }
  }
}

json

application/json

Show action report

GET

https://api.cakemail.dev

/reports/workflows/{workflow_id}/actions/{action_id}

Required scope(s): reports:read

Show action report › path Parameters

workflow_id

string · required

action_id

string · required

Show action report › query Parameters

account_id

integer · min: 1

Optional Account ID to be used for the request

Show action report › Responses

Successful Response

object · required

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

curl --request GET \
  --url https://api.cakemail.dev/reports/workflows/:workflow_id/actions/:action_id

shell

Example Responses

{
  "data": {
    "bounces": 0,
    "bounces_address_changed": 0,
    "bounces_challenge_response": 0,
    "bounces_dns_failure": 0,
    "bounces_full_mailbox": 0,
    "bounces_hard": 0,
    "bounces_mail_blocked": 0,
    "bounces_soft": 0,
    "bounces_transient": 0,
    "unique_clicks": 0,
    "forwards": 0,
    "implied_opens": 0,
    "unique_opens": 0,
    "unopens": 0,
    "clicks": 0,
    "opens": 0,
    "spams": 0,
    "spam_rate": 0,
    "unsubscribes": 0,
    "sent_emails": 0
  }
}

json

application/json

List campaigns reports exports

GET

https://api.cakemail.dev

/reports/campaigns-exports

List all campaign report export tasks.

Required scope(s): reports:read

List campaigns reports 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

filter

string

Valid Terms:

status
progress

Valid Operators:

==

Query separator:

Valid Terms:

status
progress

Valid Operators:

==

Query separator:

List campaigns reports exports › Responses

Successful Response

object · required

object[] · required

List of campaign report exports

GET/reports/campaigns-exports

curl --request GET \
  --url https://api.cakemail.dev/reports/campaigns-exports

shell

Example Responses

{
  "pagination": {
    "page": 0,
    "per_page": 0,
    "count": 0
  },
  "data": [
    {
      "id": "id",
      "status": "pending",
      "created_on": 0,
      "expires_on": 0,
      "progress": 0,
      "requested_by": {
        "email": "test@example.com",
        "id": 0
      },
      "type": "contactsexport",
      "description": "description",
      "payload": {}
    }
  ]
}

json

application/json

Create a campaigns reports export

POST

https://api.cakemail.dev

/reports/campaigns-exports

Create a new campaign report export to CSV.

Required scope(s): reports:read

Create a campaigns reports export › query Parameters

account_id

integer · min: 1

Optional Account ID to be used for the request

Create a campaigns reports export › Request Body

description

string

Create a campaigns reports export › Responses

Successful Response

object · required

POST/reports/campaigns-exports

curl --request POST \
  --url https://api.cakemail.dev/reports/campaigns-exports \
  --header 'Content-Type: application/json' \
  --data '
{
  "description": "description"
}
'

shell

Example Request Body

{
  "description": "description"
}

json

Example Responses

{
  "data": {
    "id": "id",
    "status": "pending",
    "created_on": 0,
    "expires_on": 0,
    "progress": 0,
    "requested_by": {
      "email": "test@example.com",
      "id": 0
    },
    "type": "contactsexport",
    "description": "description",
    "payload": {}
  }
}

json

application/json

Get a campaigns reports export

GET

https://api.cakemail.dev

/reports/campaigns-exports/{export_id}

Retrieve the details and status of a campaign report export task.

Required scope(s): reports:read

Get a campaigns reports export › path Parameters

export_id

string · required

Get a campaigns reports export › query Parameters

account_id

integer · min: 1

Optional Account ID to be used for the request

Get a campaigns reports export › Responses

Successful Response

object · required

GET/reports/campaigns-exports/{export_id}

curl --request GET \
  --url https://api.cakemail.dev/reports/campaigns-exports/:export_id

shell

Example Responses

{
  "data": {
    "id": "id",
    "status": "pending",
    "created_on": 0,
    "expires_on": 0,
    "progress": 0,
    "requested_by": {
      "email": "test@example.com",
      "id": 0
    },
    "type": "contactsexport",
    "description": "description",
    "payload": {}
  }
}

json

application/json

Delete a campaigns report export

DELETE

https://api.cakemail.dev

/reports/campaigns-exports/{export_id}

Delete a campaign report export.

Required scope(s): reports:read

Delete a campaigns report export › path Parameters

export_id

string · required

Delete a campaigns report export › query Parameters

account_id

integer · min: 1

Optional Account ID to be used for the request

Delete a campaigns report export › Responses

Successful Response

object · required

DELETE/reports/campaigns-exports/{export_id}

curl --request DELETE \
  --url https://api.cakemail.dev/reports/campaigns-exports/:export_id

shell

Example Responses

{
  "data": {
    "id": "id",
    "status": "pending",
    "created_on": 0,
    "expires_on": 0,
    "progress": 0,
    "requested_by": {
      "email": "test@example.com",
      "id": 0
    },
    "type": "contactsexport",
    "description": "description",
    "payload": {}
  }
}

json

application/json

Download a campaigns reports export

GET

https://api.cakemail.dev

/reports/campaigns-exports/{export_id}/download

Get a download link for a completed campaign report export.

Required scope(s): reports:read

Download a campaigns reports export › path Parameters

export_id

string · required

Download a campaigns reports export › query Parameters

account_id

integer · min: 1

Optional Account ID to be used for the request

Download a campaigns reports export › Responses

Successful Response

object · required

GET/reports/campaigns-exports/{export_id}/download

curl --request GET \
  --url https://api.cakemail.dev/reports/campaigns-exports/:export_id/download

shell

Example Responses

{
  "data": {
    "expires_on": 0,
    "url": "https://www.example.com/path/to/resource"
  }
}

json

application/json

Tags Log