Get database usage metrics

GET/v1/databases/{databaseId}/usageGet database usage metrics

Returns usage metrics for the specified database.

Parameters

databaseIdstringpathrequired

pattern ^(db_)?([cC][^\s-]{8,}|[a-z0-9]+)$

startDatestring · date-timequery

Start date for metrics query. Defaults to start of current month if not provided.

endDatestring · date-timequery

End date for metrics query. Will be set to end of day if a future date is provided. Defaults to current date if not provided.

Responses

object

generatedAtstring · date-timerequired

metricsobjectrequired

Show child attributes

operationsobjectrequired

Show child attributes

unitstringrequired

const "ops"

usednumberrequired

storageobjectrequired

Show child attributes

unitstringrequired

const "GiB"

usednumberrequired

periodobjectrequired

Show child attributes

endstring · date-timerequired

startstring · date-timerequired

Example response

{
  "generatedAt": "2026-06-09T00:00:00Z",
  "metrics": {
    "operations": {
      "unit": "ops",
      "used": 0
    },
    "storage": {
      "unit": "GiB",
      "used": 0
    }
  },
  "period": {
    "end": "2026-06-09T00:00:00Z",
    "start": "2026-06-09T00:00:00Z"
  }
}

object

errorobjectrequired

Show child attributes

codestringrequired

hintstring

messagestringrequired

Example response

{
  "error": {
    "code": "string",
    "hint": "string",
    "message": "string"
  }
}

object

errorobjectrequired

Show child attributes

codestringrequired

hintstring

messagestringrequired

Example response

{
  "error": {
    "code": "string",
    "hint": "string",
    "message": "string"
  }
}

object

errorobjectrequired

Show child attributes

codestringrequired

hintstring

messagestringrequired

Example response

{
  "error": {
    "code": "string",
    "hint": "string",
    "message": "string"
  }
}

object

errorobjectrequired

Show child attributes

codestringrequired

hintstring

messagestringrequired

Example response

{
  "error": {
    "code": "string",
    "hint": "string",
    "message": "string"
  }
}

Headers

Retry-After

Seconds to wait before retrying the request

minimum 1

object

errorobjectrequired

Show child attributes

codestringrequired

hintstring

messagestringrequired

Example response

{
  "error": {
    "code": "string",
    "hint": "string",
    "message": "string"
  }
}

Examples

databaseIdrequiredpath parameter

startDatequery parameter

endDatequery parameter

curl -X GET 'https://api.prisma.io/v1/databases/string/usage?endDate=2026-06-09T00%3A00%3A00Z&startDate=2026-06-09T00%3A00%3A00Z'

const response = await fetch('https://api.prisma.io/v1/databases/string/usage?endDate=2026-06-09T00%3A00%3A00Z&startDate=2026-06-09T00%3A00%3A00Z', { method: 'GET' });
const data = await response.json();

const response = await fetch('https://api.prisma.io/v1/databases/string/usage?endDate=2026-06-09T00%3A00%3A00Z&startDate=2026-06-09T00%3A00%3A00Z', { method: 'GET' });
console.log(await response.json());

import requests

response = requests.request("GET", "https://api.prisma.io/v1/databases/string/usage?endDate=2026-06-09T00%3A00%3A00Z&startDate=2026-06-09T00%3A00%3A00Z")
print(response.json())

package main

import (
	"context"
	"net/http"
)

func main() {
	ctx := context.Background()
	req, err := http.NewRequestWithContext(ctx, "GET", "https://api.prisma.io/v1/databases/string/usage?endDate=2026-06-09T00%3A00%3A00Z&startDate=2026-06-09T00%3A00%3A00Z", nil)
	if err != nil {
		panic(err)
	}
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
}

<?php
$request = curl_init("https://api.prisma.io/v1/databases/string/usage?endDate=2026-06-09T00%3A00%3A00Z&startDate=2026-06-09T00%3A00%3A00Z");
curl_setopt($request, CURLOPT_CUSTOMREQUEST, "GET");
$response = curl_exec($request);
curl_close($request);

var request = HttpRequest.newBuilder(URI.create("https://api.prisma.io/v1/databases/string/usage?endDate=2026-06-09T00%3A00%3A00Z&startDate=2026-06-09T00%3A00%3A00Z"))
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();
var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());

require 'net/http'

uri = URI("https://api.prisma.io/v1/databases/string/usage?endDate=2026-06-09T00%3A00%3A00Z&startDate=2026-06-09T00%3A00%3A00Z")
request = Net::HTTPGenericRequest.new("GET", false, true, uri)
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Get, "https://api.prisma.io/v1/databases/string/usage?endDate=2026-06-09T00%3A00%3A00Z&startDate=2026-06-09T00%3A00%3A00Z");
using var response = await client.SendAsync(request);

{
  "generatedAt": "2026-06-09T00:00:00Z",
  "metrics": {
    "operations": {
      "unit": "ops",
      "used": 0
    },
    "storage": {
      "unit": "GiB",
      "used": 0
    }
  },
  "period": {
    "end": "2026-06-09T00:00:00Z",
    "start": "2026-06-09T00:00:00Z"
  }
}

{
  "error": {
    "code": "string",
    "hint": "string",
    "message": "string"
  }
}

{
  "error": {
    "code": "string",
    "hint": "string",
    "message": "string"
  }
}

{
  "error": {
    "code": "string",
    "hint": "string",
    "message": "string"
  }
}

{
  "error": {
    "code": "string",
    "hint": "string",
    "message": "string"
  }
}

{
  "error": {
    "code": "string",
    "hint": "string",
    "message": "string"
  }
}

Search documentation

Projects

Databases

Databases Connections

Database Backups

Database Usage

Connections

Integrations

Service Tokens

Workspaces

Regions

Misc

[Experimental]

Agents

Buckets

Parameters

Responses

Headers

Projects

Databases

Databases Connections

Database Backups

Database Usage

Connections

Integrations

Service Tokens

Workspaces

Regions

Misc

[Experimental]

Agents

Buckets