Menu
GET datasets User APIService tier

Datasets in the caller's org, one summary row each.

Query: q (name / description contains), source_kind, limit, offset, full=1 for the complete dataset payload per row.

URL

  • User APIhttps://analytics.mattering.io/api/user/v1/datasets
  • Service tierhttps://analytics.mattering.io/api/internal/v1/datasets

Query parameters

NameDefault
fullnone
qnone
searchnone
source_kindnone

Pagination

Accepts limit and offset. The response meta carries total, limit and offset.

Responses

200 data and meta envelope

{
  "data": [
    "..."
  ],
  "meta": {
    "total": 0,
    "limit": 0,
    "offset": 0,
    "returned": 0,
    "has_more": true,
    "view": "full"
  }
}

Field names come from the code; values are placeholders (... is a string, 0 a number, dates are ISO 8601).

Example

curl -X GET "https://analytics.mattering.io/api/user/v1/datasets?full=...&q=...&search=..." \
  -H "Authorization: Bearer $MATTERING_API_KEY"

Source: AnalyticsCore/api.py (api.list_datasets)

GET datasets/{public_id} User APIService tier

Read one of the datasets by id. derived from route

URL

  • User APIhttps://analytics.mattering.io/api/user/v1/datasets/{public_id}
  • Service tierhttps://analytics.mattering.io/api/internal/v1/datasets/{public_id}

Path parameters

NameType
public_idstr

Responses

200 data and meta envelope

{
  "data": "..."
}

Field names come from the code; values are placeholders (... is a string, 0 a number, dates are ISO 8601).

Example

curl -X GET "https://analytics.mattering.io/api/user/v1/datasets/PUBLIC_ID" \
  -H "Authorization: Bearer $MATTERING_API_KEY"

Source: AnalyticsCore/api.py (api.get_dataset)

POST datasets/{public_id}/publish User APIService tier

Materialize a dataset's shaped rows into a Data Studio datatable.

The loop-closing half of the integration: an agent can shape data here and hand it to automations as datatable entries to trigger on. Append-only.

Body: {"datatable_id": "<uuid>"} or {"create_name": "<name>"}.

This read is not paginated. It returns at most 20 rows and does not report a total, so a result of exactly 20 may be truncated.

URL

  • User APIhttps://analytics.mattering.io/api/user/v1/datasets/{public_id}/publish
  • Service tierhttps://analytics.mattering.io/api/internal/v1/datasets/{public_id}/publish

Path parameters

NameType
public_idstr

Body keys (JSON)

KeyRequiredDefault
create_nameoptional or conditionalnone
datatable_idoptional or conditionalnone

Keys the view reads. A key not in this list is ignored by the view. Where a key is required only for some actions (for example the action dispatch), the description above says which.

Responses

200 data and meta envelope

{
  "data": {
    "datatable_id": "...",
    "created": true,
    "partial": true,
    "rejected": 0,
    "rejected_sample": "..."
  },
  "meta": {
    "errors": [
      "..."
    ],
    "error_count": 0
  }
}

Field names come from the code; values are placeholders (... is a string, 0 a number, dates are ISO 8601).

Errors

StatusCode
400invalid_json
400missing_field
409nothing_to_publish
502publish_failed

Example

curl -X POST "https://analytics.mattering.io/api/user/v1/datasets/PUBLIC_ID/publish" \
  -H "Authorization: Bearer $MATTERING_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "create_name": "...",
  "datatable_id": "..."
}'

Source: AnalyticsCore/api.py (api.publish_dataset)

POST datasets/{public_id}/refresh User APIService tier

POST to datasets/{public_id}/refresh. derived from route

URL

  • User APIhttps://analytics.mattering.io/api/user/v1/datasets/{public_id}/refresh
  • Service tierhttps://analytics.mattering.io/api/internal/v1/datasets/{public_id}/refresh

Path parameters

NameType
public_idstr

Query parameters

NameDefault
fullnone
schemanone

Responses

200 data and meta envelope

{
  "data": {
    "row_count": 0,
    "fetched_at": "2026-01-01T00:00:00Z",
    "duration_ms": 0,
    "column_count": 0,
    "schema": "..."
  }
}

Field names come from the code; values are placeholders (... is a string, 0 a number, dates are ISO 8601).

Errors

StatusCode
502refresh_failed

Example

curl -X POST "https://analytics.mattering.io/api/user/v1/datasets/PUBLIC_ID/refresh" \
  -H "Authorization: Bearer $MATTERING_API_KEY"

Source: AnalyticsCore/api.py (api.refresh_dataset)

GET datasets/{public_id}/rows User APIService tier

Materialized rows for a dataset, honoring its refresh policy.

URL

  • User APIhttps://analytics.mattering.io/api/user/v1/datasets/{public_id}/rows
  • Service tierhttps://analytics.mattering.io/api/internal/v1/datasets/{public_id}/rows

Path parameters

NameType
public_idstr

Query parameters

NameDefault
columnsnone
fieldsnone
schemanone

Pagination

Accepts limit and offset. The response meta carries total, limit and offset.

Responses

200 data and meta envelope

{
  "data": {
    "rows": [
      "..."
    ],
    "schema": [
      "..."
    ]
  },
  "meta": {
    "total": 0,
    "limit": 0,
    "offset": 0,
    "returned": 0,
    "has_more": true,
    "columns": [
      "..."
    ],
    "fetched_at": "2026-01-01T00:00:00Z",
    "stale_error": "..."
  }
}

Field names come from the code; values are placeholders (... is a string, 0 a number, dates are ISO 8601).

Example

curl -X GET "https://analytics.mattering.io/api/user/v1/datasets/PUBLIC_ID/rows?columns=...&fields=...&schema=..." \
  -H "Authorization: Bearer $MATTERING_API_KEY"

Source: AnalyticsCore/api.py (api.dataset_rows)

All Analytics resources
Start Free Explore our Products