Linkly (Pré-visualização)
Linkly é um encurtador de links e um rastreador de cliques. Crie links curtos de marca com domínios personalizados, adicione parâmetros UTM e pixels de retargeting, reporte conversões e faça análises de pull click agrupadas por país, plataforma, referenciador ou campanha.
Este conector está disponível nos seguintes produtos e regiões:
| Serviço | Class | Regions |
|---|---|---|
| Estúdio Copiloto | Premium | Todas as regiões Power Automate exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Aplicações Lógicas | Standard | Todas as regiões do Logic Apps , exceto as seguintes: - Regiões Azure Government - 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 (CCG) - 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 (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Entrar em contato | |
|---|---|
| Name | Suporte Linkly |
| URL | https://linklyhq.com/support |
| support@linklyhq.com |
| Metadados do conector | |
|---|---|
| Publisher | Linkly |
| Sítio Web | https://linklyhq.com |
| Política de privacidade | https://linklyhq.com/support/privacy |
| Categorias | Marketing; Sítio Web |
Linkly
Linkly é um encurtador de links e um rastreador de cliques. Cria links curtos com marca no seu próprio domínio, regista cada clique com países, plataformas e falhas de referenciadores, dispara pixels de retargeting e regista conversões de volta para o link que os produziu. Este conector permite que fluxos criem e geram links, pull-click analytics e reportem conversões num espaço de trabalho Linkly.
Publisher: Linkly
Prerequisites
Uma conta Linkly . O plano gratuito é suficiente para usar todas as ações deste conector. Reportar e listar conversões também requer que a funcionalidade de acompanhamento de conversões do Linkly esteja ativada no espaço de trabalho.
Operações suportadas
Listar espaços de trabalho
Devolve os espaços de trabalho disponíveis a esta ligação. Usa-o para encontrar o espaço de trabalho que outras ações exigem.
Crie ou atualize um link
Cria um novo link curto, ou atualiza um existente quando é fornecido um link ID. Suporta domínios e slugs personalizados, parâmetros UTM, retargeting pixels e metadados Open Graph.
Obter uma ligação
Recupera um único link pelo seu ID, incluindo o destino, URL curto e configuração.
Ligações da lista
Devolve uma lista paginada dos links num espaço de trabalho, com estatísticas de cliques. Suporta pesquisa e ordenação.
Eliminar uma ligação
Move um link para o lixo. O seu URL curto deixa de redirecionar, e o link pode ser restaurado mais tarde a partir do lixo.
Obtenha análises de cliques
Devolve a contagem de cliques ao longo do tempo para um espaço de trabalho ou para links específicos, opcionalmente filtrados por intervalo de datas, país, navegador, plataforma, referente ou ISP.
Obtenha a contagem de cliques por dimensão
Devolve contagens de cliques agrupadas por uma dimensão como país, cidade, plataforma, referente ou parâmetro UTM, ordenadas por contagem descendente.
Listar domínios personalizados
Devolve os domínios personalizados configurados para um espaço de trabalho. Estes nomes de domínio podem ser usados na criação de links.
Reporte uma conversão
Regista uma conversão, como uma compra, inscrição ou evento personalizado, e atribui-a ao link que foi clicado quando um token de atribuição é fornecido.
Conversões de lista
Devolve as conversões mais recentes registadas no espaço de trabalho.
Obtenção de credenciais
Este conector utiliza OAuth 2.0. Não é necessária nenhuma chave API.
- Se ainda não tem uma conta Linkly, inscreva-se em https://linklyhq.com. O plano gratuito funciona.
- Quando criar uma ligação, escolha Iniciar sessão com o Linkly e iniciar sessão com a sua conta Linkly.
- Escolhe o espaço de trabalho que esta ligação deve usar quando solicitado, depois aprova o pedido.
A ligação está ligada ao espaço de trabalho que escolheu. Para trabalhar noutro espaço de trabalho, cria uma segunda ligação.
Introdução
- Crie uma ligação como descrito acima.
- Adicione a ação Criar ou atualizar um link a um fluxo, introduza o URL de destino e, opcionalmente, um domínio personalizado e um slug. A ação devolve o URL curto e o ID do link.
- Use links de lista, obtenha análises de cliques ou obtenha contagens de cliques por dimensão para ler dados de cliques. As ações que ocupam um Workspace permitem-te escolhê-lo de uma lista, que é preenchida por workspaces de lista.
- Para atribuir compras ou registos a links, passe o
linkly_cidvalor do URL da sua página de destino para Reportar uma conversão como token de atribuição.
Problemas conhecidos e limitações
- Uma ligação está ligada a um único espaço de trabalho Linkly, aquele escolhido ao iniciar sessão. Crie uma ligação por espaço de trabalho.
- Reportar uma conversão e Listar as conversões requerem a funcionalidade de rastreamento de conversões do Linkly. Os espaços de trabalho sem isso recebem um erro destas ações.
- Webhooks de clique em tempo real não são expostos como gatilhos. Use a funcionalidade webhook do Linkly com um fluxo ativado por HTTP em vez disso.
- A criação em massa de links, exportação de links e gestão de domínios estão disponíveis na API Linkly, mas não estão incluídos neste conector.
- A API tem taxa limitada. Obter contagens de cliques por dimensão devolve um erro de limite de taxa quando o limite é ultrapassado; tente novamente após um pequeno atraso.
Perguntas Mais Frequentes
Em que espaço de trabalho são executadas as minhas ações?
As ações que utilizam um parâmetro de Espaço de Trabalho mostram uma lista dos espaços de trabalho disponíveis para a ligação. Ações sem ele, como Obter um link, Reportar uma conversão e Listar conversões, usam o espaço de trabalho vinculado à ligação.
Como uso um domínio personalizado?
Adicione primeiro o domínio no Linkly, depois passe o nome no campo Domíniode Criar ou atualize um link. A lista de domínios personalizados devolve os nomes disponíveis num espaço de trabalho.
Eliminar um link remove o link permanentemente?
No. O link é movido para o lixo e deixa de redirecionar. Pode ser restaurado a partir do lixo no Linkly.
Instruções de implantação
- No portal maker, abra conectores personalizados, escolha Novo conector personalizado e depois Importe um ficheiro OpenAPI. Selecione
apiDefinition.swagger.json. - No separador Security , escolha OAuth 2.0 com o fornecedor de identidade Generic Oauth 2 . Introduza o ID do cliente e o secret do cliente emitidos pelo Linkly, defina o URL de autorização para
https://app.linklyhq.com/oauth/authorize, e defina tanto o URL do token como o URL de atualização parahttps://app.linklyhq.com/oauth/token. - Crie o conector, depois copie o URL de redirecionamento mostrado no separador Segurança e registe-o no Linkly para esse ID de cliente.
- Crie uma ligação iniciando sessão com a sua conta Linkly e depois teste uma ação como Listar espaços de trabalho.
Ações
| Conversões de lista |
Devolve as conversões mais recentes registadas no espaço de trabalho. |
| Crie ou atualize um link |
Cria um novo link curto, ou atualiza um existente quando é fornecido um link ID. Suporta domínios e slugs personalizados, parâmetros UTM, retargeting pixels e metadados Open Graph. |
| Eliminar uma ligação |
Move um link para o lixo. O seu URL curto deixa de redirecionar, e o link pode ser restaurado mais tarde a partir do lixo. |
| Ligações da lista |
Devolve uma lista paginada dos links num espaço de trabalho, com estatísticas de cliques. Suporta pesquisa e ordenação. |
| Listar domínios personalizados |
Devolve os domínios personalizados configurados para um espaço de trabalho. Estes nomes de domínio podem ser usados na criação de links. |
| Listar espaços de trabalho |
Devolve os espaços de trabalho disponíveis a esta ligação. Usa-o para encontrar o espaço de trabalho que outras ações exigem. |
| Obtenha a contagem de cliques por dimensão |
Devolve contagens de cliques agrupadas por uma dimensão como país, cidade, plataforma, referente ou parâmetro UTM, ordenadas por contagem descendente. |
| Obtenha análises de cliques |
Devolve a contagem de cliques ao longo do tempo para um espaço de trabalho ou para links específicos, opcionalmente filtrados por intervalo de datas, país, navegador, plataforma, referente ou ISP. |
| Obter uma ligação |
Recupera um único link pelo seu ID, incluindo o destino, URL curto e configuração. |
| Reporte uma conversão |
Regista uma conversão, como uma compra, inscrição ou evento personalizado, e atribui-a ao link que foi clicado quando um token de atribuição é fornecido. |
Conversões de lista
Devolve as conversões mais recentes registadas no espaço de trabalho.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Descrição |
|---|---|---|---|---|
|
Limit
|
limit | integer |
O número máximo de conversões a devolver, entre 1 e 1000. |
Devoluções
| Nome | Caminho | Tipo | Descrição |
|---|---|---|---|
|
Conversions
|
conversions | array of object |
As conversões, a mais recente, primeiro. |
|
Quantia (Cêntimos)
|
conversions.amount_cents | integer |
O valor na menor unidade monetária. Pode ser negativo para registar um reembolso. |
|
Clique em ID
|
conversions.click_id | string |
O ID do clique atribuído. |
|
País
|
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. Por defeito, é USD. |
|
ID do Evento
|
conversions.event_id | string |
O seu identificador para o evento. Reportar o mesmo valor duas vezes não cria uma segunda conversão. |
|
Nome do evento
|
conversions.event_name | string |
O que aconteceu, por exemplo, comprar, inscrever-se ou trial_started. |
|
Tipo de Evento
|
conversions.event_type | string |
Do tipo de evento grosseiro. Use o lead para estabelecer a identidade do cliente e a venda para registar receitas. Por defeito, é personalizado. |
|
ID do Cliente
|
conversions.external_id | string |
O seu identificador para o cliente. Envie-o em todos os eventos para que as vendas posteriores possam ser associadas ao clique original. |
|
ID de conversão
|
conversions.id | string |
O identificador único da conversão. Os IDs ordenam-se cronologicamente. |
|
Inserido em
|
conversions.inserted_at | date-time |
Quando a conversão foi registada. |
|
Fonte IP
|
conversions.ip_source | string |
Cuja morada foi registada: visitante, servidor ou desconhecida. Server significa que o endereço de ligação pertencia ao seu backend ou a um relé de plataforma, por isso está excluído do relatório geográfico. |
|
Link ID
|
conversions.link_id | integer |
O ID do link atribuído, ou nulo se a conversão não pudesse 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, em formato ISO 8601. Por padrão, define-se para o momento atual. |
|
Source
|
conversions.source | string |
Que integração reportou isso. |
Crie ou atualize um link
Cria um novo link curto, ou atualiza um existente quando é fornecido um link ID. Suporta domínios e slugs personalizados, parâmetros UTM, retargeting pixels e metadados Open Graph.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Descrição |
|---|---|---|---|---|
|
URL de destino
|
url | uri |
O URL de destino para onde o link curto redireciona. É necessário criar um novo link. |
|
|
Link ID
|
id | integer |
O ID de um link existente para atualizar. Deixe em branco para criar um novo link. |
|
|
Name
|
name | string |
Um apelido para o link, mostrado no painel de controlo. |
|
|
Domain
|
domain | string |
O domínio personalizado para usar na ligação curta, sem barra final. |
|
|
slug
|
slug | string |
Um caminho personalizado para a ligação curta. Tem de começar com uma barra. |
|
|
Ativado
|
enabled | boolean |
Se a ligação está ativa. |
|
|
Note
|
note | string |
Uma nota privada sobre a ligação. |
|
|
Fonte UTM
|
utm_source | string |
O parâmetro utm_source adicionado à URL de destino. |
|
|
UTM Médio
|
utm_medium | string |
O parâmetro utm_medium adicionado à URL de destino. |
|
|
Campanha UTM
|
utm_campaign | string |
O parâmetro utm_campaign adicionado à URL de destino. |
|
|
Conteúdo UTM
|
utm_content | string |
O parâmetro utm_content adicionado à URL de destino. |
|
|
Termo UTM
|
utm_term | string |
O parâmetro utm_term adicionado à URL de destino. |
|
|
Meta Pixel ID
|
fb_pixel_id | string |
O Meta (Facebook) Pixel ID para disparar quando o link é clicado. |
|
|
ID de Etiqueta do Google Analytics 4
|
ga4_tag_id | string |
O ID de medição do Google Analytics 4 para disparar quando o link é clicado. |
|
|
ID do Gestor de Etiquetas do Google
|
gtm_id | string |
O ID do contentor do Google Tag Manager para carregar quando o link é clicado. |
|
|
Block Bots
|
block_bots | boolean |
Se deve bloquear bots conhecidos de seguirem a ligação. |
|
|
Etiquetas do Corpo
|
body_tags | string |
Etiquetas HTML personalizadas ou de rastreio inseridas no corpo da página de redirecionamento. |
|
|
Camuflagem
|
cloaking | boolean |
Se deve esconder o destino abrindo-o dentro de uma moldura. |
|
|
Parâmetros Futuros
|
forward_params | boolean |
Se deve encaminhar os parâmetros da consulta do link curto para o destino. |
|
|
Etiquetas de Cabeça
|
head_tags | string |
Etiquetas HTML personalizadas ou de rastreio inseridas no cabeçalho da página de redirecionamento. |
|
|
Ocultar Referente
|
hide_referrer | boolean |
Se deve esconder o referenciador do local de destino. |
|
|
Abrir Descrição do Gráfico
|
og_description | string |
A descrição mostrada quando o link é partilhado nas redes sociais. |
|
|
Abrir imagem do gráfico
|
og_image | string |
O URL da imagem é mostrado quando o link é partilhado nas redes sociais. |
|
|
Abrir título do gráfico
|
og_title | string |
O título é mostrado quando o link é partilhado nas redes sociais. |
|
|
TikTok Pixel ID
|
tiktok_pixel_id | string |
O TikTok Pixel ID para disparar quando o link é clicado. |
Devoluções
| Nome | Caminho | Tipo | Descrição |
|---|---|---|---|
|
Meta Pixel ID
|
fb_pixel_id | string |
O Meta (Facebook) Pixel ID para disparar quando o link é clicado. |
|
ID de Parceiro LinkedIn
|
linkedin_partner_id | string |
O ID de parceiro do LinkedIn Insight Tag para disparar quando o link for clicado. |
|
Microsoft UET Tag ID
|
microsoft_uet_tag_id | string |
O ID da etiqueta Microsoft Advertising UET para disparar quando o link é clicado. |
|
Reddit Pixel ID
|
reddit_pixel_id | string |
O Reddit Pixel ID para disparar quando o link é clicado. |
|
TikTok Pixel ID
|
tiktok_pixel_id | string |
O TikTok Pixel ID para disparar quando o link é clicado. |
|
Ocultar Referente
|
hide_referrer | boolean |
Se deve esconder o referenciador do local de destino. |
|
Data de Expiração
|
expiry_datetime | string |
Quando a ligação deixa de funcionar, em formato ISO 8601. |
|
Destino de Expiração
|
expiry_destination | uri |
O URL para redirecionar depois do link expirar. Deixe em branco para devolver uma página não encontrada. |
|
X Pixel ID
|
twitter_pixel_id | string |
O X (Twitter) Pixel ID para disparar quando o link é clicado. |
|
Camuflagem
|
cloaking | boolean |
Se deve esconder o destino abrindo-o dentro de uma moldura. |
|
URL curto
|
full_url | uri |
O link completo e curto. |
|
Abrir Descrição do Gráfico
|
og_description | string |
A descrição mostrada quando o link é partilhado nas redes sociais. |
|
Saltar o rastreamento do rastreador social
|
skip_social_crawler_tracking | boolean |
Se deve excluir os rastreadores de pré-visualização das redes sociais do rastreio de cliques. |
|
Etiquetas do Corpo
|
body_tags | string |
Etiquetas HTML personalizadas ou de rastreio inseridas no corpo da página de redirecionamento. |
|
Abrir título do gráfico
|
og_title | string |
O título é mostrado quando o link é partilhado nas redes sociais. |
|
Note
|
note | string |
Uma nota privada sobre a ligação. |
|
Name
|
name | string |
Um apelido para o link, mostrado no painel de controlo. |
|
Link ID
|
id | integer |
O ID de um link existente para atualizar. Deixe em branco para criar um novo link. |
|
ID do Gestor de Etiquetas do Google
|
gtm_id | string |
O ID do contentor do Google Tag Manager para carregar quando o link é clicado. |
|
Abrir imagem do gráfico
|
og_image | string |
O URL da imagem é mostrado quando o link é partilhado nas redes sociais. |
|
Block Bots
|
block_bots | boolean |
Se deve bloquear bots conhecidos de seguirem a ligação. |
|
Snapchat Pixel ID
|
snapchat_pixel_id | string |
O Pixel ID do Snapchat para disparar quando o link é clicado. |
|
Conteúdo UTM
|
utm_content | string |
O parâmetro utm_content adicionado à URL de destino. |
|
Ativado
|
enabled | boolean |
Se a ligação está ativa. |
|
URL de destino
|
url | uri |
O URL de destino para onde o link curto redireciona. É necessário criar um novo link. |
|
Eliminados
|
deleted | boolean |
Se o link está no lixo. |
|
Webhooks
|
webhooks | array of string |
Os URLs do webhook subscreveram os cliques neste link. |
|
Cliques de Expiração
|
expiry_clicks | integer |
O número de cliques após os quais o link deixa de funcionar. |
|
Notificar o Slack
|
notify_slack | boolean |
Se deve enviar uma notificação no Slack quando o link é clicado. |
|
ID do espaço de trabalho
|
workspace_id | integer |
A ID do espaço de trabalho. |
|
Análise Pública
|
public_analytics | boolean |
Se a página de análises do link é publicamente visível. |
|
ID da Etiqueta Pinterest
|
pinterest_tag_id | string |
O ID da etiqueta do Pinterest para disparar quando o link é clicado. |
|
Fonte UTM
|
utm_source | string |
O parâmetro utm_source adicionado à URL de destino. |
|
slug
|
slug | string |
Um caminho personalizado para a ligação curta. Tem de começar com uma barra. |
|
Domain
|
domain | string |
O domínio personalizado para usar na ligação curta, sem barra final. |
|
Parâmetros Futuros
|
forward_params | boolean |
Se deve encaminhar os parâmetros da consulta do link curto para o destino. |
|
UTM Médio
|
utm_medium | string |
O parâmetro utm_medium adicionado à URL de destino. |
|
Etiquetas de Cabeça
|
head_tags | string |
Etiquetas HTML personalizadas ou de rastreio inseridas no cabeçalho da página de redirecionamento. |
|
ID de Etiqueta do Google Analytics 4
|
ga4_tag_id | string |
O ID de medição do Google Analytics 4 para disparar quando o link é clicado. |
|
Termo UTM
|
utm_term | string |
O parâmetro utm_term adicionado à URL de destino. |
|
Campanha UTM
|
utm_campaign | string |
O parâmetro utm_campaign adicionado à URL de destino. |
Eliminar uma ligação
Move um link para o lixo. O seu URL curto deixa de redirecionar, e o link pode ser restaurado mais tarde a partir do lixo.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Descrição |
|---|---|---|---|---|
|
Workspace
|
workspace_id | True | string |
O espaço de trabalho para trabalhar. Escolhe-o da lista ou introduza o seu ID. |
|
Link ID
|
id | True | integer |
O ID do link. |
Devoluções
Uma mensagem de confirmação.
- response
- string
Ligações da lista
Devolve uma lista paginada dos links num espaço de trabalho, com estatísticas de cliques. Suporta pesquisa e ordenação.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Descrição |
|---|---|---|---|---|
|
Workspace
|
workspace_id | True | string |
O espaço de trabalho para trabalhar. Escolhe-o da lista ou introduza o seu ID. |
|
Pesquisa
|
search | string |
Um termo de pesquisa para filtrar links por nome, URL ou slug. |
|
|
Página
|
page | integer |
O número da página a voltar, começando em 1. |
|
|
Tamanho da Página
|
page_size | integer |
O número de links a devolver por página. |
|
|
Ordenar Por
|
sort_by | string |
O campo para ordenar, por exemplo, clicks_total, nome ou inserted_at. |
|
|
Direção de Ordenação
|
sort_dir | string |
A direção de sorte, seja ascendente ou desc. |
|
|
Eliminados
|
deleted | boolean |
Se deves devolver links que estão no lixo em vez de ligações ativas. |
Devoluções
| Nome | Caminho | Tipo | Descrição |
|---|---|---|---|
|
Links
|
links | array of object |
Os links nesta página. |
|
Meta Pixel ID
|
links.fb_pixel_id | string |
O Meta (Facebook) Pixel ID para disparar quando o link é clicado. |
|
Cliques Humanos Total
|
links.human_clicks_total | integer |
cliques ao longo da vida sem sinal de bot; o subconjunto de clicks_total onde nem um agente de utilizador bot nem uma categoria de bot verificado foram detetados. Gravado a partir de 2019. |
|
Cliques (30 Dias)
|
links.clicks_thirty_days | integer |
Cliques nos últimos 30 dias, incluindo tráfego de bots. |
|
TikTok Pixel ID
|
links.tiktok_pixel_id | string |
O TikTok Pixel ID para disparar quando o link é clicado. |
|
Ocultar Referente
|
links.hide_referrer | boolean |
Se deve esconder o referenciador do local de destino. |
|
Camuflagem
|
links.cloaking | boolean |
Se deve esconder o destino abrindo-o dentro de uma moldura. |
|
URL curto
|
links.full_url | uri |
O link completo e curto. |
|
Cliques Hoje
|
links.clicks_today | integer |
Cliques até agora hoje (UTC), incluindo tráfego de bots. |
|
Abrir Descrição do Gráfico
|
links.og_description | string |
A descrição mostrada quando o link é partilhado nas redes sociais. |
|
Etiquetas do Corpo
|
links.body_tags | string |
Etiquetas HTML personalizadas ou de rastreio inseridas no corpo da página de redirecionamento. |
|
Abrir título do gráfico
|
links.og_title | string |
O título é mostrado quando o link é partilhado nas redes sociais. |
|
Note
|
links.note | string |
Uma nota privada sobre a ligação. |
|
Name
|
links.name | string |
Um apelido para o link, mostrado no painel de controlo. |
|
Link ID
|
links.id | integer |
O identificador único do link. |
|
ID do Gestor de Etiquetas do Google
|
links.gtm_id | string |
O ID do contentor do Google Tag Manager para carregar quando o link é clicado. |
|
Abrir imagem do gráfico
|
links.og_image | string |
O URL da imagem é mostrado quando o link é partilhado nas redes sociais. |
|
Block Bots
|
links.block_bots | boolean |
Se deve bloquear bots conhecidos de seguirem a ligação. |
|
Total de cliques
|
links.clicks_total | integer |
Cliques vitalícios, incluindo tráfego de bots. |
|
Cliques Humanos (30 Dias)
|
links.human_clicks_thirty_days | integer |
Cliques 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 adicionado à URL de destino. |
|
Cliques Humanos Hoje
|
links.human_clicks_today | integer |
Até agora cliquem hoje (UTC) sem sinal de bot. |
|
Ativado
|
links.enabled | boolean |
Se a ligação está ativa. |
|
URL de destino
|
links.url | uri |
O URL de destino para onde o link curto redireciona. |
|
Eliminados
|
links.deleted | boolean |
Se o link está no lixo. |
|
ID do espaço de trabalho
|
links.workspace_id | integer |
A ID do espaço de trabalho. |
|
Análise Pública
|
links.public_analytics | boolean |
Se a página de análises do link é publicamente visível. |
|
Fonte UTM
|
links.utm_source | string |
O parâmetro utm_source adicionado à URL de destino. |
|
slug
|
links.slug | string |
Um caminho personalizado para a ligação curta. Tem de começar com uma barra. |
|
Domain
|
links.domain | string |
O domínio personalizado para usar na ligação curta, sem barra final. |
|
Parâmetros Futuros
|
links.forward_params | boolean |
Se deve encaminhar os parâmetros da consulta do link curto para o destino. |
|
UTM Médio
|
links.utm_medium | string |
O parâmetro utm_medium adicionado à URL de destino. |
|
Etiquetas de Cabeça
|
links.head_tags | string |
Etiquetas HTML personalizadas ou de rastreio inseridas no cabeçalho da página de redirecionamento. |
|
ID de Etiqueta do Google Analytics 4
|
links.ga4_tag_id | string |
O ID de medição do Google Analytics 4 para disparar quando o link é clicado. |
|
Termo UTM
|
links.utm_term | string |
O parâmetro utm_term adicionado à URL de destino. |
|
Campanha UTM
|
links.utm_campaign | string |
O parâmetro utm_campaign adicionado à URL de destino. |
|
Cliques Humanos Ontem
|
links.human_clicks_previous_day | integer |
Cliquem 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 devolver por página. |
|
Total de Inscrições
|
total_entries | integer |
O número total de links que correspondem ao pedido. |
|
Total de Páginas
|
total_pages | integer |
O número total de páginas disponíveis. |
|
Linhas Totais
|
total_rows | integer |
O número total de linhas. |
|
Contagem de Links do Workspace
|
workspace_link_count | integer |
O número total de links no espaço de trabalho. |
Listar domínios personalizados
Devolve os domínios personalizados configurados para um espaço de trabalho. Estes nomes de domínio podem ser usados na criação de links.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Descrição |
|---|---|---|---|---|
|
Workspace
|
workspace_id | True | string |
O espaço de trabalho para trabalhar. Escolhe-o da lista ou introduza o seu ID. |
Devoluções
| Nome | Caminho | Tipo | Descrição |
|---|---|---|---|
|
Domains
|
domains | array of object |
Os domínios personalizados no espaço de trabalho. |
|
Nome de Domínio
|
domains.name | string |
O nome de domínio, por exemplo, go.yourcompany.com. |
Listar espaços de trabalho
Devolve os espaços de trabalho disponíveis a esta ligação. Usa-o para encontrar o espaço de trabalho que outras ações exigem.
Devoluções
| Nome | Caminho | Tipo | Descrição |
|---|---|---|---|
|
|
array of object | ||
|
ID do espaço de trabalho
|
id | integer |
O identificador exclusivo do espaço de trabalho. |
|
Nome do espaço de trabalho
|
name | string |
O nome do espaço de trabalho. |
Obtenha a contagem de cliques por dimensão
Devolve contagens de cliques agrupadas por uma dimensão como país, cidade, plataforma, referente ou parâmetro UTM, ordenadas por contagem descendente.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Descrição |
|---|---|---|---|---|
|
Workspace
|
workspace_id | True | string |
O espaço de trabalho para trabalhar. Escolhe-o da lista ou introduza o seu ID. |
|
Dimensão
|
counter | True | string |
A dimensão para agrupar cliques por país, cidade, plataforma, referer ou utm_campaign. |
|
Link ID
|
link_id | string |
O ID de um único link para filtrar. |
|
|
IDs de ligação
|
link_ids | string |
Uma lista separada por hífen de IDs de links para filtrar. |
|
|
Data de Início
|
start | string |
O início do intervalo de datas, em formato YYYY-MM-DD. |
|
|
Data de Fim
|
end | string |
O fim do intervalo de datas, no formato YYYY-MM-DD. |
|
|
País
|
country | string |
Um código de país ISO 3166-1 de duas letras, por exemplo EUA. |
|
|
Incluir Bots
|
bots | boolean |
Se deve incluir cliques identificados como bots. Defina para falso para os excluir. |
|
|
Apenas Único
|
unique | boolean |
Se devemos contar apenas cliques únicos. |
Devoluções
| Nome | Caminho | Tipo | Descrição |
|---|---|---|---|
|
Total
|
total | integer |
Total de cliques em todos os grupos, incluindo os que não foram devolvidos em valores. Quando o resultado é truncado, isto é maior do que a soma da contagem em valores, pelo que contagem / total ainda fornece uma percentagem precisa. |
|
Values
|
values | array of object |
Contagens agrupadas, ordenadas por contagem descendente. Truncado para os 10.000 primeiros valores; se a dimensão tiver valores mais distintos do que isso, o restante não é devolvido. |
|
Contagem
|
values.count | integer |
O número de cliques para este valor. |
|
Value
|
values.value | string |
O valor da dimensão, por exemplo, um código de país. |
Obtenha análises de cliques
Devolve a contagem de cliques ao longo do tempo para um espaço de trabalho ou para links específicos, opcionalmente filtrados por intervalo de datas, país, navegador, plataforma, referente ou ISP.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Descrição |
|---|---|---|---|---|
|
Workspace
|
workspace_id | True | string |
O espaço de trabalho para trabalhar. Escolhe-o da lista ou introduza o seu ID. |
|
Link ID
|
link_id | string |
O ID de um único link para filtrar. |
|
|
IDs de ligação
|
link_ids | string |
Uma lista separada por hífen de IDs de links para filtrar. |
|
|
Data de Início
|
start | string |
O início do intervalo de datas, em formato YYYY-MM-DD. |
|
|
Data de Fim
|
end | string |
O fim do intervalo de datas, no formato YYYY-MM-DD. |
|
|
País
|
country | string |
Um código de país ISO 3166-1 de duas letras, por exemplo EUA. |
|
|
Browser
|
browser | string |
Um nome de navegador para filtrar, por exemplo, Chrome, Firefox ou Safari. |
|
|
Platform
|
platform | string |
Uma plataforma ou sistema operativo para filtrar por, por exemplo, Windows, Mac, iOS ou Android. |
|
|
Referenciador
|
referer | string |
Um domínio referencial para filtrar. |
|
|
ISP
|
isp | string |
Um nome de fornecedor de serviços de internet para filtrar. |
|
|
Incluir Bots
|
bots | boolean |
Se deve incluir cliques identificados como bots. Defina para falso para os excluir. |
|
|
Apenas Único
|
unique | boolean |
Se devemos contar apenas cliques únicos. |
|
|
Fuso Horário
|
timezone | string |
O fuso horário IANA usado para cálculos de datas, por exemplo Europa/Londres. |
|
|
Frequência
|
frequency | string |
A granularidade das séries temporais, seja dia ou hora. |
Devoluções
| Nome | Caminho | Tipo | Descrição |
|---|---|---|---|
|
Traffic
|
traffic | array of object |
Os cliques contam ao longo do tempo. |
|
Partida por balde
|
traffic.t | string |
O início do balde: YYYY-MM-DD para baldes diários ou YYYY-MM-DDTHH:MM:SS para baldes a cada hora. |
|
Cliques
|
traffic.y | integer |
O número de cliques no balde. |
Obter uma ligação
Recupera um único link pelo seu ID, incluindo o destino, URL curto e configuração.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Descrição |
|---|---|---|---|---|
|
Link ID
|
id | True | string |
O ID do link. |
Devoluções
| Nome | Caminho | Tipo | Descrição |
|---|---|---|---|
|
Meta Pixel ID
|
fb_pixel_id | string |
O Meta (Facebook) Pixel ID para disparar quando o link é clicado. |
|
ID de Parceiro LinkedIn
|
linkedin_partner_id | string |
O ID de parceiro do LinkedIn Insight Tag para disparar quando o link for clicado. |
|
Microsoft UET Tag ID
|
microsoft_uet_tag_id | string |
O ID da etiqueta Microsoft Advertising UET para disparar quando o link é clicado. |
|
Reddit Pixel ID
|
reddit_pixel_id | string |
O Reddit Pixel ID para disparar quando o link é clicado. |
|
TikTok Pixel ID
|
tiktok_pixel_id | string |
O TikTok Pixel ID para disparar quando o link é clicado. |
|
Ocultar Referente
|
hide_referrer | boolean |
Se deve esconder o referenciador do local de destino. |
|
Data de Expiração
|
expiry_datetime | string |
Quando a ligação deixa de funcionar, em formato ISO 8601. |
|
Destino de Expiração
|
expiry_destination | uri |
O URL para redirecionar depois do link expirar. Deixe em branco para devolver uma página não encontrada. |
|
X Pixel ID
|
twitter_pixel_id | string |
O X (Twitter) Pixel ID para disparar quando o link é clicado. |
|
Camuflagem
|
cloaking | boolean |
Se deve esconder o destino abrindo-o dentro de uma moldura. |
|
URL curto
|
full_url | uri |
O link completo e curto. |
|
Abrir Descrição do Gráfico
|
og_description | string |
A descrição mostrada quando o link é partilhado nas redes sociais. |
|
Saltar o rastreamento do rastreador social
|
skip_social_crawler_tracking | boolean |
Se deve excluir os rastreadores de pré-visualização das redes sociais do rastreio de cliques. |
|
Etiquetas do Corpo
|
body_tags | string |
Etiquetas HTML personalizadas ou de rastreio inseridas no corpo da página de redirecionamento. |
|
Abrir título do gráfico
|
og_title | string |
O título é mostrado quando o link é partilhado nas redes sociais. |
|
Note
|
note | string |
Uma nota privada sobre a ligação. |
|
Name
|
name | string |
Um apelido para o link, mostrado no painel de controlo. |
|
Link ID
|
id | integer |
O identificador único do link. |
|
ID do Gestor de Etiquetas do Google
|
gtm_id | string |
O ID do contentor do Google Tag Manager para carregar quando o link é clicado. |
|
Abrir imagem do gráfico
|
og_image | string |
O URL da imagem é mostrado quando o link é partilhado nas redes sociais. |
|
Block Bots
|
block_bots | boolean |
Se deve bloquear bots conhecidos de seguirem a ligação. |
|
Snapchat Pixel ID
|
snapchat_pixel_id | string |
O Pixel ID do Snapchat para disparar quando o link é clicado. |
|
Conteúdo UTM
|
utm_content | string |
O parâmetro utm_content adicionado à URL de destino. |
|
Ativado
|
enabled | boolean |
Se a ligação está ativa. |
|
URL de destino
|
url | uri |
O URL de destino para onde o link curto redireciona. |
|
Eliminados
|
deleted | boolean |
Se o link está no lixo. |
|
Webhooks
|
webhooks | array of string |
Os URLs do webhook subscreveram os cliques neste link. |
|
Cliques de Expiração
|
expiry_clicks | integer |
O número de cliques após os quais o link deixa de funcionar. |
|
Notificar o Slack
|
notify_slack | boolean |
Se deve enviar uma notificação no Slack quando o link é clicado. |
|
ID do espaço de trabalho
|
workspace_id | integer |
A ID do espaço de trabalho. |
|
Análise Pública
|
public_analytics | boolean |
Se a página de análises do link é publicamente visível. |
|
ID da Etiqueta Pinterest
|
pinterest_tag_id | string |
O ID da etiqueta do Pinterest para disparar quando o link é clicado. |
|
Fonte UTM
|
utm_source | string |
O parâmetro utm_source adicionado à URL de destino. |
|
slug
|
slug | string |
Um caminho personalizado para a ligação curta. Tem de começar com uma barra. |
|
Domain
|
domain | string |
O domínio personalizado para usar na ligação curta, sem barra final. |
|
Parâmetros Futuros
|
forward_params | boolean |
Se deve encaminhar os parâmetros da consulta do link curto para o destino. |
|
UTM Médio
|
utm_medium | string |
O parâmetro utm_medium adicionado à URL de destino. |
|
Etiquetas de Cabeça
|
head_tags | string |
Etiquetas HTML personalizadas ou de rastreio inseridas no cabeçalho da página de redirecionamento. |
|
ID de Etiqueta do Google Analytics 4
|
ga4_tag_id | string |
O ID de medição do Google Analytics 4 para disparar quando o link é clicado. |
|
Termo UTM
|
utm_term | string |
O parâmetro utm_term adicionado à URL de destino. |
|
Campanha UTM
|
utm_campaign | string |
O parâmetro utm_campaign adicionado à URL de destino. |
Reporte uma conversão
Regista uma conversão, como uma compra, inscrição ou evento personalizado, e atribui-a ao link que foi clicado quando um token de atribuição é fornecido.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Descrição |
|---|---|---|---|---|
|
Quantia (Cêntimos)
|
amount_cents | integer |
Valor na menor unidade monetária. Pode ser negativo para registar um reembolso ou estorno, o que compensa a receita anterior. |
|
|
País
|
country | string |
Código de país de duas letras para a conversão. Inferido para chamadas do lado do navegador; forneça explicitamente a partir de uma integração do lado do servidor, onde o endereço de ligação é a sua própria infraestrutura e não o do cliente. |
|
|
Moeda
|
currency | string |
Código de moeda ISO 4217. Por defeito, é USD. |
|
|
ID do Evento
|
event_id | string |
O seu identificador para este evento. Usado como chave de idempotência; reportar 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 a conduzir o funil. O lead estabelece a identidade do cliente, a venda regista receitas. Por defeito, é personalizado. |
|
|
ID do Cliente
|
external_id | string |
O seu identificador para o cliente. Envie-a em todos os eventos: é o que liga uma venda posterior do lado do servidor ao clique que gerou a inscrição. |
|
|
Token de Atribuição
|
linkly_cid | string |
O token de atribuição é capturado a partir da URL da página de destino. Omita se não estiver disponível; a conversão é então registada sem 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. Por padrão, define-se para o momento atual. |
|
|
IP do visitante
|
visitor_ip | string |
O IP do cliente final, quando o teu servidor o tem. Omita, a menos que o faça; para chamadas do lado do servidor, o Linkly regista o endereço de ligação como seu servidor, não como cliente, e exclui-lo do relatório geográfico. Enviar isto afirma que tem base legal para o partilhar. Nunca devolvido pela API. |
Devoluções
| Nome | Caminho | Tipo | Descrição |
|---|---|---|---|
|
Quantia (Cêntimos)
|
amount_cents | integer |
O valor na menor unidade monetária. Pode ser negativo para registar um reembolso. |
|
Clique em ID
|
click_id | string |
O ID do clique atribuído. |
|
País
|
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. Por defeito, é USD. |
|
ID do Evento
|
event_id | string |
O seu identificador para o evento. Reportar o mesmo valor duas vezes não cria uma segunda conversão. |
|
Nome do evento
|
event_name | string |
O que aconteceu, por exemplo, comprar, inscrever-se ou trial_started. |
|
Tipo de Evento
|
event_type | string |
Do tipo de evento grosseiro. Use o lead para estabelecer a identidade do cliente e a venda para registar receitas. Por defeito, é personalizado. |
|
ID do Cliente
|
external_id | string |
O seu identificador para o cliente. Envie-o em todos os eventos para que as vendas posteriores possam ser associadas ao clique original. |
|
ID de conversão
|
id | string |
O identificador único da conversão. Os IDs ordenam-se cronologicamente. |
|
Inserido em
|
inserted_at | date-time |
Quando a conversão foi registada. |
|
Fonte IP
|
ip_source | string |
Cuja morada foi registada: visitante, servidor ou desconhecida. Server significa que o endereço de ligação pertencia ao seu backend ou a um relé de plataforma, por isso está excluído do relatório geográfico. |
|
Link ID
|
link_id | integer |
O ID do link atribuído, ou nulo se a conversão não pudesse 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, em formato ISO 8601. Por padrão, define-se para o momento atual. |
|
Source
|
source | string |
Que integração reportou isso. |
Definições
cadeia (de caracteres)
Este é o tipo de dados básico 'string'.