GET
/
api
/
v1
/
runs
curl --request GET \
  --url https://api.nekt.ai/api/v1/runs/ \
  --header 'x-api-key: <api-key>'
{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2",
  "results": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "started_at": "2023-11-07T05:31:56Z",
      "ended_at": "2023-11-07T05:31:56Z",
      "status": "queued",
      "pipeline": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "slug": "<string>",
        "description": "<string>",
        "type": "extractor",
        "active": true,
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "latest_run_started": "2023-11-07T05:31:56Z",
        "latest_run_ended": "2023-11-07T05:31:56Z",
        "latest_run_status": "<string>",
        "triggers": [
          {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "created_at": "2023-11-07T05:31:56Z",
            "updated_at": "2023-11-07T05:31:56Z",
            "type": "manual",
            "cron_expression": "<string>",
            "cron_timezone": "Africa/Abidjan",
            "events": [
              "<string>"
            ],
            "event_rule": "any"
          }
        ],
        "current_status": "<string>"
      },
      "log": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "parsed_log": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z"
      },
      "use_custom_logs": true,
      "trigger_type": "manual",
      "trigger": {
        "type": "<string>",
        "cron_expression": "<string>",
        "cron_timezone": "<string>",
        "event_rule": "<string>"
      },
      "triggered_by": {
        "id": 123,
        "first_name": "<string>",
        "last_name": "<string>",
        "email": "jsmith@example.com",
        "picture": "<string>",
        "role": "<string>",
        "date_joined": "2023-11-07T05:31:56Z",
        "last_login": "2023-11-07T05:31:56Z",
        "is_active": false
      },
      "triggered_by_token": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "token": "<string>",
        "is_active": true,
        "description": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "last_used_at": "2023-11-07T05:31:56Z"
      }
    }
  ]
}

Authorizations

​
x-api-key
string
header
required

API Key authentication. Format: 'x-api-key: {api_token}'

Query Parameters

​
date
string
​
page
integer

A page number within the paginated result set.

​
page_size
integer

Number of results to return per page.

​
pipeline_slug
string[]

Multiple values may be separated by commas.

​
pipeline_trigger_type
string[]

Multiple values may be separated by commas.

​
pipeline_type
string[]

Multiple values may be separated by commas.

​
search
string

A search term.

​
status
string[]

Multiple values may be separated by commas.

Response

200 - application/json
​
count
integer
required
Example:

123

​
results
object[]
required
​
next
string | null
Example:

"http://api.example.org/accounts/?page=4"

​
previous
string | null
Example:

"http://api.example.org/accounts/?page=2"