Skip to main content
GET
/
api
/
public
/
usage
Get daily usage data
curl --request GET \
  --url https://api.ropes.ai/api/public/usage \
  --header 'x-api-key: <api-key>'
import requests

url = "https://api.ropes.ai/api/public/usage"

headers = {"x-api-key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.ropes.ai/api/public/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://api.ropes.ai/api/public/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: <api-key>"
],
]);

$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://api.ropes.ai/api/public/usage"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("x-api-key", "<api-key>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.ropes.ai/api/public/usage")
.header("x-api-key", "<api-key>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.ropes.ai/api/public/usage")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body
{
  "usage": [
    {
      "date": "<string>",
      "assessmentCredits": 123,
      "videoScreeningCredits": 123
    }
  ],
  "pagination": {
    "page": 123,
    "pageSize": 123,
    "totalItems": 123,
    "totalPages": 123
  },
  "startDate": "<string>",
  "endDate": "<string>"
}
{
"error": "<string>",
"details": [
{}
]
}
{
"error": "<string>",
"details": [
{}
]
}
{
"error": "<string>",
"details": [
{}
]
}
{
"error": "<string>",
"details": [
{}
]
}

Authorizations

x-api-key
string
header
required

Query Parameters

startDate
string

Start date in YYYY-MM-DD format

endDate
string

End date in YYYY-MM-DD format

currentContract
enum<string>

If "true", automatically use the current contract date range

Available options:
true,
false
page
string
default:1

Page number (default: 1)

pageSize
string
default:100

Number of items per page (default: 100, max: 365)

timezone
string

IANA timezone for daily bucketing (e.g. "America/Los_Angeles"). Defaults to UTC.

Response

Successfully retrieved usage data

usage
object[]
required

Daily usage data

pagination
object
required

Pagination metadata

startDate
string
required

Start date of the queried range (YYYY-MM-DD)

endDate
string
required

End date of the queried range (YYYY-MM-DD)