# Estatísticas de uso

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)                                                               | `dia`, `mês`, `ano`                                                                                                 | `https://data.oxylabs.io/v2/stats?group_by=day`             |
| `date_from`                                                                                                              | O limite inferior de data. Melhor usado junto com `date_to`.                                                                                                       | Qualquer data no `Y-m-d` formato.                                                                                   | `https://data.oxylabs.io/v2/stats?date_from=2022-01-17`     |
| `date_to`                                                                                                                | O limite superior de data. Melhor usado junto com `date_from`.                                                                                                     | Qualquer data no `Y-m-d` formato.                                                                                   | `https://data.oxylabs.io/v2/stats?date_to=2022-06-17`       |
| `source`                                                                                                                 | Permite obter estatísticas de uso de uma única `source` de sua escolha.                                                                                            | Qualquer `source` .                                                                                                 | `https://data.oxylabs.io/v2/stats?source=universal`         |
| <p><code>product</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. Aplica-se somente se você usar o mesmo nome de usuário para acessar mais de uma 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

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

# Imprima a response JSON formatada no 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 `v2/stats` a saída 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 são posteriormente divididas em estatísticas separadas para resultados HTML e analisados. Consulte a [**dicionário de dados**](#data-dictionary) seção para descobrir o significado de cada chave de saída.

#### Exemplo de saída

```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 via método de integração Push-Pull.                                      | Inteiro     |
| `mode_realtime_count`      | A quantidade de resultados, atendidos via método de integração Realtime.                                       | Inteiro     |
| `mode_superapi_count`      | A quantidade de resultados, atendidos via método de integração Proxy Endpoint.                                 | Inteiro     |
| `contenttype_parsed_count` | A quantidade de resultados analisados.                                                                         | Inteiro     |
| `contenttype_html_count`   | A quantidade de resultados 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 `geo_location` valor de parâmetro definido pelo usuário. | Inteiro     |
| `average_response_time`    | O tempo médio de resposta (segundos).                                                                          | Float       |
| `request_traffic`          | O total **request** de tráfego (bytes).                                                                        | Inteiro     |
| `response_traffic`         | O total **response** 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 dizem respeito a resultados analisados.                              | Booleano    |


---

# Agent Instructions: Querying This Documentation

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

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

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

The question should be specific, self-contained, and written in natural language.
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.
