RunService

CreateRun

Create a run.

post/api/v2/runs

Request

  • Base URL: https://api.siftstack.com
  • URL: https://api.siftstack.com/api/v2/runs
  • Auth: HTTP bearer

Request body

namestring required

The name that will be assigned to the new run.

descriptionstring required

A description about the new run.

tagsstring[]

Tags to associate with the new run.

startTimestring date-time

The time at which data ingestion begins for this new run. It must be before the stop_time, and it must be provided if a stop_time is provided. Important note: start_time will be automatically computed during data ingestion and will be set based on the timestamp of the data for this run.

stopTimestring date-time

The time at which data ingestion for this new run concludes. Important note: stop_time will be automatically computed during data ingestion and will be set based on the timestamp of the data for this run.

organizationIdstring

An organization ID is only required if the user belongs to multiple organizations.

clientKeystring

An arbitrary user-chosen key that uniquely identifies this run. Optional, though it is recommended to provide.

createDefaultReportboolean

Whether to create a default report for this run. This facilitates getting the report ID for live rules that will be automatically created for this run which can streamline programatically creating Campaigns. Defaults to false if not specified (This default can be changed for your organization by Sift. Contact support to change this default behavior.).

Response

A successful response.

Changes

No recorded changes to this operation across all 1 revision of this API.