GET

api

public

metrics

overview

KPIs da empresa

curl --request GET \
  --url https://api.indiqai.com/api/v1/public/metrics/overview \
  --header 'X-API-Key: <x-api-key>'

import requests

url = "https://api.indiqai.com/api/v1/public/metrics/overview"

headers = {"X-API-Key": "<x-api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'X-API-Key': '<x-api-key>'}};

fetch('https://api.indiqai.com/api/v1/public/metrics/overview', 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.indiqai.com/api/v1/public/metrics/overview",
  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: <x-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.indiqai.com/api/v1/public/metrics/overview"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<x-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.indiqai.com/api/v1/public/metrics/overview")
  .header("X-API-Key", "<x-api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.indiqai.com/api/v1/public/metrics/overview")

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

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<x-api-key>'

response = http.request(request)
puts response.read_body

{
  "total_clients": 342,
  "active_clients_30d": 128,
  "total_points_distributed": 85200,
  "total_points_redeemed": 42600,
  "total_coupons_generated": 215,
  "total_coupons_used": 189,
  "total_loyalty_cards": 156,
  "completed_loyalty_cards": 47,
  "total_referrals": 89,
  "period": "all_time",
  "generated_at": "2026-03-20T12:00:00Z"
}

{
  "detail": "API Key inválida ou não fornecida"
}

Visão Geral de Métricas

Retorna KPIs resumidos da operação de fidelização da empresa, incluindo clientes, pontos, cupons e cartões.

Request

curl -X GET "https://api.indiqai.com/api/v1/public/metrics/overview" \
  -H "X-API-Key: indiqai_sua_chave_aqui"

const response = await fetch('https://api.indiqai.com/api/v1/public/metrics/overview', {
  headers: { 'X-API-Key': 'indiqai_sua_chave_aqui' }
});

const data = await response.json();

import httpx

response = httpx.get(
    'https://api.indiqai.com/api/v1/public/metrics/overview',
    headers={'X-API-Key': 'indiqai_sua_chave_aqui'}
)

data = response.json()

Response

{
  "total_clients": 342,
  "active_clients_30d": 128,
  "total_points_distributed": 85200,
  "total_points_redeemed": 42600,
  "total_coupons_generated": 215,
  "total_coupons_used": 189,
  "total_loyalty_cards": 156,
  "completed_loyalty_cards": 47,
  "total_referrals": 89,
  "period": "all_time",
  "generated_at": "2026-03-20T12:00:00Z"
}

{
  "detail": "API Key inválida ou não fornecida"
}

Campos da Resposta

integer

Total de clientes cadastrados

integer

Clientes com atividade nos últimos 30 dias

integer

Total de pontos distribuídos (histórico completo)

integer

Total de pontos resgatados

integer

Total de cupons gerados

integer

Total de cupons utilizados

integer

Total de cartões fidelidade criados

integer

Cartões fidelidade completados

integer

Total de indicações registradas

string

Período das métricas (atualmente all_time)

string

Timestamp de geração das métricas (ISO 8601)

Headers

X-API-Key

string

required

Chave de API

Response

Successful Response

KPIs resumidos da empresa.

active_clients

integer

default:0

total_clients

integer

default:0

total_coupons

integer

default:0

total_points_distributed

integer

default:0

total_rewards_claimed

integer

default:0

Listar RecompensasLista as recompensas disponíveis para resgate

KPIs da empresa

curl --request GET \
  --url https://api.indiqai.com/api/v1/public/metrics/overview \
  --header 'X-API-Key: <x-api-key>'

import requests

url = "https://api.indiqai.com/api/v1/public/metrics/overview"

headers = {"X-API-Key": "<x-api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'X-API-Key': '<x-api-key>'}};

fetch('https://api.indiqai.com/api/v1/public/metrics/overview', 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.indiqai.com/api/v1/public/metrics/overview",
  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: <x-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.indiqai.com/api/v1/public/metrics/overview"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<x-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.indiqai.com/api/v1/public/metrics/overview")
  .header("X-API-Key", "<x-api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.indiqai.com/api/v1/public/metrics/overview")

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

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<x-api-key>'

response = http.request(request)
puts response.read_body

{
  "total_clients": 342,
  "active_clients_30d": 128,
  "total_points_distributed": 85200,
  "total_points_redeemed": 42600,
  "total_coupons_generated": 215,
  "total_coupons_used": 189,
  "total_loyalty_cards": 156,
  "completed_loyalty_cards": 47,
  "total_referrals": 89,
  "period": "all_time",
  "generated_at": "2026-03-20T12:00:00Z"
}

{
  "detail": "API Key inválida ou não fornecida"
}

Comece aqui

Clientes

Cupons

Produtos

Cartões Fidelidade

Indicações

Quests Públicas

NFC-e

Email

Pontos

Métricas

Prêmios

Visão Geral de Métricas

Visão Geral de Métricas

Request

Response

Campos da Resposta

Headers

Response

​Visão Geral de Métricas

​Request

​Response

​Campos da Resposta

Headers

Response

Visão Geral de Métricas

Request

Response

Campos da Resposta