Skip to content

Datasets Endpoints

This API reference is organized by resource type and endpoint. Each resource type has one or more data representations and one or more methods.

Beacons

For more information about Beacons endpoints, see the Beacons Reference.

Datasets

For more information about Dataset endpoints, see the Datasets Reference.

Method HTTP Request Description
create POST /v2/datasets Create a dataset.
delete DELETE /v2/datasets/{DATASET_ID} Delete a dataset.
get GET /v2/datasets/{DATASET_ID} Retrieve metadata about a dataset.
query POST /v2/datasets/{DATASET_ID}/query Query a dataset.
batch_query POST /v1/batch_query Batch query one or more datasets.

Dataset Commits

For more information about Dataset Commit endpoints, see the Dataset Commits Reference.

Dataset commits are automatically created from dataset imports. You cannot create a dataset commit manually.

Method HTTP Request Description
delete DELETE /v2/dataset_commits/{COMMIT_ID} Delete a dataset commit.
get GET /v2/dataset_commits/{COMMIT_ID} Retrieve metadata about a dataset commit.
list GET /v2/datasets/{DATASET_ID}/commits List the dataset commits associated with a dataset.
rollback POST /v2/dataset_commits/{COMMIT_ID}/rollback Roll back a dataset commit.
cancel PUT /v2/dataset_commits/{COMMIT_ID} Cancel a dataset commit.

Dataset Exports

For more information about Dataset Export endpoints, see the Dataset Exports Reference.

Method HTTP Request Description
create POST /v2/dataset_exports Create a dataset export for a dataset.
delete DELETE /v2/dataset_exports/{EXPORT_ID} Delete a dataset export.
download GET /v2/dataset_exports/{EXPORT_ID}/download Download a dataset export.
get GET /v2/dataset_exports/{EXPORT_ID} Retrieve metadata about an export.
list GET /v2/datasets/{DATASET_ID}/exports List the exports associated with a dataset.
cancel PUT /v2/dataset_exports/{EXPORT_ID} Cancel a dataset export.

Dataset Fields

For more information about Dataset Field endpoints, see the Dataset Fields Reference.

Method HTTP Request Description
create POST /v2/dataset_fields Add a field to a dataset.
get GET /v2/dataset_fields/{FIELD_ID} Retrieve metadata about a field.
list GET /v2/datasets/{DATASET_ID}/fields List the fields of a dataset.
update PUT /v2/dataset_fields/{FIELD_ID} Edit a dataset field.

Dataset Imports

For more information about Dataset Import endpoints, see the Dataset Imports Reference.

Method HTTP Request Description
create POST /v2/dataset_imports Create a dataset import for a dataset.
delete DELETE /v2/dataset_imports/{IMPORT_ID} Delete a dataset import.
get GET /v2/dataset_imports/{IMPORT_ID} Retrieve metadata about an import.
list GET /v2/datasets/{DATASET_ID}/imports List the imports associated with a dataset.
cancel PUT /v2/dataset_imports/{IMPORT_ID} Cancel a dataset import.

Dataset Migrations

For more information about Dataset Migration endpoints, see the Dataset Migrations Reference.

Method HTTP Request Description
create POST /v2/dataset_migrations Create a new dataset migration.
delete DELETE /v2/dataset_migrations/{MIGRATION_ID} Delete a dataset migration.
get GET /v2/dataset_migrations/{MIGRATION_ID} Retrieve metadata about a migration.
list GET /v2/datasets/{DATASET_ID}/migrations List the migrations associated with a dataset (as the migration source).
cancel PUT /v2/dataset_migrations/{MIGRATION_ID} Cancel a dataset migration.

Dataset Templates

For more information about Dataset Template endpoints, see the Dataset Templates Reference.

Method HTTP Request Description
create POST /v2/dataset_templates Create a new dataset template.
delete DELETE /v2/dataset_templates/{TEMPLATE_ID} Delete a dataset template.
generate GET /v2/datasets/{DATASET_ID}/template Generate an unsaved template for an existing dataset.
get GET /v2/dataset_templates/{TEMPLATE_ID} Retrieve dataset template.
list GET /v2/dataset_templates List the dataset templates available to you.

Expressions

For more information about Expression endpoints, see the Expressions Reference. For Expression Functions, see the Expression Functions Reference.

Method HTTP Request Description
annotate POST /v1/annotate Annotate one or more records.
evaluate POST /v1/evaluate Evaluate an expression.