Get Email Campaign List V2

Prev Next

Get Email Analytics V2 is now released with more metrics. If you want to have more metrics, you can start using the V2 endpoints listed in this guide. 

This API enables you to retrieve the email campaign list from your back end without using Insider One's InOne platform.

The email campaigns sent through Architect journeys are not included in Email Analytics. You can get insights about your journey emails via Architect Email Channel Analytics.

Campaigns in Draft and Scheduled statuses are not listed in the response.

Endpoint and Headers

GET https://analytics.api.useinsider.com/email/v2/campaign/list

Visit our Postman collection to test this request.

Header

Sample Value

Description

X-INS-AUTH-KEY

1a2b3c4d5e6f

This key is required to authorize your request. Refer to API Authentication Tokens to generate your token.

Query Parameters

Parameter

Data Type

Description

Required

page

Integer

Specifies the number of pages of email campaigns

Yes

perPage

Integer

Specifies the number of email campaigns to be listed per page

Yes

Sample Example

Sample Query

Before sending the request, make sure:

  • To replace the authorization value with your own API key.

  • To replace the sample values in page and perPage with your own values in the required data type.

curl --location --request GET 'https://analytics.api.useinsider.com/email/v2/campaign/list?page=1&perPage=100' \
2--header 'X-INS-AUTH-KEY: 1a2b3c4d5e6f'

Sample Responses

  • 200 OK

{
   "currentPage": 1,
   "data": [
       {
           "id": 6648,
           "name": "My Email Campaign",
           "tags": "marketing",
           "type": "experiment",
           "subject": "Here is your experiment",
           "senderDomain": "@useinsider.com",
           "utmParameters": {
               "utm_term": "",
               "utm_medium": "email",
               "utm_source": "insider",
               "utm_status": true,
               "utm_content": "example",
               "utm_campaign": "insider_0225"
           },
           "startTime": "05-02-2025 09:00:05"
       }
   ],
“firstPageUrl”: “https://analytics.useinsider.com/email/v2/campaign/list?page=1&perPage=10”,
    “from”: 0,
    “lastPage”: 79,
    “lastPageUrl”: “https://analytics.useinsider.com/email/v2/campaign/list?page=79&perPage=10”,
    “nextPageUrl”: “https://analytics.useinsider.com/email/v2/campaign/list?page=2&perPage=10”,
    “path”: “/email/v2/campaign/list”,
    “perPage”: 10,
    “prevPageUrl”: “https://analytics.useinsider.com/email/v2/campaign/list?page=1&perPage=10”,
    “to”: 0,
    “total”: 787
}
  • 400 - Bad Request: Sorry, we’ve received an invalid request from your side. You can try again later.

  • 400 - Bad Request: Sorry, we couldn’t validate the request at the moment. You can try again later.

  • 500 - Internal Server Error: Sorry, we couldn’t receive any response from our server. You can try again later.


Limitations

  • All functions must be executed with an HTTPS GET request.

  • The x-ins-auth-key should be provided as the authorization key in the request header. If the key is incorrect, the operation will not be executed, and an authorization error will return in the response.

  • This API provides data for a 1-year range.

  • You can send 100 requests per minute with the same API Key. If you exceed the rate limit, you will receive a 429 error.

  • The perPage value should be between 1 and 100.

The default limit shown here is a standard baseline. If your use case requires higher capacity, feel free to reach out to the Insider One team. We can adjust it to fit your needs.