Skip to main content
POST
/
datasets
Create dataset
curl --request POST \
  --url https://api.axiom.co/v2/datasets \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "description": "string",
  "kind": "axiom:events:v1",
  "name": "string",
  "retentionDays": 30
}
'
{
  "created": "2022-07-20T02:35:14.137Z",
  "description": "string",
  "id": "string",
  "kind": "axiom:events:v1",
  "name": "string",
  "who": "string"
}

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.

Query Parameters

​
referrer
string

Referrer slug

Body

application/json
​
name
string
required

Dataset unique name

​
description
string
default:""

Dataset description

​
edgeDeployment
string

Edge deployment of the dataset

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

The kind of the dataset

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

"axiom:events:v1"

​
retentionDays
integer

Number of days to retain data in the dataset

​
useRetentionPeriod
boolean

Whether to use the retention period

Response

Created

​
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

​
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