> For the complete documentation index, see [llms.txt](https://developers.oxylabs.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developers.oxylabs.io/products/pt-br/web-scraper-api/usage-and-billing/usage-statistics.md).

# Estatísticas de uso

Aprenda a verificar estatísticas de uso da Web Scraper API usando solicitações simples.

Você pode verificar suas estatísticas de uso gratuitamente enviando uma solicitação de API.

O endpoint abaixo é para consultas de estatísticas de uso:

```
GET https://data.oxylabs.io/v2/stats
```

### Entrada

Por padrão, a API retornará estatísticas de uso sem filtro (de todos os tempos, de todas as fontes). Se quiser, você pode obter estatísticas agrupadas e/ou filtradas.

Você pode combinar dois ou mais parâmetros na mesma consulta, por exemplo, agrupar as estatísticas por dia e filtrar por fonte.

| Parâmetro                                                                                                                | Descrição                                                                                                                                                        | Valores válidos                                                                                                     | Exemplo de URL                                              |
| ------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------- |
| `group_by`                                                                                                               | Permite exibir estatísticas de uso diárias, mensais ou anuais (em vez de exibir estatísticas totais)                                                             | `day`, `month`, `year`                                                                                              | `https://data.oxylabs.io/v2/stats?group_by=day`             |
| `date_from`                                                                                                              | O limite inferior da data. Melhor usado junto com `date_to`.                                                                                                     | Qualquer data em `Y-m-d` formato.                                                                                   | `https://data.oxylabs.io/v2/stats?date_from=2022-01-17`     |
| `date_to`                                                                                                                | O limite superior da data. Melhor usado junto com `date_from`.                                                                                                   | Qualquer data em `Y-m-d` formato.                                                                                   | `https://data.oxylabs.io/v2/stats?date_to=2022-06-17`       |
| `source`                                                                                                                 | Permite obter estatísticas de uso de um único `source` de sua escolha.                                                                                           | Qualquer válido `source` valor.                                                                                     | `https://data.oxylabs.io/v2/stats?source=universal`         |
| <p><code>produto</code><br><br>Este filtro é para usuários legados (contas criadas antes de 25 de setembro de 2024).</p> | Permite obter estatísticas de uso de um único produto de sua escolha. Aplicável apenas se você usar o mesmo nome de usuário para acessar mais de um Scraper API. | <p><code>serp\_scraper\_api</code>;</p><p><code>ecommerce\_scraper\_api</code> ; <code>web\_scraper\_api</code></p> | `https://data.oxylabs.io/v2/stats?product=serp_scraper_api` |

A consulta abaixo retorna estatísticas mensais.

{% tabs %}
{% tab title="cURL" %}

```shell
curl --user "user:pass1" 'https://data.oxylabs.io/v2/stats?group_by=month'
```

{% endtab %}

{% tab title="Python" %}

```python
import requests
from pprint import pprint

# Obter resposta do endpoint de estatísticas.
response = requests.request(
    method='GET',
    url='https://data.oxylabs.io/v2/stats',
    auth=('user', 'pass1'),
)

# Imprimir resposta JSON formatada para stdout.
pprint(response.json())
```

{% endtab %}

{% tab title="PHP" %}

```php
<?php

$ch = curl_init();

curl_setopt($ch, CURLOPT_URL, "https://data.oxylabs.io/v2/stats");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");
curl_setopt($ch, CURLOPT_USERPWD, "user" . ":" . "pass1");

$result = curl_exec($ch);
echo $result;

if (curl_errno($ch)) {
    echo 'Error:' . curl_error($ch);
}
curl_close ($ch);
?>
```

{% endtab %}
{% endtabs %}

### Saída

A URL `v2/stats` o output contém estatísticas de uso, incluindo estatísticas no nível de produto (E-Commerce Scraper API / SERP Scraper API / Web Scraper API). As estatísticas no nível de produto são divididas em estatísticas no nível de fonte, que por sua vez são divididas em estatísticas separadas para HTML e resultados analisados. Veja a [**dicionário de dados**](#data-dictionary) seção para descobrir o significado de cada chave de saída.

#### Saída de exemplo

```json
{
    "meta": {
        "group_by": null,
        "date_from": null,
        "date_to": null,
        "source": null,
        "product": null
    },
    "data": {
        "products": [
            {
                "all_count": 5837,
                "mode_callback_count": 5514,
                "mode_realtime_count": 315,
                "mode_superapi_count": 8,
                "contenttype_parsed_count": 56,
                "contenttype_html_count": 5781,
                "render_count": 3,
                "geo_location_count": 2330,
                "average_response_time": 88.54,
                "request_traffic": 4685091,
                "response_traffic": 602064208,
                "title": "serp_scraper_api",
                "sources": [
                    {
                        "all_count": 5616,
                        "mode_callback_count": 5414,
                        "mode_realtime_count": 194,
                        "mode_superapi_count": 8,
                        "render_count": 0,
                        "geo_location_count": 2190,
                        "average_response_time": 91.59,
                        "request_traffic": 4550507,
                        "response_traffic": 585423946,
                        "title": "serp_source1",
                        "parsed": false
                    },
                    {
                        "all_count": 1,
                        "mode_callback_count": 0,
                        "mode_realtime_count": 1,
                        "mode_superapi_count": 0,
                        "render_count": 0,
                        "geo_location_count": 1,
                        "average_response_time": 11,
                        "request_traffic": 0,
                        "response_traffic": 0,
                        "title": "serp_source2",
                        "parsed": false
                    }
                ]
            }
        ]
    }
}
```

### Dicionário de dados

| Chave                      | Descrição                                                                                                                   | Tipo                      |
| -------------------------- | --------------------------------------------------------------------------------------------------------------------------- | ------------------------- |
| `meta`                     | O contêiner de todas as estatísticas enviadas [**parâmetros de consulta**](#input).                                         | -                         |
| `data`                     | O contêiner de todos os dados de estatísticas.                                                                              | objeto JSON               |
| `products`                 | A lista de objetos de estatísticas no nível de produto.                                                                     | array JSON                |
| `all_count`                | A quantidade total de resultados.                                                                                           | inteiro                   |
| `mode_callback_count`      | A quantidade de resultados, atendidos por meio do método de integração Push-Pull.                                           | inteiro                   |
| `mode_realtime_count`      | A quantidade de resultados, atendidos por meio do método de integração Realtime.                                            | inteiro                   |
| `mode_superapi_count`      | A quantidade de resultados, atendidos por meio do método de integração Proxy Endpoint.                                      | inteiro                   |
| `contenttype_parsed_count` | A quantidade de resultados analisados.                                                                                      | inteiro                   |
| `contenttype_html_count`   | A quantidade de resultados em HTML.                                                                                         | inteiro                   |
| `render_count`             | A quantidade de resultados atendidos com execução de JavaScript.                                                            | inteiro                   |
| `geo_location_count`       | A quantidade de resultados que foram atendidos com um valor de parâmetro definido pelo usuário `geo_location` de parâmetro. | inteiro                   |
| `average_response_time`    | O tempo médio de resposta (segundos).                                                                                       | número de ponto flutuante |
| `request_traffic`          | O total **requisição** de tráfego (bytes).                                                                                  | inteiro                   |
| `response_traffic`         | O total **resposta** de tráfego (bytes).                                                                                    | inteiro                   |
| `title`                    | Nome do produto ou da fonte.                                                                                                | string                    |
| `sources`                  | A lista de fontes pertencentes a um produto específico.                                                                     | string                    |
| `parsed`                   | A indicação de se os dados no objeto JSON se referem a resultados analisados.                                               | boolean                   |


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://developers.oxylabs.io/products/pt-br/web-scraper-api/usage-and-billing/usage-statistics.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
