Get the consumption breakdown over a date range
curl --request GET \
--url https://api.starleads.co/Consumption/breakdown \
--header 'X-Api-Key: <api-key>'import requests
url = "https://api.starleads.co/Consumption/breakdown"
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.starleads.co/Consumption/breakdown', 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.starleads.co/Consumption/breakdown",
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.starleads.co/Consumption/breakdown"
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.starleads.co/Consumption/breakdown")
.header("X-Api-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.starleads.co/Consumption/breakdown")
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{
"periodFrom": "2023-11-07T05:31:56Z",
"periodTo": "2023-11-07T05:31:56Z",
"totalCredits": 123,
"byChannel": [
{
"channel": "<string>",
"credits": 123
}
],
"byMonth": [
{
"month": "<string>",
"credits": 123
}
],
"byAgent": [
{
"agentId": "<string>",
"nameStatus": "<string>",
"credits": 123,
"campaigns": [
{
"campaignId": "<string>",
"nameStatus": "<string>",
"credits": 123
}
]
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}Consumption
Get the consumption breakdown
Returns the credit consumption of the company owning the API key over the requested range, broken down by channel, month and agent (each agent with its own campaign breakdown). Each axis sums to the total. The range is mandatory, must be ordered and may not span more than 366 days.
GET
/
Consumption
/
breakdown
Get the consumption breakdown over a date range
curl --request GET \
--url https://api.starleads.co/Consumption/breakdown \
--header 'X-Api-Key: <api-key>'import requests
url = "https://api.starleads.co/Consumption/breakdown"
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.starleads.co/Consumption/breakdown', 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.starleads.co/Consumption/breakdown",
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.starleads.co/Consumption/breakdown"
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.starleads.co/Consumption/breakdown")
.header("X-Api-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.starleads.co/Consumption/breakdown")
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{
"periodFrom": "2023-11-07T05:31:56Z",
"periodTo": "2023-11-07T05:31:56Z",
"totalCredits": 123,
"byChannel": [
{
"channel": "<string>",
"credits": 123
}
],
"byMonth": [
{
"month": "<string>",
"credits": 123
}
],
"byAgent": [
{
"agentId": "<string>",
"nameStatus": "<string>",
"credits": 123,
"campaigns": [
{
"campaignId": "<string>",
"nameStatus": "<string>",
"credits": 123
}
]
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}Authorizations
Headers
API key for authentication
Query Parameters
Start of the consumption range (inclusive)
End of the consumption range (inclusive)
Response
Success
Credit consumption broken down by channel, month and agent over a date range
Start of the range the figures below cover (echoes the requested 'from')
End of the range the figures below cover (echoes the requested 'to')
Total credits consumed over the requested range. Each axis below sums to this value.
Consumption split by channel over the whole range
Show child attributes
Show child attributes
Consumption split by calendar month
Show child attributes
Show child attributes
Consumption split by agent, each with its own campaign breakdown
Show child attributes
Show child attributes