logo
API docs by Redocly

Content API (0.1)

Overview

The Content API lets you access and retrieve data from the platform for integration and content extraction. It supports both raw and transformed data, allowing real-time retrieval for your systems. Rate limits help maintain performance and should be followed when making API calls.

What You'll Learn:

  • How to retrieve raw or transformed data via API calls.
  • Guidelines for managing rate limits.
  • Steps to download extracted data.

Rate Limiting

Included headers in every authenticated response (success or failure):

  • X-Rate-Limit-Group: The name of the API group.
  • X-Rate-Limit-Remaining: The number of remaining requests in the current time window.
  • X-Rate-Limit-Reset: The timestamp when the rate limit will reset.

If the rate limit is exceeded, the API will return an HTTP 429 status code and a message with how many seconds to wait until the limit resets.

{"status":"fail","message":"Rate Limit Exceeded. Please wait -timeUntilReset- seconds before trying again."}

Data

Retrieves the raw data for a database

Authorizations:
bearerAuth
path Parameters
db_id
required
integer

ID of the database to get transformed data from

query Parameters
direction
string

Order direction, can be > or <

limit
number

How many results should be returned

offset
number

Offset used for paging

selector
string

The query selector to filter data by

header Parameters
x-api-key
required
string

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "total_run_time": 0.054791927337646,
  • "total_data_iterate_run_time": 0.000046014785766602,
  • "select_data_run_time": 0.035505056381226,
  • "total_count": 462,
  • "data": [
    ],
  • "total_chunks": 1
}

Downloads Data (either general, export or raw with no transformer)

Authorizations:
bearerAuth
path Parameters
db_id
required
integer

ID of the database that the export belongs to

export_id
required
integer

ID of the export

header Parameters
x-api-key
required
string
Request Body schema: application/json

Downloads Data with several options including general, export or raw

delimiter
required
string
Enum: "tab" "comma" "pipe" "semicolon"

The delimiter used to parse data

do_notify
required
boolean

A flag to check if the user should be alerted when the process completes

fe_download
required
boolean

A flag to format the response for download

ignore_export_selector
required
boolean

A flag to determine if export selector should be ignored

no_transformers
boolean

A flag to return raw data (no transformers applied)

push
string
Enum: "true" "false"

Determines if an export should get pushed or simply produce the output

selected_columns
Array of any

An array with the specific columns the output should include

Responses

Request samples

Content type
application/json
Example
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "",
  • "data": {
    }
}

Retrieves the transformed data for a database/export

Authorizations:
bearerAuth
path Parameters
db_id
required
integer

ID of the database to get transformed data from

export_id
required
integer

The export ID to get transformed data from. Default to 0 for all

query Parameters
direction
string

Order direction, can be > or <

limit
number

How many results should be returned

offset
number

Offset used for paging

selector
string

The query selector to filter data by

override_logs
boolean

Returns override_logs with each row of data to get the original values pre-transformed data overrides

header Parameters
x-api-key
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]