Request single profile export (beta)

Beta

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

Single profile export

Export a single profile, identified by the export key, together with their attribute values (and optionally the change history of these) and events.

This endpoint is asynchronous via callbacks.

How it works

Call this endpoint providing a callback_url which is a public endpoint that accepts HTTP POST requests. For example:

{
  "callback_url": "https://example.com/callbacks/single-profile-export"
}

Provided your call is correct, you should receive an empty HTTP 202 Accepted response and after a while your server under callback_url should receive an HTTP POST call with the body similar to the following:

{
  "code": 100,
  "message": "Callback verified"
}

When we're ready, we will call the callback_url server again and provide it with the URL to fetch the actual data:

{
  "code": 200,
  "message": "https://api.apsis.one/audience/profiles/export-single/accounts/test/definitions/01af2d3c-d30d-43ec-8f47-996c881148b4?metadata=true"
}

Finally, call that URL with a GET verb and the auth token usually used for APSIS One API to get your export file.

Export file

An example export file follows this structure:

{
  "profiles": {
    "<export key>": {
      "sections": {
        "<section ID>": {
          "attributes": { },
          "events": [ ]
        }
      }
    }
  },
  "metadata": {
    "sections": {
      "<section ID>": {
        "events": { },
        "attributes": { }
      }
    }
  }
}

The profiles object contains the attribute values and event instances that exist in the profile in any section.

The metadata object contains attribute and event definitions for these sections.

If include_attribute_history is set to true the changes to attribute values are also included. They appear inside the attributes object as history.

If include_type_definitions is set to true the export payload also contains the metadata object with type definitions per section.

If include_merged_profiles is set to true more profile keys may appear in the profiles object depending on whether the originally requested profile has been merged or not.