Master URA MVNO - Autoatendimento (C)

{{HOST}}/service/v1/report/addon-rtp-0003 no formato POST, o uso do corpo (body) como filtro e o formato do JSON de resposta associado:

Endpoint: {{HOST}}/service/v1/report/addon-rtp-0003

Método: POST

Descrição: Este endpoint permite gerar um relatório específico do tipo "Master URA MVNO - Autoatendimento (C)" com base em filtros específicos de data, enviado por meio de uma solicitação POST. O objetivo é obter métricas e estatísticas relacionadas a pesquisas, ativações, notificações e encaminhamentos dentro de um período de tempo específico.

Corpo da Solicitação (JSON):

{
    "filters": [
        {
            "field": "dateStart",
            "selectedValue": "2023-05-01 00:00:00"
        },
        {
            "field": "dateEnd",
            "selectedValue": "2023-05-10 23:59:59"
        }
    ],
    "format": "json"
}

Resposta de Sucesso:

Código de Status: 200 (OK)

Corpo da Resposta (JSON):

        [
          [
              {
                  "search": 2,
                  "found": 0,
                  "activation_fail": 0,
                  "ticket_opened": 0,
                  "activated": 0,
                  "send_notification": 0,
                  "forward": 2,
                  "date": "2023-05-02"
              }
          ]
        ]

Campos da Resposta:

Campo da Resposta	Tipo	Descrição
`search`	Inteiro	O número de pesquisas registradas no período especificado.
`found`	Inteiro	O número de itens encontrados no período.
`activation_fail`	Inteiro	O número de falhas de ativação.
`ticket_opened`	Inteiro	O número de tickets abertos.
`activated`	Inteiro	O número de ativações bem-sucedidas.
`send_notification`	Inteiro	O número de notificações enviadas.
`forward`	Inteiro	O número de itens encaminhados.
`date`	String	A data para a qual o relatório foi gerado, no formato "AAAA-MM-DD".

Requisição

Parâmetros Header

Parâmetros Bodyapplication/json

Exemplo

{
    "filters": [
        {
            "field": "dateStart",
            "selectedValue": "2024-02-11 00:00:00"
        },
        {
            "field": "dateEnd",
            "selectedValue": "2024-02-22 23:59:59"
        }
    ],
    "format": "json"
}

Códigos de solicitação

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Respostas

🟢200Master URA 4.0 MVNO - Autoatendimento (C)

application/json

Body

Exemplo

[
    [
        {
            "search": 2,
            "found": 0,
            "activation_fail": 0,
            "ticket_opened": 0,
            "activated": 0,
            "send_notification": 0,
            "forward": 2,
            "date": "2023-05-02"
        },
        {
            "search": 2,
            "found": 0,
            "activation_fail": 0,
            "ticket_opened": 0,
            "activated": 0,
            "send_notification": 0,
            "forward": 2,
            "date": "2023-05-06"
        },
        {
            "search": 2,
            "found": 0,
            "activation_fail": 0,
            "ticket_opened": 0,
            "activated": 0,
            "send_notification": 0,
            "forward": 2,
            "date": "2023-05-10"
        },
        {
            "search": 8,
            "found": 0,
            "activation_fail": 0,
            "ticket_opened": 0,
            "activated": 0,
            "send_notification": 0,
            "forward": 6,
            "date": "2023-05-05"
        },
        {
            "search": 4,
            "found": 0,
            "activation_fail": 0,
            "ticket_opened": 0,
            "activated": 0,
            "send_notification": 0,
            "forward": 4,
            "date": "2023-05-09"
        },
        {
            "search": 2,
            "found": 0,
            "activation_fail": 0,
            "ticket_opened": 0,
            "activated": 0,
            "send_notification": 0,
            "forward": 2,
            "date": "2023-05-08"
        }
    ]
]