Usage

Get Usage
Get Usage Users

POST /api/v1/core/usage/{assetId}/usageGet usage data for a specific asset.Request Body

object

Page settings.

integer

Page number, starting at 1.

integer

Records per page.

string

Free-text search term.

array

Array of filter objects.

array

Array of sort instructions.

boolean

Set to true to request export output.

Path Parameters

string

required

Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6

Response

boolean

Whether the request completed successfully

string

Human-readable result message

string

ISO 8601 server timestamp

string

Unique ID for this request

object

object[]

integer

Example: 0.

Example

curl -X POST "https://<your-workspace>.prizmdata.ai/api/v1/core/usage/{assetId}/usage" \
  -H "Authorization: Bearer <YOUR_API_TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{
    "pagination": {
      "page": 1,
      "pageSize": 20
    },
    "search": "",
    "filters": [],
    "sorting": [],
    "export": false
  }'

This request body matches the payload the Prizm web app sends for this endpoint. IDs and values are placeholders.

Request body

{
  "pagination": {
    "page": 1,
    "pageSize": 20
  },
  "search": "",
  "filters": [],
  "sorting": [],
  "export": false
}

Response

{
  "success": true,
  "message": "Get usage data for a specific asset.",
  "timestamp": "2026-09-21T09:43:50.316067+00:00",
  "correlation_id": "1bff0823-3db2-4b12-bf56-22ea8d38bba2",
  "data": {
    "data": [],
    "total_count": 0
  }
}

POST /api/v1/core/usage/{assetId}/usage-usersGet usage users for a specific asset.Request BodyField descriptions are inferred from the entity model. Which fields are required is not confirmed for this endpoint.

object

Page settings.

integer

Page number, starting at 1.

integer

Records per page.

string

Free-text search term.

array

Array of filter objects.

array

Array of sort instructions.

boolean

Set to true to request export output.

Path Parameters

string

required

Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6

Response

boolean

Whether the request completed successfully

string

Human-readable result message

string

ISO 8601 server timestamp

string

Unique ID for this request

object

object[]

integer

Example: 0.

object[]

Example

curl -X POST "https://<your-workspace>.prizmdata.ai/api/v1/core/usage/{assetId}/usage-users" \
  -H "Authorization: Bearer <YOUR_API_TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{
    "pagination": {
      "page": 1,
      "pageSize": 20
    },
    "search": "",
    "filters": [],
    "sorting": [],
    "export": false
  }'

Representative request body. Field names follow the corresponding entity model and values are illustrative; send only the fields you need.

Request body

{
  "pagination": {
    "page": 1,
    "pageSize": 20
  },
  "search": "",
  "filters": [],
  "sorting": [],
  "export": false
}

Response

{
  "success": true,
  "message": "Get usage users for a specific asset.",
  "timestamp": "2026-09-21T09:43:50.316067+00:00",
  "correlation_id": "1bff0823-3db2-4b12-bf56-22ea8d38bba2",
  "data": {
    "data": [],
    "total_count": 0,
    "metrics": []
  }
}

Get Started

Core

Metrics

Schedule

Notification

Integrations

Governance

Logging