Obter cliques do Bitlink por dispositivo no Bitly, por uma API
Retorna os cliques de um Bitlink por tipo de dispositivo em uma janela. unit e units definem a janela: unit day com units 30 são os 30 dias até unit_reference. Planos sem esse relatório respondem 402 UPGRADE_REQUIRED.
- Identificador
- bitly_get_bitlink_clicks_by_device
A chamada
POST https://connect.reportei.com/api/tools/bitly_get_bitlink_clicks_by_device/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"bitlink": "<bitlink>",
"unit": "minute",
"units": 1
}
}Seu sistema envia o id da conexão do cliente e os argumentos da tool. Os headers são os mesmos de toda a API do Connect: o token do seu produto e o token do cliente.
Parâmetros
As descrições dos parâmetros seguem a documentação oficial do app, em inglês.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| bitlink | string | Sim | The id of the link, from List Bitlinks or Create Bitlink: the domain and the back-half without https://, like bit.ly/3AbCdEf. |
| unit | string | Sim | Unit of time of the window.Valores: minute, hour, day, week, month |
| units | integer | Sim | How many units the window has, counting back from unit_reference. -1 is the whole history. |
| unit_reference | string | Não | ISO-8601 time the window ends at, like 2026-10-01T00:00:00+0000, sent as plain text. The default is now. |
| size | integer | Não | How many device types to return. The default is 50. |
Conexões possíveis
O seu cliente conecta a conta do Bitly uma vez, por um dos modos abaixo. A mesma conexão serve para todas as tools do toolkit.
Chave de API
O cliente cola a chave do app numa tela do Connect, ou o seu sistema envia a chave por POST /api/customer-toolkits, sem tela.
OAuth com o app do seu produto
Você cadastra o app OAuth do seu produto uma vez, em POST /api/merchants/credentials/bitly, e o cliente autoriza a conta numa tela de consentimento. O Connect renova o token quando ele está para vencer.
A resposta
Em caso de sucesso, o Connect preserva o status e o corpo da resposta do app. Erros HTTP retornados pelo app usam o envelope {error, api_error}; falhas de autenticação ou validação podem ocorrer antes da execução. O header X-Toolkit-Execution-Id identifica a execução registrada, consultável em GET /api/tools/executions/{uuid}.
Pronta para agentes de IA
O input desta tool é um JSON Schema, disponível em GET /api/tools/bitly_get_bitlink_clicks_by_device. Ele vira a definição de tool do seu agente sem conversão.
Outras tools do Bitly
- Listar gruposGETLista os grupos a que a conta pertence. Cada grupo tem o guid que as outras tools pedem como group_guid e, em bsds, os domínios personalizados com que o grupo pode encurtar links.
- Listar BitlinksGETLista os Bitlinks de um grupo, com id, link, long_url, título e tags. A resposta tem links e pagination: passe pagination.search_after como search_after, com os mesmos filtros, para ler a próxima página.
- Obter BitlinkGETRetorna um Bitlink: o link curto, long_url, título, tags, archived, created_at e os back-halves personalizados que ele teve.
- Criar BitlinkPOSTEncurta uma URL longa em um novo Bitlink e o retorna, com o link curto em link e o id em id. Conta no limite mensal de links do plano, e recursos que o plano não tem, como back-half personalizado, respondem 402 UPGRADE_REQUIRED.
- Atualizar BitlinkPATCHAtualiza um Bitlink e o retorna. Campos omitidos mantêm o valor. Alterar long_url redireciona o link e sempre conta no limite mensal de links do plano; planos sem redirecionamento respondem 402 UPGRADE_REQUIRED.
- Obter cliques do BitlinkGETRetorna os cliques de um Bitlink por unidade de tempo, em link_clicks com date e clicks. unit e units definem a janela: unit day com units 30 são os 30 dias até unit_reference.
- Obter resumo de cliques do BitlinkGETRetorna o total de cliques de um Bitlink em uma janela, em total_clicks. unit e units definem a janela: unit day com units 30 são os 30 dias até unit_reference.
- Obter cliques do Bitlink por paísGETRetorna os cliques de um Bitlink por país em uma janela, em metrics com value (o código do país) e clicks. unit e units definem a janela: unit day com units 30 são os 30 dias até unit_reference.
Veja o Connect aplicado ao seu produto.
Teste por 15 dias sem cartão, ou mostre seu cenário ao nosso time.
