Linkly (versão prévia)
Linkly é um encurtador de link e um rastreador de clique. Crie links curtos com a marca com domínios personalizados, adicione parâmetros UTM e pixels de redirecionamento, conversões de relatório e análise de clique de pull agrupada por país, plataforma, referenciador ou campanha.
Esse conector está disponível nos seguintes produtos e regiões:
| Serviço | Classe | Regions |
|---|---|---|
| Copilot Studio | Premium | Todas as regiões Power Automate exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Aplicativos Lógicos | Standard | Todas as regiões dos Aplicativos Lógicos , exceto as seguintes: – Azure Governamental regiões - Regiões do Azure China - Departamento de Defesa dos EUA (DoD) |
| Power Apps | Premium | Todas as regiões Power Apps exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Power Automate | Premium | Todas as regiões Power Automate exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Contato | |
|---|---|
| Name | Suporte linkly |
| URL | https://linklyhq.com/support |
| support@linklyhq.com |
| Metadados do conector | |
|---|---|
| Publicador | Linkly |
| Website | https://linklyhq.com |
| Política de privacidade | https://linklyhq.com/support/privacy |
| Categories | Marketing; Site |
Linkly
Linkly é um encurtador de link e um rastreador de clique. Ele cria links curtos de marca em seu próprio domínio, rastreia cada clique com detalhamentos de país, plataforma e referenciador, dispara pixels de redirecionamento e registra conversões de volta para o link que os produziu. Esse conector permite que os fluxos criem e gerenciem links, efetuem pull de análise de clique e conversões de relatório em um workspace linkly.
Publisher: Linkly
Prerequisites
Uma conta linkly . O plano gratuito é suficiente para usar todas as ações neste conector. Conversões de relatórios e listagem também exigem que o recurso de acompanhamento de conversão linkly seja habilitado no workspace.
Operações com suporte
Listar workspaces
Retorna os workspaces disponíveis para essa conexão. Use-o para localizar o workspace que outras ações exigem.
Criar ou atualizar um link
Cria um novo link curto ou atualiza um existente quando uma ID de link é fornecida. Dá suporte a domínios e lesmas personalizados, parâmetros UTM, pixels de redirecionamento e metadados do Open Graph.
Obter um link
Recupera um único link por sua ID, incluindo seu destino, URL curta e configuração.
Listar links
Retorna uma lista paginada dos links em um workspace, com estatísticas de clique. Dá suporte à pesquisa e à classificação.
Excluir um link
Move um link para o lixo. Sua URL curta interrompe o redirecionamento e o link pode ser restaurado posteriormente do lixo.
Obter análise de cliques
Retorna contagens de cliques ao longo do tempo para um workspace ou para links específicos, opcionalmente filtrados por intervalo de datas, país, navegador, plataforma, referenciador ou ISP.
Obter contagens de cliques por dimensão
Retorna contagens de clique agrupadas por uma dimensão, como país, cidade, plataforma, referenciador ou parâmetro UTM, ordenadas pela contagem decrescente.
Listar domínios personalizados
Retorna os domínios personalizados configurados para um workspace. Esses nomes de domínio podem ser usados ao criar links.
Relatar uma conversão
Registra uma conversão, como uma compra, uma inscrição ou um evento personalizado, e atribui-a ao link que foi clicado quando um token de atribuição é fornecido.
Listar conversões
Retorna as conversões mais recentes registradas no workspace.
Obtendo credenciais
Esse conector usa o OAuth 2.0. Nenhuma chave de API é necessária.
- Se você ainda não tiver uma conta do Linkly, inscreva-se em https://linklyhq.com. O plano gratuito funciona.
- Ao criar uma conexão, escolha Entrar com o Linkly e entre com sua conta do Linkly.
- Escolha o workspace que essa conexão deve usar quando solicitado e aprove a solicitação.
A conexão está associada ao workspace escolhido. Para trabalhar em outro workspace, crie uma segunda conexão.
Introdução
- Crie uma conexão conforme descrito acima.
- Adicione a ação Criar ou atualizar um link a um fluxo, insira a URL de destino e, opcionalmente, um domínio e uma lesma personalizados. A ação retorna a URL curta e a ID do link.
- Use links de lista, Obter análise de cliques ou Obter contagens de cliques por dimensão para ler dados de clique. As ações que tomam um Workspace permitem que você o escolha em uma lista, que é preenchida por workspaces de lista.
- Para atribuir compras ou inscrição em links, passe o
linkly_cidvalor da URL da página de aterrissagem para Relatar uma conversão como o token de atribuição.
Problemas e limitações conhecidos
- Uma conexão é associada a um único workspace do Linkly, aquele escolhido ao entrar. Crie uma conexão por workspace.
- Relatar uma conversão e conversões de lista exigem o recurso de acompanhamento de conversão linkly. Workspaces sem ele recebem um erro dessas ações.
- Os webhooks de clique em tempo real não são expostos como gatilhos. Use o recurso de webhook do Linkly com um fluxo disparado por HTTP.
- A criação de link em massa, a exportação de link e o gerenciamento de domínio estão disponíveis na API linkly, mas não estão incluídos neste conector.
- A API é limitada por taxa. Obter contagens de cliques por dimensão retorna um erro de limite de taxa quando o limite é excedido; tente novamente após um pequeno atraso.
Perguntas frequentes
Em qual workspace minhas ações são executadas?
As ações que tomam um parâmetro workspace mostram uma lista dos workspaces disponíveis para a conexão. Ações sem um, como Obter um link, relatar uma conversão e conversões de lista, usam o workspace associado à conexão.
Como posso usar um domínio personalizado?
Adicione o domínio em Linkly primeiro e, em seguida, passe seu nome no campo Domínio de Criar ou atualizar um link. Listar domínios personalizados retorna os nomes disponíveis em um workspace.
Excluir um link remove o link permanentemente?
No. O link é movido para o lixo e para de redirecionar. Ele pode ser restaurado do lixo em Linkly.
Instruções de implantação
- No portal do criador, abra conectores personalizados, escolha Novo conector personalizado e importe um arquivo OpenAPI. Selecione
apiDefinition.swagger.json. - Na guia Segurança , escolha OAuth 2.0 com o provedor de identidade genérico Oauth 2 . Insira a ID do cliente e o segredo do cliente emitidos pelo Linkly, defina a URL
https://app.linklyhq.com/oauth/authorizede autorização como e defina a URL do token e a URL de atualização comohttps://app.linklyhq.com/oauth/token. - Crie o conector e copie a URL de redirecionamento mostrada na guia Segurança e registre-a no Linkly para essa ID do cliente.
- Crie uma conexão entrando com sua conta do Linkly e, em seguida, teste uma ação como listar workspaces.
Ações
| Criar ou atualizar um link |
Cria um novo link curto ou atualiza um existente quando uma ID de link é fornecida. Dá suporte a domínios e lesmas personalizados, parâmetros UTM, pixels de redirecionamento e metadados do Open Graph. |
| Excluir um link |
Move um link para o lixo. Sua URL curta interrompe o redirecionamento e o link pode ser restaurado posteriormente do lixo. |
| Listar conversões |
Retorna as conversões mais recentes registradas no workspace. |
| Listar domínios personalizados |
Retorna os domínios personalizados configurados para um workspace. Esses nomes de domínio podem ser usados ao criar links. |
| Listar links |
Retorna uma lista paginada dos links em um workspace, com estatísticas de clique. Dá suporte à pesquisa e à classificação. |
| Listar workspaces |
Retorna os workspaces disponíveis para essa conexão. Use-o para localizar o workspace que outras ações exigem. |
| Obter análise de cliques |
Retorna contagens de cliques ao longo do tempo para um workspace ou para links específicos, opcionalmente filtrados por intervalo de datas, país, navegador, plataforma, referenciador ou ISP. |
| Obter contagens de cliques por dimensão |
Retorna contagens de clique agrupadas por uma dimensão, como país, cidade, plataforma, referenciador ou parâmetro UTM, ordenadas pela contagem decrescente. |
| Obter um link |
Recupera um único link por sua ID, incluindo seu destino, URL curta e configuração. |
| Relatar uma conversão |
Registra uma conversão, como uma compra, uma inscrição ou um evento personalizado, e atribui-a ao link que foi clicado quando um token de atribuição é fornecido. |
Criar ou atualizar um link
Cria um novo link curto ou atualiza um existente quando uma ID de link é fornecida. Dá suporte a domínios e lesmas personalizados, parâmetros UTM, pixels de redirecionamento e metadados do Open Graph.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
URL de Destino
|
url | uri |
A URL de destino para a qual o link curto redireciona. Necessário para criar um novo link. |
|
|
Link ID
|
id | integer |
A ID de um link existente a ser atualizado. Deixe em branco para criar um novo link. |
|
|
Name
|
name | string |
Um apelido para o link, mostrado no painel. |
|
|
Domínio
|
domain | string |
O domínio personalizado a ser usado para o link curto, sem uma barra à direita. |
|
|
Slug
|
slug | string |
Um caminho personalizado para o link curto. Deve começar com uma barra. |
|
|
Enabled
|
enabled | boolean |
Se o link está ativo. |
|
|
Note
|
note | string |
Uma nota privada sobre o link. |
|
|
Origem UTM
|
utm_source | string |
O parâmetro utm_source acrescentado à URL de destino. |
|
|
Médio UTM
|
utm_medium | string |
O parâmetro utm_medium acrescentado à URL de destino. |
|
|
Campanha UTM
|
utm_campaign | string |
O parâmetro utm_campaign acrescentado à URL de destino. |
|
|
Conteúdo UTM
|
utm_content | string |
O parâmetro utm_content acrescentado à URL de destino. |
|
|
Termo UTM
|
utm_term | string |
O parâmetro utm_term acrescentado à URL de destino. |
|
|
Meta Pixel ID
|
fb_pixel_id | string |
A ID de Pixel do Meta (Facebook) a ser acionada quando o link for clicado. |
|
|
ID da marca do Google Analytics 4
|
ga4_tag_id | string |
A ID de medida do Google Analytics 4 a ser disparada quando o link é clicado. |
|
|
Google Tag Manager ID
|
gtm_id | string |
A ID do contêiner do Google Tag Manager a ser carregada quando o link for clicado. |
|
|
Bloquear Bots
|
block_bots | boolean |
Se os bots conhecidos devem ser bloqueados após o link. |
|
|
Marcas de corpo
|
body_tags | string |
HTML personalizado ou marcas de acompanhamento inseridas no corpo da página de redirecionamento. |
|
|
Cloaking
|
cloaking | boolean |
Se deseja ocultar o destino abrindo-o dentro de um quadro. |
|
|
Encaminhar parâmetros
|
forward_params | boolean |
Se os parâmetros de consulta devem ser encaminhados do link curto para o destino. |
|
|
Marcas de cabeçalho
|
head_tags | string |
HTML personalizado ou marcas de acompanhamento inseridas no cabeçalho da página de redirecionamento. |
|
|
Ocultar Referenciador
|
hide_referrer | boolean |
Se o referenciador deve ser ocultado do site de destino. |
|
|
Abrir descrição do Grafo
|
og_description | string |
A descrição mostrada quando o link é compartilhado nas redes sociais. |
|
|
Abrir Imagem do Graph
|
og_image | string |
A URL da imagem mostrada quando o link é compartilhado nas mídias sociais. |
|
|
Abrir Título do Graph
|
og_title | string |
O título mostrado quando o link é compartilhado nas redes sociais. |
|
|
TikTok Pixel ID
|
tiktok_pixel_id | string |
A ID do Pixel TikTok a ser disparada quando o link for clicado. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Meta Pixel ID
|
fb_pixel_id | string |
A ID de Pixel do Meta (Facebook) a ser acionada quando o link for clicado. |
|
ID do parceiro LinkedIn
|
linkedin_partner_id | string |
A ID do parceiro LinkedIn Insight Tag a ser disparada quando o link for clicado. |
|
Microsoft ID da marca UET
|
microsoft_uet_tag_id | string |
O Microsoft Advertising ID da marca UET a ser disparada quando o link for clicado. |
|
Reddit Pixel ID
|
reddit_pixel_id | string |
A ID do Pixel do Reddit a ser acionada quando o link for clicado. |
|
TikTok Pixel ID
|
tiktok_pixel_id | string |
A ID do Pixel TikTok a ser disparada quando o link for clicado. |
|
Ocultar Referenciador
|
hide_referrer | boolean |
Se o referenciador deve ser ocultado do site de destino. |
|
Data de vencimento
|
expiry_datetime | string |
Quando o link parar de funcionar, no formato ISO 8601. |
|
Destino de expiração
|
expiry_destination | uri |
A URL para a qual redirecionar depois que o link expirar. Deixe em branco para retornar uma página não encontrada. |
|
X Pixel ID
|
twitter_pixel_id | string |
A ID do Pixel X (Twitter) a ser disparada quando o link for clicado. |
|
Cloaking
|
cloaking | boolean |
Se deseja ocultar o destino abrindo-o dentro de um quadro. |
|
URL encurtada
|
full_url | uri |
A URL de link curto completa. |
|
Abrir descrição do Grafo
|
og_description | string |
A descrição mostrada quando o link é compartilhado nas redes sociais. |
|
Ignorar o rastreamento de rastreamento social
|
skip_social_crawler_tracking | boolean |
Se os rastreadores de visualização de mídia social devem ser excluídos do rastreamento de cliques. |
|
Marcas de corpo
|
body_tags | string |
HTML personalizado ou marcas de acompanhamento inseridas no corpo da página de redirecionamento. |
|
Abrir Título do Graph
|
og_title | string |
O título mostrado quando o link é compartilhado nas redes sociais. |
|
Note
|
note | string |
Uma nota privada sobre o link. |
|
Name
|
name | string |
Um apelido para o link, mostrado no painel. |
|
Link ID
|
id | integer |
A ID de um link existente a ser atualizado. Deixe em branco para criar um novo link. |
|
Google Tag Manager ID
|
gtm_id | string |
A ID do contêiner do Google Tag Manager a ser carregada quando o link for clicado. |
|
Abrir Imagem do Graph
|
og_image | string |
A URL da imagem mostrada quando o link é compartilhado nas mídias sociais. |
|
Bloquear Bots
|
block_bots | boolean |
Se os bots conhecidos devem ser bloqueados após o link. |
|
Snapchat Pixel ID
|
snapchat_pixel_id | string |
A ID do Pixel do Snapchat a ser acionada quando o link for clicado. |
|
Conteúdo UTM
|
utm_content | string |
O parâmetro utm_content acrescentado à URL de destino. |
|
Enabled
|
enabled | boolean |
Se o link está ativo. |
|
URL de Destino
|
url | uri |
A URL de destino para a qual o link curto redireciona. Necessário para criar um novo link. |
|
Excluída
|
deleted | boolean |
Se o link está no lixo. |
|
Webhooks
|
webhooks | array of string |
As URLs do webhook assinadas para cliques neste link. |
|
Cliques de Expiração
|
expiry_clicks | integer |
O número de cliques após o qual o link para de funcionar. |
|
Notificar o Slack
|
notify_slack | boolean |
Se deseja enviar uma notificação do Slack quando o link é clicado. |
|
ID do espaço de trabalho
|
workspace_id | integer |
A ID do workspace |
|
Análise Pública
|
public_analytics | boolean |
Se a página de análise do link é publicamente acessível. |
|
ID da marca do Pinterest
|
pinterest_tag_id | string |
A ID da Marca do Pinterest a ser disparada quando o link é clicado. |
|
Origem UTM
|
utm_source | string |
O parâmetro utm_source acrescentado à URL de destino. |
|
Slug
|
slug | string |
Um caminho personalizado para o link curto. Deve começar com uma barra. |
|
Domínio
|
domain | string |
O domínio personalizado a ser usado para o link curto, sem uma barra à direita. |
|
Encaminhar parâmetros
|
forward_params | boolean |
Se os parâmetros de consulta devem ser encaminhados do link curto para o destino. |
|
Médio UTM
|
utm_medium | string |
O parâmetro utm_medium acrescentado à URL de destino. |
|
Marcas de cabeçalho
|
head_tags | string |
HTML personalizado ou marcas de acompanhamento inseridas no cabeçalho da página de redirecionamento. |
|
ID da marca do Google Analytics 4
|
ga4_tag_id | string |
A ID de medida do Google Analytics 4 a ser disparada quando o link é clicado. |
|
Termo UTM
|
utm_term | string |
O parâmetro utm_term acrescentado à URL de destino. |
|
Campanha UTM
|
utm_campaign | string |
O parâmetro utm_campaign acrescentado à URL de destino. |
Excluir um link
Move um link para o lixo. Sua URL curta interrompe o redirecionamento e o link pode ser restaurado posteriormente do lixo.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Workspace
|
workspace_id | True | string |
O workspace no qual trabalhar. Escolha-o na lista ou insira sua ID. |
|
Link ID
|
id | True | integer |
A ID do link. |
Retornos
Uma mensagem de confirmação.
- response
- string
Listar conversões
Retorna as conversões mais recentes registradas no workspace.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Limit
|
limit | integer |
O número máximo de conversões a serem retornadas, entre 1 e 1000. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Conversions
|
conversions | array of object |
As conversões, as mais recentes primeiro. |
|
Valor (Centavos)
|
conversions.amount_cents | integer |
O valor na menor unidade de moeda. Pode ser negativo registrar um reembolso. |
|
ID do Clique
|
conversions.click_id | string |
A ID do clique atribuído. |
|
Country
|
conversions.country | string |
Um código de país ISO 3166-1 de duas letras, por exemplo, EUA. |
|
Moeda
|
conversions.currency | string |
O código de moeda ISO 4217. O padrão é USD. |
|
ID do evento
|
conversions.event_id | string |
Seu identificador para o evento. Relatar o mesmo valor duas vezes não cria uma segunda conversão. |
|
Nome do evento
|
conversions.event_name | string |
O que aconteceu, por exemplo, compra, inscrição ou trial_started. |
|
Tipo de evento
|
conversions.event_type | string |
O tipo de evento grosseiro. Use o lead para estabelecer a identidade e a venda do cliente para registrar a receita. O padrão é personalizado. |
|
ID do Cliente
|
conversions.external_id | string |
Seu identificador para o cliente. Envie-o em todos os eventos para que as vendas posteriores possam ser vinculadas ao clique original. |
|
ID de conversão
|
conversions.id | string |
O identificador exclusivo da conversão. As IDs são classificadas cronologicamente. |
|
Inserido em
|
conversions.inserted_at | date-time |
Quando a conversão foi registrada. |
|
Origem do IP
|
conversions.ip_source | string |
Cujo endereço foi registrado: visitante, servidor ou desconhecido. O servidor significa que o endereço de conexão pertencia ao back-end ou a uma retransmissão de plataforma, portanto, ele é excluído dos relatórios geográficos. |
|
Link ID
|
conversions.link_id | integer |
A ID do link atribuído ou nula se a conversão não puder ser atribuída a um link. |
|
Metadata
|
conversions.metadata | object |
Metadados JSON arbitrários, até 10.000 bytes. |
|
Ocorreu em
|
conversions.occurred_at | date-time |
Quando a conversão aconteceu, no formato ISO 8601. O valor padrão é o momento atual. |
|
Source
|
conversions.source | string |
Qual integração o relatou. |
Listar domínios personalizados
Retorna os domínios personalizados configurados para um workspace. Esses nomes de domínio podem ser usados ao criar links.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Workspace
|
workspace_id | True | string |
O workspace no qual trabalhar. Escolha-o na lista ou insira sua ID. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Domains
|
domains | array of object |
Os domínios personalizados no workspace. |
|
Nome de domínio
|
domains.name | string |
O nome de domínio, por exemplo, go.yourcompany.com. |
Listar links
Retorna uma lista paginada dos links em um workspace, com estatísticas de clique. Dá suporte à pesquisa e à classificação.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Workspace
|
workspace_id | True | string |
O workspace no qual trabalhar. Escolha-o na lista ou insira sua ID. |
|
Pesquisa
|
search | string |
Um termo de pesquisa para filtrar links por nome, URL ou lesma. |
|
|
Página
|
page | integer |
O número da página a ser retornado, começando em 1. |
|
|
Tamanho da Página
|
page_size | integer |
O número de links a serem retornados por página. |
|
|
Classificar por
|
sort_by | string |
O campo a ser classificado por, por exemplo, clicks_total, nome ou inserted_at. |
|
|
Direção da Ordenação
|
sort_dir | string |
A direção de classificação, seja asc ou desc. |
|
|
Excluída
|
deleted | boolean |
Se deseja retornar links que estão no lixo em vez de links ativos. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Links
|
links | array of object |
Os links nesta página. |
|
Meta Pixel ID
|
links.fb_pixel_id | string |
A ID de Pixel do Meta (Facebook) a ser acionada quando o link for clicado. |
|
Total de Cliques Humanos
|
links.human_clicks_total | integer |
Cliques de tempo de vida sem sinal de bot; o subconjunto de clicks_total em que nem um agente de usuário de bot nem uma categoria de bot verificado foram detectados. Gravado a partir de 2019. |
|
Cliques (30 dias)
|
links.clicks_thirty_days | integer |
Cliques nos últimos 30 dias, incluindo o tráfego de bot. |
|
TikTok Pixel ID
|
links.tiktok_pixel_id | string |
A ID do Pixel TikTok a ser disparada quando o link for clicado. |
|
Ocultar Referenciador
|
links.hide_referrer | boolean |
Se o referenciador deve ser ocultado do site de destino. |
|
Cloaking
|
links.cloaking | boolean |
Se deseja ocultar o destino abrindo-o dentro de um quadro. |
|
URL encurtada
|
links.full_url | uri |
A URL de link curto completa. |
|
Cliques hoje
|
links.clicks_today | integer |
Cliques até agora hoje (UTC), incluindo o tráfego de bot. |
|
Abrir descrição do Grafo
|
links.og_description | string |
A descrição mostrada quando o link é compartilhado nas redes sociais. |
|
Marcas de corpo
|
links.body_tags | string |
HTML personalizado ou marcas de acompanhamento inseridas no corpo da página de redirecionamento. |
|
Abrir Título do Graph
|
links.og_title | string |
O título mostrado quando o link é compartilhado nas redes sociais. |
|
Note
|
links.note | string |
Uma nota privada sobre o link. |
|
Name
|
links.name | string |
Um apelido para o link, mostrado no painel. |
|
Link ID
|
links.id | integer |
O identificador exclusivo do link. |
|
Google Tag Manager ID
|
links.gtm_id | string |
A ID do contêiner do Google Tag Manager a ser carregada quando o link for clicado. |
|
Abrir Imagem do Graph
|
links.og_image | string |
A URL da imagem mostrada quando o link é compartilhado nas mídias sociais. |
|
Bloquear Bots
|
links.block_bots | boolean |
Se os bots conhecidos devem ser bloqueados após o link. |
|
Total de cliques
|
links.clicks_total | integer |
Cliques de tempo de vida, incluindo o tráfego de bot. |
|
Cliques humanos (30 dias)
|
links.human_clicks_thirty_days | integer |
Clique nos últimos 30 dias sem sinal de bot; o subconjunto de clicks_thirty_days. |
|
Conteúdo UTM
|
links.utm_content | string |
O parâmetro utm_content acrescentado à URL de destino. |
|
Cliques humanos hoje
|
links.human_clicks_today | integer |
Clica até hoje (UTC) sem sinal de bot. |
|
Enabled
|
links.enabled | boolean |
Se o link está ativo. |
|
URL de Destino
|
links.url | uri |
A URL de destino para a qual o link curto redireciona. |
|
Excluída
|
links.deleted | boolean |
Se o link está no lixo. |
|
ID do espaço de trabalho
|
links.workspace_id | integer |
A ID do workspace |
|
Análise Pública
|
links.public_analytics | boolean |
Se a página de análise do link é publicamente acessível. |
|
Origem UTM
|
links.utm_source | string |
O parâmetro utm_source acrescentado à URL de destino. |
|
Slug
|
links.slug | string |
Um caminho personalizado para o link curto. Deve começar com uma barra. |
|
Domínio
|
links.domain | string |
O domínio personalizado a ser usado para o link curto, sem uma barra à direita. |
|
Encaminhar parâmetros
|
links.forward_params | boolean |
Se os parâmetros de consulta devem ser encaminhados do link curto para o destino. |
|
Médio UTM
|
links.utm_medium | string |
O parâmetro utm_medium acrescentado à URL de destino. |
|
Marcas de cabeçalho
|
links.head_tags | string |
HTML personalizado ou marcas de acompanhamento inseridas no cabeçalho da página de redirecionamento. |
|
ID da marca do Google Analytics 4
|
links.ga4_tag_id | string |
A ID de medida do Google Analytics 4 a ser disparada quando o link é clicado. |
|
Termo UTM
|
links.utm_term | string |
O parâmetro utm_term acrescentado à URL de destino. |
|
Campanha UTM
|
links.utm_campaign | string |
O parâmetro utm_campaign acrescentado à URL de destino. |
|
Cliques humanos ontem
|
links.human_clicks_previous_day | integer |
Clica ontem (UTC) sem sinal de bot. |
|
Número da Página
|
page_number | integer |
O número da página atual. |
|
Tamanho da Página
|
page_size | integer |
O número de links a serem retornados por página. |
|
Total de Entradas
|
total_entries | integer |
O número total de links correspondentes à solicitação. |
|
Total de Páginas
|
total_pages | integer |
O número total de páginas disponíveis. |
|
Linhas de totalização
|
total_rows | integer |
O número total de linhas. |
|
Contagem de vínculos do workspace
|
workspace_link_count | integer |
O número total de links no workspace. |
Listar workspaces
Retorna os workspaces disponíveis para essa conexão. Use-o para localizar o workspace que outras ações exigem.
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
|
array of object | ||
|
ID do espaço de trabalho
|
id | integer |
O identificador exclusivo do workspace. |
|
Nome do espaço de trabalho
|
name | string |
O nome do espaço de trabalho. |
Obter análise de cliques
Retorna contagens de cliques ao longo do tempo para um workspace ou para links específicos, opcionalmente filtrados por intervalo de datas, país, navegador, plataforma, referenciador ou ISP.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Workspace
|
workspace_id | True | string |
O workspace no qual trabalhar. Escolha-o na lista ou insira sua ID. |
|
Link ID
|
link_id | string |
A ID de um único link para filtrar. |
|
|
Link IDs
|
link_ids | string |
Uma lista separada por hífen de IDs de link para filtrar. |
|
|
Data de Início
|
start | string |
O início do intervalo de datas, no formato YYYY-MM-DD. |
|
|
Data de término
|
end | string |
O fim do intervalo de datas, no formato YYYY-MM-DD. |
|
|
Country
|
country | string |
Um código de país ISO 3166-1 de duas letras, por exemplo, EUA. |
|
|
Navegador
|
browser | string |
Um nome de navegador pelo qual filtrar, por exemplo, Chrome, Firefox ou Safari. |
|
|
Platform
|
platform | string |
Uma plataforma ou sistema operacional para filtrar, por exemplo, Windows, Mac, iOS ou Android. |
|
|
Referenciador
|
referer | string |
Um domínio de referência pelo qual filtrar. |
|
|
ISP
|
isp | string |
Um nome de provedor de serviços de Internet pelo qual filtrar. |
|
|
Incluir Bots
|
bots | boolean |
Se deseja incluir cliques identificados como bots. Defina como false para excluí-los. |
|
|
Somente Exclusivo
|
unique | boolean |
Se deve contar somente cliques exclusivos. |
|
|
Fuso horário
|
timezone | string |
O fuso horário IANA usado para cálculos de data, por exemplo, Europa/Londres. |
|
|
Frequência
|
frequency | string |
A granularidade da série temporal, dia ou hora. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Traffic
|
traffic | array of object |
O clique conta ao longo do tempo. |
|
Início do bucket
|
traffic.t | string |
O início do bucket: YYYY-MM-DD para buckets diários ou YYYY-MM-DDTHH:MM:SS para buckets por hora. |
|
Cliques
|
traffic.y | integer |
O número de cliques no bucket. |
Obter contagens de cliques por dimensão
Retorna contagens de clique agrupadas por uma dimensão, como país, cidade, plataforma, referenciador ou parâmetro UTM, ordenadas pela contagem decrescente.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Workspace
|
workspace_id | True | string |
O workspace no qual trabalhar. Escolha-o na lista ou insira sua ID. |
|
Dimensão
|
counter | True | string |
A dimensão para agrupar cliques por, por exemplo, país, cidade, plataforma, referenciador ou utm_campaign. |
|
Link ID
|
link_id | string |
A ID de um único link para filtrar. |
|
|
Link IDs
|
link_ids | string |
Uma lista separada por hífen de IDs de link para filtrar. |
|
|
Data de Início
|
start | string |
O início do intervalo de datas, no formato YYYY-MM-DD. |
|
|
Data de término
|
end | string |
O fim do intervalo de datas, no formato YYYY-MM-DD. |
|
|
Country
|
country | string |
Um código de país ISO 3166-1 de duas letras, por exemplo, EUA. |
|
|
Incluir Bots
|
bots | boolean |
Se deseja incluir cliques identificados como bots. Defina como false para excluí-los. |
|
|
Somente Exclusivo
|
unique | boolean |
Se deve contar somente cliques exclusivos. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Total
|
total | integer |
Total de cliques em todos os grupos, incluindo qualquer não retornado em valores. Quando o resultado é truncado, isso é maior que a soma da contagem em valores, portanto, a contagem/total ainda fornece uma porcentagem precisa. |
|
Values
|
values | array of object |
Contagens agrupadas, ordenadas por contagem decrescente. Truncado para os 10.000 principais valores; se a dimensão tiver valores mais distintos do que isso, o restante não será retornado. |
|
Contagem
|
values.count | integer |
O número de cliques para esse valor. |
|
Value
|
values.value | string |
O valor da dimensão, por exemplo, um código de país. |
Obter um link
Recupera um único link por sua ID, incluindo seu destino, URL curta e configuração.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Link ID
|
id | True | string |
A ID do link. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Meta Pixel ID
|
fb_pixel_id | string |
A ID de Pixel do Meta (Facebook) a ser acionada quando o link for clicado. |
|
ID do parceiro LinkedIn
|
linkedin_partner_id | string |
A ID do parceiro LinkedIn Insight Tag a ser disparada quando o link for clicado. |
|
Microsoft ID da marca UET
|
microsoft_uet_tag_id | string |
O Microsoft Advertising ID da marca UET a ser disparada quando o link for clicado. |
|
Reddit Pixel ID
|
reddit_pixel_id | string |
A ID do Pixel do Reddit a ser acionada quando o link for clicado. |
|
TikTok Pixel ID
|
tiktok_pixel_id | string |
A ID do Pixel TikTok a ser disparada quando o link for clicado. |
|
Ocultar Referenciador
|
hide_referrer | boolean |
Se o referenciador deve ser ocultado do site de destino. |
|
Data de vencimento
|
expiry_datetime | string |
Quando o link parar de funcionar, no formato ISO 8601. |
|
Destino de expiração
|
expiry_destination | uri |
A URL para a qual redirecionar depois que o link expirar. Deixe em branco para retornar uma página não encontrada. |
|
X Pixel ID
|
twitter_pixel_id | string |
A ID do Pixel X (Twitter) a ser disparada quando o link for clicado. |
|
Cloaking
|
cloaking | boolean |
Se deseja ocultar o destino abrindo-o dentro de um quadro. |
|
URL encurtada
|
full_url | uri |
A URL de link curto completa. |
|
Abrir descrição do Grafo
|
og_description | string |
A descrição mostrada quando o link é compartilhado nas redes sociais. |
|
Ignorar o rastreamento de rastreamento social
|
skip_social_crawler_tracking | boolean |
Se os rastreadores de visualização de mídia social devem ser excluídos do rastreamento de cliques. |
|
Marcas de corpo
|
body_tags | string |
HTML personalizado ou marcas de acompanhamento inseridas no corpo da página de redirecionamento. |
|
Abrir Título do Graph
|
og_title | string |
O título mostrado quando o link é compartilhado nas redes sociais. |
|
Note
|
note | string |
Uma nota privada sobre o link. |
|
Name
|
name | string |
Um apelido para o link, mostrado no painel. |
|
Link ID
|
id | integer |
O identificador exclusivo do link. |
|
Google Tag Manager ID
|
gtm_id | string |
A ID do contêiner do Google Tag Manager a ser carregada quando o link for clicado. |
|
Abrir Imagem do Graph
|
og_image | string |
A URL da imagem mostrada quando o link é compartilhado nas mídias sociais. |
|
Bloquear Bots
|
block_bots | boolean |
Se os bots conhecidos devem ser bloqueados após o link. |
|
Snapchat Pixel ID
|
snapchat_pixel_id | string |
A ID do Pixel do Snapchat a ser acionada quando o link for clicado. |
|
Conteúdo UTM
|
utm_content | string |
O parâmetro utm_content acrescentado à URL de destino. |
|
Enabled
|
enabled | boolean |
Se o link está ativo. |
|
URL de Destino
|
url | uri |
A URL de destino para a qual o link curto redireciona. |
|
Excluída
|
deleted | boolean |
Se o link está no lixo. |
|
Webhooks
|
webhooks | array of string |
As URLs do webhook assinadas para cliques neste link. |
|
Cliques de Expiração
|
expiry_clicks | integer |
O número de cliques após o qual o link para de funcionar. |
|
Notificar o Slack
|
notify_slack | boolean |
Se deseja enviar uma notificação do Slack quando o link é clicado. |
|
ID do espaço de trabalho
|
workspace_id | integer |
A ID do workspace |
|
Análise Pública
|
public_analytics | boolean |
Se a página de análise do link é publicamente acessível. |
|
ID da marca do Pinterest
|
pinterest_tag_id | string |
A ID da Marca do Pinterest a ser disparada quando o link é clicado. |
|
Origem UTM
|
utm_source | string |
O parâmetro utm_source acrescentado à URL de destino. |
|
Slug
|
slug | string |
Um caminho personalizado para o link curto. Deve começar com uma barra. |
|
Domínio
|
domain | string |
O domínio personalizado a ser usado para o link curto, sem uma barra à direita. |
|
Encaminhar parâmetros
|
forward_params | boolean |
Se os parâmetros de consulta devem ser encaminhados do link curto para o destino. |
|
Médio UTM
|
utm_medium | string |
O parâmetro utm_medium acrescentado à URL de destino. |
|
Marcas de cabeçalho
|
head_tags | string |
HTML personalizado ou marcas de acompanhamento inseridas no cabeçalho da página de redirecionamento. |
|
ID da marca do Google Analytics 4
|
ga4_tag_id | string |
A ID de medida do Google Analytics 4 a ser disparada quando o link é clicado. |
|
Termo UTM
|
utm_term | string |
O parâmetro utm_term acrescentado à URL de destino. |
|
Campanha UTM
|
utm_campaign | string |
O parâmetro utm_campaign acrescentado à URL de destino. |
Relatar uma conversão
Registra uma conversão, como uma compra, uma inscrição ou um evento personalizado, e atribui-a ao link que foi clicado quando um token de atribuição é fornecido.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Valor (Centavos)
|
amount_cents | integer |
Valor na menor unidade de moeda. Pode ser negativo registrar um reembolso ou um chargeback, que é líquido em relação à receita anterior. |
|
|
Country
|
country | string |
Código de país de duas letras para a conversão. Inferido para chamadas do lado do navegador; forneça-o explicitamente a partir de uma integração do lado do servidor, em que o endereço de conexão é sua própria infraestrutura, em vez da do cliente. |
|
|
Moeda
|
currency | string |
Código de moeda ISO 4217. O padrão é USD. |
|
|
ID do evento
|
event_id | string |
Seu identificador para este evento. Usado como uma chave de idempotency; relatar o mesmo valor duas vezes não criará uma segunda conversão. Aplica-se a qualquer tipo de evento, não apenas a compras. |
|
|
Nome do evento
|
event_name | True | string |
O que aconteceu, por exemplo, compra, inscrição, trial_started. |
|
Tipo de evento
|
event_type | string |
Tipo grosseiro que conduz o funil. O lead estabelece a identidade do cliente, a receita de registros de venda. O padrão é personalizado. |
|
|
ID do Cliente
|
external_id | string |
Seu identificador para o cliente. Envie-o em todos os eventos: é o que vincula uma venda posterior do lado do servidor ao clique que produziu a inscrição. |
|
|
Token de atribuição
|
linkly_cid | string |
O token de atribuição capturado da URL da página de aterrissagem. Omita se não estiver disponível; a conversão é então gravada sem uma atribuição de link. |
|
|
Metadata
|
metadata | object |
JSON arbitrário, até 10.000 bytes codificados. |
|
|
Ocorreu em
|
occurred_at | date-time |
Quando a conversão aconteceu. O valor padrão é o momento atual. |
|
|
IP do visitante
|
visitor_ip | string |
O IP do cliente final, quando o servidor o tem. Omita, a menos que você o faça; para chamadas do lado do servidor, Linkly, caso contrário, registra o endereço de conexão como seu servidor, não o cliente e o exclui de relatórios geográficos. Enviar isso afirma que você tem uma base legal para compartilhá-la. Nunca retornado pela API. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Valor (Centavos)
|
amount_cents | integer |
O valor na menor unidade de moeda. Pode ser negativo registrar um reembolso. |
|
ID do Clique
|
click_id | string |
A ID do clique atribuído. |
|
Country
|
country | string |
Um código de país ISO 3166-1 de duas letras, por exemplo, EUA. |
|
Moeda
|
currency | string |
O código de moeda ISO 4217. O padrão é USD. |
|
ID do evento
|
event_id | string |
Seu identificador para o evento. Relatar o mesmo valor duas vezes não cria uma segunda conversão. |
|
Nome do evento
|
event_name | string |
O que aconteceu, por exemplo, compra, inscrição ou trial_started. |
|
Tipo de evento
|
event_type | string |
O tipo de evento grosseiro. Use o lead para estabelecer a identidade e a venda do cliente para registrar a receita. O padrão é personalizado. |
|
ID do Cliente
|
external_id | string |
Seu identificador para o cliente. Envie-o em todos os eventos para que as vendas posteriores possam ser vinculadas ao clique original. |
|
ID de conversão
|
id | string |
O identificador exclusivo da conversão. As IDs são classificadas cronologicamente. |
|
Inserido em
|
inserted_at | date-time |
Quando a conversão foi registrada. |
|
Origem do IP
|
ip_source | string |
Cujo endereço foi registrado: visitante, servidor ou desconhecido. O servidor significa que o endereço de conexão pertencia ao back-end ou a uma retransmissão de plataforma, portanto, ele é excluído dos relatórios geográficos. |
|
Link ID
|
link_id | integer |
A ID do link atribuído ou nula se a conversão não puder ser atribuída a um link. |
|
Metadata
|
metadata | object |
Metadados JSON arbitrários, até 10.000 bytes. |
|
Ocorreu em
|
occurred_at | date-time |
Quando a conversão aconteceu, no formato ISO 8601. O valor padrão é o momento atual. |
|
Source
|
source | string |
Qual integração o relatou. |
Definições
cadeia
Esse é o tipo de dados básico 'string'.