Dashboards

The dashbords endpoint allows you to access dashboards created on Axiom.

Creating an Access Token

Access Tokens can be your API or Personal Tokens managed inside your account setings.

API Token

API Tokens allow access to datasets for either querying data, ingesting data, or both. In your settings menu click on API Tokens and create your API Token

• Learn more about API Tokens

Personal Token

Personal tokens allows you to access the Axiom API programmatically for custom integrations. In your settings menu, click on Profile and select Personal Token.

• Learn more about Personal Tokens

Get dashboards

GET /api/v1/dashboards return the dashboard you have access to.

Example Request

curl -X 'GET' \
  'https://cloud.axiom.co/api/v1/dashboards?limit=4&offset=7' \
  -H 'Authorization: Bearer <$PERSONAL_TOKEN>' \
  -H 'X-Axiom-Org-ID: <$ORG_ID>'

Example Response

[
  {
    "charts": {},
    "description": "string",
    "layout": {},
    "name": "string",
    "owner": "string",
    "refreshTime": 0,
    "schemaVersion": 0,
    "timeWindowEnd": "string",
    "timeWindowStart": "string",
    "version": "string",
    "id": "string"
  }
]

Create dashboard

POST /api/v1/dashboards creates a new dashboard.

Example Request

curl -X 'POST' \
  'https://cloud.axiom.co/api/v1/dashboards' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer <$API_TOKEN or $PERSONAL_TOKEN>' \
  -H 'x-Axiom-Org-ID: <$ORG_ID>' \
  -d '{
  "charts": {},
  "description": "string",
  "layout": {},
  "name": "string",
  "owner": "string",
  "refreshTime": 0,
  "schemaVersion": 0,
  "timeWindowEnd": "string",
  "timeWindowStart": "string",
  "version": "string"
}'

Example Response

{
  "charts": {},
  "description": "string",
  "layout": {},
  "name": "string",
  "owner": "string",
  "refreshTime": 0,
  "schemaVersion": 0,
  "timeWindowEnd": "string",
  "timeWindowStart": "string",
  "version": "string",
  "id": "string"
}

DELETE /dashboards/{id}

DELETE /api/v1/dashboards/<dashboard_id>

Example Request

curl -X 'DELETE' \
  'https://cloud.axiom.co/api/v1/dashboards/<dashboard_id>' \
  -H 'Authorization: Bearer <$PERSONAL_TOKEN>' \
  -H 'X-Axiom-Org-ID: <$ORG_ID>'

where id is the string parameter.

Example Response

A successful response will have status code 204 and an empty body.

Get /dashboards/{id}

GET /api/v1/dashboards/<dashboard_id>

Example Request

curl -X 'GET' \
  'https://cloud.axiom.co/api/v1/dashboards/<dashboard_id>' \
  -H 'Authorization: Bearer <$PERSONAL_TOKEN>' \
  -H 'X-Axiom-Org-ID: <$ORG_ID>'

Example Response

Response status should be 200, and the response body

{
  "charts": {},
  "description": "string",
  "layout": {},
  "name": "string",
  "owner": "string",
  "refreshTime": 0,
  "schemaVersion": 0,
  "timeWindowEnd": "string",
  "timeWindowStart": "string",
  "version": "string",
  "id": "string"
}

PUT /dashboards/{id}

PUT /api/v1/dashboards/<dashboard_id>

Example Request

curl -X 'PUT' \
  'https://cloud.axiom.co/api/v1/dashboards/<dashboard_id>' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer <$PERSONAL_TOKEN>' \
  -H 'X-Axiom-Org-ID: <$ORG_ID>' \
  -d '{
  "charts": {},
  "description": "string",
  "layout": {},
  "name": "string",
  "owner": "string",
  "refreshTime": 0,
  "schemaVersion": 0,
  "timeWindowEnd": "string",
  "timeWindowStart": "string",
  "version": "string"
}'

Example Response

When a dashboard has been successfully updated, the API returns code 200 and the updated dashboard as the body of the response.

{
  "charts": {},
  "description": "string",
  "layout": {},
  "name": "string",
  "owner": "string",
  "refreshTime": 0,
  "schemaVersion": 0,
  "timeWindowEnd": "string",
  "timeWindowStart": "string",
  "version": "string",
  "id": "string"
}