Skip to main content
GET
/
datasets
Get list of datasets
curl --request GET \
  --url https://api.axiom.co/v2/datasets \
  --header 'Authorization: Bearer <token>'
[
  {
    "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"
  }
]

Authorizations

​
Authorization
string
header
required

Authenticate using an API token or personal access token (PAT). Include the token as a Bearer token: Authorization: Bearer <token>. For more information, see Tokens.

Response

Success

​
created
string<date-time>
required

The RFC3339-formatted time when the dataset was created.

​
description
string
required

Dataset description

​
id
string
required

Dataset ID

​
kind
enum<string>
default:axiom:events:v1
required

The kind of the dataset

Available options:
otel:metrics:v1,
otel:traces:v1,
otel:logs:v1,
axiom:events:v1
Example:

"axiom:events:v1"

​
name
string
required

Unique dataset name

​
updatedAt
string<date-time>
required

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

​
who
string
required

Name of the dataset creator

​
canWrite
boolean

Whether this dataset has write access

​
edgeDeployment
string

Edge deployment of the dataset

​
mapFields
string[]
​
retentionDays
integer

Number of days to retain data in the dataset

​
sharedByOrg
string

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

​
useRetentionPeriod
boolean

Whether to use the retention period

Example:
[
  {
    "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"
  }
]