Skip to content

Listar diagnósticos do estabelecimento

Retorna, de forma paginada, os diagnósticos do estabelecimento criados para realização de análises retroativas de recorrência — incluindo os criados pelo painel administrativo.

Sobre o diagnóstico

O envio de compras em um diagnóstico não irá gerar pontos no programa de fidelidade. O objetivo de cada diagnóstico é apenas analítico.

bash
curl --location --request GET 'https://sandbox.fidelizii.com.br/api/v4/estabelecimentos/3954/diagnosticos' \
--header 'app-token: {{app-token}}' \
--header 'access-token: {{access-token}}' \
--header 'Accept: application/json'

Este endpoint poderá contemplar os seguintes parâmetros GET:

ParâmetroDescriçãoExemplo
searchFiltra pelo título do diagnóstico (busca parcial)Rede
statusFiltra por status. Valores aceitos: rascunho, na-fila, processando, erro, aguardando-autorizacao, concluidoconcluido
archivedFiltro de exclusão. true retorna apenas excluídos, false (padrão) apenas ativos, all retorna todosfalse
per_pageQuantidade de itens por página (padrão 15)15

No retorno deverá conter:

json
{
    "success": true,
    "message": "Diagnósticos retornados com sucesso.",
    "data": {
        "current_page": 1,
        "data": [
            {
                "id_diagnostico": 171,
                "id_parceiro": 3954,
                "id_categoria": 1,
                "titulo": "Rede - teste de processamento de arquivo",
                "periodo_analisado": {
                    "fim": "2024-04-29",
                    "inicio": "2024-03-01"
                },
                "metadados": null,
                "metricas_gerais": {
                    "faturamento": "88891,04",
                    "total_compras": "4231",
                    "total_clientes": 2641,
                    "periodo_existente": {
                        "data_ultima_compra": "2024-04-29 00:00:00",
                        "data_primeira_compra": "2024-03-01 00:00:00"
                    }
                },
                "tags": [],
                "status": "concluido",
                "criado_em": "2026-04-06 15:56:59",
                "atualizado_em": "2026-07-11 12:15:04",
                "deletado_em": null,
                "total_erros": 0,
                "arquivos_com_erro": 0,
                "adquirentes_identificadas": ["rede"],
                "arquivos": [
                    { "id": 560, "nome": "cc85654772_rede_vendas_1.xlsx" }
                ],
                "categoria": {
                    "id_categoria": 1,
                    "nome": "Alimentação",
                    "slug": "alimentacao",
                    "categoria_pai": null,
                    "nivel": null
                }
            }
        ],
        "first_page_url": "https://sandbox.fidelizii.com.br/api/v4/estabelecimentos/3954/diagnosticos?page=1",
        "from": 1,
        "last_page": 1,
        "last_page_url": "https://sandbox.fidelizii.com.br/api/v4/estabelecimentos/3954/diagnosticos?page=1",
        "next_page_url": null,
        "per_page": 15,
        "prev_page_url": null,
        "to": 5,
        "total": 5
    }
}