> ## Documentation Index
> Fetch the complete documentation index at: https://docs.kinetica.com/llms.txt
> Use this file to discover all available pages before exploring further.

# /get/records/byseries

```
URL: http://<db.host>:<db.port>/get/records/byseries
```

Retrieves the complete series/track records from the given input parameter
*world\_table\_name* based on the partial track information contained in the
input parameter *table\_name*.

This operation supports paging through the data via the input parameter
*offset* and input parameter *limit* parameters.

In contrast to [/get/records](/content/api/rest/get_records_rest) this returns
records grouped by series/track. So if input parameter *offset* is 0 and input
parameter *limit* is 5 this operation would return the first 5 series/tracks in
input parameter *table\_name*. Each series/track will be returned sorted by
their TIMESTAMP column.

## Input Parameter Description

<ParamField body="table_name" type="string">
  Name of the table or view for which series/tracks will be fetched, in \[schema\_name.]table\_name format, using standard [name resolution rules](../../concepts/tables/#table-name-resolution).
</ParamField>

<ParamField body="world_table_name" type="string">
  Name of the table containing the complete series/track information to be returned for the tracks present in the input parameter *table\_name*, in \[schema\_name.]table\_name format, using standard [name resolution rules](../../concepts/tables/#table-name-resolution). Typically this is used when retrieving series/tracks from a view (which contains partial series/tracks) but the user wants to retrieve the entire original series/tracks. Can be blank.
</ParamField>

<ParamField body="offset" type="int">
  A positive integer indicating the number of initial series/tracks to skip (useful for paging through the results).

  The default value is 0. The minimum allowed value is 0. The maximum allowed value is MAX\_INT.
</ParamField>

<ParamField body="limit" type="int">
  A positive integer indicating the maximum number of series/tracks to be returned. Or END\_OF\_SET (-9999) to indicate that the max number of results should be returned.

  The default value is 250.
</ParamField>

<ParamField body="encoding" type="string">
  Specifies the encoding for returned records; either *binary* or *json*.

  The default value is `binary`.

  The supported values are:

  * binary
  * json
</ParamField>

<ParamField body="options" type="map of string to strings">
  Optional parameters.

  The default value is an empty map ( \{} ).
</ParamField>

## Output Parameter Description

The Kinetica server embeds the endpoint response inside a standard response structure which contains status information and the actual response to the query.  Here is a description of the various fields of the wrapper:

<ResponseField name="status" type="String">
  'OK' or 'ERROR'
</ResponseField>

<ResponseField name="message" type="String">
  Empty if success or an error message
</ResponseField>

<ResponseField name="data_type" type="String">
  'get\_records\_by\_series\_response' or 'none' in case of an error
</ResponseField>

<ResponseField name="data" type="String">
  Empty string
</ResponseField>

<ResponseField name="data_str" type="JSON or String">
  This embedded JSON represents the result of the /get/records/byseries endpoint:

  <Expandable title="data_str">
    <ResponseField name="table_names" type="array of strings">
      The table name (one per series/track) of the returned series/tracks.
    </ResponseField>

    <ResponseField name="type_names" type="array of strings">
      The type IDs (one per series/track) of the returned series/tracks.
    </ResponseField>

    <ResponseField name="type_schemas" type="array of strings">
      The type schemas (one per series/track) of the returned series/tracks.
    </ResponseField>

    <ResponseField name="list_records_binary" type="array of arrays of bytes">
      If the encoding parameter of the request was 'binary' then this list-of-lists contains the binary encoded records for each object (inner list) in each series/track (outer list). Otherwise, empty list-of-lists.
    </ResponseField>

    <ResponseField name="list_records_json" type="array of arrays of strings">
      If the encoding parameter of the request was 'json' then this list-of-lists contains the JSON-encoded records for each object (inner list) in each series/track (outer list). Otherwise, empty list-of-lists.
    </ResponseField>

    <ResponseField name="info" type="map of string to strings">
      Additional information.
    </ResponseField>
  </Expandable>

  Empty string in case of an error.
</ResponseField>
