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

HTTPRequired

Responses

200

Successful response

application/json

get/api/v2/raw

GET /api/v2/raw HTTP/1.1
Host: {{base_url}}
Authorization: apikey YOUR_SECRET_TOKEN
Accept: */*

200

Successful response

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

HTTPRequired

Query parameters

tablestringOptional

The table to get the data from, sample: telephone_calls_inbound

Example: telephone_calls_inbound

columnsstringOptional

Comma separated list of the columns you want data from.

Example: id,brand_id,ticket_id

filters[]stringOptional

Array of filters you want to apply. Availability is dependent per table. Simply give the filter name as index for this parameter.

startstringOptional

type: ISO datetime

Timestamp of when the data should start, example: 2025-01-01 00:00:00

Example: 2025-01-01 00:00:00

endstringOptional

type: ISO datetime

Timestamp of when the data should end, example: 2025-02-01 00:00:00

Example: 2025-04-20 22:00:00

Responses

200

OK

application/json

Responseobject

get/api/v2/raw/tableData

GET /api/v2/raw/tableData HTTP/1.1
Host: {{base_url}}
Authorization: apikey YOUR_SECRET_TOKEN
Accept: */*

200

OK

{
  "type": "itemList",
  "itemStart": 0,
  "itemTotal": 20,
  "itemLimit": 5,
  "items": [
    {
      "id": 59027,
      "brand_id": 2,
      "channel_id": 1,
      "direction": "inbound",
      "status": "solved",
      "priority": "high",
      "title": "Question about my package",
      "created_at": "2016-09-02 23:48:03",
      "last_update": "2018-01-30 17:19:41",
      "grade_by_customer": null,
      "customer_external_id": "r701sqvjzki8s1z88sq6"
    },
    {
      "id": 59029,
      "brand_id": 2,
      "channel_id": 1,
      "direction": "inbound",
      "status": "new",
      "priority": "high",
      "title": "What is the best product for my situation?",
      "created_at": "2016-09-09 20:47:22",
      "last_update": "2016-09-18 22:22:34",
      "grade_by_customer": null,
      "customer_external_id": null
    },
    {
      "id": 59031,
      "brand_id": 2,
      "channel_id": 2,
      "direction": "inbound",
      "status": "pending",
      "priority": "medium",
      "title": "Please provide additional information",
      "created_at": "2016-09-09 20:47:22",
      "last_update": "2018-04-16 15:43:40",
      "grade_by_customer": null,
      "customer_external_id": "r701sqvjzki8s1z88sq6"
    },
    {
      "id": 59046,
      "brand_id": 1,
      "channel_id": 8,
      "direction": "inbound",
      "status": "solved",
      "priority": "high",
      "title": "Where are you located?",
      "created_at": "2016-10-01 17:09:44",
      "last_update": "2016-10-01 17:09:44",
      "grade_by_customer": null,
      "customer_external_id": null
    },
    {
      "id": 59048,
      "brand_id": 1,
      "channel_id": 3,
      "direction": "inbound",
      "status": "solved",
      "priority": "low",
      "title": "Just an idea",
      "created_at": "2016-10-01 17:22:33",
      "last_update": "2016-10-01 17:22:33",
      "grade_by_customer": null,
      "customer_external_id": null
    }
  ]
}

fullTable

get

Returns the raw data of the full table.

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

Authorizations

HTTPRequired

Responses

200

Successful response

application/json

get/api/v2/raw/fullTable

GET /api/v2/raw/fullTable HTTP/1.1
Host: {{base_url}}
Authorization: apikey YOUR_SECRET_TOKEN
Accept: */*

200

Successful response