---
title: "Histórico de consultas - Resumo."
url: "https://devcenter.stone.com.br/apis/stone-tax/versions/206fd1c1-6382-4ada-8612-c67fdc65e050/paths/api-v1-CatalogoProduto-Historico-Resumo/get"
---

> Full API specification: https://devcenter.stone.com.br/apis/stone-tax/versions/206fd1c1-6382-4ada-8612-c67fdc65e050.md

# Histórico de consultas - Resumo.

`GET` `/api/v1/CatalogoProduto/Historico/Resumo`

Fornece dados totalizados do histórico de consultas na api. Permite ao usuário fazer o acompanhamento da bilhetagem de consumo dos serviços filtrando por intervalo de datas ou texto de busca genérica.

## Query parameters

- `modoConsulta` (string, optional) - Filtrar pelo modo da consulta realizada.
- `tipoFiltro` (string, optional) - Filtrar pelo tipo de filtro aplicado na consulta.
- `busca` (string, optional) - Busca genérica - Filtro ou Hash.
- `statusConsulta` (string, optional) - Filtrar pelo status de retorno da consulta.
- `dataConsultaInicial` (string, date-time, optional) - Filtrar pela data de consulta "a partir de".
- `dataConsultaFinal` (string, date-time, optional) - Filtrar pela data de consulta "até".

## Header parameters

- `DocumentoEmissor` (string, required) - Documento do emissor.

## Responses

- `200` - OK
- `400` - Bad Request
- `401` - Unauthorized
- `403` - Forbidden
- `500` - Internal Server Error

## OpenAPI definition

```yaml
openapi: 3.0.4
info:
  title: Stone Tax API
  version: 1.0.0
servers:
  - url: https://stone-tax-sdx.stone.com.br
    description: Ambiente de Desenvolvimento
  - url: https://stone-tax.stone.com.br
    description: Ambiente de Produção
paths:
  /api/v1/CatalogoProduto/Historico/Resumo:
    get:
      tags:
        - CatalogoProduto
      summary: Histórico de consultas - Resumo.
      description: Fornece dados totalizados do histórico de consultas na api. Permite
        ao usuário fazer o acompanhamento da bilhetagem de consumo dos serviços
        filtrando por intervalo de datas ou texto de busca genérica.
      parameters:
        - name: modoConsulta
          in: query
          description: Filtrar pelo modo da consulta realizada.
          schema:
            $ref: "#/components/schemas/ModoConsultaProdutoModelEnum"
        - name: tipoFiltro
          in: query
          description: Filtrar pelo tipo de filtro aplicado na consulta.
          schema:
            $ref: "#/components/schemas/TipoFiltroConsultaProdutoModelEnum"
        - name: busca
          in: query
          description: Busca genérica - Filtro ou Hash.
          schema:
            type: string
        - name: statusConsulta
          in: query
          description: Filtrar pelo status de retorno da consulta.
          schema:
            $ref: "#/components/schemas/StatusConsultaProdutoModelEnum"
        - name: dataConsultaInicial
          in: query
          description: Filtrar pela data de consulta "a partir de".
          schema:
            type: string
            format: date-time
        - name: dataConsultaFinal
          in: query
          description: Filtrar pela data de consulta "até".
          schema:
            type: string
            format: date-time
        - name: DocumentoEmissor
          in: header
          description: Documento do emissor.
          required: true
          schema:
            type: string
      responses:
        "200":
          description: OK
          content:
            text/plain:
              schema:
                $ref: "#/components/schemas/ResumoConsultasProdutoVisaoAplicacaoViewModel"
            application/json:
              schema:
                $ref: "#/components/schemas/ResumoConsultasProdutoVisaoAplicacaoViewModel"
            text/json:
              schema:
                $ref: "#/components/schemas/ResumoConsultasProdutoVisaoAplicacaoViewModel"
        "400":
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ResponseErrorResult"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ResponseErrorResult"
        "403":
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ResponseErrorResult"
        "500":
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ResponseErrorResult"
      security:
        - BearerAuth: []
security:
  - BearerAuth: []
components:
  schemas:
    ModoConsultaProdutoModelEnum:
      enum:
        - ConsultaProduto
        - EmissaoDeNotaFiscal
      type: string
      description: Tipo de consulta realizada pelo emissor.
    TipoFiltroConsultaProdutoModelEnum:
      enum:
        - Ean
        - DescricaoSimilar
        - Hash
      type: string
      description: Tipo de filtro do catálogo de produto.
    StatusConsultaProdutoModelEnum:
      enum:
        - Sucesso
        - NaoEncontrado
        - Falha
      type: string
      description: Status de retorno da consulta do produto.
    ResumoConsultasProdutoVisaoAplicacaoViewModel:
      type: object
      properties:
        totalConsultas:
          type: integer
          description: Total de consultas realizadas pelo emissor.
          format: int32
        totalSucesso:
          type: integer
          description: Total de consultas concluídas com sucesso.
          format: int32
        totalNaoEncontrado:
          type: integer
          description: Total de consultas cujo produto não foi encontrado.
          format: int32
        totalFalha:
          type: integer
          description: Total de consultas que apresentaram falhas no processo.
          format: int32
      additionalProperties: false
      description: Dados do resumo da consulta realizada pelo emissor exibidos na aplicação.
    ResponseErrorResult:
      type: object
      properties:
        status:
          type: integer
          format: int32
        titulo:
          type: string
          nullable: true
        erros:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
          nullable: true
      additionalProperties: false
  securitySchemes:
    BearerAuth:
      type: http
      description: Autenticação via token JWT. Obtenha o token através do endpoint
        /Autenticacao/ObterToken usando Basic Auth. O token expira em 1 hora.
      scheme: bearer
      bearerFormat: JWT
```