MOST Docs
Billing/DailySummary [application/json]
POSThttps://mostqiapi.com/billing/daily-summaryLast modified: 4 months ago
Rota para obter o resumo de consumo do período anterior (D-1), com agrupamento diário por serviço.
Request
Header Params
Authorization
string
required
Token de autorização obtido no método user/authenticate.
Example:
Bearer XXXXXXXXXXXXX
Body Params application/json
startDate
string <date-time>
required
Data inicial do período de consumo a ser pesquisado.
Example:
2024-01-01 00:00:00.000Z
endDate
string <date-time>
required
Data final do período de consumo a ser pesquisado.
Example:
2024-01-30 00:00:00.000Z
Example
{
"startDate": "2024-01-01 00:00:00.000Z",
"endDate": "2024-01-30 00:00:00.000Z"
}Request samples
Responses
OK(200)
HTTP Code: 200
Content Type : JSONapplication/json
Data Schema
result
object | null
optional
Lista contendo o resultado do método (consulte na documentação específica de cada um).
details
array [object {2}] | null
optional
Objeto que fornece uma visão geral das atividades de faturamento ao longo do período informado, permitindo analisar o desempenho e o uso dos diferentes serviços.
requestCount
integer
required
Atributo que retorna a soma de todas as requisições realizadas durante o período informado, abrangendo todos os serviços.
typifiedItemCount
integer
required
Atributo que retorna a soma de todos os documentos identificados durante o período informado, abrangendo todos os serviços.
nonTypifiedItemCount
integer
required
Atributo que retorna a soma de todos os documentos não identificados durante o período informado, abrangendo todos os serviços.
billingCount
integer
required
Atributo que descreve o total a ser faturado no período informado, abrangendo todos os serviços consumidos.
requestId
string
required
Código único de identificação da solicitação ao servidor, que será registrado no histórico de consumo dos serviços.
elapsedMilliseconds
integer
required
Tempo de duração do processamento em milissegundos.
status
object
required
Objeto contendo o código de status e a mensagem de resposta.
code
string
required
Código de status interno. Veja os valores possíveis nas mensagens de erro do mostQI.
message
string | null
required
Mensagem de retorno de status. Veja os valores possíveis nas mensagens de erro do mostQI.
errors
array [object {2}] | null
required
Lista de objetos do tipo Error, o formato é variável.
ExampleSucesso
{
"result": {
"details": [
{
"date": "2024-05-03T00:00:00Z",
"services": [
{
"serviceName": "Document Extraction",
"requestCount": 5,
"typifiedItemCount": 5,
"nonTypifiedItemCount": 0,
"billingCount": 5
},
{
"serviceName": "mostId PF Tier",
"requestCount": 1,
"typifiedItemCount": 1,
"nonTypifiedItemCount": 0,
"billingCount": 1
}
]
},
{
"date": "2024-05-06T00:00:00Z",
"services": [
{
"serviceName": "Enrichment",
"requestCount": 1,
"typifiedItemCount": 1,
"nonTypifiedItemCount": 0,
"billingCount": 1
}
]
},
{
"date": "2024-05-07T00:00:00Z",
"services": [
{
"serviceName": "mostId PF Tier",
"requestCount": 5,
"typifiedItemCount": 5,
"nonTypifiedItemCount": 0,
"billingCount": 5
}
]
},
{
"date": "2024-05-09T00:00:00Z",
"services": [
{
"serviceName": "Enrichment",
"requestCount": 3,
"typifiedItemCount": 3,
"nonTypifiedItemCount": 0,
"billingCount": 3
}
]
},
{
"date": "2024-05-10T00:00:00Z",
"services": [
{
"serviceName": "Enrichment",
"requestCount": 6,
"typifiedItemCount": 6,
"nonTypifiedItemCount": 0,
"billingCount": 6
}
]
},
{
"date": "2024-05-13T00:00:00Z",
"services": [
{
"serviceName": "mostId PF Tier",
"requestCount": 2,
"typifiedItemCount": 2,
"nonTypifiedItemCount": 0,
"billingCount": 2
},
{
"serviceName": "mostId PJ Tier",
"requestCount": 1,
"typifiedItemCount": 1,
"nonTypifiedItemCount": 0,
"billingCount": 1
},
{
"serviceName": "Enrichment",
"requestCount": 5,
"typifiedItemCount": 5,
"nonTypifiedItemCount": 0,
"billingCount": 5
}
]
},
{
"date": "2024-05-14T00:00:00Z",
"services": [
{
"serviceName": "Generative Content Extraction",
"requestCount": 2,
"typifiedItemCount": 2,
"nonTypifiedItemCount": 0,
"billingCount": 2
}
]
},
{
"date": "2024-05-15T00:00:00Z",
"services": [
{
"serviceName": "Document Extraction",
"requestCount": 2,
"typifiedItemCount": 2,
"nonTypifiedItemCount": 2,
"billingCount": 4
},
{
"serviceName": "Generative Content Extraction",
"requestCount": 1,
"typifiedItemCount": 1,
"nonTypifiedItemCount": 0,
"billingCount": 1
}
]
},
{
"date": "2024-05-22T00:00:00Z",
"services": [
{
"serviceName": "Document Extraction",
"requestCount": 3,
"typifiedItemCount": 3,
"nonTypifiedItemCount": 0,
"billingCount": 3
}
]
},
{
"date": "2024-05-24T00:00:00Z",
"services": [
{
"serviceName": "Document Extraction",
"requestCount": 1,
"typifiedItemCount": 1,
"nonTypifiedItemCount": 0,
"billingCount": 1
},
{
"serviceName": "mostId PF Tier",
"requestCount": 1,
"typifiedItemCount": 1,
"nonTypifiedItemCount": 0,
"billingCount": 1
},
{
"serviceName": "Enrichment",
"requestCount": 2,
"typifiedItemCount": 2,
"nonTypifiedItemCount": 0,
"billingCount": 2
}
]
},
{
"date": "2024-05-27T00:00:00Z",
"services": [
{
"serviceName": "Document Extraction",
"requestCount": 2,
"typifiedItemCount": 2,
"nonTypifiedItemCount": 0,
"billingCount": 2
},
{
"serviceName": "Document Compare",
"requestCount": 1,
"typifiedItemCount": 0,
"nonTypifiedItemCount": 1,
"billingCount": 1
},
{
"serviceName": "BIGDATA PEOPLE PF",
"requestCount": 5,
"typifiedItemCount": 5,
"nonTypifiedItemCount": 0,
"billingCount": 5
},
{
"serviceName": "mostId PF Tier",
"requestCount": 3,
"typifiedItemCount": 3,
"nonTypifiedItemCount": 0,
"billingCount": 3
},
{
"serviceName": "mostId PJ Tier",
"requestCount": 2,
"typifiedItemCount": 2,
"nonTypifiedItemCount": 0,
"billingCount": 2
},
{
"serviceName": "Enrichment",
"requestCount": 1,
"typifiedItemCount": 1,
"nonTypifiedItemCount": 0,
"billingCount": 1
}
]
},
{
"date": "2024-05-28T00:00:00Z",
"services": [
{
"serviceName": "Document Extraction",
"requestCount": 1,
"typifiedItemCount": 0,
"nonTypifiedItemCount": 1,
"billingCount": 1
},
{
"serviceName": "Liveness Detection",
"requestCount": 1,
"typifiedItemCount": 1,
"nonTypifiedItemCount": 0,
"billingCount": 1
},
{
"serviceName": "mostId PF Tier",
"requestCount": 1,
"typifiedItemCount": 1,
"nonTypifiedItemCount": 0,
"billingCount": 1
},
{
"serviceName": "mostId PJ Tier",
"requestCount": 1,
"typifiedItemCount": 1,
"nonTypifiedItemCount": 0,
"billingCount": 1
},
{
"serviceName": "Vio Extraction",
"requestCount": 1,
"typifiedItemCount": 1,
"nonTypifiedItemCount": 0,
"billingCount": 1
},
{
"serviceName": "Generative Content Extraction",
"requestCount": 1,
"typifiedItemCount": 1,
"nonTypifiedItemCount": 0,
"billingCount": 1
}
]
},
{
"date": "2024-05-29T00:00:00Z",
"services": [
{
"serviceName": "Document Extraction",
"requestCount": 2,
"typifiedItemCount": 2,
"nonTypifiedItemCount": 0,
"billingCount": 2
},
{
"serviceName": "Face Recognition ",
"requestCount": 2,
"typifiedItemCount": 0,
"nonTypifiedItemCount": 2,
"billingCount": 2
},
{
"serviceName": "Vehicle Plate Extraction",
"requestCount": 1,
"typifiedItemCount": 1,
"nonTypifiedItemCount": 0,
"billingCount": 1
},
{
"serviceName": "Liveness Detection",
"requestCount": 2,
"typifiedItemCount": 2,
"nonTypifiedItemCount": 0,
"billingCount": 2
},
{
"serviceName": "Enrichment",
"requestCount": 1,
"typifiedItemCount": 18,
"nonTypifiedItemCount": 0,
"billingCount": 18
},
{
"serviceName": "Vio Extraction",
"requestCount": 1,
"typifiedItemCount": 1,
"nonTypifiedItemCount": 0,
"billingCount": 1
},
{
"serviceName": "Generative Content Extraction",
"requestCount": 1,
"typifiedItemCount": 1,
"nonTypifiedItemCount": 0,
"billingCount": 1
}
]
}
],
"requestCount": 71,
"typifiedItemCount": 84,
"nonTypifiedItemCount": 6,
"billingCount": 90
},
"requestId": "w5G4pAPp30qrmAp3PKzYA",
"elapsedMilliseconds": 39,
"status": {
"message": "Ok",
"code": "200",
"errors": null
}
}Last modified: 4 months ago