Raw

All the endpoints that can be called on the Raw controller.

All the endpoints require the API_RAW_TABLE_READ permission.

index

get

The index lists all available data through the raw endpoint.

See the Response tab below for a sample response.

Authorizations

Responses

get

HTTPcURLJavaScriptPython

GET /api/v2/raw HTTP/1.1
Host: {{base_url}}
apiKey: YOUR_API_KEY
Accept: */*

200Success

No content

tableData

get

The actual data can be fetched with this endpoint. Use the data of the method above to generate a valid URL with valid columns and filters.

Authorizations

Query parameters

tablestring · min: 5Required

The table to get the data from, sample: telephone_calls_inbound

Pattern: ^([a-z_]+)$

columnsstringRequired

Comma separated list of the columns you want data from.

Pattern: ^([a-z_,]+)$

filtersstring[]Optional

Array of filters you want to apply. Availability is dependent per table.

Simply give the filter name as key, and the parameter as value.

startstring · min: 1Optional

Timestamp of when the data should start

Default: ""Pattern: ^(\d{4})-(\d{2})-(\d{2}) (\d{2}):(\d{2}):(\d{2})$

endstring · min: 1Optional

Timestamp of when the data should end

Default: ""Pattern: ^(\d{4})-(\d{2})-(\d{2}) (\d{2}):(\d{2}):(\d{2})$

itemStartnumberOptional

The record that should be started at.

Default: 0

itemLimitnumber · max: 9999Optional

Amount of records to return.

Default: 1000

Responses

get

HTTPcURLJavaScriptPython

GET /api/v2/raw/tableData?table=text&columns=text HTTP/1.1
Host: {{base_url}}
apiKey: YOUR_API_KEY
Accept: */*

200

tableData tickets

{
  "itemLimit": 1,
  "itemStart": 1,
  "itemTotal": 1,
  "items": [
    {
      "brand_id": 1,
      "channel_id": 1,
      "created_at": "text",
      "customer_external_id": "text",
      "direction": "text",
      "grade_by_customer": null,
      "id": 1,
      "last_update": "text",
      "priority": "text",
      "status": "text",
      "title": "text"
    }
  ]
}

fullTable

get

Returns the raw data of the full table.

Uses the table parameter to get the raw_fulltable_crons entry and serves the given file.

Authorizations

Query parameters

tablestring · min: 5OptionalPattern: ^([a-z_]+)$

Responses

get

HTTPcURLJavaScriptPython

GET /api/v2/raw/fullTable HTTP/1.1
Host: {{base_url}}
apiKey: YOUR_API_KEY
Accept: */*

200Success

No content