API Guide







Create Export

Create Export allows customers to create new Exports (also known as Segments) and make them available to download.

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

Endpoint URL:

https://api.250ok.com/api/1.0/analytics/export

Sample POST:

Note: the filters object can contain arrays (see 'age') or comma-separated values (see 'gender').

{
    "export_description": "US Mobile Customers - Men\/Women (Age 30-34)",
    "filters": {
        "country": "US",
        "gender": "female,male",
        "age": [
            30,
            31,
            32,
            33,
            34
        ],
        "platform": 3
    }
}
        

Sample Output:

{
    "status": "success",
    "id": 1234,
    "size_estimate": 123456
}
        

Parameters

Parameter Description Acceptable Values Required
export_description The description of the export String Y
filters An array of applicable filters from Get Engagement Filters. String Y

Error Responses

Description Code Cause
Please provide an export_description. 404 A description of the export is required.
Invalid filter values for fields: field (invalid value). 404 Invalid filter values passed in filter object.
No results found. 404 We couldn't find any results matching your criteria.