Skip to main content
API docs by Redocly

Activation Segments (AS 2.0)

Download OpenAPI specification:Download

InfoSum Support: support@infosum.com Terms of Service

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.
  • a. Skip to step 1 if you already have an activation segment
  • b. Jump to step 3 if creating a new activation query

  1. Get an existing activation segment

  2. Refresh an existing activation segment

  3. Check activation segment status

  4. List Destinations within the collaboration

  5. Get Destination configuration, including required runtime variables

  6. Push query results to Destination

  7. Check Destination push status

Parameter Reference Table

Step Number Parameter Name Parameter Structure Where to find it When to collect
All Collaboration ID CLB.xx Within the collaboration Have ready before hand
1 Query "SELECT self.ID FROM self INTERSECT them" Write it in Query Tool or find in Activations Page. Have ready before hand
1 Activation Segment ID ATS.xx Results of step 0 or 2 Can be collected from previous steps or have ahead of time
5, 6 Destination ID DST.xx Results of step 4 Can be collected in step 4
6 Destination Config json object Results of step 5 Can be collected in step 5
7 Export ID xx Results of step 6 Can be collected in step 6

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.
Accessing the API

Activation Segments

0. Create Activation Segment

Creates a new activation segment in the given collaboration.

Authorizations:
None
path Parameters
collaboration_id
required
string

The ID of the collaboration to create the activation segment in.

Request Body schema: application/json
required
column_separator
string

The separator to be used to delimit activation segment data columns when writing to file based destinations.

object

An optional map of column headers to override when exporting the activation segment to file based destinations.

object

The settings for flattening multi-value output columns into multiple rows when exporting the activation segment.

inaccuracy_proportion
number <float>

The proportion of rows to be added to the results that did not match the original query. Valid values are 0 - 1.0.

multi_value_delimiter
string

The delimiter to use for multi-valid columns when exporting the activation segment to file based destinations.

name
string

The name of the activation segment.

Array of objects (Activation_Segments.PathOverride)

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

query
string

The InfoSum Query Language (IQL) query string that defines the activation segment.

Array of objects (Activation_Segments.StringLiteralColumn)

A list of the optional string literal columns to append to an activation segment export.

Responses

Request samples

Content type
application/json
{
  • "column_separator": "string",
  • "header_overrides": {
    },
  • "identity_flattening": {
    },
  • "inaccuracy_proportion": 0.1,
  • "multi_value_delimiter": "string",
  • "name": "string",
  • "path_overrides": [
    ],
  • "query": "string",
  • "string_literal_columns": [
    ]
}

Response samples

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

1. Get Activation Segments

Returns a list of activation segments in the given collaboration. The output is affected by provided filters.

Authorizations:
None
path Parameters
collaboration_id
required
string

The ID of the collaboration to get activation segment details from.

query Parameters
pagination.page
integer <int32>

The requested page of records. Default is 1.

pagination.per_page
integer <int32>

The number of records to return per page. Maximum is 500. Default is 100.

order_by
string

OrderBy is a comma seperated value to define sorting. e.g 'created_date_time,name DESC' The values are seperated by space, '{column} {ASC/DESC}' Valid columns: created_date_time, updated_date_time, name

filter
string

Supported filters are activation_segment_id, creator_id, name

Responses

Response samples

Content type
application/json
{
  • "activation_segments": [
    ],
  • "pagination": {
    }
}

2. Refresh Activation Segment

Recalculates the audience size based on the activation segment query and collaboration.

Authorizations:
None
path Parameters
collaboration_id
required
string

The ID of the collaboration the activation segment belongs to.

activation_segment_id
required
string

The ID of the activation segment to calculate.

Responses

Response samples

Content type
application/json
{
  • "query_id": "string"
}

3. Get Activation Segment Status

Returns the details for the requested activation segment from a given collaboration.

Authorizations:
None
path Parameters
collaboration_id
required
string

The ID of the collaboration the activation segment belongs to.

activation_segment_id
required
string

The ID of the activation segment you want information about.

Responses

Response samples

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

4. List Destinations

Returns a list of destinations in the given collaboration. The output is affected by provided filters.

Authorizations:
None
path Parameters
collaboration_id
required
string

The ID of the collaboration to get destination details from.

query Parameters
pagination.page
integer <int32>

The requested page of records. Default is 1.

pagination.per_page
integer <int32>

The number of records to return per page. Maximum is 500. Default is 100.

order_by
string

OrderBy is a comma seperated value to define sorting. e.g 'created_time,name DESC' The values are seperated by space, '{column} {ASC/DESC}' Valid columns: created_date_time, updated_date_time, owner, name

filter
string

Supported filters are destination_id, owner_id, destination_type_id

Responses

Response samples

Content type
application/json
{
  • "destinations": [
    ],
  • "pagination": {
    }
}

5. Get Activation Segment Destination Push Schema

Returns the push time schema for a specific destination instance subject to constraints defined in the destination instance.

Authorizations:
None
path Parameters
collaboration_id
required
string

The ID of the collaboration.

activation_segment_id
required
string

The ID of the activation segment ID to export.

destination_id
required
string

The ID of the destination instance to export to.

Responses

Response samples

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

6. Export Activation Segment

Exports results of an activation segment to a specific destination instance.

Authorizations:
None
path Parameters
collaboration_id
required
string

The ID of the collaboration.

activation_segment_id
required
string

The ID of the activation segment to export.

Request Body schema: application/json
required
destination_id
string

Destination instance ID.

push_config
object

Configuration following the push time schema for the destination instance. Default values from the underlying instance can be found in the push schema default annotations. Defaults will not be used unless they are re-submitted as part of this config. Submit the X-INFOSUM-REDACTED keyword for x-infosum-secret properties to retain their default value from the underlying destination instance.

Responses

Request samples

Content type
application/json
{
  • "destination_id": "string",
  • "push_config": { }
}

Response samples

Content type
application/json
{
  • "export_id": "string"
}

7. Get Activation Segment Export Results

Returns the details for a specific activation segment export.

Authorizations:
None
path Parameters
collaboration_id
required
string

The ID of the collaboration.

activation_segment_id
required
string

The ID of the activation segment that has been exported.

export_id
required
string

The ID of the activation export.

Responses

Response samples

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