List

Description

Retrieve a list of record results.

Request

HTTP Method: GET

Query Parameter Description
range_start The start time for the time range of record results (ISO 8601 timestamp).
range_end The end time for the time range of record results (ISO 8601 timestamp).
record_type_id The ID of the record type (optional if record_field_ids are present).
record_field_ids An array of record field IDs to filter the results (optional if record_type_id is present).
story_ids Optional An array of story IDs to filter the results.
order_direction Optional The direction to order record results: ASC or DESC. Defaults to DESC.
order_field_id Optional The ID of the field used to order record results.
per_page Optional Set the number of record results returned per page. Defaults to 20, maximum is 500.
page Optional The page number of results to fetch.
filters Optional An array of objects each specifying a record result filter (see the table below).

Supported parameters in filters

Parameters Description
field_id The record field (i.e. record column) id.
operator EQUAL, NOT_EQUAL, GREATER_THAN, GREATER_THAN_OR_EQUAL_TO, LESS_THAN, LESS_THAN_OR_EQUAL_TO, IS_EMPTY, IS_NOT_EMPTY, IS_TRUE, or IS_FALSE.
value Depending on the operator, a string, number, or omitted. 
curl -X GET \
  https://<<META.tenant.domain>>/api/v1/records?range_end=2023-07-03T00:00:00Z&range_start=2022-07-03T23:59:59Z&record_field_ids[]=<id> \
  -H 'content-type: application/json' \
  -H 'x-user-token: <<CREDENTIAL.tines_api_key>>'

Tip: You can copy the cURL command of the record table and its filters you're viewing in the Tines app.

Response

A successful request will return a JSON object containing the record results the requesting token has access to.

Field description

Parameter Description
record_results Array of objects each representing a record result.
id Integer ID of the record result set.
Story name The name of the story this record result set was created in.
Timestamp The timestamp representing the date and time the record result set was created.

Sample response

{
  "record_results": [
    {
      "Story name": "Create new issue",
      "Timestamp": "2023-06-06 16:18:34",
      "Alert": "High",
      "id": 1
    },
    {
      "Story name": "Create new issue",
      "Timestamp": "2023-06-13 18:13:15",
      "Alert": "Medium",
      "id": 2
    },
    {
      "Story name": "Create new issue",
      "Timestamp": "2023-06-13 18:13:16",
      "Alert": "Low",
      "id": 3
    }
  ]
}
Was this helpful?