Consultar resumo do dashboard
curl --request GET \
--url https://api.ephra.io/v1/dashboard/summary \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.ephra.io/v1/dashboard/summary"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.ephra.io/v1/dashboard/summary', 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.ephra.io/v1/dashboard/summary",
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.ephra.io/v1/dashboard/summary"
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.ephra.io/v1/dashboard/summary")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ephra.io/v1/dashboard/summary")
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{
"success": true,
"data": {
"grossAmount": 4871200,
"netAmount": 4602140,
"transactionsCount": 214,
"paidTransactions": 97,
"paidToday": 6,
"averageTicket": 47444.74,
"refundsCount": 3,
"refundedAmount": 149700,
"approvalRate": 45.33,
"refundRate": 3.09,
"lastHourNetAmount": 94810,
"approvalRateByMethod": {
"pix": 61.2,
"creditCard": 38.7,
"boleto": 22.5
},
"salesShareByMethod": {
"pix": {
"percentage": 58.8,
"count": 57
},
"creditCard": {
"percentage": 37.1,
"count": 36
},
"boleto": {
"percentage": 4.1,
"count": 4
}
}
}
}{
"success": false,
"message": "Token inválido ou expirado"
}{
"success": false,
"message": "name: Nome é obrigatório"
}{
"success": false,
"message": "Muitas requisições. Tente novamente em breve."
}{
"success": false,
"message": "Erro interno do servidor"
}Crescimento
Consultar resumo do dashboard
Devolve os indicadores do período para a empresa autenticada: faturamento bruto e líquido, vendas aprovadas, ticket médio, taxa de aprovação e de reembolso, e como as vendas se dividiram entre Pix, cartão e boleto. É a leitura que abre o painel e a barra de métricas de Vendas. Sem período, considera o mês corrente.
GET
/
v1
/
dashboard
/
summary
Consultar resumo do dashboard
curl --request GET \
--url https://api.ephra.io/v1/dashboard/summary \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.ephra.io/v1/dashboard/summary"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.ephra.io/v1/dashboard/summary', 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.ephra.io/v1/dashboard/summary",
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.ephra.io/v1/dashboard/summary"
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.ephra.io/v1/dashboard/summary")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ephra.io/v1/dashboard/summary")
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{
"success": true,
"data": {
"grossAmount": 4871200,
"netAmount": 4602140,
"transactionsCount": 214,
"paidTransactions": 97,
"paidToday": 6,
"averageTicket": 47444.74,
"refundsCount": 3,
"refundedAmount": 149700,
"approvalRate": 45.33,
"refundRate": 3.09,
"lastHourNetAmount": 94810,
"approvalRateByMethod": {
"pix": 61.2,
"creditCard": 38.7,
"boleto": 22.5
},
"salesShareByMethod": {
"pix": {
"percentage": 58.8,
"count": 57
},
"creditCard": {
"percentage": 37.1,
"count": 36
},
"boleto": {
"percentage": 4.1,
"count": 4
}
}
}
}{
"success": false,
"message": "Token inválido ou expirado"
}{
"success": false,
"message": "name: Nome é obrigatório"
}{
"success": false,
"message": "Muitas requisições. Tente novamente em breve."
}{
"success": false,
"message": "Erro interno do servidor"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
Início do período, em ISO 8601. Sem from e to, o painel considera o mês corrente.
Fim do período, em ISO 8601.
⌘I
