curl --request GET \
--url https://api.bevits.com/v1/purchases/stats \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.bevits.com/v1/purchases/stats"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.bevits.com/v1/purchases/stats', 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.bevits.com/v1/purchases/stats",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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.bevits.com/v1/purchases/stats"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
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.bevits.com/v1/purchases/stats")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.bevits.com/v1/purchases/stats")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"object": "purchase_stats",
"purchase_count": 1,
"customer_count": 1,
"revenue_in_cents": 123,
"average_ticket_in_cents": 123,
"currency": "BRL",
"mixed_currencies": true,
"group_by": "<string>",
"groups": [
{
"key": "<string>",
"purchase_count": 1,
"revenue_in_cents": 123,
"average_ticket_in_cents": 123
}
],
"groups_truncated": true
}{
"error": {
"type": "authentication_error",
"message": "Invalid API key.",
"request_id": "req_07f6cdc3c20249d6afcd90b4"
}
}{
"error": {
"type": "validation_error",
"message": "Invalid query parameters.",
"param": "limit",
"request_id": "req_07f6cdc3c20249d6afcd90b4"
}
}{
"error": {
"type": "authentication_error",
"message": "<string>",
"request_id": "<string>",
"param": "<string>"
},
"retry_after": 2
}{
"error": {
"type": "authentication_error",
"message": "<string>",
"request_id": "<string>",
"param": "<string>"
}
}Agregar compras
Soma pedidos, receita, ticket médio e clientes únicos com os mesmos filtros da listagem, com ranking opcional por dimensão, inclusive UTM.
curl --request GET \
--url https://api.bevits.com/v1/purchases/stats \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.bevits.com/v1/purchases/stats"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.bevits.com/v1/purchases/stats', 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.bevits.com/v1/purchases/stats",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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.bevits.com/v1/purchases/stats"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
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.bevits.com/v1/purchases/stats")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.bevits.com/v1/purchases/stats")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"object": "purchase_stats",
"purchase_count": 1,
"customer_count": 1,
"revenue_in_cents": 123,
"average_ticket_in_cents": 123,
"currency": "BRL",
"mixed_currencies": true,
"group_by": "<string>",
"groups": [
{
"key": "<string>",
"purchase_count": 1,
"revenue_in_cents": 123,
"average_ticket_in_cents": 123
}
],
"groups_truncated": true
}{
"error": {
"type": "authentication_error",
"message": "Invalid API key.",
"request_id": "req_07f6cdc3c20249d6afcd90b4"
}
}{
"error": {
"type": "validation_error",
"message": "Invalid query parameters.",
"param": "limit",
"request_id": "req_07f6cdc3c20249d6afcd90b4"
}
}{
"error": {
"type": "authentication_error",
"message": "<string>",
"request_id": "<string>",
"param": "<string>"
},
"retry_after": 2
}{
"error": {
"type": "authentication_error",
"message": "<string>",
"request_id": "<string>",
"param": "<string>"
}
}Autorizações
API key criada nas configurações da organização.
Parâmetros de consulta
Filtra compras por cliente.
^cus_[A-Za-z0-9_-]+$Filtra pelo estado financeiro da compra.
any, pending, authorized, paid, abandoned, refunded, voided Filtra pela plataforma de origem.
nuvemshop, shopify, woocommerce, bling, instagram, popup Inclui itens criados a partir deste instante, inclusive.
Inclui itens criados até este instante, inclusive.
Valor mínimo da compra em centavos.
x >= 0Valor máximo da compra em centavos.
x >= 0Filtra pelo utm_source do pedido.
256Filtra pelo utm_medium do pedido.
256Filtra pelo utm_campaign do pedido.
256Filtra pelo utm_content do pedido.
256Filtra pelo utm_term do pedido.
256Agrupa o resultado por uma dimensão e devolve o ranking dela.
status, platform, currency, day, utm_source, utm_medium, utm_campaign, utm_content, utm_term Quantidade máxima de grupos retornados.
1 <= x <= 50Resposta
Métricas agregadas de compras.
"purchase_stats"x >= 0x >= 0"BRL"
Show child attributes
Show child attributes