This entry provides detailed information on the Data Export processes of the DMP.
Contents of the Table |
---|
The data export API is meant to analyze millions of data points with latencies between a few seconds up to 15 minutes. The expected result set is in the range of 1 to 1.000.000 rows since even the raw data events can be exported.
https://platform.flxone.com/api/viz/data?x=[JSON_encoded]
Service | /api/viz/data | |
---|---|---|
Method | POST |
Key | Explanation | Required |
---|---|---|
x | Contains a JSON query object array with the outline of the report parameters | Yes |
csrf | Token | Yes |
Key | Explanation | |||
---|---|---|---|---|
dimensions | See the list of available identifiers. | |||
measures | See the list of available identifiers. | |||
filters | Filter on date dimension is required. It looks like this:
To use a dynamic date the JSON would look like this:
The available options are:
You can also add additional filters, such as an advertiser filter:
| |||
limit | How many items to return. 5000 is the max. | |||
order | On which measure(s) should the data be sorted. | |||
batch_export |
| |||
callback_id | This can be anything and it will be returned as is. It is used to keep track of queries when sending requests in parallel. |
Below a configuration example of a JSON query object array for the "x" parameter.
[{ "dimensions": [ "advertiser_id" ], "measures": [ "impressions_sum" ], "filters": [{ "dimension": "date", "date_start": "2014-03-20", "date_end": "2014-03-27", "date_dynamic": null }], "limit": "5000", "order": [{ "key": "impressions_sum", "order": "desc" }], "callback_id": "b02de879-4205-969a-582a-8c1587b77b34" }] |
The DMP also offers a batch export service in case you want to:
By making a request to the batch export service the query will run in the background and as a result the API response will provide you of a batch export ID in case the "status" was "OK".
Endpoint | /api/viz/batch-export |
---|
Once the batch export is completed you can either:
Endpoint | /api/viz/export?id=<id> |
---|
Also see a more detailed batch export example