Skip to main content
POST
/
api
/
v2
/
runs
CreateRun
curl --request POST \
  --url https://your-sift-api-url.com/api/v2/runs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "description": "<string>",
  "tags": [
    "<string>"
  ],
  "startTime": "2023-11-07T05:31:56Z",
  "stopTime": "2023-11-07T05:31:56Z",
  "organizationId": "<string>",
  "clientKey": "<string>",
  "metadata": [
    {
      "key": {
        "name": "<string>",
        "type": "METADATA_KEY_TYPE_UNSPECIFIED",
        "archivedDate": "2023-11-07T05:31:56Z"
      },
      "stringValue": "<string>",
      "numberValue": 123,
      "booleanValue": true,
      "archivedDate": "2023-11-07T05:31:56Z"
    }
  ]
}'
{
  "run": {
    "runId": "<string>",
    "createdDate": "2023-11-07T05:31:56Z",
    "modifiedDate": "2023-11-07T05:31:56Z",
    "createdByUserId": "<string>",
    "modifiedByUserId": "<string>",
    "organizationId": "<string>",
    "startTime": "2023-11-07T05:31:56Z",
    "stopTime": "2023-11-07T05:31:56Z",
    "isPinned": true,
    "name": "<string>",
    "description": "<string>",
    "tags": [
      "<string>"
    ],
    "defaultReportId": "<string>",
    "clientKey": "<string>",
    "metadata": [
      {
        "key": {
          "name": "<string>",
          "type": "METADATA_KEY_TYPE_UNSPECIFIED",
          "archivedDate": "2023-11-07T05:31:56Z"
        },
        "stringValue": "<string>",
        "numberValue": 123,
        "booleanValue": true,
        "archivedDate": "2023-11-07T05:31:56Z"
      }
    ],
    "assetIds": [
      "<string>"
    ],
    "archivedDate": "2023-11-07T05:31:56Z",
    "isAdhoc": true
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

The request of a call to RunService_CreateRuns to create a new run.

​
name
string
required

The name that will be assigned to the new run.

​
description
string
required

A description about the new run.

​
tags
string[]

Tags to associate with the new run.

​
startTime
string<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.

​
stopTime
string<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.

​
organizationId
string

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

​
clientKey
string

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

​
metadata
object[]

The metadata values associated with this run.

Response

A successful response.

​
run
object
required