Activation Queries & Destinations (AD 1.0)

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: support@infosum.com | Terms of Service | Official Documentation

We highly suggest attempting to activate and push to a destination in the UI first. This way users can confirm they have the correct rights to activate and push to a destination. Additionally, this will allow users to create the destinations and set the configurations before attempting to push via the API. Future versions of the API Playbooks will outline creating a destination and modifying configurations. Task List

Create an activation query
Optional: Check results ran successfully after running the query
Optional: Confirm the destination exists before pushing or grab the Destination configuration
Push query results to Destination

Parameter Reference Table

Postman 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

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

object

Responses

Request samples

Payload

Content type

application/json

{"query": "Query",
"campaign_name": "Campaign Name"
}

Response samples

200
400
401
500

Content type

application/json

{"query_id": "<string>",
"done": "<boolean>"
}

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

200
401
404
500

Content type

application/json

{"dimensions": [{"value": "<string>",
"category": "<string>",
"count": "<long>",
"continuous": "<boolean>",
"private_id": "<string>",
"dimensions": [{"value": "<Circular reference to #/components/schemas/tyraelDimension detected>"
},
{"value": "<Circular reference to #/components/schemas/tyraelDimension detected>"
}
]
},
{"value": "<string>",
"category": "<string>",
"count": "<long>",
"continuous": "<boolean>",
"private_id": "<string>",
"dimensions": [{"value": "<Circular reference to #/components/schemas/tyraelDimension detected>"
},
{"value": "<Circular reference to #/components/schemas/tyraelDimension detected>"
}
]
}
],
"audience": "<long>",
"quality_measures": {"redaction_threshold_outlier": "<float>",
"rounding_threshold_outlier": "<float>",
"model_accuracy": "<float>",
"result_precision_include_empty_bins": "<float>",
"result_precision_exclude_empty_bins": "<float>"
},
"join_metadata": [{"from_dataset": {"id": "<string>",
"name": "<string>"
},
"to_dataset": {"id": "<string>",
"name": "<string>"
},
"keys": [{"key_id": "<int64>",
"name": "<string>"
},
{"key_id": "<int64>",
"name": "<string>"
}
]
},
{"from_dataset": {"id": "<string>",
"name": "<string>"
},
"to_dataset": {"id": "<string>",
"name": "<string>"
},
"keys": [{"key_id": "<int64>",
"name": "<string>"
},
{"key_id": "<int64>",
"name": "<string>"
}
]
}
],
"count_metadata": [{"dataset": {"id": "<string>",
"name": "<string>"
},
"keys": [{"key_id": "<int64>",
"name": "<string>"
},
{"key_id": "<int64>",
"name": "<string>"
}
]
},
{"dataset": {"id": "<string>",
"name": "<string>"
},
"keys": [{"key_id": "<int64>",
"name": "<string>"
},
{"key_id": "<int64>",
"name": "<string>"
}
]
}
]
}

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": {"config": { },
"created_time": "<dateTime>",
"creator_id": "<string>",
"description": "<string>",
"destination_type_id": "<string>",
"editable_paths": ["<string>",
"<string>"
],
"id": "<string>",
"incoming_share_id": "<string>",
"name": "<string>",
"outgoing_share_ids": ["<string>",
"<string>"
],
"owner_id": "<string>",
"permission_ids": ["<string>",
"<string>"
],
"permissioned_to_permitted_company": "<boolean>",
"updated_time": "<dateTime>"
}
}

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

object

Responses

Request samples

Payload

Content type

application/json

{"push_config"": {"filename": "filename"
}
}

Response samples

Content type

application/json

{"push_id": "<string>"
}