Request profiles in segment report (beta)

Beta

This is a new feature in APSIS One API since September 2021 and we are still keeping a close look on performance and potential issues. Please report any feedback to [email protected].

Profiles in Segment Report

Request a report with profiles from specific segments. Optionally specify to include known or unknown profiles only.

How to use

Once completed successfully, this endpoint returns a poll URL that is valid for 1 day.

Call this URL repeatedly with exponential back-off using the same authentication token as for the other APSIS One API calls. Until the result is ready, you will keep getting HTTP 404 Not Found response status code.

As soon as the report file is ready, the poll URL returns HTTP 200 OK and starts streaming a report file as a response.

The HTTP 410 Gone means that the file is no longer available or the ID used is invalid.

Compression

By default the report file is an uncompressed CSV so your code should treat it as .csv. If you prefer a compressed report, provide Accept-Encoding: gzip request header when calling the poll URL. The response will then contain Content-Encoding: gzip header and you will be able to handle the file as .csv.gz.

You can download the same report multiple times using the same poll URL with or without compression.

Additional file format support

By default the report file is a CSV and the Content-Type response header when calling the poll URL is similar to text/csv;charset=UTF-8;header=present. We also support Excel (XLSX) file format. To receive it, provide the Accept: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet request header when calling the poll URL. The response will then contain Content-Type header with the same value.

You can download the same report multiple times using the same poll URL in different file formats.

Report file

The report file always contains the export key. You can select other attributes and tags to include their value as columns in the report file.

Limits

Receiving HTTP 413 Payload Too Large from this POST request usually means that the request body contains a number of attributes and/or tags that is currently not supported.

More information

Video guides

Accept-Encoding request header

Accept request header

Language
Authentication
Bearer
JWT
URL