Management APIs / Projects

Get project metrics

GEThttps://api.spice.ai/v1/projects/{projectId}/metrics

Returns current resource utilization metrics (CPU, memory, disk I/O) and data ingestion metrics for a project.

Authorizations

  • AuthorizationstringRequired

    Bearer <token>. Authentication lists the tokens it accepts.

Path parameters

  • projectIdintegerRequired

    The ID of the project

Query parameters

  • windowstring

    Prometheus-style duration (e.g. 5m, 1h, 30s). When provided, counter metrics are returned as rates over the window instead of raw cumulative values. For example, rows_ingested returns average rows per second with a window, or total cumulative rows without one.

Header parameters

  • X-Org-Namestring

    The organization to act on, by handle. Omit it to act on the organization the credential is bound to; sending it blank is a 400, not the same as omitting it. A user credential may name any organization its owner belongs to; a machine credential is pinned to its own. A portal session token is bound to none, so it must send this header on every route but GET /v1/orgs (400 org_assertion_required otherwise).

    • Pattern: ^[A-Za-z0-9._-]{1,255}$

Responses

200OKapplication/json

Resource and ingestion metrics. Missing fields indicate no data is currently available. Individual metric queries may fail independently; partial results are returned when possible.

  • ingestionobject

    Aggregated data ingestion metrics

    2 properties

    • rows_ingestednumber

      Total rows ingested (without window) or rows per second (with window)

    • bytes_ingestednumber

      Total bytes ingested (without window) or bytes per second (with window)

  • clusterobject

    Cluster metrics for the project

    1 property

    • active_executors_countnumber

      Number of active executors registered with the scheduler

  • metricsmap of object

    Resource metrics keyed by pod name

    6 properties

    • cpu_usage_percentnumber

      CPU usage as a percentage (0-100)

    • memory_usage_bytesnumber

      Memory usage in bytes

    • disk_read_bytesnumber

      Disk bytes read per second (with window) or cumulative (without window)

    • disk_read_operationsnumber

      Disk read operations per second (with window) or cumulative count (without window)

    • disk_write_bytesnumber

      Disk bytes written per second (with window) or cumulative (without window)

    • disk_write_operationsnumber

      Disk write operations per second (with window) or cumulative count (without window)

400Invalid project ID

401Unauthorized

403Insufficient scope

404Project or organization not found

422Organization is not fully configured

500Internal server error

503Metrics service unavailable

curl "https://api.spice.ai/v1/projects/<projectId>/metrics" \
  -H "Authorization: Bearer <token>"
{
  "ingestion": {
    "rows_ingested": 0,
    "bytes_ingested": 0
  },
  "cluster": {
    "active_executors_count": 0
  },
  "metrics": {}
}

application/json

GEThttps://api.spice.ai/v1/orgs/{orgId}/projects/{projectId}/metrics

The org is orgId in the path. Returns current resource utilization metrics (CPU, memory, disk I/O) and data ingestion metrics for a project.

Authorizations

  • AuthorizationstringRequired

    Bearer <token>. Authentication lists the tokens it accepts.

Path parameters

  • orgIdintegerRequired

    The org id from GET /v1/orgs

    • Minimum: 1

  • projectIdintegerRequired

    The ID of the project

Query parameters

  • windowstring

    Prometheus-style duration (e.g. 5m, 1h, 30s). When provided, counter metrics are returned as rates over the window instead of raw cumulative values. For example, rows_ingested returns average rows per second with a window, or total cumulative rows without one.

Header parameters

  • X-Org-Namestring

    When present, X-Org-Name must name the same org as orgId. Otherwise the request returns org_path_mismatch (400).

    • Pattern: ^[A-Za-z0-9._-]{1,255}$

Responses

200OKapplication/json

Resource and ingestion metrics. Missing fields indicate no data is currently available. Individual metric queries may fail independently; partial results are returned when possible.

  • ingestionobject

    Aggregated data ingestion metrics

    2 properties

    • rows_ingestednumber

      Total rows ingested (without window) or rows per second (with window)

    • bytes_ingestednumber

      Total bytes ingested (without window) or bytes per second (with window)

  • clusterobject

    Cluster metrics for the project

    1 property

    • active_executors_countnumber

      Number of active executors registered with the scheduler

  • metricsmap of object

    Resource metrics keyed by pod name

    6 properties

    • cpu_usage_percentnumber

      CPU usage as a percentage (0-100)

    • memory_usage_bytesnumber

      Memory usage in bytes

    • disk_read_bytesnumber

      Disk bytes read per second (with window) or cumulative (without window)

    • disk_read_operationsnumber

      Disk read operations per second (with window) or cumulative count (without window)

    • disk_write_bytesnumber

      Disk bytes written per second (with window) or cumulative (without window)

    • disk_write_operationsnumber

      Disk write operations per second (with window) or cumulative count (without window)

400Bad Request

Invalid project ID. orgId is not a valid org id (invalid_org_id), or X-Org-Name does not name that org (org_path_mismatch).

401Unauthorized

403Forbidden

Insufficient scope. The caller is not a member of the org (org_forbidden). A machine credential named a different org (org_assertion_mismatch). The org is deleted (org_deleted).

404Project or organization not found

422Organization is not fully configured

500Internal server error

503Metrics service unavailable

curl "https://api.spice.ai/v1/orgs/<orgId>/projects/<projectId>/metrics" \
  -H "Authorization: Bearer <token>"
{
  "ingestion": {
    "rows_ingested": 0,
    "bytes_ingested": 0
  },
  "cluster": {
    "active_executors_count": 0
  },
  "metrics": {}
}

application/json

GEThttps://api.spice.ai/v1/apps/{appId}/metricsDeprecated

Legacy alias of /v1/projects/{projectId}/metrics — projects were previously called apps. Returns current resource utilization metrics (CPU, memory, disk I/O) and data ingestion metrics for a project.

Authorizations

  • AuthorizationstringRequired

    Bearer <token>. Authentication lists the tokens it accepts.

Path parameters

  • appIdintegerRequired

    The ID of the project

Query parameters

  • windowstring

    Prometheus-style duration (e.g. 5m, 1h, 30s). When provided, counter metrics are returned as rates over the window instead of raw cumulative values. For example, rows_ingested returns average rows per second with a window, or total cumulative rows without one.

Header parameters

  • X-Org-Namestring

    The organization to act on, by handle. Omit it to act on the organization the credential is bound to; sending it blank is a 400, not the same as omitting it. A user credential may name any organization its owner belongs to; a machine credential is pinned to its own. A portal session token is bound to none, so it must send this header on every route but GET /v1/orgs (400 org_assertion_required otherwise).

    • Pattern: ^[A-Za-z0-9._-]{1,255}$

Responses

200OKapplication/json

Resource and ingestion metrics. Missing fields indicate no data is currently available. Individual metric queries may fail independently; partial results are returned when possible.

  • ingestionobject

    Aggregated data ingestion metrics

    2 properties

    • rows_ingestednumber

      Total rows ingested (without window) or rows per second (with window)

    • bytes_ingestednumber

      Total bytes ingested (without window) or bytes per second (with window)

  • clusterobject

    Cluster metrics for the project

    1 property

    • active_executors_countnumber

      Number of active executors registered with the scheduler

  • metricsmap of object

    Resource metrics keyed by pod name

    6 properties

    • cpu_usage_percentnumber

      CPU usage as a percentage (0-100)

    • memory_usage_bytesnumber

      Memory usage in bytes

    • disk_read_bytesnumber

      Disk bytes read per second (with window) or cumulative (without window)

    • disk_read_operationsnumber

      Disk read operations per second (with window) or cumulative count (without window)

    • disk_write_bytesnumber

      Disk bytes written per second (with window) or cumulative (without window)

    • disk_write_operationsnumber

      Disk write operations per second (with window) or cumulative count (without window)

400Invalid project ID

401Unauthorized

403Insufficient scope

404Project or organization not found

422Organization is not fully configured

500Internal server error

503Metrics service unavailable

OpenAPIapi.spice.ai/openapi.json

curl "https://api.spice.ai/v1/apps/<appId>/metrics" \
  -H "Authorization: Bearer <token>"
{
  "ingestion": {
    "rows_ingested": 0,
    "bytes_ingested": 0
  },
  "cluster": {
    "active_executors_count": 0
  },
  "metrics": {}
}

application/json