Forecast the month's usage against the spend cap

GET /v1/analytics/forecast

Forecasts the current UTC month's live usage (1.57.0): month to date plus, per remaining day, the mean of the same weekday over the last four weeks, banded by their lowest and highest, against the Organization's spend cap, with every input. The platform fee is a separate line and not included. The prepaid balance and its date of exhaustion are P2.

Request

Set VOCAL_API to the base URL of your API and VOCAL_API_KEY to an API key with the usage:read scope (Authentication and keys). Replace each placeholder, such as agt_... or <name>, with your own value.

curl "$VOCAL_API/v1/analytics/forecast" \
  -H "Authorization: Bearer $VOCAL_API_KEY"

const response = await fetch(`${process.env.VOCAL_API}/v1/analytics/forecast`, {
  headers: {
    Authorization: `Bearer ${process.env.VOCAL_API_KEY}`,
  },
});
console.log(response.status, await response.text());

import os

import requests

response = requests.get(
    f"{os.environ['VOCAL_API']}/v1/analytics/forecast",
    headers={
        "Authorization": f"Bearer {os.environ['VOCAL_API_KEY']}",
    },
)
print(response.status_code, response.text)

Responses

Fields of the 200 answer

The shape is Forecast.