Request profiles in segment by consent report (beta)

Beta

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

Profiles in Segment by Consent Report

Request a report with profiles that fall into the specified segments and have consented to the particular topics via the specific channels.

Due to a current limitation, the report file still contains profiles that have not consented to receive the communication via the channel (email or SMS) selected via the request parameters. These records contain a blank email address or phone number. This inconvenience will soon be removed.

How to use

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

Call this URL repeatedly with exponential backoff 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 export 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.

Report file

The report file always contains the profile key as well as the attirbute corresponding to the channel specified in the request (Email attribute for email channel and Mobile attribute for sms channel). You can select other attributes and tags to include their value as columns in the report file.

For each segments provided in the request body the report file contains a column. These columns are named after the segment names from the request body. A row contains 1 when a corresponding profile matched the segment in question. Otherwise that row says 0.

Limits

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

Language
Authentication
Bearer
URL
Click Try It! to start a request and see the response here!