Datasets

Get dataset by ID

Changed on Nov 2, 2026

Retrieves a dataset by its name.

get/datasets/{dataset_id}

Request

Base URL
https://api.axiom.co/v2
Auth
OAuth 2
Authorization codehttps://accounts.google.com/o/oauth2/v2/auth
Token URLhttps://www.googleapis.com/oauth2/v4/token
TypeScript
https://skmtc.dev/axiom/apis/axiom-public-api/docs/datasets/:dataset_id/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

dataset_idstring required

Query parameters

exclude'labels'

Exclude resolved label objects from the dataset response. The labelIds and labelNames fields are still returned.

Response

Dataset.

canWriteboolean

Whether this dataset has write access

createdstring date-time required

The RFC3339-formatted time when the dataset was created.

createdByAgentboolean

true when the MCP server created this dataset

descriptionstring required

Dataset description

edgeDeploymentstring

Edge deployment of the dataset

edgeDeploymentUrlstring

URL of the edge deployment

idstring required

Dataset ID

kind'otel:metrics:v1' | 'otel:traces:v1' | 'otel:logs:v1' | 'axiom:events:v1' required

The kind of the dataset

labelIdsLabelID[] required

IDs of labels assigned to this dataset.

labelNamesstring[] required

Names of assigned labels, including with exclude=labels; [] when unassigned.

mapFieldsstring[]

namestring required

Unique dataset name

reclaimableFieldsinteger

Number of unused fields a vacuum can reclaim, when the dataset is a vacuum candidate

retentionDaysinteger

Number of days to retain data in the dataset

sharedByOrgstring

ID of the org that shared this resource, if it's shared

updatedAtstring date-time required

The RFC3339-formatted time when the dataset was last updated.

useRetentionPeriodboolean

Whether to use the retention period

vacuumCandidateboolean

Whether the dataset has unused fields that a vacuum can reclaim

whostring required

Name of the dataset creator

Example response

{
  "created": "2022-07-20T02:35:14.137Z",
  "description": "string",
  "id": "string",
  "kind": "axiom:events:v1",
  "name": "string",
  "updatedAt": "2022-07-20T02:35:14.137Z",
  "who": "string"
}

Changes

Nov 2, 2026v2e3baf3b85e8d Revision changes
- info
  added the optional property to the response with the status
- info
  added the required property to the response with the status
Oct 14, 2026v28920e1697284 Revision changes
- info
  added the new optional query request parameter exclude
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the required property to the response with the status

Operation history