Get account usage

Try in Playground

Return daily UTC request and error totals by platform for the authenticated account. Choose a period with days. Accepts a customer API key or first-party dashboard session.

GET/v1/usagex-api-key

Headers

Get your API key

x-api-keystringrequiredheader

Your ScrapeAtlas customer key. Create one on /account/ and set SCRAPEATLAS_API_KEY.

Query parameters

daysintegerdefault: 30query

Number of UTC calendar days including today, 1–30.

default: 30 · 1 – 30

Example7

Response fields

successboolean

True when analytics were queried successfully.

statusstring

partial when usable counts are available. A sink or authentication outage is a failure, not an empty success.

requestIdstring

Gateway request correlation UUID.

Reports best_effort_usage and ingestion_delay.

coverage.completeboolean

Always included.

coverage.warningsstring[]

Always included.

days and rows of day, platform, requests, errors and duration_ms_sum.

data.daysinteger

Always included.

1 – 30

Always included.

up to 2048 items

data.rows.daystring

Always included.

data.rows.platformstring

Always included.

data.rows.requestsinteger

Always included.

-9007199254740991 – 9007199254740991

data.rows.errorsinteger

Always included.

-9007199254740991 – 9007199254740991

data.rows.duration_ms_sumnumber

Always included.

≥ 0

HTTP 200 returns the success variant. Check status: partial means usable data with warnings, and failed or challenged requests carry a failure object described in Errors & responses.

Error codes

HTTP	failure.code	Meaning
400	`invalid_request`	Invalid, duplicate or unknown parameter
401	`unauthorized`	Missing or invalid session/customer key
429	`busy`	Account analytics query limit
503	`busy`	Analytics or authentication unavailable, or global admission full

Code example

curl "https://api.scrapeatlas.com/v1/usage?days=7" \
  -H "x-api-key: YOUR_API_KEY"

const response = await fetch(
  "https://api.scrapeatlas.com/v1/usage?days=7",
  {
    headers: {
      "x-api-key": "YOUR_API_KEY"
    }
  }
);

const data = await response.json();
console.log(data.status, data);

type Result = {
  status: "success" | "partial" | "failed" | "challenged";
  requestId: string;
  [field: string]: unknown;
};

const response = await fetch(
  "https://api.scrapeatlas.com/v1/usage?days=7",
  {
    headers: {
      "x-api-key": process.env.SCRAPEATLAS_API_KEY!
    }
  }
);

const data = (await response.json()) as Result;
if (data.status === "failed" || data.status === "challenged") {
  throw new Error(`Account usage request failed: ${data.requestId}`);
}
console.log(data);

import requests

response = requests.get(
    "https://api.scrapeatlas.com/v1/usage",
    headers={"x-api-key": "YOUR_API_KEY"},
    params={
        "days": 7
    },
    timeout=60,
)
data = response.json()
print(data["status"], data)

package main

import (
	"encoding/json"
	"fmt"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.scrapeatlas.com/v1/usage?days=7", nil)
	req.Header.Set("x-api-key", "YOUR_API_KEY")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()

	var data map[string]interface{}
	json.NewDecoder(resp.Body).Decode(&data)
	fmt.Println(data["status"], data)
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Main {
    public static void main(String[] args) throws Exception {
        var client = HttpClient.newHttpClient();
        var request = HttpRequest.newBuilder()
            .uri(URI.create("https://api.scrapeatlas.com/v1/usage?days=7"))
            .GET()
            .header("x-api-key", "YOUR_API_KEY")
            .build();
        var response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.body());
    }
}

Use your sa_live_… customer key at https://api.scrapeatlas.com.

Responses

Successful result. Synthetic example validated against the runtime contract.

{
  "success": true,
  "status": "partial",
  "requestId": "00000000-0000-4000-8000-000000000001",
  "coverage": {
    "complete": false,
    "warnings": [
      "best_effort_usage",
      "ingestion_delay"
    ]
  },
  "data": {
    "days": 7,
    "rows": [
      {
        "day": "2026-09-12",
        "platform": "telegram",
        "requests": 2,
        "errors": 1,
        "duration_ms_sum": 60
      }
    ]
  }
}

Invalid, duplicate or unknown parameter

{}

Gateway failure example. Worker failures preserve their own response fields; respect retry-after when present.

{
  "success": false,
  "status": "failed",
  "requestId": "33333333-3333-4333-8333-333333333333",
  "failure": {
    "code": "unauthorized",
    "message": "Missing or invalid customer key."
  }
}

Gateway failure example. Worker failures preserve their own response fields; respect retry-after when present.

{
  "success": false,
  "status": "failed",
  "requestId": "33333333-3333-4333-8333-333333333333",
  "failure": {
    "code": "upstream_rate_limited",
    "message": "Account or upstream rate limit reached. Respect retry-after."
  }
}

Gateway failure example. Worker failures preserve their own response fields; respect retry-after when present.

{
  "success": false,
  "status": "failed",
  "requestId": "33333333-3333-4333-8333-333333333333",
  "failure": {
    "code": "busy",
    "message": "Authentication, gateway capacity or the requested platform is unavailable."
  }
}

Get account usage

Headers

Your privacy, your choice

Credit the developer who referred you