API Guide

Get Analytics Campaigns

This API returns a list of Analytics campaigns matching your search criteria. Data is returned in the following formats: XML, JSON, CSV and Serialized.

Required headers: X-API-KEY
Optional headers: ACCEPT (json, xml, csv, serialized)
Method: GET

Endpoint URL:


Sample Output:

        "id": 1012768,
        "created": "2014-11-18 05:38:45",
        "refreshed": "2014-12-02 13:00:58",
        "expires": "2014-12-18 05:39:53",
        "firsttracked": null,
        "subject": "Email Subject 1",
        "opencount": 0
        "id": 881617,
        "created": "2014-10-07 12:34:00",
        "refreshed": "2014-11-07 12:00:20",
        "expires": "2014-11-06 07:34:12",
        "firsttracked": null,
        "subject": "Email Subject 2",
        "opencount": 0


Parameter Description Acceptable Values Required
id Retrieve a campaign by ID. Integer N
search The campaign name search query String N
start The starting count of total campaign to return. Integer N
limit The limit of total campaign to return. Integer N

Error Responses

Description Code Cause
No results found. 404 We couldn't find any results matching your criteria.
Invalid campaign ID. 404 The unique identifier of the campaign is missing or invalid.
Invalid starting number. 404 The starting number must be numeric.
Invalid limit. 404 The limit number must be numeric.
NULL 401 Your API key does not have sufficient permission to access this endpoint.