Skip to main content
POST
/
v1
/
analytics
/
usage
/
forecast
forecast usage
curl --request POST \
  --url https://api.unprice.dev/v1/analytics/usage/forecast \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "customer_id": "<string>",
  "feature_slug": "<string>",
  "period_key": "<string>",
  "horizon_days": 14
}
'
import requests

url = "https://api.unprice.dev/v1/analytics/usage/forecast"

payload = {
"customer_id": "<string>",
"feature_slug": "<string>",
"period_key": "<string>",
"horizon_days": 14
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
customer_id: '<string>',
feature_slug: '<string>',
period_key: '<string>',
horizon_days: 14
})
};

fetch('https://api.unprice.dev/v1/analytics/usage/forecast', 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.unprice.dev/v1/analytics/usage/forecast",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'customer_id' => '<string>',
'feature_slug' => '<string>',
'period_key' => '<string>',
'horizon_days' => 14
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.unprice.dev/v1/analytics/usage/forecast"

payload := strings.NewReader("{\n \"customer_id\": \"<string>\",\n \"feature_slug\": \"<string>\",\n \"period_key\": \"<string>\",\n \"horizon_days\": 14\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")

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

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

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.unprice.dev/v1/analytics/usage/forecast")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"customer_id\": \"<string>\",\n \"feature_slug\": \"<string>\",\n \"period_key\": \"<string>\",\n \"horizon_days\": 14\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.unprice.dev/v1/analytics/usage/forecast")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"customer_id\": \"<string>\",\n \"feature_slug\": \"<string>\",\n \"period_key\": \"<string>\",\n \"horizon_days\": 14\n}"

response = http.request(request)
puts response.read_body
{
  "answer": "<string>",
  "freshness": {
    "generatedAt": 123,
    "dataFrom": 123,
    "dataTo": 123
  },
  "evidence": [
    {
      "id": "<string>",
      "timestamp": 123
    }
  ],
  "warnings": [
    "<string>"
  ],
  "nextActions": [
    "<string>"
  ],
  "project_id": "<string>",
  "customer_id": "<string>",
  "feature_slug": "<string>",
  "horizonDays": 123,
  "projectedUsage": 123,
  "observedDays": 123,
  "baselineUsage": 123,
  "trendPerDay": 123,
  "periodKey": "<string>"
}
{
"error": {
"code": "BAD_REQUEST",
"docs": "https://docs.unprice.dev/api-reference/errors/code/BAD_REQUEST",
"message": "<string>",
"requestId": "req_1234"
}
}
{
"error": {
"code": "UNAUTHORIZED",
"docs": "https://docs.unprice.dev/api-reference/errors/code/UNAUTHORIZED",
"message": "<string>",
"requestId": "req_1234"
}
}
{
"error": {
"code": "FORBIDDEN",
"docs": "https://docs.unprice.dev/api-reference/errors/code/FORBIDDEN",
"message": "<string>",
"requestId": "req_1234"
}
}
{
"error": {
"code": "NOT_FOUND",
"docs": "https://docs.unprice.dev/api-reference/errors/code/NOT_FOUND",
"message": "<string>",
"requestId": "req_1234"
}
}
{
"error": {
"code": "CONFLICT",
"docs": "https://docs.unprice.dev/api-reference/errors/code/CONFLICT",
"message": "<string>",
"requestId": "req_1234"
}
}
{
"error": {
"code": "PRECONDITION_FAILED",
"docs": "https://docs.unprice.dev/api-reference/errors/code/PRECONDITION_FAILED",
"message": "<string>",
"requestId": "req_1234"
}
}
{
"error": {
"code": "TOO_MANY_REQUESTS",
"docs": "https://docs.unprice.dev/api-reference/errors/code/TOO_MANY_REQUESTS",
"message": "<string>",
"requestId": "req_1234"
}
}
{
"error": {
"code": "INTERNAL_SERVER_ERROR",
"docs": "https://docs.unprice.dev/api-reference/errors/code/INTERNAL_SERVER_ERROR",
"message": "<string>",
"requestId": "req_1234"
}
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Forecast usage request

customer_id
string
required
feature_slug
string
required
period_key
string
horizon_days
integer
default:14
Required range: 1 <= x <= 31

Response

Forecast usage response

answer
string
required
confidence
enum<string>
required
Available options:
high,
medium,
low
freshness
object
required
evidence
object[]
required
warnings
string[]
required
nextActions
string[]
required
project_id
string
required
customer_id
string
required
feature_slug
string
required
horizonDays
integer
required
projectedUsage
number
required
observedDays
integer
required
baselineUsage
number
required
trendPerDay
number
required
periodKey
string