Get All Campaigns

This call returns a list of all available campaigns.

URL:

GET https://api.emailonacid.com/v5/analytics/campaigns/

Example Response:

[
    {
        "id": "<CAMPAIGN GUID>",
        "date": 1696473823,
        "type": "analytics",
        "subject": "<Sample campaign name>"
    },
    {
        "id": "<CAMPAIGN GUID>",
        "date": 1696473789,
        "type": "analytics",
        "subject": "<Sample campaign name>"
    },
    {
        "id": "<CAMPAIGN GUID>",
        "date": 1696473715,
        "type": "analytics",
        "subject": "<Sample campaign name>"
    },
]

Search Campaigns

This call returns a list of campaigns that match the criteria in the query string. Its structure is identical to the above call.

The query string is a standard URL parameterized version containing any or all of the following parameters.

URL:

GET https://api.emailonacid.com/v5/analytics/campaigns?<query_string>

Query String Details

Name Description Example
from The starting point of your campaign date range. from=2024-05-12+04:59:21, from=2024-05-12%2004:59:21, from=1715489961, from=yesterday
to The ending point of your campaign date range. to=2024-05-12+04:59:21, to=1715489961, to=yesterday
subject The name of the campaign. The "subject" field of returned campaigns must contain the exact string. This search is case-insensitive. subject=My+example+test, subject=My%2Bexample%2Btest, subject=Another%20example
results The number of results to return. Must be between 1 and 200. The default value is 50 results=50
page The page number. If you submit a number higher than the number of pages in the data, an empty array will be returned. The default value is 1 page=2
customer_id The "customer_id" associated with a campaign. customer_id=example_customer