List rows

GET https://api.ap1.datadoghq.com/api/v2/reference-tables/tables/{id}/rows/listhttps://api.ap2.datadoghq.com/api/v2/reference-tables/tables/{id}/rows/listhttps://api.datadoghq.eu/api/v2/reference-tables/tables/{id}/rows/listhttps://api.ddog-gov.com/api/v2/reference-tables/tables/{id}/rows/listhttps://api.us2.ddog-gov.com/api/v2/reference-tables/tables/{id}/rows/listhttps://api.datadoghq.com/api/v2/reference-tables/tables/{id}/rows/listhttps://api.us3.datadoghq.com/api/v2/reference-tables/tables/{id}/rows/listhttps://api.us5.datadoghq.com/api/v2/reference-tables/tables/{id}/rows/list

Overview

List all rows in a reference table using cursor-based pagination. Pass the page[continuation_token] from the previous response to fetch the next page on the same consistent snapshot. Returns 400 for tables with more than 10,000,000 rows.

Arguments

Path Parameters

Name

Type

Description

id [required]

string

Unique identifier of the reference table to list rows from.

Query Strings

Name

Type

Description

page[limit]

integer

Number of rows to return per page. Defaults to 100, maximum is 1000.

page[continuation_token]

string

Opaque cursor from the previous response’s next link. Pass this to retrieve the next page on the same consistent snapshot.

Response

OK

Paginated list of reference table rows.

Expand All

Field

Type

Description

data [required]

[object]

The rows.

attributes

object

Column values for this row in the reference table.

values

object

Key-value pairs representing the row data, where keys are field names from the schema.

id

string

Row identifier, corresponding to the primary key value.

type [required]

enum

Row resource type. Allowed enum values: row

default: row

links [required]

object

Pagination links for the list rows response.

first [required]

string

Link to the first page of results.

next

string

Link to the next page of results. Only present when more rows are available.

self [required]

string

Link to the current page of results.

{
  "data": [
    {
      "attributes": {
        "values": {
          "category": "tor",
          "intention": "suspicious",
          "ip_address": "102.130.113.9"
        }
      },
      "id": "102.130.113.9",
      "type": "row"
    }
  ],
  "links": {
    "first": "/api/v2/reference-tables/tables/00000000-0000-0000-0000-000000000000/rows/list?page%5Blimit%5D=100",
    "self": "/api/v2/reference-tables/tables/00000000-0000-0000-0000-000000000000/rows/list?page%5Bcontinuation_token%5D=eyJzaWQiOjEyMzQ1LCJwayI6ImV4YW1wbGVfcGsifQ%3D%3D\u0026page%5Blimit%5D=100"
  }
}

Bad Request

API error response.

Expand All

Field

Type

Description

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Forbidden

API error response.

Expand All

Field

Type

Description

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Not Found

API error response.

Expand All

Field

Type

Description

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Too many requests

API error response.

Expand All

Field

Type

Description

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Code Example

                  # Path parameters
export id="00000000-0000-0000-0000-000000000000"
# Curl command
curl -X GET "https://api.ap1.datadoghq.com"https://api.ap2.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.us2.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/reference-tables/tables/${id}/rows/list" \ -H "Accept: application/json" \ -H "DD-API-KEY: ${DD_API_KEY}" \ -H "DD-APPLICATION-KEY: ${DD_APP_KEY}"