Download OpenAPI specification:Download
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.
List current activations, subject to the optional request filters.
filter.campaign_name | string Campaign Name The filter to be applied to the campaign name. Case insensitive. Supports partial names. |
filter.submitted_at_filter.start_time | string <date-time> Start Defines the earliest time the filter is applied from. The filter matches all dates after this point in time, inclusive. |
filter.submitted_at_filter.end_time | string <date-time> End Defines the time the filter is applied until. The filter matches all dates before this point in time, inclusive. |
filter.query_successful | boolean Query Successful Filters activations that were successfully completed or not. |
filter.results_expired | boolean Results Expired Filters activations that have expired or not. |
filter.push_destinations | Array of strings Push Destinations Filters queries that have been pushed to the specified destinations. |
filter.output_columns | Array of strings Output Columns Filters activations by the selected output columns. Activations which contain any of the specified output columns are included in the result |
filter.activation_dataset_private_ids | Array of strings Activation Dataset Private IDs Filters queries by the activation dataset private ID used in the query. Activations for any of the dataset private IDs specified are included in the result. |
filter.project_ids | Array of strings Project IDs Filters queries by the projects that the activation dataset belongs to. Activations whose dataset belongs to any of the specified projects are included in the result. |
sort.by | string By is the field to sort by. |
sort.order | string Default: "ASCENDING" Enum: "ASCENDING" "DESCENDING" Order is the order to sort in. Defaults to ascending.
|
{- "activations": [
- {
- "activation_id": "string",
- "campaign_name": "string",
- "status": "QUERY_PENDING",
- "total_rows": 0,
- "submitted_at": "2019-08-24T14:15:22Z",
- "query_successful": true,
- "results_expired": true,
- "dataset_id": "string",
- "project_ids": [
- "string"
], - "column_separator": "string",
- "string_literal_column": {
- "column_name": "string",
- "column_literal": "string"
}, - "original_record_count": 0,
- "string_literal_columns": [
- {
- "column_name": "string",
- "column_literal": "string"
}
]
}
]
}
Create an Activation and queue the query for execution. Returns immediately with an ID of the Activation created. Use the Get Activation endpoint to see if the query has run. Only available for use with Activation Datasets.
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 (tyraelActivationStringLiteral) ActivationStringLiteral contains information about a string literal activation column. | |
object (HeaderOverrides) An optional map of query output column to header override. | |
Array of objects (StringLiteralColumns) The optional list of string literal columns. |
{- "query": "string",
- "path_overrides": [
- {
- "source_dataset": {
- "private_id": "string",
- "keys": [
- "string"
]
}, - "destination_private_id": "string"
}
], - "campaign_name": "string",
- "column_separator": "string",
- "string_literal_column": {
- "column_name": "string",
- "column_literal": "string"
}, - "header_overrides": {
- "property1": "string",
- "property2": "string"
}, - "string_literal_columns": [
- {
- "column_name": "string",
- "column_literal": "string"
}
]
}
{- "activation_id": "string",
- "query_completed": true,
- "query_error": {
- "code": 0,
- "message": "string",
- "details": [
- {
- "@type": "string",
- "property1": null,
- "property2": null
}
]
}, - "query_response": {
- "identities": [
- "string"
], - "total_rows": 0,
- "quality_measures": {
- "redaction_threshold_outlier": 0,
- "model_accuracy": 0
}
}
}
Performs validation of an Activation Query without executing it.
query | string (Query) The query to be validated. This takes the format of an IQL Query. See the documentation of the IQL 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. | |
object (tyraelActivationStringLiteral) ActivationStringLiteral contains information about a string literal activation column. | |
object HeaderOverrides is an optional map of query output column to header override. | |
Array of objects (String Literal Columns) The list of optional string literal output columns for the query |
{- "query": "string",
- "path_overrides": [
- {
- "source_dataset": {
- "private_id": "string",
- "keys": [
- "string"
]
}, - "destination_private_id": "string"
}
], - "string_literal_column": {
- "column_name": "string",
- "column_literal": "string"
}, - "header_overrides": {
- "property1": "string",
- "property2": "string"
}, - "string_literal_columns": [
- {
- "column_name": "string",
- "column_literal": "string"
}
]
}
{- "success": true
}
Get detailed information about an Activation, including query and push statuses.
activation_id required | string Activation ID The unique ID of the activation to get. |
{- "activation": {
- "summary": {
- "activation_id": "string",
- "campaign_name": "string",
- "status": "QUERY_PENDING",
- "total_rows": 0,
- "submitted_at": "2019-08-24T14:15:22Z",
- "query_successful": true,
- "results_expired": true,
- "dataset_id": "string",
- "project_ids": [
- "string"
], - "column_separator": "string",
- "string_literal_column": {
- "column_name": "string",
- "column_literal": "string"
}, - "original_record_count": 0,
- "string_literal_columns": [
- {
- "column_name": "string",
- "column_literal": "string"
}
]
}, - "query_error": {
- "code": 0,
- "message": "string",
- "details": [
- {
- "@type": "string",
- "property1": null,
- "property2": null
}
]
}, - "output_columns": [
- "string"
], - "pushes": [
- {
- "push_id": "string",
- "status": "PUSH_PENDING",
- "connector_type": "string",
- "pushed_at": "2019-08-24T14:15:22Z",
- "completed_at": "2019-08-24T14:15:22Z",
- "push_error": {
- "code": 0,
- "message": "string",
- "details": [
- {
- "@type": "string",
- "property1": null,
- "property2": null
}
]
}, - "push_successful": true
}
], - "query_string": "string",
- "join_metadata": [
- {
- "from_dataset": {
- "id": "string",
- "name": "string"
}, - "to_dataset": {
- "id": "string",
- "name": "string"
}, - "keys": [
- {
- "key_id": "string",
- "name": "string"
}
]
}
]
}
}
Pushes the result of an activation query to the specified push connector
activation_id required | string Activation ID The ID of the activation to push the results of. |
push_connector_id | string (Push Connector ID) Is the ID of the Push Connector to push the results to. |
object (PushConnectorConfig) The push connector map of Configuration Form field IDs to their values for configuring the push connector. |
{- "push_connector_id": "string",
- "push_connector_config": {
- "property1": "string",
- "property2": "string"
}
}
{- "push_id": "string"
}
Returns a list of all the Push Connectors that can be used with the specified Activation Query.
activation_id required | string Activation ID Is the ID of the activation to list the permitted push connectors for. |
{- "push_connectors": [
- {
- "id": "string",
- "name": "string"
}
]
}
Returns a list of asymmetric datasets the user has access to. An asymmetric dataset is one with permissions sent or received which enable the dataset to be used in asymmetric exports.
dataset_filters.private_ids | Array of strings PrivateIds An optional filter to be applied to the private IDs of the returned Datasets. |
dataset_filters.ownership | string Default: "ANY_OWNERSHIP" Enum: "ANY_OWNERSHIP" "OWNED" "NOT_OWNED" Ownership A filter for returned datasets based on their ownership.
|
{- "datasets": [
- {
- "private_id": "string",
- "dataset_id": "string",
- "owner": {
- "id": "string",
- "display_name": "string"
}, - "output_columns": [
- "string"
], - "asymmetric_permissions": 0
}
]
}
Creates a new cohort version for the given asymmetric dataset against the supplied output column. The requesting user must own the target dataset.
dataset_private_id required | string DatasetPrivateId is the private ID of the dataset to generate cohorts for. |
output_column | string OutputColumn is the selected output column to generate cohorts from. |
{- "output_column": "string"
}
{- "cohort_version_id": "string"
}
Pushes the asymmetric results of a cohort version to the specified push connector
dataset_private_id required | string DatasetPrivateId The unique identifier of the dataset to push results for. |
cohort_version_id required | string CohortVersionId The version ID of the generated cohorts against the dataset used in asymmetric exports. |
object (Push Connector Config) The configuration for a Push Connector. |
{- "push_connector_config": {
- "id": "string",
- "config": {
- "property1": "string",
- "property2": "string"
}
}
}
{- "push_id": "string"
}
Returns detailed information about an asymmetric push
dataset_private_id required | string DatasetPrivateId The unique identifier of the dataset to push results for. |
cohort_version_id required | string CohortVersionId The version ID of the generated cohorts against the dataset used in asymmetric exports. |
push_id required | string PushId The unique identifier of the push. |
{- "push": {
- "push_id": "string",
- "status": "PUSH_PENDING",
- "connector_type": "string",
- "pushed_at": "2019-08-24T14:15:22Z",
- "completed_at": "2019-08-24T14:15:22Z",
- "push_error": {
- "code": 0,
- "message": "string",
- "details": [
- {
- "@type": "string",
- "property1": null,
- "property2": null
}
]
}, - "push_successful": true
}
}
Returns a list of all cohort versions available for the given asymmetric dataset.
private_id required | string PrivateId Is the ID of the dataset to list cohort versions for. |
{- "cohort_versions": [
- {
- "cohort_version_id": "string",
- "output_column": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "expires_at": "2019-08-24T14:15:22Z",
- "status": "COHORTVERSION_PENDING",
- "version_error": {
- "code": 0,
- "message": "string",
- "details": [
- {
- "@type": "string",
- "property1": null,
- "property2": null
}
]
}, - "successful_version": true
}
]
}
Returns detailed information about a cohort version
private_id required | string PrivateId Is the private ID of the Dataset. |
cohort_version_id required | string CohortVersionId Is the cohort version of the request cohort. |
{- "cohort_version": {
- "cohort_version_id": "string",
- "output_column": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "expires_at": "2019-08-24T14:15:22Z",
- "status": "COHORTVERSION_PENDING",
- "version_error": {
- "code": 0,
- "message": "string",
- "details": [
- {
- "@type": "string",
- "property1": null,
- "property2": null
}
]
}, - "successful_version": true
}, - "pushes": [
- {
- "push_id": "string",
- "status": "PUSH_PENDING",
- "connector_type": "string",
- "pushed_at": "2019-08-24T14:15:22Z",
- "completed_at": "2019-08-24T14:15:22Z",
- "push_error": {
- "code": 0,
- "message": "string",
- "details": [
- {
- "@type": "string",
- "property1": null,
- "property2": null
}
]
}, - "push_successful": true
}
]
}
Returns a list of all asymmetric queries subject to the supplied filters
filter.dataset_private_ids | Array of strings DatasetPrivateIds Is a list of dataset private IDs of asymmetric datasets to fetch queries for. |
filter.campaign_name | string CampaignName Is the filter to be applied to the query's name. Case insensitive. |
filter.submitted_at_filter.start_time | string <date-time> Start Defines the earliest time the filter is applied from. The filter matches all dates after this point in time, inclusive. |
filter.submitted_at_filter.end_time | string <date-time> End Defines the time the filter is applied until. The filter matches all dates before this point in time, inclusive. |
filter.live_cohorts | boolean LiveCohorts Filters queries that are marked as live to be included in cohorts. |
filter.query_successful | boolean QuerySuccessful Filters queries that have successfully completed or not. |
filter.results_expired | boolean ResultsExpired Filters queries that have expired or not. |
filter.output_columns | Array of strings OutputColumns Filters queries by the output columns that were targeted. |
sort.by | string By is the field to sort by. |
sort.order | string Default: "ASCENDING" Enum: "ASCENDING" "DESCENDING" Order is the order to sort in. Defaults to ascending.
|
{- "asymmetric_queries": [
- {
- "query_id": "string",
- "user_id": "string",
- "dataset_private_id": "string",
- "campaign_name": "string",
- "live": true,
- "query_string": "string",
- "status": "ASYMMETRICQUERY_PENDING",
- "output_column": "string",
- "query_successful": true,
- "query_error": {
- "code": 0,
- "message": "string",
- "details": [
- {
- "@type": "string",
- "property1": null,
- "property2": null
}
]
}, - "submitted_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "expires_at": "2019-08-24T14:15:22Z",
- "results_expired": true,
- "total_rows": 0,
- "original_record_count": 0,
- "latest_cohort_version": "string",
- "join_metadata": [
- {
- "from_dataset": {
- "id": "string",
- "name": "string"
}, - "to_dataset": {
- "id": "string",
- "name": "string"
}, - "keys": [
- {
- "key_id": "string",
- "name": "string"
}
]
}
]
}
]
}
Queue an Asymmetric Query for execution. The requesting user must receive an asymmetric exports enabled permission to the target dataset. Returns immediately with an ID of the Asymmetric Query created.
query | string (Query) Query is the Query that should be queued. This takes the format of an InfoSum Query Language Identity Query. See the documentation of the InfoSum Query Language for more information. |
campaign_name | string (CampaignName) A name that a user can associate with an activation query. |
Array of objects (Path Overrides) A list of instructions on how to connect two datasets, overriding the automatic choices made by the core engine. |
{- "query": "string",
- "campaign_name": "string",
- "path_overrides": [
- {
- "source_dataset": {
- "private_id": "string",
- "keys": [
- "string"
]
}, - "destination_private_id": "string"
}
]
}
{- "asymmetric_query_id": "string"
}
Performs validation of an Asymmetric Query without actually executing it. Good for testing that your queries are correctly formatted.
query | string (Query) Query is the Asymmetric Query that should be validated. This takes the format of an InfoSum Query Language Identity Query. See the documentation of the InfoSum Query Language for more information. |
Array of objects (PathOverrides) PathOverrides is a list of instructions on how to connect two datasets, overriding the automatic choices made by the core engine. |
{- "query": "string",
- "path_overrides": [
- {
- "source_dataset": {
- "private_id": "string",
- "keys": [
- "string"
]
}, - "destination_private_id": "string"
}
]
}
{- "valid": true,
- "validation_details": "string"
}
Update details of an Asymmetric Query
query.query_id required | string QueryId QueryId is the id of the asymmetric query to update. |
update_mask | string UpdateMask is a field mask, allowing partial resource update.
The update mask applies to the Asymmetric Query. For the |
AsymmetricQuery
is the asymmetric query to update.
live | boolean (Live) Indicates if the given query should be included in cohort generation. |
{- "live": true
}
{ }
Returns information about an Asymmetric Query
query_id required | string QueryId The ID of the Query to retrieve. |
{- "asymmetric_query": {
- "query_id": "string",
- "user_id": "string",
- "dataset_private_id": "string",
- "campaign_name": "string",
- "live": true,
- "query_string": "string",
- "status": "ASYMMETRICQUERY_PENDING",
- "output_column": "string",
- "query_successful": true,
- "query_error": {
- "code": 0,
- "message": "string",
- "details": [
- {
- "@type": "string",
- "property1": null,
- "property2": null
}
]
}, - "submitted_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "expires_at": "2019-08-24T14:15:22Z",
- "results_expired": true,
- "total_rows": 0,
- "original_record_count": 0,
- "latest_cohort_version": "string",
- "join_metadata": [
- {
- "from_dataset": {
- "id": "string",
- "name": "string"
}, - "to_dataset": {
- "id": "string",
- "name": "string"
}, - "keys": [
- {
- "key_id": "string",
- "name": "string"
}
]
}
]
}
}
List all Push Connectors that the recipient can use to push the results from an Identity Query.
recipient_id | string RecipientId The ListPushConnectors method will return all PushConnectors that can be used by the user with this ID. |
{- "push_connectors": [
- {
- "id": "string",
- "name": "string"
}
]
}
Create a new Push Connector, based on an existing type of Push Connector, that can be used to push the results from an Identity Query.
base_id required | string BaseId The ID of the base Push Connector that the new Push Connector is based on. |
name | string (Name) A descriptive name for the new Push Connector. |
recipient_ids | Array of strings (RecipientIds) A list of the user IDs of users who can use the new Push Connector. Only users in this list will be allowed to use the new template. If left empty, any user will be allowed to use the new template if the owner specifies it in a permission shared with them. |
Array of objects (Values) Values is a list of modified fields for the new Push Connector. Any fields present in the base Push Connector that aren't in this list will be left unchanged in the new Push Connector. |
{- "name": "string",
- "recipient_ids": [
- "string"
], - "values": [
- {
- "field_id": "string",
- "value": "string",
- "user_editable": true
}
]
}
{- "push_connector": {
- "id": "string",
- "name": "string"
}
}
Returns a Form which describes the values that need to be specified in order to configure a Push Connector.
push_connector_id required | string PushConnectorId The ID of the Push Connector. |
user_email_domain | string UserEmailDomain is the domain part only of the requesting user's email address |
{- "form": {
- "panels": [
- {
- "label": "string",
- "fields": [
- {
- "id": "string",
- "label": "string",
- "options": [
- "string"
]
}
]
}
]
}
}
List all Connections available from user owned Datasets to Datasets which the user has been granted access.
filter.origin_private_ids | Array of strings Origin Private Dataset IDs The private IDs of the Datasets to display all connections from. |
filter.connected_datasets.private_ids | Array of strings PrivateIds The filter to be applied to the private IDs of the returned Datasets. Only Datasets with private IDs containing one of the strings specified in this filter will be returned. Case insensitive. |
filter.connected_datasets.public_names | Array of strings PublicNames The filter to be applied to the public names of the returned Datasets. Only Datasets with public names containing one of the string specified in this filter will be returned. Case insensitive. |
filter.connected_datasets.public_description | string PublicDescription The filter to be applied to the public descriptions of the returned Datasets. Only Datasets with public descriptions containing the string specified in this filter will be returned. Case insensitive. |
filter.connected_datasets.create_time_filter.start_time | string <date-time> Start Defines the earliest time the filter is applied from. The filter matches all dates after this point in time, inclusive. |
filter.connected_datasets.create_time_filter.end_time | string <date-time> End Defines the time the filter is applied until. The filter matches all dates before this point in time, inclusive. |
filter.connected_datasets.owner_ids | Array of strings Owner User IDs Filters Datasets on the specified owner user IDs. |
filter.connected_datasets.categories.ids | Array of strings <int64> Ids The IDs of the Categories that must be present in the Dataset. |
filter.connected_datasets.categories.min_fill_rates | Array of numbers <double> MinFillRates The minimum fill rates for each category specified in Ids. These are inclusive of the bound. A value must be specified for each Category. If the user doesn't want to filter by fill rate, they can set the minimum fill rate to 0, which will match all fill rate values. Values should be in the range 0 to 1, inclusive. |
filter.connected_datasets.project_ids | Array of strings ProjectIds The filter to be applied to the projects associated with the returned Datasets. Only Datasets within projects matching one of the project ids specified in this filter will be returned. Case insensitive. |
filter.min_intersection | number <double> Min Intersection The lowest acceptable intersection relative to the size of the connected Dataset. This is calculated by taking the number of rows in the from Dataset that are also in the to Dataset when using the 'best' key, and diving by the total number of rows in the from Dataset. Values can be between 0 and 1, inclusive. If ommitted, any intersection will be allowed. |
sort.by | string By is the field to sort by. |
sort.order | string Default: "ASCENDING" Enum: "ASCENDING" "DESCENDING" Order is the order to sort in. Defaults to ascending.
|
{- "connections": [
- {
- "from_dataset_private_id": "string",
- "to_dataset_private_id": "string",
- "keys": [
- {
- "name": "string",
- "intersection": "string",
- "duplicates": "string",
- "bad_estimate": true,
- "union": "string",
- "exclude": "string",
- "intersection_expansion_count": "string",
- "intersection_reduction_count": "string"
}
], - "selected_key_name": "string"
}
], - "datasets": [
- {
- "private_id": "string",
- "owner": {
- "id": "string",
- "display_name": "string"
}, - "public_name": "string",
- "public_description": "string",
- "create_time": "2019-08-24T14:15:22Z",
- "last_queried_time": "2019-08-24T14:15:22Z",
- "expire_time": "2019-08-24T14:15:22Z",
- "state": {
- "bunker_state": "CLAIMED",
- "progress": 0
}, - "latest_access": {
- "user": {
- "id": "string",
- "display_name": "string"
}, - "access_time": "2019-08-24T14:15:22Z"
}, - "stats": {
- "version": {
- "version": "string",
- "last_normalised_time": "2019-08-24T14:15:22Z",
- "global_schema_id": "string",
- "global_schema_name": "string",
- "global_schema_status": "string",
- "dataset_version": "string"
}, - "row_count": "string",
- "redaction_threshold": 0,
- "keys": [
- {
- "label": "string",
- "null_fraction": 0,
- "num_distinct": 0
}
], - "categories": [
- {
- "label": "string",
- "representations": [
- {
- "label": "string",
- "data_type": "STRINGS",
- "precision": 0,
- "statistics": {
- "average": 0,
- "standard_deviation": 0,
- "percentiles": [
- null
], - "null_fraction": 0,
- "num_distinct": 0,
- "most_common": [
- null
]
}, - "possible_values": [
- "string"
]
}
], - "version": "string",
- "unit": "string"
}
], - "identities": [
- {
- "name": "string"
}
]
}, - "credits": {
- "allocation": 0,
- "current_allocation": 0,
- "used": 0,
- "shares": [
- {
- "user": {
- "id": "string",
- "display_name": "string"
}, - "allowance": 0,
- "current_allowance": 0,
- "used": 0,
- "uses_parent_allocation": true
}
]
}, - "product": "INSIGHT"
}
]
}
Gets metadata for a specific Connection between two Datasets.
first_private_id required | string First Private Datasets ID The Private ID of the first Dataset in this Connection. |
second_private_id required | string Second Datasets ID The Private ID of the second Dataset in this Connection. |
{- "connection": {
- "from_dataset_private_id": "string",
- "to_dataset_private_id": "string",
- "keys": [
- {
- "name": "string",
- "intersection": "string",
- "duplicates": "string",
- "bad_estimate": true,
- "union": "string",
- "exclude": "string",
- "intersection_expansion_count": "string",
- "intersection_reduction_count": "string"
}
], - "selected_key_name": "string"
}
}
Lists Datasets the user has access to.
filter.ownership | string Default: "ANY_OWNERSHIP" Enum: "ANY_OWNERSHIP" "OWNED" "NOT_OWNED" OwnershipFilter Specifies whether to return all Datasets, or only those that are owned or not owned by the requesting user.
|
filter.datasets.private_ids | Array of strings PrivateIds The filter to be applied to the private IDs of the returned Datasets. Only Datasets with private IDs containing one of the strings specified in this filter will be returned. Case insensitive. |
filter.datasets.public_names | Array of strings PublicNames The filter to be applied to the public names of the returned Datasets. Only Datasets with public names containing one of the string specified in this filter will be returned. Case insensitive. |
filter.datasets.public_description | string PublicDescription The filter to be applied to the public descriptions of the returned Datasets. Only Datasets with public descriptions containing the string specified in this filter will be returned. Case insensitive. |
filter.datasets.create_time_filter.start_time | string <date-time> Start Defines the earliest time the filter is applied from. The filter matches all dates after this point in time, inclusive. |
filter.datasets.create_time_filter.end_time | string <date-time> End Defines the time the filter is applied until. The filter matches all dates before this point in time, inclusive. |
filter.datasets.owner_ids | Array of strings Owner User IDs Filters Datasets on the specified owner user IDs. |
filter.datasets.categories.ids | Array of strings <int64> Ids The IDs of the Categories that must be present in the Dataset. |
filter.datasets.categories.min_fill_rates | Array of numbers <double> MinFillRates The minimum fill rates for each category specified in Ids. These are inclusive of the bound. A value must be specified for each Category. If the user doesn't want to filter by fill rate, they can set the minimum fill rate to 0, which will match all fill rate values. Values should be in the range 0 to 1, inclusive. |
filter.datasets.project_ids | Array of strings ProjectIds The filter to be applied to the projects associated with the returned Datasets. Only Datasets within projects matching one of the project ids specified in this filter will be returned. Case insensitive. |
sort.by | string By is the field to sort by. |
sort.order | string Default: "ASCENDING" Enum: "ASCENDING" "DESCENDING" Order is the order to sort in. Defaults to ascending.
|
{- "datasets": [
- {
- "private_id": "string",
- "owner": {
- "id": "string",
- "display_name": "string"
}, - "public_name": "string",
- "public_description": "string",
- "create_time": "2019-08-24T14:15:22Z",
- "last_queried_time": "2019-08-24T14:15:22Z",
- "expire_time": "2019-08-24T14:15:22Z",
- "state": {
- "bunker_state": "CLAIMED",
- "progress": 0
}, - "latest_access": {
- "user": {
- "id": "string",
- "display_name": "string"
}, - "access_time": "2019-08-24T14:15:22Z"
}, - "stats": {
- "version": {
- "version": "string",
- "last_normalised_time": "2019-08-24T14:15:22Z",
- "global_schema_id": "string",
- "global_schema_name": "string",
- "global_schema_status": "string",
- "dataset_version": "string"
}, - "row_count": "string",
- "redaction_threshold": 0,
- "keys": [
- {
- "label": "string",
- "null_fraction": 0,
- "num_distinct": 0
}
], - "categories": [
- {
- "label": "string",
- "representations": [
- {
- "label": "string",
- "data_type": "STRINGS",
- "precision": 0,
- "statistics": {
- "average": 0,
- "standard_deviation": 0,
- "percentiles": [
- null
], - "null_fraction": 0,
- "num_distinct": 0,
- "most_common": [
- null
]
}, - "possible_values": [
- "string"
]
}
], - "version": "string",
- "unit": "string"
}
], - "identities": [
- {
- "name": "string"
}
]
}, - "credits": {
- "allocation": 0,
- "current_allocation": 0,
- "used": 0,
- "shares": [
- {
- "user": {
- "id": "string",
- "display_name": "string"
}, - "allowance": 0,
- "current_allowance": 0,
- "used": 0,
- "uses_parent_allocation": true
}
]
}, - "product": "INSIGHT"
}
]
}
Gets metadata for a specific Dataset the user owns or has access to.
private_id required | string Private Dataset ID The Private ID of the Dataset to retrieve, as assigned by the user. |
{- "dataset": {
- "private_id": "string",
- "owner": {
- "id": "string",
- "display_name": "string"
}, - "public_name": "string",
- "public_description": "string",
- "create_time": "2019-08-24T14:15:22Z",
- "last_queried_time": "2019-08-24T14:15:22Z",
- "expire_time": "2019-08-24T14:15:22Z",
- "state": {
- "bunker_state": "CLAIMED",
- "progress": 0
}, - "latest_access": {
- "user": {
- "id": "string",
- "display_name": "string"
}, - "access_time": "2019-08-24T14:15:22Z"
}, - "stats": {
- "version": {
- "version": "string",
- "last_normalised_time": "2019-08-24T14:15:22Z",
- "global_schema_id": "string",
- "global_schema_name": "string",
- "global_schema_status": "string",
- "dataset_version": "string"
}, - "row_count": "string",
- "redaction_threshold": 0,
- "keys": [
- {
- "label": "string",
- "null_fraction": 0,
- "num_distinct": 0
}
], - "categories": [
- {
- "label": "string",
- "representations": [
- {
- "label": "string",
- "data_type": "STRINGS",
- "precision": 0,
- "statistics": {
- "average": 0,
- "standard_deviation": 0,
- "percentiles": [
- 0
], - "null_fraction": 0,
- "num_distinct": 0,
- "most_common": [
- {
- "value": null,
- "frequency": null
}
]
}, - "possible_values": [
- "string"
]
}
], - "version": "string",
- "unit": "string"
}
], - "identities": [
- {
- "name": "string"
}
]
}, - "credits": {
- "allocation": 0,
- "current_allocation": 0,
- "used": 0,
- "shares": [
- {
- "user": {
- "id": "string",
- "display_name": "string"
}, - "allowance": 0,
- "current_allowance": 0,
- "used": 0,
- "uses_parent_allocation": true
}
]
}, - "product": "INSIGHT"
}, - "schema": {
- "version": "string",
- "update_time": "2019-08-24T14:15:22Z",
- "categories": [
- {
- "label": "string",
- "representations": [
- {
- "label": "string",
- "data_type": "STRINGS",
- "precision": 0,
- "statistics": {
- "average": 0,
- "standard_deviation": 0,
- "percentiles": [
- 0
], - "null_fraction": 0,
- "num_distinct": 0,
- "most_common": [
- {
- "value": "string",
- "frequency": 0
}
]
}, - "possible_values": [
- "string"
]
}
], - "version": "string",
- "unit": "string"
}
], - "num_rows": "string",
- "redaction_threshold": 0,
- "keys": [
- {
- "label": "string",
- "null_fraction": 0,
- "num_distinct": 0
}
]
}
}
Gets a time series of credit usage on the specified Dataset.
private_id required | string Private Dataset ID The Private ID of the Dataset to return usage data for. |
start_time | string <date-time> Start Time The timestamp from which to return usage data. If not specified, will default to the beginning of the current month. If specified, the StartTime will be rounded down to the next group boundary as specified by Grouping. |
end_time | string <date-time> End Time The timestamp up to which to return usage data. If not specified, will return all data up to the present moment. The EndTime will be rounded up to the next group boundary as specified by Grouping. |
grouping | string Default: "TIME_GROUPING_UNSPECIFIED" Enum: "TIME_GROUPING_UNSPECIFIED" "DAY" "WEEK" "MONTH" "YEAR" Grouping Specifies how to roll up a time series into discrete groups.
|
{- "timeseries": [
- {
- "timestamp": "2019-08-24T14:15:22Z",
- "usage": {
- "owner": {
- "id": "string",
- "display_name": "string"
}, - "allocation": 0,
- "current_allocation": 0,
- "used": 0,
- "permissions": [
- {
- "recipient": {
- "id": "string",
- "display_name": "string"
}, - "allowance": 0,
- "current_allowance": 0,
- "used": 0,
- "uses_parent_allocation": true
}
]
}
}
]
}
Add access to the Demo Datasets for querying.
Used to add Demo Datasets with the AddDemoDatasets method.
{ }
{- "permissions": [
- {
- "owner": {
- "id": "string",
- "display_name": "string"
}, - "private_id": "string",
- "recipient": {
- "id": "string",
- "display_name": "string"
}, - "create_time": "2019-08-24T14:15:22Z",
- "accept_time": "2019-08-24T14:15:22Z",
- "accepted": true,
- "credits": {
- "user": {
- "id": "string",
- "display_name": "string"
}, - "allowance": 0,
- "current_allowance": 0,
- "used": 0,
- "uses_parent_allocation": true
}, - "dataset_public_name": "string",
- "dataset_public_desc": "string"
}
]
}
Provides information about the choices made by the platfrom before executing a query.
query | string (Query) The Query whose execution will be explained. This takes the format of an InfoSum Query Language Query. See the documentation of the InfoSum 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. |
{- "query": "string",
- "path_overrides": [
- {
- "source_dataset": {
- "private_id": "string",
- "keys": [
- "string"
]
}, - "destination_private_id": "string"
}
]
}
{- "query_plan": {
- "query": "string",
- "plan": {
- "private_id": "string",
- "representation": {
- "category": "string",
- "selected_representation": "string",
- "inferred": true,
- "bins": [
- "string"
], - "filter": "string",
- "representations": [
- {
- "name": "string",
- "type": "string",
- "score": 0,
- "precision": 0,
- "bins": [
- "string"
], - "filter": "string"
}
]
}, - "aggregation_joins": {
- "combinator": {
- "type": "AND",
- "joins": [
- { }
]
}, - "id": 0,
- "from_private_id": "string",
- "to_private_id": "string",
- "representation": {
- "category": "string",
- "selected_representation": "string",
- "inferred": true,
- "bins": [
- "string"
], - "filter": "string",
- "representations": [
- {
- "name": "string",
- "type": "string",
- "score": 0,
- "precision": 0,
- "bins": [
- "string"
], - "filter": "string"
}
]
}, - "keys": {
- "max_overcounted": 0,
- "used": [
- "string"
], - "keys": [
- {
- "key_name": "string",
- "overlap": "string",
- "duplicates": "string",
- "from_dataset_size": "string",
- "to_dataset_size": "string"
}
], - "inferred": true
}
}, - "filter_joins": {
- "combinator": {
- "type": "AND",
- "joins": [
- { }
]
}, - "id": 0,
- "from_private_id": "string",
- "to_private_id": "string",
- "representation": {
- "category": "string",
- "selected_representation": "string",
- "inferred": true,
- "bins": [
- "string"
], - "filter": "string",
- "representations": [
- {
- "name": "string",
- "type": "string",
- "score": 0,
- "precision": 0,
- "bins": [
- "string"
], - "filter": "string"
}
]
}, - "keys": {
- "max_overcounted": 0,
- "used": [
- "string"
], - "keys": [
- {
- "key_name": "string",
- "overlap": "string",
- "duplicates": "string",
- "from_dataset_size": "string",
- "to_dataset_size": "string"
}
], - "inferred": true
}
}
}, - "results": {
- "max_overcounted_values": 0,
- "dimensions": [
- {
- "private_id": "string",
- "category": "string",
- "bins": [
- "string"
], - "inferred_bins": true
}
], - "filter": "string",
- "rounding_threshold": {
- "threshold": 0,
- "datasets": [
- {
- "private_id": "string",
- "threshold": 0
}
]
}, - "redaction_threshold": {
- "threshold": 0,
- "datasets": [
- {
- "private_id": "string",
- "threshold": 0
}
]
}
}
}, - "hop_table": [
- {
- "id": 0,
- "join_id": 0,
- "from_private_id": "string",
- "to_private_id": "string",
- "key_name": "string",
- "overlap": "string",
- "duplicates": "string",
- "from_dataset_size": "string",
- "to_dataset_size": "string",
- "max_overcounted_values": 0,
- "representation": {
- "category": "string",
- "selected_representation": "string",
- "inferred": true,
- "bins": [
- "string"
], - "filter": "string",
- "representations": [
- {
- "name": "string",
- "type": "string",
- "score": 0,
- "precision": 0,
- "bins": [
- "string"
], - "filter": "string"
}
]
}
}
]
}
Queue a Query for execution. Returns immediately with an ID of the Query created.
query | string (Query) The Query that should be queued. This takes the format of an InfoSum Query Language Query. See the documentation of the InfoSum 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. | |
sample | boolean (Sample) A flag that can be used to execute the query against a smaller sample of the data. Can be used to reduce the execution time for a less accurate result. |
{- "query": "string",
- "path_overrides": [
- {
- "source_dataset": {
- "private_id": "string",
- "keys": [
- "string"
]
}, - "destination_private_id": "string"
}
], - "sample": true
}
{- "query_id": "string",
- "done": true
}
Get the Result of a Query, when it is available.
query_id required | string Query ID The ID of the Query, as returned from the CreateQuery method. |
{- "dimensions": [
- {
- "value": "string",
- "category": "string",
- "count": 0,
- "continuous": true,
- "private_id": "string",
- "dimensions": [
- { }
]
}
], - "audience": 0,
- "quality_measures": {
- "redaction_threshold_outlier": 0,
- "rounding_threshold_outlier": 0,
- "model_accuracy": 0,
- "result_precision_include_empty_bins": 0,
- "result_precision_exclude_empty_bins": 0
}, - "join_metadata": [
- {
- "from_dataset": {
- "id": "string",
- "name": "string"
}, - "to_dataset": {
- "id": "string",
- "name": "string"
}, - "keys": [
- {
- "key_id": "string",
- "name": "string"
}
]
}
]
}
Performs validation of a query without actually executing it. Good for testing that your queries are correctly formatted.
query | string (Query) The Query that should be validated. This takes the format of an InfoSum Query Language Query. See the documentation of the InfoSum 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. |
{- "query": "string",
- "path_overrides": [
- {
- "source_dataset": {
- "private_id": "string",
- "keys": [
- "string"
]
}, - "destination_private_id": "string"
}
]
}
{- "success": true
}
List all Permissions the user has offered or been offered.
filter.direction | string Default: "ANY_DIRECTION" Enum: "ANY_DIRECTION" "INCOMING" "OUTGOING" Direction Specifies whether to return all Permissions, or only those that are incoming or outgoing.
|
filter.accepted | string Default: "ANY_ACCEPTED" Enum: "ANY_ACCEPTED" "INACTIVE" "ACTIVE" Accepted Specifies whether to return all Permissions, or only those that have or have not been accepted by the recipient.
|
filter.owned_datasets.private_ids | Array of strings PrivateIds The filter to be applied to the private IDs of the returned Datasets. Only Datasets with private IDs containing one of the strings specified in this filter will be returned. Case insensitive. |
filter.owned_datasets.public_names | Array of strings PublicNames The filter to be applied to the public names of the returned Datasets. Only Datasets with public names containing one of the string specified in this filter will be returned. Case insensitive. |
filter.owned_datasets.public_description | string PublicDescription The filter to be applied to the public descriptions of the returned Datasets. Only Datasets with public descriptions containing the string specified in this filter will be returned. Case insensitive. |
filter.owned_datasets.create_time_filter.start_time | string <date-time> Start Defines the earliest time the filter is applied from. The filter matches all dates after this point in time, inclusive. |
filter.owned_datasets.create_time_filter.end_time | string <date-time> End Defines the time the filter is applied until. The filter matches all dates before this point in time, inclusive. |
filter.owned_datasets.owner_ids | Array of strings Owner User IDs Filters Datasets on the specified owner user IDs. |
filter.owned_datasets.categories.ids | Array of strings <int64> Ids The IDs of the Categories that must be present in the Dataset. |
filter.owned_datasets.categories.min_fill_rates | Array of numbers <double> MinFillRates The minimum fill rates for each category specified in Ids. These are inclusive of the bound. A value must be specified for each Category. If the user doesn't want to filter by fill rate, they can set the minimum fill rate to 0, which will match all fill rate values. Values should be in the range 0 to 1, inclusive. |
filter.owned_datasets.project_ids | Array of strings ProjectIds The filter to be applied to the projects associated with the returned Datasets. Only Datasets within projects matching one of the project ids specified in this filter will be returned. Case insensitive. |
filter.other_datasets.private_ids | Array of strings PrivateIds The filter to be applied to the private IDs of the returned Datasets. Only Datasets with private IDs containing one of the strings specified in this filter will be returned. Case insensitive. |
filter.other_datasets.public_names | Array of strings PublicNames The filter to be applied to the public names of the returned Datasets. Only Datasets with public names containing one of the string specified in this filter will be returned. Case insensitive. |
filter.other_datasets.public_description | string PublicDescription The filter to be applied to the public descriptions of the returned Datasets. Only Datasets with public descriptions containing the string specified in this filter will be returned. Case insensitive. |
filter.other_datasets.create_time_filter.start_time | string <date-time> Start Defines the earliest time the filter is applied from. The filter matches all dates after this point in time, inclusive. |
filter.other_datasets.create_time_filter.end_time | string <date-time> End Defines the time the filter is applied until. The filter matches all dates before this point in time, inclusive. |
filter.other_datasets.owner_ids | Array of strings Owner User IDs Filters Datasets on the specified owner user IDs. |
filter.other_datasets.categories.ids | Array of strings <int64> Ids The IDs of the Categories that must be present in the Dataset. |
filter.other_datasets.categories.min_fill_rates | Array of numbers <double> MinFillRates The minimum fill rates for each category specified in Ids. These are inclusive of the bound. A value must be specified for each Category. If the user doesn't want to filter by fill rate, they can set the minimum fill rate to 0, which will match all fill rate values. Values should be in the range 0 to 1, inclusive. |
filter.other_datasets.project_ids | Array of strings ProjectIds The filter to be applied to the projects associated with the returned Datasets. Only Datasets within projects matching one of the project ids specified in this filter will be returned. Case insensitive. |
sort.by | string By is the field to sort by. |
sort.order | string Default: "ASCENDING" Enum: "ASCENDING" "DESCENDING" Order is the order to sort in. Defaults to ascending.
|
{- "permissions": [
- {
- "owner": {
- "id": "string",
- "display_name": "string"
}, - "private_id": "string",
- "recipient": {
- "id": "string",
- "display_name": "string"
}, - "create_time": "2019-08-24T14:15:22Z",
- "accept_time": "2019-08-24T14:15:22Z",
- "accepted": true,
- "credits": {
- "user": {
- "id": "string",
- "display_name": "string"
}, - "allowance": 0,
- "current_allowance": 0,
- "used": 0,
- "uses_parent_allocation": true
}, - "dataset_public_name": "string",
- "dataset_public_desc": "string"
}
]
}
Gets a time series of credit usage on the specified Dataset.
private_id required | string Private Dataset ID The Private ID of the Dataset that the Permission is from, which identifies the Permission to return usage data for when combined with RecipientId. |
recipient_id required | string Recipient user ID The user ID of the recipient of the Permission to return usage data for, which identifies a single Permission when combined with Dataset ID. |
start_time | string <date-time> Start Time The timestamp from which to return usage data. If not specified, will default to the beginning of the current month. If specified, the StartTime will be rounded down to the next group boundary as specified by Grouping. |
end_time | string <date-time> End Time The timestamp up to which to return usage data. If not specified, will return all data up to the present moment. The EndDate will be rounded up to the next group boundary as specified by Grouping. |
grouping | string Default: "TIME_GROUPING_UNSPECIFIED" Enum: "TIME_GROUPING_UNSPECIFIED" "DAY" "WEEK" "MONTH" "YEAR" Grouping Specifies how to roll up a time series into discrete groups.
|
{- "timeseries": [
- {
- "timestamp": "2019-08-24T14:15:22Z",
- "usage": {
- "allowance": 0,
- "current_allowance": 0,
- "used": 0,
- "uses_parent_allocation": true,
- "parent_allocation": 0,
- "current_parent_allocation": 0
}
}
]
}