Harvest runs

List harvest runs across all datasources in the org (paginated)

GET

/api/tenant/v1/runs

Authorization

headerx-api-key<token>

A service key (nvs_...) in the x-api-key header. A service key belongs to one organization: an X-Org-Id header is optional and, when sent, must name that organization. This header also accepts any credential the bearer scheme does, and when a request sends both headers, this one is used.

Query Parameters

limit?integer

Maximum items per page (1–100, default 25)

Range1 <= value <= 100

Default25

cursor?string

Opaque cursor from a prior nextCursor

datasourceId?string

status?string

Value in"running""done"

startedFrom?string

Formatdate-time

startedTo?string

Formatdate-time

sort?string

Sort order: "-field" descending, "field" ascending. Accepted: startedAt, -startedAt (default -startedAt)

Response Body

Paginated harvest runs across all datasources in the org, newest first

application/json

response

items*array<>

pagination*

sort*

filters*

facets?

Value/count breakdown for each field requested via ?facets=. Present only when facets were requested.

included?

Example Request

curl -X GET 'https://api.nuvelics.com/api/tenant/v1/runs'

Example Request

curl -X GET 'https://api.nuvelics.com/api/tenant/v1/runs'

Example ResponseSchema

{
  "items": [
    {
      "id": "string",
      "datasourceId": "string",
      "status": "running",
      "startedAt": "2019-08-24T14:15:22Z",
      "finishedAt": "2019-08-24T14:15:22Z",
      "stats": {
        "property1": 0,
        "property2": 0
      }
    }
  ],
  "pagination": {
    "nextCursor": "string"
  },
  "sort": {
    "applied": "string",
    "default": "string",
    "available": [
      "string"
    ]
  },
  "filters": {
    "applied": {
      "property1": null,
      "property2": null
    },
    "available": [
      {
        "field": "string",
        "kind": "string",
        "facetable": true
      }
    ]
  },
  "facets": {
    "property1": {
      "values": [
        {
          "value": "string",
          "count": 0
        }
      ],
      "capped": true
    },
    "property2": {
      "values": [
        {
          "value": "string",
          "count": 0
        }
      ],
      "capped": true
    }
  },
  "included": {
    "datasources": {
      "property1": {
        "id": "string",
        "name": "string",
        "type": "string",
        "vendor": "datafactory",
        "iconId": "string"
      },
      "property2": {
        "id": "string",
        "name": "string",
        "type": "string",
        "vendor": "datafactory",
        "iconId": "string"
      }
    },
    "credentials": {
      "property1": {
        "id": "string",
        "name": "string",
        "schemeType": "string"
      },
      "property2": {
        "id": "string",
        "name": "string",
        "schemeType": "string"
      }
    },
    "users": {
      "property1": {
        "id": "string",
        "name": "string",
        "email": "string"
      },
      "property2": {
        "id": "string",
        "name": "string",
        "email": "string"
      }
    },
    "articlePitches": {
      "property1": [
        {
          "id": "string",
          "title": "string",
          "status": "string",
          "newsdeskId": "string"
        }
      ],
      "property2": [
        {
          "id": "string",
          "title": "string",
          "status": "string",
          "newsdeskId": "string"
        }
      ]
    }
  }
}

{  "items": [    {      "id": "string",      "datasourceId": "string",      "status": "running",      "startedAt": "2019-08-24T14:15:22Z",      "finishedAt": "2019-08-24T14:15:22Z",      "stats": {        "property1": 0,        "property2": 0      }    }  ],  "pagination": {    "nextCursor": "string"  },  "sort": {    "applied": "string",    "default": "string",    "available": [      "string"    ]  },  "filters": {    "applied": {      "property1": null,      "property2": null    },    "available": [      {        "field": "string",        "kind": "string",        "facetable": true      }    ]  },  "facets": {    "property1": {      "values": [        {          "value": "string",          "count": 0        }      ],      "capped": true    },    "property2": {      "values": [        {          "value": "string",          "count": 0        }      ],      "capped": true    }  },  "included": {    "datasources": {      "property1": {        "id": "string",        "name": "string",        "type": "string",        "vendor": "datafactory",        "iconId": "string"      },      "property2": {        "id": "string",        "name": "string",        "type": "string",        "vendor": "datafactory",        "iconId": "string"      }    },    "credentials": {      "property1": {        "id": "string",        "name": "string",        "schemeType": "string"      },      "property2": {        "id": "string",        "name": "string",        "schemeType": "string"      }    },    "users": {      "property1": {        "id": "string",        "name": "string",        "email": "string"      },      "property2": {        "id": "string",        "name": "string",        "email": "string"      }    },    "articlePitches": {      "property1": [        {          "id": "string",          "title": "string",          "status": "string",          "newsdeskId": "string"        }      ],      "property2": [        {          "id": "string",          "title": "string",          "status": "string",          "newsdeskId": "string"        }      ]    }  }}

List harvest runs across all datasources in the org (paginated)Copy Anchor Link

AuthorizationCopy Anchor Link

Query ParametersCopy Anchor Link

Response BodyCopy Anchor Link

On this page

List harvest runs across all datasources in the org (paginated)

Authorization

Query Parameters

Response Body