CreateRun

Create a run.

POST /api/v2/runs

CreateRun

cURL

curl --request POST \
  --url https://api.siftstack.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",
        "isArchived": true
      },
      "stringValue": "<string>",
      "numberValue": 123,
      "booleanValue": true,
      "archivedDate": "2023-11-07T05:31:56Z",
      "isArchived": true
    }
  ],
  "createDefaultReport": true
}
'

200

{
  "run": {
    "runId": "<string>",
    "createdDate": "2023-11-07T05:31:56Z",
    "modifiedDate": "2023-11-07T05:31:56Z",
    "createdByUserId": "<string>",
    "modifiedByUserId": "<string>",
    "organizationId": "<string>",
    "isPinned": true,
    "name": "<string>",
    "description": "<string>",
    "tags": [
      "<string>"
    ],
    "metadata": [
      {
        "key": {
          "name": "<string>",
          "type": "METADATA_KEY_TYPE_UNSPECIFIED",
          "archivedDate": "2023-11-07T05:31:56Z",
          "isArchived": true
        },
        "stringValue": "<string>",
        "numberValue": 123,
        "booleanValue": true,
        "relationValue": {
          "resourceType": "<string>",
          "resourceId": "<string>"
        },
        "archivedDate": "2023-11-07T05:31:56Z",
        "isArchived": true
      }
    ],
    "assetIds": [
      "<string>"
    ],
    "isAdhoc": true,
    "isArchived": true,
    "startTime": "2023-11-07T05:31:56Z",
    "stopTime": "2023-11-07T05:31:56Z",
    "defaultReportId": "<string>",
    "clientKey": "<string>",
    "archivedDate": "2023-11-07T05:31:56Z",
    "duration": "<string>"
  }
}

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.

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.

Show child attributes

createDefaultReport · boolean

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

200

application/json

A successful response.

run · object · required

Show child attributes