Regions

The ContactMonkey Analytics API is divided based on region. The base urls are as follows:

• US: https://www.contactmonkey.com
• EU: https://www.contactmonkeyeu.com
• CA: https://www.contactmonkey.ca
• AU: https://www.contactmonkey.au

Authentication

The ContactMonkey Analytics API uses API Keys to authenticate requests.

Authentication to the API is done by Bearer Token. You will need to include the bearer_auth header in your request. The token can be generated in the ContactMonkey web app, under Settings > Integrations > Analytics API.

Deleting your API key in the ContactMonkey web app will require you to re-authenticate the integration.

📘

Your API keys are unique to your company. Make sure to keep them secure and do not share them outside of your organization.

Pagination

Endpoints that return a list of items are paginated to make result sets easier to manage. You can navigate through pages of data using the page and per_page query parameters. If you don't supply these parameters, default values are applied.

• page (integer, optional) – The page number to retrieve. Defaults to 1.
• per_page (integer, optional) – The number of items per page. Defaults to 10. Maximum is 100.

Example Request

GET /resources?page=2&per_page=50

Example Response

{
  "data": [
    { "id": 101, "name": "Item 101" },
    { "id": 102, "name": "Item 102" }
    // ...
  ],
  "meta": {
    "page": 2,
    "per_page": 50,
    "total_pages": 10,
    "total_entries": 500
  }
}

If not specified, results start at page 1 with 10 items per page.

The Meta Object

The meta object is included in responses that return a list of items. It provides information about the pagination state, allowing you to navigate through the entire dataset.