IMimprovado
Extracts

List extracts

List extracts

get/api/v3/extracts

Request

Query parameters

extraction_idsstring
Example:123,456

Extraction IDs

connection_idstring
Example:123,456

Filter extracts by connection ID. Accepts a single ID or a comma-separated list (e.g. 123 or 123,456).

datasource_namestring
Example:reddit,facebook

Filter extracts by datasource name (e.g. reddit, facebook). Accepts a single value or a comma-separated list.

data_table_idstring
Example:789,790

Filter extracts by data table ID. Accepts a single ID or a comma-separated list.

account_idstring
Example:101,102

Internal account IDs, comma-separated.

statusstring
Example:paused,error

Filter by UI status; accepts comma-separated values.

querystring

Case-insensitive extraction title search.

Response

Get a list of Extracts

countinteger

Number of extracts

nextstring

URL to the next page

previousstring

URL to the previous page

Example response

[
  {
    "extracts_list": {
      "value": {
        "count": 2,
        "next": null,
        "previous": null,
        "results": [
          {
            "id": 1,
            "title": "Extract 1",
            "connection_id": 1,
            "account_id": 1,
            "account_name": "Account 1",
            "account_entity_id": 1001,
            "account_embedded_id": 5001,
            "template": {
              "id": 1,
              "title": "Extract Template 1",
              "datasource_name": "google_sheets",
              "data_class": "table",
              "is_wide_template": false
            },
            "data_table": {
              "id": 1,
              "name": "table_1",
              "title": "Table 1"
            },
            "created_at": "2021-01-01T00:00:00Z",
            "last_sync": "2021-01-01T00:00:00Z",
            "status": "active",
            "error_text": "Error text",
            "sync_historical_data": "2025-02-25"
          },
          {
            "id": 2,
            "title": "Extract 2",
            "connection_id": 2,
            "account_id": 2,
            "account_name": "Account 2",
            "account_entity_id": 1002,
            "account_embedded_id": null,
            "template": {
              "id": 2,
              "title": "Extract Template 2",
              "datasource_name": "google_ads",
              "data_class": "table",
              "is_wide_template": false
            },
            "data_table": {
              "id": 2,
              "name": "table_2",
              "title": "Table 2"
            },
            "created_at": "2021-01-01T00:00:00Z",
            "last_sync": "2021-01-01T00:00:00Z",
            "status": "active",
            "error_text": "Error text",
            "sync_historical_data": null
          }
        ]
      }
    }
  }
]

Changes

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