Usage report
curl --request GET \
--url https://ybhqmgyprapjxomdxifs.supabase.co/functions/v1/api/v1/usage \
--header 'x-api-key: <api-key>'import requests
url = "https://ybhqmgyprapjxomdxifs.supabase.co/functions/v1/api/v1/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://ybhqmgyprapjxomdxifs.supabase.co/functions/v1/api/v1/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://ybhqmgyprapjxomdxifs.supabase.co/functions/v1/api/v1/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://ybhqmgyprapjxomdxifs.supabase.co/functions/v1/api/v1/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://ybhqmgyprapjxomdxifs.supabase.co/functions/v1/api/v1/usage")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://ybhqmgyprapjxomdxifs.supabase.co/functions/v1/api/v1/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{
"object": "usage_report",
"period": {
"from": "<string>",
"to": "<string>"
},
"data": [
{
"brand_id": "<string>",
"brand_name": "<string>",
"images": 123,
"image_credits": 123,
"videos": 123,
"video_credits": 123
}
],
"totals": {
"images": 123,
"videos": 123,
"credits": 123
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}API Reference
Usage report
Agency (white-label) keys get usage broken down per client brand — images, videos, and credits — for invoicing. Personal keys get their own totals. Defaults to the current calendar month.
GET
/
v1
/
usage
Usage report
curl --request GET \
--url https://ybhqmgyprapjxomdxifs.supabase.co/functions/v1/api/v1/usage \
--header 'x-api-key: <api-key>'import requests
url = "https://ybhqmgyprapjxomdxifs.supabase.co/functions/v1/api/v1/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://ybhqmgyprapjxomdxifs.supabase.co/functions/v1/api/v1/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://ybhqmgyprapjxomdxifs.supabase.co/functions/v1/api/v1/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://ybhqmgyprapjxomdxifs.supabase.co/functions/v1/api/v1/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://ybhqmgyprapjxomdxifs.supabase.co/functions/v1/api/v1/usage")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://ybhqmgyprapjxomdxifs.supabase.co/functions/v1/api/v1/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{
"object": "usage_report",
"period": {
"from": "<string>",
"to": "<string>"
},
"data": [
{
"brand_id": "<string>",
"brand_name": "<string>",
"images": 123,
"image_credits": 123,
"videos": 123,
"video_credits": 123
}
],
"totals": {
"images": 123,
"videos": 123,
"credits": 123
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}Authorizations
ApiKeyAuthBearerAuth
Query Parameters
Period start (ISO 8601). Defaults to the start of the current month.
Period end (ISO 8601). Defaults to now.
Filter to one client brand id (agency keys only).
⌘I