GET/twconnect/api/v1/data/{entity}

Retrieve data for a specific entity.

Return the schema of all entities in the underlying storage.

Path Params

  • Name
    entity
    Type
    integer
    required
    Description

Query Params

  • Name
    orderMode
    Type
    string
    Description

    Set if the ordering is ascending or descending.

    Default
    asc
  • Name
    orderBy
    Type
    string
    Description

    Allow ordering the result set using a specific field.

  • Name
    cursor
    Type
    string
    Description

    Allow navigating through the result set using a cursor.

  • Name
    limit
    Type
    integer
    Description

    Limit the maximum number of records to return.

    Default
    1000
  • Name
    fields
    Type
    array[string]
    Description

    Allow selecting specific fields to return.

    Format
    Comma separated values

Responses

  • Code
    200
    Type
    object
    Schema
    Description
    200 OK
    ClickHouseDataResponse contains the data returned from ClickHouse.
  • Code
    400
    Type
    object
    Schema
    Description
    400 Bad Request
    ErrorResponse is the response for one or more errors.

Examples

200 OK

ClickHouseDataResponse
{
  "data": [
    {}
  ],
  "meta": {
    "limit": 0,
    "nextCursor": "string"
  }
}