Dashboard API
Acesso programático aos usuários dos produtos da Oxylabs para acompanhar estatísticas de uso com a Dashboard API.
O Dashboard API permite que você acesse as estatísticas de uso do seu produto programaticamente e integre as métricas aos seus sistemas internos. Isso permite relatórios automatizados e monitoramento de uso em tempo real sem usar o dashboard da Oxylabs na web.
Observação: O Dashboard API atualmente oferece suporte a Datacenter Proxies (DC) e Headless Browser (HB). Você também pode acompanhar as estatísticas de uso de Residential Proxies, Mobile Proxies, Web Unblocker, e Web Scraper API com solicitações simples de API.
Todas as solicitações de API passam por este caminho base:
https://api.oxylabs.io/Autenticação
Importante: Para obter sua chave da Dashboard API, entre em contato com nossa equipe de Suporte ao Cliente . Após a solicitação, a chave será gerada e entregue diretamente a você em até um dia útil.
Você deve incluir a chave no cabeçalho Authorization de cada solicitação usando o esquema Bearer .
Authorization: Bearer {YOUR_API_KEY}Endpoints
O Dashboard API inclui endpoints para Descoberta de Instâncias do produto e Estatísticas de Uso. Todas as respostas são entregues em formato JSON.
A solicitação retorna uma lista paginada de instâncias de produtos às quais sua conta tem autorização de acesso. Você pode usar os IDs retornados para filtrar resultados ao chamar outros endpoints.
A solicitação retorna estatísticas agregadas de uso por produto para as instâncias de produto do cliente autenticado.
Descoberta de instâncias
GET /stats/v1/filters/instancesParâmetros de consulta
products[]
Filtrar por produto. Valores aceitos: HB (Headless Browser), DC (Datacenter Proxies), null (todos os produtos).
Array de strings
page
Número da página. Padrão: 1.
Integer
per_page
Resultados por página. Padrão: 100. Máximo: 100.
Integer
Exemplo de solicitação
Para começar a filtrar os dados, primeiro você precisa identificar seus recursos específicos. O exemplo a seguir mostra como listar suas instâncias disponíveis de Datacenter Proxies (DC) e Headless Browser (HB).
Exemplo de entrada
Exemplo de saída
Campos de resposta
uuid
Identificador único da instância.
String (UUID)
name
Nome da instância conforme configurado no dashboard.
String
status
Status da instância do produto (ex.: enabled ou disabled).
String
product
Identificador do produto (ex.: HB (Headless Browser), DC (Datacenter Proxies), etc.).
String
page
Número da página atual.
Integer
per_page
Número de resultados nesta página.
Integer
total_items
Total de registros correspondentes em todas as páginas.
Integer
total_pages
Número total de páginas. Sempre pelo menos 1, mesmo quando não há resultados.
Integer
Estatísticas de uso
Importante: O intervalo máximo de datas para uma única solicitação (a diferença entre date_to e date_from) é 31 days. Para recuperar dados de uso por um período mais longo, faça suas consultas em lotes de 31 dias.
Parâmetros de consulta
product
Identificador do produto (ex.: HB (Headless Browser), DC (Datacenter Proxies), etc.)
String
date_to
Data de início, inclusiva (ex.: UTC YYYY-MM-DDTHH:mm:ssZ ou com fuso horário explícito YYYY-MM-DDTHH:mm:ss+02:00).
Data (ISO 8601)
date_from
Data de fim, inclusiva. Mesmo formato de date_to.
Data (ISO 8601)
group_by
Opções de agrupamento dos resultados. Valores aceitos: DAY, TARGET, INSTANCE. Vários valores podem ser combinados. A ordem dos valores determina a ordem do agrupamento dos dados.
Array de strings
instances[]
Filtra os resultados para instâncias específicas. Aceita vários UUIDs obtidos de GET /stats/v1/filters/instances. UUIDs inválidos ou não reconhecidos são ignorados.
UUID (Array de strings)
page
Número da página. Padrão: 1.
Integer
per_page
Resultados por página. Padrão: 100. Máximo: 100.
Integer
- parâmetro obrigatório
Exemplos de solicitação
1. Agrupar por TARGET
O exemplo a seguir mostra como recuperar métricas de uso do Headless Browser (HB) agrupando os resultados por target, para ver a contagem total de solicitações e o volume de tráfego de cada target dentro do intervalo de datas selecionado.
Exemplo de entrada
Exemplo de saída
2. Agrupar por DAY + TARGET
Este exemplo mostra como detalhar o uso do Headless Browser (HB) por Dia e Target para ver exatamente quanto tráfego cada target consumiu dia a dia.
Exemplo de entrada
Exemplo de saída
Campos de resposta
grouped_by
Opções de agrupamento na mesma ordem dos group_by parâmetros
Array de strings
data.requests
Contagem total de solicitações para a combinação de período/dimensão agrupada.
Integer
data.traffic_bytes
Tráfego total em bytes para a combinação de período/dimensão agrupada.
Integer
totals
Valores totais agregados para o período selecionado.
Object
totals.requests
Contagem total de solicitações em todo o período selecionado.
Integer
totals.traffic_bytes
Tráfego total em bytes em todo o período selecionado.
Integer
page
Número da página atual.
Integer
per_page
Número de resultados nesta página.
Integer
total_items
Total de registros correspondentes em todas as páginas.
Integer
total_pages
Número total de páginas. Sempre pelo menos 1, mesmo quando não há resultados.
Integer
meta.grouping
As opções de agrupamento ativas na ordem em que aparecem em grouped_by. Reflete o group_by parâmetro de solicitação.
Array de strings
Limites de taxa
Para garantir estabilidade, os limites de taxa do Dashboard API são aplicados por chave de API e por conta de cliente para todas as solicitações.
10solicitações por chave de API100solicitações em todas as chaves de API de um cliente individual
Tratamento de erros
Aqui estão alguns tipos de erro comuns que você pode encontrar ao usar o Dashboard API:
400
Bad request
A solicitação não pôde ser entendida. Verifique se a solicitação está formatada corretamente.
401
Invalid request
O usuário inseriu uma chave de API inválida.
403
Forbidden
Acesso negado: chave de API ausente. Entre em contato com o suporte ou com o gerente da sua conta.
429
Too many requests
O usuário atingiu o limite de threads/sessões simultâneas.
500
Internal server error
Tivemos um problema inesperado com o servidor. Tente novamente mais tarde.
Para dúvidas, problemas de acesso ou suporte de integração, entre em contato com support@oxylabs.io ou com o gerente da sua conta. Ao relatar um problema, inclua:
O endpoint e os parâmetros de consulta usados
O código de status HTTP retornado
O corpo completo da resposta (oculte sua chave de API antes de compartilhar)
Os timestamps das solicitações com falha (UTC preferencial)
Atualizado
Isto foi útil?