Skip to main content
API docs by Redocly

Activation Queries & Destinations (AD 1.1)

Download OpenAPI specification:Download

This page contains the essential endpoints of the InfoSum API that help users securely manage data throughout the activation process, allowing them to activate and push data for analysis from InfoSum to one of our destinations. You can download the swagger file above or email solutions@infosum.com to share a Postman Collection.

InfoSum Support | Terms of Service | Official Documentation

About Destinations Destinations are locations outside the InfoSum platform such as media platforms, walled gardens, SSPs, DSPs, CDPs, ad servers, or cloud environments. Once created, you only need runtime variables to push an activation file. Destinations are available to all users in your company and can be reused indefinitely.

Task List

  1. Create an activation query

  2. Optional: Check results ran successfully after running the query

  3. Optional: Confirm the destination exists before pushing or grab the Destination configuration

  4. Push query results to Destination

Parameter Reference Table

Step Number Parameter Name Parameter Structure Where to find it When to collect
1 Query "SELECT self.ID FROM self INTERSECT them" Write it in Query Tool or find in Activations Page. Have ready before hand
1 Campaign Name text This is user generated. This will be the name InfoSum uses to reference the activation result. Have ready before hand
2 Query ID xx Response from step 1 Can be grabbed from output of step 1
3, 4 Destination ID DST.xx in URL of Destinations page Have ready before hand
4 Destination Push Config JSON config Response from step 3 Can be grabbed from output of step 3
4 Destination Filename text.csv (or another file type) This is user generated. This will be the name InfoSum gives to the file in the destination. Have ready before hand

Best Practices

  • Ensure your Bunker has Export Columns enabled or use a partner’s Bunker.
  • Verify the destination accepts the identifier types you plan to export (e.g., email, MAID, IP).
  • Limit to a maximum of 15 key types in your dataset.
  • Use the UI first to confirm setup before automating via API.
  • Saved destinations can be reused indefinitely across your company.

Activations

1. Create a Query

Queue a Query for execution. Returns immediately with an ID of the Query created.

Authorizations:
apikeyAuth
header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
required
query
string (Query)

The Query that should be executed. This takes the format of an InfoSum Activation Query. See the documentation of the InfoSum Activation Query Language for more information.

Array of objects (Path Overrides)

A list of instructions on how to connect two datasets, overriding the automatic choices made by the core engine.

campaign_name
string (CampaignName)

A name that a user can associate with an activation query.

column_separator
string (Column Separator)

The separator to be used to delimit activation data columns.

object (HeaderOverrides)

An optional map of query output column to header override.

Array of objects (StringLiteralColumns)

The optional list of string literal columns.

multi_value_delimiter
string (MultiValueDelimiter)

The delimiter for multi-value columns.

identities_to_flatten
Array of strings (IdentitiesToFlatten)

A list of multi-value identity columns to be flattened.

collaboration_id
string

Responses

Request samples

Content type
application/json
{
  • "query": "string",
  • "path_overrides": [
    ],
  • "campaign_name": "string",
  • "column_separator": "string",
  • "header_overrides": {
    },
  • "string_literal_columns": [
    ],
  • "multi_value_delimiter": "string",
  • "identities_to_flatten": [
    ],
  • "collaboration_id": "string"
}

Response samples

Content type
application/json
{
  • "activation_id": "<string>",
  • "query_completed": true,
  • "query_error": {
    },
  • "query_response": {
    }
}

2. Get a Result

Get the Result of a Query, when it is available.

Authorizations:
apikeyAuth
path Parameters
query_id
required
string
header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "dimensions": [
    ],
  • "audience": "<long>",
  • "quality_measures": {
    },
  • "join_metadata": [
    ],
  • "count_metadata": [
    ]
}

Destinations

3. Get Destination Instance

Returns details about an owned Destination Instance.

Authorizations:
apikeyAuth
path Parameters
destination_id
required
string
header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "destination": {
    }
}

4. Push Activation Result to Destination

Pushes results of a query to a specific destination instance.

Authorizations:
apikeyAuth
path Parameters
query_id
required
string
destination_id
required
string
header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
query

Responses

Request samples

Content type
application/json
{
  • "push_config"": {
    }
}

Response samples

Content type
application/json
{
  • "push_id": "<string>"
}