Skip to main content
API docs by Redocly

InfoSum Developer API (2.0)

Download OpenAPI specification:Download

InfoSum Support: support@infosum.com Terms of Service

This page contains the documentation for the InfoSum Developer API. The methods allow you to try making requests and inspect the input and output formats.

Official Documentation

Accounts

Service for mapping users to their display name and companies.

Get a company's display name.

Get a company's display name.

Authorizations:
API_Keys
query Parameters
company_id
string

The ID of the company to look up the display name for.

Responses

Response samples

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

List users' display name and company name.

List users' display name and company name.

Authorizations:
API_Keys
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.

filter
string

The filter to restrict the list of returned users.

Responses

Response samples

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

Connections

Service for estimating intersections between datasets to establish if they are connected by common keys.

Calculate match rate

Calculates the match rate between two PAIR enabled datasets.

Authorizations:
API_Keys
Request Body schema: application/json
required

CalculateMatchRateRequest is the input to the CalculateMatchRate method.

advertiser_dataset_id
string

AdvertiserDatasetId is the ID of the dataset belonging to the advertiser.

publisher_dataset_id
string

PublisherDatasetId is the ID of the dataset belonging to the publisher.

Responses

Request samples

Content type
application/json
{
  • "advertiser_dataset_id": "string",
  • "publisher_dataset_id": "string"
}

Response samples

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

Queries

Service for executing queries against datasets in the InfoSum platform.

InfoSum Support Portal Article

Create a PAIR enabled activation query

Create a PAIR enabled activation query.

Authorizations:
API_Keys
Request Body schema: application/json
required

CreatePairQueryRequest is the input to the CreatePairQuery method.

collaborator_dataset_id
string

CollaboratorDatasetId is the ID of the dataset you are collaborating with.

object

ColumnIdentifier contains details of the column to be used as the identifier.

dataset_id
string

DatasetId is the ID of the dataset you want the query to be run against.

query_name
string

QueryName is the name of the query.

Responses

Request samples

Content type
application/json
{
  • "collaborator_dataset_id": "string",
  • "column_identifier": {
    },
  • "dataset_id": "string",
  • "query_name": "string"
}

Response samples

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

Create new private path collaboration

Create a new private path collaboration between given datasets

Authorizations:
API_Keys
Request Body schema: application/json
required

CreatePrivatePathRequest is the input to the CreatePrivatePath method.

dataset_ids
Array of strings

DatasetIds is the list of datasets allowed in the collaboration.

Responses

Request samples

Content type
application/json
{
  • "dataset_ids": [
    ]
}

Response samples

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

Get details of an existing private path collaboration.

Get details of an existing private path collaboration.

Authorizations:
API_Keys
path Parameters
collaboration_id
required
string

CollaborationId is the unique ID generated for the private path collaboration.

Responses

Response samples

Content type
application/json
{
  • "private_path_datasets": [
    ]
}

Reports

Service for generating and managing data insight reports.

List insight reports.

List insight reports.

Authorizations:
API_Keys
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

The ordering for returned insight reports.

filter
string

Filter is a string containing logic that can specify a restricted set of reports to be returned. e.g. name co 'Test' or name co 'Acme'

A string containing logic that can specify a restricted set of insight reports to be returned. e.g. name eq 'Test' or name co 'Acme'

Responses

Response samples

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

Create a new insight report.

Create a new insight report.

Authorizations:
API_Keys
Request Body schema: application/json
required

CreateRequest is the Create rpc input.

object

Baseline defines the dataset/audience to be used as the baseline data.

baseline_filter
string

An IQL filter to define how to filter the baseline.

categories
Array of strings

The list names of categories to include in the insight report.

name
string

Name is the user given name to assign to a insight report.

object

Seed defines the dataset/audience to be used as the seed data.

seed_filter
string

An IQL filter to define how to filter the seed.

Responses

Request samples

Content type
application/json
{
  • "baseline": {
    },
  • "baseline_filter": "string",
  • "categories": [
    ],
  • "name": "string",
  • "seed": {
    },
  • "seed_filter": "string"
}

Response samples

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

Delete an insight report.

Delete an insight report.

Authorizations:
API_Keys
path Parameters
report_id
required
string

The uniquely identifying ID of an insight report.

Responses

Response samples

Content type
application/json
{ }

Get details of an insight report.

Get details of an insight report.

Authorizations:
API_Keys
path Parameters
report_id
required
string

ReportID uniquely specifies an insight report.

Responses

Response samples

Content type
application/json
{
  • "baseline": {
    },
  • "baseline_filter": "string",
  • "categories": [
    ],
  • "created_by": "string",
  • "created_date_time": "2019-08-24T14:15:22Z",
  • "error": {
    },
  • "owner_id": "string",
  • "report_id": "string",
  • "report_name": "string",
  • "seed": {
    },
  • "seed_filter": "string",
  • "status": "NO_STATUS"
}

Get a cross category result for a completed report.

Get a cross category result for a completed report.

Authorizations:
API_Keys
path Parameters
report_id
required
string

Report ID uniquely specifies an insight report.

query Parameters
category_1
string

The name of the first category to get the cross category result for.

category_2
string

The name of the second category to get the cross category result for.

Responses

Response samples

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

List the single category results of a completed insight report.

List the single category results of a completed insight report.

Authorizations:
API_Keys
path Parameters
report_id
required
string

Report ID uniquely specifies an insight report.

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

The ordering for returned insight reports.

filter
string

Filter is a string containing logic that can specify a restricted set of reports to be returned. e.g. category_name eq 'Category1' or category_name co 'string'

A string containing logic that can specify a restricted set of insight report results to be returned. e.g. category_name eq 'Category1' or category_name co 'string'

Responses

Response samples

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

Get the status of an insight report.

Get the status of an insight report.

Authorizations:
API_Keys
path Parameters
report_id
required
string

ReportID uniquely specifies an insight report.

Responses

Response samples

Content type
application/json
{
  • "error": {
    },
  • "progress": {
    },
  • "status": "NO_STATUS"
}

Automation Configs

Service for managing configurations for scheduling and automating actions in the InfoSum platform.

List Automation Configs

Lists configs belonging to your company subject to the provided filter.

Authorizations:
API_Keys
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
Default: "updated_date_time DESC"

Comma separated list of sorting parameters and ordering in the form of {sort_column} {ASC/DESC}. Supported sort fields are: id, config_id, executed_by, started_date_time, last_updated_date_time, current_step, current_step_status, cloud_vault_id.

filter
string

Filter string as per the docs. Supported filter fields are: id, config_id, executed_by, started_date_time, last_updated_date_time, current_step, current_step_status, cloud_vault_id.

Responses

Response samples

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

Create Automation Config

Creates and validates an Automation Config based on the provided list of ordered tasks.

Authorizations:
API_Keys
Request Body schema: application/json
required

CreateConfigRequest is the information provided when creating an Automation Config.

cloud_vault_id
string

The ID of the Cloud Vault to be used for reading and writing data during Automation Execution.

cron_timer
string

The execution schedule of the Automation in UNIX CRON format as described in https://man7.org/linux/man-pages/man5/crontab.5.html. The schedule is executed relative to the supplied timezone_identifier for the Automation.

description
string

The user-friendly description of the Automation Config.

enabled
boolean

The 'enabled' flag allows Automation Execution triggers to be paused and resumed without adjusting the rest of the config or schedule.

end_date_time
string <date-time>

Optional date-time to cease triggering Automation Executions. Format is RFC3339 which defaults to UTC. Offsets relative to Zulu time must be provided to convey local times. This parameter is unaffected by timezone_identifier. An empty value indicates that the schedule should never cease.

name
string

The user-friendly name of the Automation Config. Valid characters are alphanumeric, '_', '-' and spaces.

start_date_time
string <date-time>

Optional date-time to begin triggering Automation Executions based on the CRON schedule. Format is RFC3339 which defaults to UTC. Offsets relative to Zulu time must be provided to convey local times. This parameter is unaffected by timezone_identifier. An empty value indicates that the schedule should begin as soon as possible.

Array of objects (Automation_Configs.AutomationStep)

The sequence of tasks which constitute an Execution of this Automation Config.

timezone_identifier
string

The Timezone Identifier to schedule Automation Executions relative to using the cron_timer. This parameter does not affect the start or end times for scheduling. The format is from the IANA TZ database: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones. Be aware that scheduling near the lost or gained hour in a timezone which implements daylight savings time (DST) can lead to schedule disruption during transitions.

Responses

Request samples

Content type
application/json
{
  • "cloud_vault_id": "string",
  • "cron_timer": "0 12 * * *",
  • "description": "string",
  • "enabled": true,
  • "end_date_time": "2019-11-23T18:30:00-04:00",
  • "name": "string",
  • "start_date_time": "2019-11-22T18:30:00-04:00",
  • "steps": [
    ],
  • "timezone_identifier": "Europe/London"
}

Response samples

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

Delete Automation Config

Remove the specified Automation Config along with any execution information and history. No new executions can be triggered for deleted Automation Configs.

Authorizations:
API_Keys
path Parameters
config_id
required
string

The ID of the Automation Config to be deleted.

Responses

Response samples

Content type
application/json
{ }

Get Automation Config

Fetches an Automation Config by its Config ID.

Authorizations:
API_Keys
path Parameters
config_id
required
string

The ID of the Automation Config to retrieve.

Responses

Response samples

Content type
application/json
{
  • "config": {
    },
  • "last_execution_id": "string"
}

Update Automation Config

Updates the specified Automation Config, overriding any old fields with new ones provided on the request.

Authorizations:
API_Keys
path Parameters
config_id
required
string

The ID of the Automation Config to be updated.

Request Body schema: application/json
required

Config is the config the user wants to update.

cron_timer
string

The execution schedule of the Automation in UNIX CRON format as described in https://man7.org/linux/man-pages/man5/crontab.5.html. The schedule is executed relative to the supplied timezone_identifier for the Automation.

description
string

The user-friendly description of the Automation Config.

enabled
boolean

The 'enabled' flag allows Automation Execution triggers to be paused and resumed without adjusting the rest of the config or schedule.

end_date_time
string <date-time>

Optional date-time to cease triggering Automation Executions. Format is RFC3339 which defaults to UTC. Offsets relative to Zulu time must be provided to convey local times. This parameter is unaffected by timezone_identifier. An empty value indicates that the schedule should never cease.

name
string

The user-friendly name of the Automation Config. Valid characters are alphanumeric, '_', '-' and spaces.

start_date_time
string <date-time>

Optional date-time to begin triggering Automation Executions based on the CRON schedule. Format is RFC3339 which defaults to UTC. Offsets relative to Zulu time must be provided to convey local times. This parameter is unaffected by timezone_identifier. An empty value indicates that the schedule should begin as soon as possible.

timezone_identifier
string

The Timezone Identifier to schedule Automation Executions relative to using the cron_timer. This parameter does not affect the start or end times for scheduling. The format is from the IANA TZ database: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones. Be aware that scheduling near the lost or gained hour in a timezone which implements daylight savings time (DST) can lead to schedule disruption during transitions.

Responses

Request samples

Content type
application/json
{
  • "cron_timer": "0 12 * * *",
  • "description": "string",
  • "enabled": true,
  • "end_date_time": "2019-11-22T18:30:00-04:00",
  • "name": "string",
  • "start_date_time": "2019-11-22T18:30:00-04:00",
  • "timezone_identifier": "Europe/London"
}

Response samples

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

Automation Execution

Service for fetching previous automation runs and triggering a manual run of an automation configuration.

Execute Automation Config

Execute Automation Config manually initiates the Execution of an Automation Config ignoring its schedule.

Authorizations:
API_Keys
path Parameters
config_id
required
string

The ID of the Automation Config to manually trigger an Execution of.

Responses

Response samples

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

List Executions

List Executions retrieves Automation Config Executions subject to the provided filters.

Authorizations:
API_Keys
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 separated value to define sorting. e.g 'name,created_time DESC'. The values are separated by space, '{column} {ASC/DESC}'. These are the values that are sortable: none

filter
string

Filter is a string containing logic that can specify a restricted set of Recordsets to be returned. e.g. name co 'Test' or name co 'Acme'. These are the supported fields for filtering: none

Responses

Response samples

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

Get Execution

Get Execution fetches details of an Automation Execution by its ID.

Authorizations:
API_Keys
path Parameters
execution_id
required
string

The ID of the Automation Execution to retrieve.

Responses

Response samples

Content type
application/json
{
  • "execution": {
    },
  • "execution_steps": [
    ]
}

Datasets

Service for managing datasets in the InfoSum platform.

Returns a list of datasets and their summary information.

Returns a list of datasets and their summary information.

Authorizations:
API_Keys
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 'name,created_time DESC' The values are seperated by space, '{column} {ASC/DESC}' The values that are sortable are: dataset_id public_name private_id description owner_id created_by dataset_type (DATASET_TYPE_INSIGHT / DATASET_TYPE_IDENTITY) region recordset_id execution_id publish_date_time (in RFC3339 format) created_date_time (in RFC3339 format) expiration_date_time (in RFC3339 format)

filter
string

Filter is a string containing logic that can specify a restricted set of Cloud Vaults to be returned. e.g. name co 'Test' or name co 'Acme' The filterable fields are: dataset_id public_name private_id description owner_id created_by dataset_type (DATASET_TYPE_INSIGHT / DATASET_TYPE_IDENTITY) region execution_id recordset_id created_date_time (in RFC3339 format) expiration_date_time (in RFC3339 format) publish_date_time (in RFC3339 format)

Responses

Response samples

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

Creates a dataset.

Creates a dataset.

Authorizations:
API_Keys
Request Body schema: application/json
required

CreateDatasetRequest is the input used by the CreateDataset rpc.

dataset_type
string
Default: "DATASET_TYPE_INVALID"
Enum: "DATASET_TYPE_INVALID" "DATASET_TYPE_INSIGHT" "DATASET_TYPE_IDENTITY"

DatasetType denotes whether the dataset is insight or activation.

description
string

Description is a user defined description for the dataset. Description has a max length of 1000 characters.

object

Expiration specifies information about how the dataset should expire.

private_id
string

PrivateId is the name of the dataset visible only within the owner company, used for querying. PrivateIDs can only contain upper and lower case letter and numbers with a minimum length of 1, and a maximum length of 17.

public_name
string

PublicName is the name of the dataset as seen by other companies with permission to the dataset. PublicNames can only contain alphanumeric (ascii) characters, including dash, underscore and spaces with a max length of 100 and a minimum length of 1.

region
string
Default: "UNKNOWN"
Enum: "UNKNOWN" "AWS_EU_WEST_2" "AWS_US_EAST_1" "IBM_EU_CENTRAL_1" "AWS_EU_CENTRAL_1" "AWS_AP_SOUTHEAST_2"

Region is the cloud vault region the dataset can accept input data from.

Responses

Request samples

Content type
application/json
{
  • "dataset_type": "DATASET_TYPE_INVALID",
  • "description": "string",
  • "expiration": {
    },
  • "private_id": "string",
  • "public_name": "string",
  • "region": "UNKNOWN"
}

Response samples

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

Deletes a dataset and any underlying compute resource.

Deletes a dataset and any underlying compute resource.

Authorizations:
API_Keys
path Parameters
dataset_id
required
string

DatasetId is the ID of the dataset to be deleted.

Responses

Response samples

Content type
application/json
{ }

Returns a dataset and the summary information.

Returns a dataset and the summary information.

Authorizations:
API_Keys
path Parameters
dataset_id
required
string

DatasetId is the ID of the dataset to be retrived.

Responses

Response samples

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

Updates the top level information about a dataset.

Updates the top level information about a dataset.

Authorizations:
API_Keys
path Parameters
dataset_id
required
string

DatasetId is the ID of the dataset to be updated.

Request Body schema: application/json
required

Dataset contains details of the update which can be partial.

description
string

Description is a user defined description for the dataset. Description has a max length of 1000 characters.

object

Expiration specifies information about how the dataset should expire.

private_id
string

PrivateId is the name of the dataset visible only within the owner company, used for querying. PrivateIDs can only contain upper and lower case letter and numbers with a minimum length of 1, and a maximum length of 17.

public_name
string

PublicName is the name of the dataset as seen by other companies with permission to the dataset. PublicNames can only contain alphanumeric (ascii) characters, including dash, underscore and spaces with a max length of 100 and a minimum length of 1.

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "expiration": {
    },
  • "private_id": "string",
  • "public_name": "string"
}

Response samples

Content type
application/json
{ }

Dataset Stats

Service for inspecting the key and category statistics of published datasets.

Get stats for all the attribute columns of a dataset.

Get stats for all the attribute columns of a dataset.

Authorizations:
API_Keys
path Parameters
dataset_id
required
string

Responses

Response samples

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

Get stats for all the export columns of a dataset.

Get stats for all the export columns of a dataset.

Authorizations:
API_Keys
path Parameters
dataset_id
required
string

Responses

Response samples

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

Get stats for all the key columns of a dataset.

Get stats for all the key columns of a dataset.

Authorizations:
API_Keys
path Parameters
dataset_id
required
string

Responses

Response samples

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

Get summary stats for a dataset.

Get summary stats for a dataset.

Authorizations:
API_Keys
path Parameters
dataset_id
required
string

Responses

Response samples

Content type
application/json
{
  • "attribute_columns": "string",
  • "export_columns": "string",
  • "key_columns": "string",
  • "total_rows": "string"
}

Dataset Lineage

Service for establishing the provenance of published datasets.

Get the lineage of a published dataset

Get all the configs used to publish a dataset

Authorizations:
API_Keys
path Parameters
dataset_id
required
string

The ID of the published dataset to get lineage for.

Responses

Response samples

Content type
application/json
{
  • "cloud_vault_id": "string",
  • "lineage": [
    ]
}

Destination Instances

List Destination Instances

Returns a list of Destinations owned by the caller.

Authorizations:
API_Keys
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

Supported order_by fields are id, created_time, name, updated_time, destination_type_id, creator_id

filter
string

Supported filters are name, owner_id, destination_type_id, outgoing_permission_id, creator_id

permissionable_to
string

PermissionableTo is an optional company ID which if set, filters the returned destinations based on the ability to attach the instance to a permission sent to that recipient company.

Responses

Response samples

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

Create Destination Instance

Accepts a configuration conforming to the JSON-Schema of the Destination type to be created. Returns Destination ID.

Authorizations:
API_Keys
Request Body schema: application/json
required

CreateDestinationInstanceRequest contains all parameters required to create a Destination instance.

config
object

Config is the config for the destination.

description
string

Description is an optional description given to this destination.

destination_type_id
string

DestinationTypeId is the InfoSum type ID of this destination.

editable_paths
Array of strings

EditablePaths is the list of schema paths that can be edited at push time.

name
string

Name is the display name given to this destination.

Responses

Request samples

Content type
application/json
{
  • "config": { },
  • "description": "string",
  • "destination_type_id": "string",
  • "editable_paths": [
    ],
  • "name": "string"
}

Response samples

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

Delete Destination Instance

Deletes an owned destination instance.

Authorizations:
API_Keys
path Parameters
destination_id
required
string

Destination instance ID.

Responses

Response samples

Content type
application/json
{ }

Get Destination Instance

Returns details about an owned Destination Instance.

Authorizations:
API_Keys
path Parameters
destination_id
required
string

Destination instance ID.

Responses

Response samples

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

Update Destination Instance

Update an owned destination instance.

Authorizations:
API_Keys
path Parameters
destination_id
required
string

destination_id is the ID of the Destination instance.

Request Body schema: application/json
required

DestinationInstanceUpdate is the update to the Destination instance configuration.

config
object

Complete destination config. If set, this field acts as a PUT on the underlying config. All fields must be provided even if they are unchanged in the update. The values for previously set x-infosum-secret properties can be retained by re-submitting the X-INFOSUM-REDACTED value.

description
string

Description is an optional description given to this destination.

editable_paths
Array of strings

EditablePaths is the list of schema paths that can be edited at push time.

name
string

Name is the display name given to this destination.

Responses

Request samples

Content type
application/json
{
  • "config": { },
  • "description": "string",
  • "editable_paths": [
    ],
  • "name": "string"
}

Response samples

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

Attach Destination Instance to Permission

Attach the specified Destination Instance to the given Permission. The destination must be either owned by, or shared with your company.

Authorizations:
API_Keys
path Parameters
destination_id
required
string

Destination Instance ID to attach.

Request Body schema: application/json
required
permission_id
string

Permission ID to attach to.

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "permission_ids": [
    ]
}

Detach Destination Instance from Permission

Removes the link between the specified Destination Instance and the given Permission. The destination must be either owned by, or shared with your company.

Authorizations:
API_Keys
path Parameters
destination_id
required
string

Destination Instance ID to detach.

Request Body schema: application/json
required
permission_id
string

Permission ID to detach from.

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "permission_ids": [
    ]
}

Duplicate Destination Instance

Creates a new copy of the specified, owned destination instance.Returns Destination ID.

Authorizations:
API_Keys
path Parameters
destination_id
required
string

Destination Instance ID to duplicate.

Request Body schema: application/json
required
object (Destination_Instances.DuplicateDestinationInstanceBody)

Responses

Request samples

Content type
application/json
{ }

Response samples

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

List Destination types

Returns a list of supported Destination types available to the user. Returned Destination type IDs can be used to fetch the schema and create a destination.

Authorizations:
API_Keys

Responses

Response samples

Content type
application/json
{
  • "destination_types": [
    ]
}

Get Destination Type External Config

Returns details required when configuring the third-party service to receive data for this Destination type. Returns empty if the Destination type doesn't require any configuration related to the InfoSum user.

Authorizations:
API_Keys
path Parameters
destination_type_id
required
string

Destination type identifier.

query Parameters
query_id
string

QueryID specifies the ID of an Activation Query. When provided, it enables automatic population of the mappable schema properties with the output columns from the specified query, facilitating data mapping.

Responses

Response samples

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

Get Destination Type Schema

Returns the configuration JSON-Schema for the requested Destination type ID. The JSON-Schema can be used to define a configuration for creating a Destination.

Authorizations:
API_Keys
path Parameters
destination_type_id
required
string

Destination type identifier.

Responses

Response samples

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

Destination Shares

List Destination Shares

Returns a list of Destinations shared by or with the company of the user.

Authorizations:
API_Keys
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: name, created_time

filter
string

Supported filters are owner_id, recipient_company_id, destination_id

Responses

Response samples

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

Create Destination Share

Accepts a Destination Instance ID and email to share the Destination Instance with. Sharing a Destination allows the recipient to attach it on a dataset permission back to you.

Authorizations:
API_Keys
Request Body schema: application/json
required
comment
string

An optional comment explaining why sharing this destination.

destination_id
string

ID of the Destination Instance to be shared.

other_permitted_companies
Array of strings

The ID of other companies that the sender of this share allows the recipient to send permissions to, with the shared destination associated. Currently these must be InfoSum company IDs. Using this field is currently only available where the sender and recipient of the destination share are managed service customers.

recipient_email_address
string

Recipient email address to be used to find company to share Destination Instance to.

Responses

Request samples

Content type
application/json
{
  • "comment": "string",
  • "destination_id": "string",
  • "other_permitted_companies": [
    ],
  • "recipient_email_address": "string"
}

Response samples

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

Remove Destination Share

Stops sharing a Destination to a single company.

Authorizations:
API_Keys
path Parameters
share_id
required
string

ID of the Share that should be removed.

Responses

Response samples

Content type
application/json
{ }

Get Destination Share

Returns the shared destination for a specific share ID.

Authorizations:
API_Keys
path Parameters
share_id
required
string

The ID of the Destination Share to get details about.

Responses

Response samples

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

Activation Destinations

List Activation Destinations

List the destinations which can be used for the provided activation query.

Authorizations:
API_Keys
path Parameters
query_id
required
string

QueryID is the activation query ID to get valid destination targets for.

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 specifies ordering parameters. Valid parameters are: name, created_time, destination_type_id. Default: created_time DESC

filter
string

Supported filters are owner_id, recipient_company_id, destination_id

Responses

Response samples

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

Push Activation Result to Destination

Pushes results of a query to a specific destination instance.

Authorizations:
API_Keys
path Parameters
query_id
required
string

ID of the activation query.

destination_id
required
string

Destination instance ID.

Request Body schema: application/json
required
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
{
  • "push_config": { }
}

Response samples

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

Get Activation Destination Push Schema

Returns the push time schema for a specific destination instance subject to constraints (like query ID).

Authorizations:
API_Keys
path Parameters
query_id
required
string

ID of the Activation Query to be pushed.

destination_id
required
string

Destination instance ID.

Responses

Response samples

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

Activation Pushes

List Activation Query Pushes

Returns a list of pushes for the specified activation query.

Authorizations:
API_Keys
path Parameters
query_id
required
string

The activation query ID.

query Parameters
order_by
string

OrderBy is a comma seperated value to define sorting. e.g 'destination_type,started_at_date_time DESC' The values are seperated by space, '{column} {ASC/DESC}'

filter
string

Filter is a string containing logic that can specify a restricted set of Pushes to be returned. e.g. 'destination_id eq a_specific_destination_id' or 'push_successful eq true'

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.

Responses

Response samples

Content type
application/json
{
  • "activation_pushes": [
    ],
  • "pagination_response": {
    }
}

Get Activation Query Push

Returns the details for a specific activation push subject to constraints (like query ID).

Authorizations:
API_Keys
path Parameters
query_id
required
string

The ID of the query that has been pushed.

push_id
required
string

The ID of the activation push.

Responses

Response samples

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

Cloud Vaults

Service for managing Cloud Vault data staging areas within the InfoSum platform.

InfoSum Support Portal Article

List Cloud Vaults.

List available Cloud Vaults.

Authorizations:
API_Keys
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 'name,created_time DESC' The values are seperated by space, '{column} {ASC/DESC}'

filter
string

Filter is a string containing logic that can specify a restricted set of Cloud Vaults to be returned. e.g. name co 'Test' or name co 'Acme'

Responses

Response samples

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

Create a new Cloud Vault.

Create a Cloud Vault to hold data and connect to a bunker.

Authorizations:
API_Keys
Request Body schema: application/json
required
description
string

Description is an optional description given to this Cloud Vault.

name
required
string

Name is the display name given to this Cloud Vault.

region
required
string
Default: "UNKNOWN"
Enum: "UNKNOWN" "AWS_EU_WEST_2" "AWS_US_EAST_1" "IBM_EU_CENTRAL_1" "AWS_EU_CENTRAL_1" "AWS_AP_SOUTHEAST_2"

Region identifies the region that this Cloud Vault is located in. Expected format: cloudprovider + region e.g. aws-eu-west-2 Note: ibm-eu-central-1 is a deprecated value.

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "name": "string",
  • "region": "UNKNOWN"
}

Response samples

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

Update a Cloud Vault

Updates the provided fields in a specific Cloud Vault.

Authorizations:
API_Keys
path Parameters
cloud_vault.id
required
string

Output only. ID is the unique identifier of the Cloud Vault.

Request Body schema: application/json
required
description
string

Description is an optional description given to this Cloud Vault.

name
string

Name is the display name given to this Cloud Vault.

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "name": "string"
}

Response samples

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

Delete a Cloud Vault.

Deletes a specific Cloud Vault.

Authorizations:
API_Keys
path Parameters
id
required
string
query Parameters
force
boolean

Force will, if set, delete a Cloud Vault that is associated with a bunker or is currently in use. If it is not set, an error will be returned in these cases instead.

Responses

Response samples

Content type
application/json
{ }

Get a Cloud Vault.

Get the details of a specific Cloud Vault.

Authorizations:
API_Keys
path Parameters
id
required
string

Responses

Response samples

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

Files

Service for managing files within a Cloud Vault.

Delete file

Delete the specified file

Authorizations:
API_Keys
path Parameters
cloud_vault_id
required
string

The globally unique identifier for the Cloud Vault where the file to delete is.

name
required
string.+

The path of the file to be deleted. If the path ends in '/*' then delete everthing with that path prefix.

Responses

Response samples

Content type
application/json
{ }

List files

List available files with any metadata

Authorizations:
API_Keys
path Parameters
cloud_vault_id
required
string

CloudVaultId is the id of the Cloud Vault to list files from.

path
required
string.+

Path is the path within the cloud vault which has been requested. This will often be blank (no path = list the entire cloudvault), but could also be the path of a single file or directory.

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 separated value to define sorting. e.g 'name,created_time DESC'. The values are separated by space, '{column} {ASC/DESC}'. These are the values that are sortable: name size created_date_time (in RFC3339 format) metadata.updated_date_time (in RFC3339 format) metadata.origin.task_id metadata.origin.task_type metadata.origin.properties

filter
string

Filter is a string containing logic that can specify a restricted set of Files to be returned. e.g. name co 'Test' or name co 'Acme'. These are the supported fields for filtering:

name size created_date_time (in RFC3339 format) metadata.origin.task_type metadata.origin.task_id metadata.updated_date_time (in RFC3339 format) metadata.resource_type metadata.origin.properties.{property_name} (dynamic filtering based on the properties)

Responses

Response samples

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

Import Connectors

Service for managing import connector configurations to connect to a remote data source.

InfoSum Support Portal Article

List Import Connector Configs

List Import Connector Configs belonging to your company subject to the provided filter.

Authorizations:
API_Keys
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
Default: "created_date_time DESC"

Comma separated list of sorting parameters and ordering in the form of {sort_column} {ASC/DESC}. Supported sort fields are: name, connector_type, created_date_time, updated_date_time

filter
string

Filter string as per the docs. Supported filter fields are: id, name, description, connector_type, created_date_time, updated_date_time.

Responses

Response samples

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

Create Import Connector Config

Creates and validates an Import Connector Config based on the provided connector details.

Authorizations:
API_Keys
Request Body schema: application/json
required

The input to the CreateImportConnector method.

object

The details used to create a new Import Connector Config.

description
string

An optional description given to this Import Connector Config.

object

Google Cloud Storage specific information.

name
string

The display name given to the Import Connector Config.

object

AWS S3 specific information.

object

SFTP server specific information.

Responses

Request samples

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

Response samples

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

Get server host key.

Returns the first valid public sFTP server host key found. Supported key algorithms are ECDSA, RSA and ED25519.

Authorizations:
API_Keys
path Parameters
host
required
string

The hostname or IP address of the server to get public keys from.

port
required
integer <int32>

The port to acess the server on. For example 22.

Responses

Response samples

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

Update Import Connector Config

Updates the specified Import Connector Config, overriding any old fields with new ones provided on the request.

Authorizations:
API_Keys
path Parameters
config.id
required
string

The unique ID of the Import Connector Config.

Request Body schema: application/json
required
description
string

An optional description given to this Import Connector Config.

object

Google Cloud Storage specific information.

name
string

The display name given to the Import Connector Config.

object

AWS S3 specific information.

object

SFTP server specific information.

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "gcs_connector": {
    },
  • "name": "string",
  • "s3_connector": {
    },
  • "sftp_connector": {
    }
}

Response samples

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

Delete Import Connector Config

Remove the specified Import Connector Config. Import Connector Configs can only be removed if they are not in use by an Importer.

Authorizations:
API_Keys
path Parameters
config_id
required
string

The ID of the Import Connector Config to be deleted.

Responses

Response samples

Content type
application/json
{ }

Get Import Connector Config

Fetches an Import Connector Config by its Config ID.

Authorizations:
API_Keys
path Parameters
config_id
required
string

The ID of the Import Connector Config to retrieve.

Responses

Response samples

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

Importers

Service for managing importers, which combine an import connector configuration with file patterns to allow for easy re-importing of data.

InfoSum Support Portal Article

List Importers

List available Imports.

Authorizations:
API_Keys
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

A comma seperated value to define sorting e.g 'name,created_time DESC' The values are seperated by space, '{column} {ASC/DESC}'

filter
string

A string containing logic that can specify a restricted set of Importers to be returned e.g. name co 'Test' or name co 'Acme'

Responses

Response samples

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

Create Importer

Create a configuration for importing data.

Authorizations:
API_Keys
Request Body schema: application/json
required

The input to the CreateImport method.

object

The configuration to create a new Import with.

cloud_vault_id
string

The identifier for the Cloud Vault to where the files will be imported.

object

The filtered data to import from the import connector.

description
string

A description for the import.

icc_id
string

The id of the import connector config used by the import.

name
string

The name given to the import.

owner_id
string
target_folder
string

The target folder for the import. This field can be a path containing subfolders. Valid characters are alphanumeric, '_', '-', '.', '/'. This field cannot start or end with a '/'. The 'Recordsets' folder cannot be imported into. This field will be mandatory in the near future.

Responses