--- title: List datastore items description: Datadog, the leading service for cloud-scale monitoring. breadcrumbs: Docs > API Reference > Actions Datastores --- # List datastore items{% #list-datastore-items %} Copy pageCopied {% tab title="v2" %} | Datadog site | API endpoint | | ----------------- | -------------------------------------------------------------------------------- | | ap1.datadoghq.com | GET https://api.ap1.datadoghq.com/api/v2/actions-datastores/{datastore_id}/items | | ap2.datadoghq.com | GET https://api.ap2.datadoghq.com/api/v2/actions-datastores/{datastore_id}/items | | app.datadoghq.eu | GET https://api.datadoghq.eu/api/v2/actions-datastores/{datastore_id}/items | | app.ddog-gov.com | GET https://api.ddog-gov.com/api/v2/actions-datastores/{datastore_id}/items | | us2.ddog-gov.com | GET https://api.us2.ddog-gov.com/api/v2/actions-datastores/{datastore_id}/items | | app.datadoghq.com | GET https://api.datadoghq.com/api/v2/actions-datastores/{datastore_id}/items | | us3.datadoghq.com | GET https://api.us3.datadoghq.com/api/v2/actions-datastores/{datastore_id}/items | | us5.datadoghq.com | GET https://api.us5.datadoghq.com/api/v2/actions-datastores/{datastore_id}/items | ### Overview Lists items from a datastore. You can filter the results by specifying either an item key or a filter query parameter, but not both at the same time. Supports server-side pagination for large datasets. This endpoint requires the `apps_datastore_read` permission. ### Arguments #### Path Parameters | Name | Type | Description | | ------------------------------ | ------ | --------------------------------------------------- | | datastore_id [*required*] | string | The unique identifier of the datastore to retrieve. | #### Query Strings | Name | Type | Description | | ------------ | ------- | -------------------------------------------------------------------------------------------------------------------------------- | | filter | string | Optional query filter to search items using the [logs search syntax](https://docs.datadoghq.com/logs/explorer/search_syntax.md). | | item_key | string | Optional primary key value to retrieve a specific item. Cannot be used together with the filter parameter. | | page[limit] | integer | Optional field to limit the number of items to return per page for pagination. Up to 100 items can be returned per page. | | page[offset] | integer | Optional field to offset the number of items to skip from the beginning of the result set for pagination. | | sort | string | Optional field to sort results by. Prefix with '-' for descending order (e.g., '-created_at'). | ### Response {% tab title="200" %} OK {% tab title="Model" %} A collection of datastore items with pagination and schema metadata. | Parent field | Field | Type | Description | | ------------ | ---------------------- | --------- | ---------------------------------------------------------------------------------------- | | | data [*required*] | [object] | An array of datastore items with their content and metadata. | | data | attributes | object | Metadata and content of a datastore item. | | attributes | created_at | date-time | Timestamp when the item was first created. | | attributes | modified_at | date-time | Timestamp when the item was last modified. | | attributes | org_id | int64 | The ID of the organization that owns this item. | | attributes | primary_column_name | string | The name of the primary key column for this datastore. Primary column names: | | attributes | signature | string | A unique signature identifying this item version. | | attributes | store_id | string | The unique identifier of the datastore containing this item. | | attributes | value | object | The data content (as key-value pairs) of a datastore item. | | data | id | string | The unique identifier of the datastore. | | data | type [*required*] | enum | The resource type for datastore items. Allowed enum values: `items` | | | meta | object | Metadata about the included items, including pagination info and datastore schema. | | meta | page | object | Pagination information for a collection of datastore items. | | page | hasMore | boolean | Whether there are additional pages of items beyond the current page. | | page | totalCount | int64 | The total number of items in the datastore, ignoring any filters. | | page | totalFilteredCount | int64 | The total number of items that match the current filter criteria. | | meta | schema | object | Schema information about the datastore, including its primary key and field definitions. | | schema | fields | [object] | An array describing the columns available in this datastore. | | fields | name [*required*] | string | The name of this column in the datastore. | | fields | type [*required*] | string | The data type of this column. For example, 'string', 'number', or 'boolean'. | | schema | primary_key | string | The name of the primary key column for this datastore. | {% /tab %} {% tab title="Example" %} ```json { "data": [ { "attributes": { "created_at": "2019-09-19T10:00:00.000Z", "modified_at": "2019-09-19T10:00:00.000Z", "org_id": "integer", "primary_column_name": "", "signature": "string", "store_id": "string", "value": {} }, "id": "string", "type": "items" } ], "meta": { "page": { "hasMore": false, "totalCount": "integer", "totalFilteredCount": "integer" }, "schema": { "fields": [ { "name": "", "type": "" } ], "primary_key": "string" } } } ``` {% /tab %} {% /tab %} {% tab title="400" %} Bad Request {% tab title="Model" %} API error response. | Parent field | Field | Type | Description | | ------------ | ------------------------ | -------- | ------------------------------------------------------------------------------- | | | errors [*required*] | [object] | A list of errors. | | errors | detail | string | A human-readable explanation specific to this occurrence of the error. | | errors | meta | object | Non-standard meta-information about the error | | errors | source | object | References to the source of the error. | | source | header | string | A string indicating the name of a single request header which caused the error. | | source | parameter | string | A string indicating which URI query parameter caused the error. | | source | pointer | string | A JSON pointer to the value in the request document that caused the error. | | errors | status | string | Status code of the response. | | errors | title | string | Short human-readable summary of the error. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ { "detail": "Missing required attribute in body", "meta": {}, "source": { "header": "Authorization", "parameter": "limit", "pointer": "/data/attributes/title" }, "status": "400", "title": "Bad Request" } ] } ``` {% /tab %} {% /tab %} {% tab title="404" %} Not Found {% tab title="Model" %} API error response. | Parent field | Field | Type | Description | | ------------ | ------------------------ | -------- | ------------------------------------------------------------------------------- | | | errors [*required*] | [object] | A list of errors. | | errors | detail | string | A human-readable explanation specific to this occurrence of the error. | | errors | meta | object | Non-standard meta-information about the error | | errors | source | object | References to the source of the error. | | source | header | string | A string indicating the name of a single request header which caused the error. | | source | parameter | string | A string indicating which URI query parameter caused the error. | | source | pointer | string | A JSON pointer to the value in the request document that caused the error. | | errors | status | string | Status code of the response. | | errors | title | string | Short human-readable summary of the error. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ { "detail": "Missing required attribute in body", "meta": {}, "source": { "header": "Authorization", "parameter": "limit", "pointer": "/data/attributes/title" }, "status": "400", "title": "Bad Request" } ] } ``` {% /tab %} {% /tab %} {% tab title="429" %} Too many requests {% tab title="Model" %} API error response. | Field | Type | Description | | ------------------------ | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} ### Code Example ##### \# Path parameters export datastore_id="CHANGE_ME" \# Curl command curl -X GET "https://api.datadoghq.com/api/v2/actions-datastores/${datastore_id}/items" \ -H "Accept: application/json" \ -H "DD-API-KEY: ${DD_API_KEY}" \ -H "DD-APPLICATION-KEY: ${DD_APP_KEY}" ##### ```python """ List datastore items returns "OK" response """ from os import environ from datadog_api_client import ApiClient, Configuration from datadog_api_client.v2.api.actions_datastores_api import ActionsDatastoresApi # there is a valid "datastore" in the system DATASTORE_DATA_ID = environ["DATASTORE_DATA_ID"] configuration = Configuration() with ApiClient(configuration) as api_client: api_instance = ActionsDatastoresApi(api_client) response = api_instance.list_datastore_items( datastore_id=DATASTORE_DATA_ID, ) print(response) ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=python) and then save the example to `example.py` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" python3 "example.py" ##### ```ruby # List datastore items returns "OK" response require "datadog_api_client" api_instance = DatadogAPIClient::V2::ActionsDatastoresAPI.new # there is a valid "datastore" in the system DATASTORE_DATA_ID = ENV["DATASTORE_DATA_ID"] p api_instance.list_datastore_items(DATASTORE_DATA_ID) ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=ruby) and then save the example to `example.rb` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" rb "example.rb" ##### ```go // List datastore items returns "OK" response package main import ( "context" "encoding/json" "fmt" "os" "github.com/DataDog/datadog-api-client-go/v2/api/datadog" "github.com/DataDog/datadog-api-client-go/v2/api/datadogV2" ) func main() { // there is a valid "datastore" in the system DatastoreDataID := os.Getenv("DATASTORE_DATA_ID") ctx := datadog.NewDefaultContext(context.Background()) configuration := datadog.NewConfiguration() apiClient := datadog.NewAPIClient(configuration) api := datadogV2.NewActionsDatastoresApi(apiClient) resp, r, err := api.ListDatastoreItems(ctx, DatastoreDataID, *datadogV2.NewListDatastoreItemsOptionalParameters()) if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `ActionsDatastoresApi.ListDatastoreItems`: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } responseContent, _ := json.MarshalIndent(resp, "", " ") fmt.Fprintf(os.Stdout, "Response from `ActionsDatastoresApi.ListDatastoreItems`:\n%s\n", responseContent) } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=go) and then save the example to `main.go` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" go run "main.go" ##### ```java // List datastore items returns "OK" response import com.datadog.api.client.ApiClient; import com.datadog.api.client.ApiException; import com.datadog.api.client.v2.api.ActionsDatastoresApi; import com.datadog.api.client.v2.model.ItemApiPayloadArray; public class Example { public static void main(String[] args) { ApiClient defaultClient = ApiClient.getDefaultApiClient(); ActionsDatastoresApi apiInstance = new ActionsDatastoresApi(defaultClient); // there is a valid "datastore" in the system String DATASTORE_DATA_ID = System.getenv("DATASTORE_DATA_ID"); try { ItemApiPayloadArray result = apiInstance.listDatastoreItems(DATASTORE_DATA_ID); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling ActionsDatastoresApi#listDatastoreItems"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=java) and then save the example to `Example.java` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" java "Example.java" ##### ```rust // List datastore items returns "OK" response use datadog_api_client::datadog; use datadog_api_client::datadogV2::api_actions_datastores::ActionsDatastoresAPI; use datadog_api_client::datadogV2::api_actions_datastores::ListDatastoreItemsOptionalParams; #[tokio::main] async fn main() { // there is a valid "datastore" in the system let datastore_data_id = std::env::var("DATASTORE_DATA_ID").unwrap(); let configuration = datadog::Configuration::new(); let api = ActionsDatastoresAPI::with_config(configuration); let resp = api .list_datastore_items( datastore_data_id.clone(), ListDatastoreItemsOptionalParams::default(), ) .await; if let Ok(value) = resp { println!("{:#?}", value); } else { println!("{:#?}", resp.unwrap_err()); } } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=rust) and then save the example to `src/main.rs` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" cargo run ##### ```typescript /** * List datastore items returns "OK" response */ import { client, v2 } from "@datadog/datadog-api-client"; const configuration = client.createConfiguration(); const apiInstance = new v2.ActionsDatastoresApi(configuration); // there is a valid "datastore" in the system const DATASTORE_DATA_ID = process.env.DATASTORE_DATA_ID as string; const params: v2.ActionsDatastoresApiListDatastoreItemsRequest = { datastoreId: DATASTORE_DATA_ID, }; apiInstance .listDatastoreItems(params) .then((data: v2.ItemApiPayloadArray) => { console.log( "API called successfully. Returned data: " + JSON.stringify(data) ); }) .catch((error: any) => console.error(error)); ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=typescript) and then save the example to `example.ts` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" tsc "example.ts" {% /tab %}