AXaxiom
Datasets

Get list of datasets

Changed on

Lists the datasets you can read, including datasets shared with your organization, sorted by name. Returns all matching datasets in one response without pagination.

get/datasets

Request

Query parameters

exclude'labels'

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

labelstring[]

Filter by label names in your organization. Repeat the parameter for multiple names, for example ?label=prod&label=team-a. Names match case-insensitively after whitespace normalization; duplicates count once. Commas are part of a name, not separators. Reading resources never creates missing labels.

labelMatch'any' | 'all'

How to combine label names: any (the default) requires at least one requested label on a resource; all requires every requested label on that same resource. For example, ?label=prod&label=team-a matches either label, while ?label=prod&label=team-a&labelMatch=all requires both. Unknown names have no matches with any and make all return no resources. Without label parameters, labelMatch has no effect.

labelIdsstring[]

Return datasets assigned every specified label ID. When combined with label names, both filters must match; labelMatch applies only to names.

Response

Datasets you can read.

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": "2020-01-01T00:00:00Z",
    "description": "This is an example dataset",
    "id": "example-dataset",
    "name": "example-dataset",
    "updatedAt": "2020-01-01T00:00:00Z",
    "who": "John Doe"
  },
  {
    "created": "2020-02-01T00:00:00Z",
    "description": "This is an example dataset",
    "id": "example-dataset-2",
    "name": "example-dataset-2",
    "updatedAt": "2020-02-01T00:00:00Z",
    "who": "Foo Bar"
  }
]

Changes

  • v2e3baf3b85e8dRevision changes
    • info

      added the new optional query request parameter label

    • info

      added the new optional query request parameter labelMatch

    • info

      added the optional property / to the response with the status

    • info

      added the required property / to the response with the status

  • v28920e1697284Revision changes
    • info

      added the new optional query request parameter exclude

    • info

      added the new optional query request parameter labelIds

    • info

      added the non-success 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 optional property / to the response with the status

    • info

      added the required property / to the response with the status