Get Workspace Tenant Usage
curl --request GET \
--url https://prod.dataapi.papermap.ai/api/v1/external/workspaces/{workspace_id}/tenant-usage \
--header 'X-API-Key-ID: <x-api-key-id>' \
--header 'X-Signature: <x-signature>' \
--header 'X-Valid-Until: <x-valid-until>' \
--header 'X-Workspace-ID: <x-workspace-id>'import requests
url = "https://prod.dataapi.papermap.ai/api/v1/external/workspaces/{workspace_id}/tenant-usage"
headers = {
"X-API-Key-ID": "<x-api-key-id>",
"X-Workspace-ID": "<x-workspace-id>",
"X-Valid-Until": "<x-valid-until>",
"X-Signature": "<x-signature>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {
'X-API-Key-ID': '<x-api-key-id>',
'X-Workspace-ID': '<x-workspace-id>',
'X-Valid-Until': '<x-valid-until>',
'X-Signature': '<x-signature>'
}
};
fetch('https://prod.dataapi.papermap.ai/api/v1/external/workspaces/{workspace_id}/tenant-usage', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://prod.dataapi.papermap.ai/api/v1/external/workspaces/{workspace_id}/tenant-usage",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Key-ID: <x-api-key-id>",
"X-Signature: <x-signature>",
"X-Valid-Until: <x-valid-until>",
"X-Workspace-ID: <x-workspace-id>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://prod.dataapi.papermap.ai/api/v1/external/workspaces/{workspace_id}/tenant-usage"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key-ID", "<x-api-key-id>")
req.Header.Add("X-Workspace-ID", "<x-workspace-id>")
req.Header.Add("X-Valid-Until", "<x-valid-until>")
req.Header.Add("X-Signature", "<x-signature>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://prod.dataapi.papermap.ai/api/v1/external/workspaces/{workspace_id}/tenant-usage")
.header("X-API-Key-ID", "<x-api-key-id>")
.header("X-Workspace-ID", "<x-workspace-id>")
.header("X-Valid-Until", "<x-valid-until>")
.header("X-Signature", "<x-signature>")
.asString();require 'uri'
require 'net/http'
url = URI("https://prod.dataapi.papermap.ai/api/v1/external/workspaces/{workspace_id}/tenant-usage")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key-ID"] = '<x-api-key-id>'
request["X-Workspace-ID"] = '<x-workspace-id>'
request["X-Valid-Until"] = '<x-valid-until>'
request["X-Signature"] = '<x-signature>'
response = http.request(request)
puts response.read_body{
"message": "<string>",
"success": true,
"data": {
"workspace_id": "<string>",
"usage": [
{
"tenant_id": "<string>",
"period": "<string>",
"period_start": "2023-11-07T05:31:56Z",
"period_end": "2023-11-07T05:31:56Z",
"credits_used": 123,
"request_count": 123
}
],
"total_records": 123,
"total_pages": 123
}
}{
"message": "<string>",
"success": false,
"data": null
}{
"message": "<string>",
"success": false,
"data": null
}{
"message": "<string>",
"success": false,
"data": null
}Tenant Usage
Get Workspace Tenant Usage
Retrieve usage data for all tenants in a workspace
GET
/
api
/
v1
/
external
/
workspaces
/
{workspace_id}
/
tenant-usage
Get Workspace Tenant Usage
curl --request GET \
--url https://prod.dataapi.papermap.ai/api/v1/external/workspaces/{workspace_id}/tenant-usage \
--header 'X-API-Key-ID: <x-api-key-id>' \
--header 'X-Signature: <x-signature>' \
--header 'X-Valid-Until: <x-valid-until>' \
--header 'X-Workspace-ID: <x-workspace-id>'import requests
url = "https://prod.dataapi.papermap.ai/api/v1/external/workspaces/{workspace_id}/tenant-usage"
headers = {
"X-API-Key-ID": "<x-api-key-id>",
"X-Workspace-ID": "<x-workspace-id>",
"X-Valid-Until": "<x-valid-until>",
"X-Signature": "<x-signature>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {
'X-API-Key-ID': '<x-api-key-id>',
'X-Workspace-ID': '<x-workspace-id>',
'X-Valid-Until': '<x-valid-until>',
'X-Signature': '<x-signature>'
}
};
fetch('https://prod.dataapi.papermap.ai/api/v1/external/workspaces/{workspace_id}/tenant-usage', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://prod.dataapi.papermap.ai/api/v1/external/workspaces/{workspace_id}/tenant-usage",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Key-ID: <x-api-key-id>",
"X-Signature: <x-signature>",
"X-Valid-Until: <x-valid-until>",
"X-Workspace-ID: <x-workspace-id>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://prod.dataapi.papermap.ai/api/v1/external/workspaces/{workspace_id}/tenant-usage"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key-ID", "<x-api-key-id>")
req.Header.Add("X-Workspace-ID", "<x-workspace-id>")
req.Header.Add("X-Valid-Until", "<x-valid-until>")
req.Header.Add("X-Signature", "<x-signature>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://prod.dataapi.papermap.ai/api/v1/external/workspaces/{workspace_id}/tenant-usage")
.header("X-API-Key-ID", "<x-api-key-id>")
.header("X-Workspace-ID", "<x-workspace-id>")
.header("X-Valid-Until", "<x-valid-until>")
.header("X-Signature", "<x-signature>")
.asString();require 'uri'
require 'net/http'
url = URI("https://prod.dataapi.papermap.ai/api/v1/external/workspaces/{workspace_id}/tenant-usage")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key-ID"] = '<x-api-key-id>'
request["X-Workspace-ID"] = '<x-workspace-id>'
request["X-Valid-Until"] = '<x-valid-until>'
request["X-Signature"] = '<x-signature>'
response = http.request(request)
puts response.read_body{
"message": "<string>",
"success": true,
"data": {
"workspace_id": "<string>",
"usage": [
{
"tenant_id": "<string>",
"period": "<string>",
"period_start": "2023-11-07T05:31:56Z",
"period_end": "2023-11-07T05:31:56Z",
"credits_used": 123,
"request_count": 123
}
],
"total_records": 123,
"total_pages": 123
}
}{
"message": "<string>",
"success": false,
"data": null
}{
"message": "<string>",
"success": false,
"data": null
}{
"message": "<string>",
"success": false,
"data": null
}Headers
API Key Identifier
Workspace Identifier
Validity timestamp for the request
HMAC-SHA256 signature for authentication
Path Parameters
The workspace ID
Query Parameters
Start period filter (YYYY-MM format)
Pattern:
^\d{4}-\d{2}$End period filter (YYYY-MM format)
Pattern:
^\d{4}-\d{2}$Page number
Required range:
x >= 1Items per page
Required range:
1 <= x <= 100Was this page helpful?
⌘I

