Compartilhar via


BitlyIP (Editor Independente)

O Bitly é a plataforma de gerenciamento de link mais confiável do mundo. Usando a API bitly, você exercerá todo o poder de seus links por meio da personalização automatizada de link, da vinculação profunda móvel e do clique em análise.

Esse conector está disponível nos seguintes produtos e regiões:

Service Class Regions
Copilot Studio Premium Todas as regiões do 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:
     – Regiões do Azure Governamental
     - Regiões do Azure China
     - Departamento de Defesa dos EUA (DoD)
Power Apps Premium Todas as regiões do 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 do 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
Nome Troy Taylor
URL https://www.hitachisolutions.com
Email ttaylor@hitachisolutions.com
Metadados do conector
Publicador Troy Taylor
Site https://bitly.com/
Política de privacidade https://bitly.com/pages/privacy
Categorias Mídias Sociais; Site

Criando uma conexão

O conector dá suporte aos seguintes tipos de autenticação:

Default Parâmetros para criar conexão. Todas as regiões Não compartilhável

Padrão

Aplicável: todas as regiões

Parâmetros para criar conexão.

Essa não é uma conexão compartilhável. Se o aplicativo de energia for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.

Nome Tipo Description Obrigatório
Chave de API secureString A chave de API para esta api Verdade

Limitações

Nome Chamadas Período de renovação
Chamadas à API por conexão 100 60 segundos

Ações

Adicionar bitlink personalizado

Adicione uma palavra-chave (ou back-half personalizada) a um Bitlink com um Domínio Personalizado. Esse ponto de extremidade também pode ser usado para redirecionamentos iniciais para um link.

Adicionar bitlinks em massa aos canais

Adicionar bitlinks em massa a vários canais de campanha

Atualizar bitlinks por grupo

A atualização em massa pode adicionar ou remover marcas ou arquivar até 100 links por vez; A resposta inclui uma lista de IDs do Bitlink que foram atualizadas.

Atualizar campanha

Atualiza os detalhes de uma campanha.

Atualizar grupo

Atualiza os detalhes de um grupo.

Atualizar o Bitlink

Atualiza campos no link especificado.

Atualizar o bitlink personalizado

Mova uma palavra-chave (ou parte traseira personalizada) para um Bitlink diferente.

Atualizar preferências de grupo

Atualiza as preferências de um grupo.

Atualizar usuário

Atualizar campos no usuário

Atualizar webhook

Atualizar um webhook

Canal de Atualização

Atualiza um canal existente.

Criar bitlink

Converte uma URL longa em um Bitlink.

Criar bitlink completo

Converte uma URL longa em um Bitlink e define parâmetros adicionais.

Criar campanha

Cria uma nova campanha.

Criar canal

Cria um novo canal.

Criar webhook

Cria um webhook.

Excluir webhook

Exclui um webhook.

Expandir o Bitlink

Retorna o link curto e a URL longa para o link especificado.

Obter Bitlink

Retorna informações para o link especificado.

Obter Bitlinks classificados

Retorna uma lista de Bitlinks classificados por grupo.

Obter bitlinks personalizados para BSDs

Obtém bitlinks personalizados para uma organização filtrada por BSD(s).

Obter bitlinks por grupo

Retorna uma coleção paginada de Bitlinks para um grupo.

Obter BSDs

Buscar todos os domínios curtos de marca.

Obter campanha

Retorna detalhes de uma campanha.

Obter campanhas

Retorna as campanhas para o usuário autenticado atual.

Obter canais

Retorna os canais disponíveis para um usuário.

Obter canal

Retorna os detalhes de um canal.

Obter cliques em grupo

Obtenha o número de cliques em Bitlinks em um grupo.

Obter cliques para o Bitlink

Retorna as contagens de cliques para o link especificado em uma matriz com base em uma data.

Obter cliques para o Bitlink personalizado

Retorna as contagens de cliques para o link especificado. Isso retorna uma matriz com cliques com base em uma data.

Obter contagens de redução de grupo

Retorna todas as contagens de redução para um grupo.

Obter contagens de redução de organização

Retorna as contagens de redução para uma organização específica durante um período de tempo especificado.

Obter código QR do Bitlink

Gera um código QR para um Bitlink.

Obter grupo

Retorna detalhes de um grupo.

Obter grupos

Retorna uma lista de grupos na organização.

Obter limites de plano

Retorna todos os limites e contagens de plano disponíveis para uma organização.

Obter limites de plataforma

Buscar todos os limites e contagens de plataforma disponíveis para uma organização

Obter marcas de grupo

Retorna as marcas usadas atualmente no grupo especificado. Máximo de 1000.

Obter métricas de Bitlink personalizadas por destino

Retorna métricas de clique para o link especificado por seus destinos históricos.

Obter métricas de grupo por cidades

Retorna as origens geográficas do tráfego de clique por cidade para o grupo especificado.

Obter métricas de grupo por dispositivos

Retorna os tipos de dispositivo que geram o tráfego de cliques para os links do grupo especificado.

Obter métricas de grupo por países

Retorna as origens geográficas do tráfego de clique por país para o grupo especificado.

Obter métricas de grupo referenciando redes

Retorna métricas referenciando redes para os links do grupo especificado.

Obter métricas para Bitlink por dispositivos

Retorna os tipos de dispositivo que geram o tráfego de clique para o link especificado.

Obter métricas para Bitlink por países

Retorna as origens do país do tráfego de clique para o link especificado.

Obter métricas para Bitlink por referenciadores

Retorna contagens de cliques do referenciador para o link especificado.

Obter métricas para Bitlink por referenciadores por domínios

Retorna métricas de clique agrupadas por referenciadores para o link especificado.

Obter métricas para o Bitlink por cidades

Retorna as origens da cidade do tráfego de clique para o link especificado.

Obter métricas para o Bitlink referenciando domínios

Retorna as contagens de cliques de domínio de referência para o link especificado.

Obter o aplicativo OAuth

Recupere os detalhes da ID do cliente do Aplicativo OAuth fornecida.

Obter o Bitlink personalizado

Retorna os detalhes e o histórico do link especificado.

Obter organização

Recupere os detalhes da organização especificada.

Obter organizações

Recupere uma lista de organizações.

Obter preferências de grupo

Retorna preferências para o grupo especificado.

Obter resumo de cliques para o Bitlink

Retorna as contagens de cliques para o link especificado acumulado em um único campo.

Obter usuário

Retorna informações para o usuário autenticado atual.

Obter webhook

Retorna um webhook.

Obter webhooks

Buscar todos os webhooks disponíveis para uma organização

Verificar webhook

Envia o evento de ping para testar a configuração do webhook.

Adicione uma palavra-chave (ou back-half personalizada) a um Bitlink com um Domínio Personalizado. Esse ponto de extremidade também pode ser usado para redirecionamentos iniciais para um link.

Parâmetros

Nome Chave Obrigatório Tipo Description
bitlink_id
bitlink_id string
custom_bitlink
custom_bitlink string

Retornos

CustomBitlink
CustomBitlink

Adicionar bitlinks em massa a vários canais de campanha

Parâmetros

Nome Chave Obrigatório Tipo Description
GUID de campanha
campaign_guid True string

Um GUID para uma campanha bitly

Tipo de conteúdo
Content-Type string

O tipo de conteúdo.

File
file file

O arquivo.

Retornos

BulkAddResponse
BulkAddResponse

A atualização em massa pode adicionar ou remover marcas ou arquivar até 100 links por vez; A resposta inclui uma lista de IDs do Bitlink que foram atualizadas.

Parâmetros

Nome Chave Obrigatório Tipo Description
GUID de grupo
group_guid True string

Um GUID para um grupo Bitly

Ação
action string
remove_tags
remove_tags array of string
arquivar
archive boolean
links
links array of string

Isso é limitado a 100 IDs do Bitlink

add_tags
add_tags array of string

Retornos

BulkUpdate
BulkUpdate

Atualizar campanha

Atualiza os detalhes de uma campanha.

Parâmetros

Nome Chave Obrigatório Tipo Description
GUID de campanha
campaign_guid True string

Um GUID para uma campanha bitly

group_guid
group_guid string
channel_guids
channel_guids array of string
descrição
description string
nome
name string

Retornos

Campanha
Campaign

Atualizar grupo

Atualiza os detalhes de um grupo.

Parâmetros

Nome Chave Obrigatório Tipo Description
GUID de grupo
group_guid True string

Um GUID para um grupo Bitly

bsds
bsds array of string
nome
name string
organization_guid
organization_guid string

Retornos

Grupo
Group

Atualiza campos no link especificado.

Parâmetros

Nome Chave Obrigatório Tipo Description
Bitlink
bitlink True string

Um Bitlink feito do domínio e do hash

Referências
references object
Arquivados
archived boolean
tags
tags array of string
criado_em
created_at string
title
title string
bitlink
bitlink string
install_url
install_url string
criadas
created string

Carimbo de data/hora ISO

app_uri_path
app_uri_path string
modificado
modified string

Carimbo de data/hora ISO

install_type
install_type string
app_guid
app_guid string
guid
guid string
os
os string
brand_guid
brand_guid string
created_by
created_by string
long_url
long_url string
ID do cliente
client_id string
custom_bitlinks
custom_bitlinks array of string
link
link string
launchpad_ids
launchpad_ids array of string
id
id string

Retornos

BitlinkBody
BitlinkBody

Mova uma palavra-chave (ou parte traseira personalizada) para um Bitlink diferente.

Parâmetros

Nome Chave Obrigatório Tipo Description
Bitlink personalizado
custom_bitlink True string

Um Bitlink personalizado feito do domínio e da palavra-chave

bitlink_id
bitlink_id string

Retornos

CustomBitlink
CustomBitlink

Atualizar preferências de grupo

Atualiza as preferências de um grupo.

Parâmetros

Nome Chave Obrigatório Tipo Description
GUID de grupo
group_guid True string

Um GUID para um grupo Bitly

group_guid
group_guid string
domain_preference
domain_preference string

Retornos

GroupPreferences
GroupPreferences

Atualizar usuário

Atualizar campos no usuário

Parâmetros

Nome Chave Obrigatório Tipo Description
default_group_guid
default_group_guid string
nome
name string

Retornos

Utilizador
User

Atualizar webhook

Atualizar um webhook

Parâmetros

Nome Chave Obrigatório Tipo Description
Webhook GUID
webhook_guid True string

Um GUID para um webhook bitly

nome
name string
url
url string
group_guid
group_guid string
fetch_tags
fetch_tags boolean
is_active
is_active boolean
organization_guid
organization_guid string
ID do cliente
client_id string
segredo_do_cliente
client_secret string
oauth_url
oauth_url string
guid
guid True string
evento
event string

Retornos

Webhook
Webhook

Canal de Atualização

Atualiza um canal existente.

Parâmetros

Nome Chave Obrigatório Tipo Description
GUID do Canal
channel_guid True string

Um GUID para um canal bitly

group_guid
group_guid string
guid
guid string
nome
name string
modificado
modified string

ISO_TIMESTAMP

criadas
created string

ISO TIMESTAMP

campaign_guid
campaign_guid string
bitlink_id
bitlink_id string

Retornos

Channel
Channel

Converte uma URL longa em um Bitlink.

Parâmetros

Nome Chave Obrigatório Tipo Description
group_guid
group_guid string
domínio
domain string
long_url
long_url True string

Retornos

ShortenBitlinkBody
ShortenBitlinkBody

Converte uma URL longa em um Bitlink e define parâmetros adicionais.

Parâmetros

Nome Chave Obrigatório Tipo Description
domínio
domain string
title
title string
group_guid
group_guid string

Sempre inclua um grupo específico e um domínio personalizado em suas chamadas abreviadas.

tags
tags array of string
app_uri_path
app_uri_path string
install_type
install_type string
install_url
install_url string
app_id
app_id string
long_url
long_url True string

Retornos

BitlinkBody
BitlinkBody

Criar campanha

Cria uma nova campanha.

Parâmetros

Nome Chave Obrigatório Tipo Description
group_guid
group_guid string
channel_guids
channel_guids array of string
descrição
description string
nome
name string

Retornos

Campanha
Campaign

Criar canal

Cria um novo canal.

Parâmetros

Nome Chave Obrigatório Tipo Description
group_guid
group_guid string
guid
guid string
nome
name string
modificado
modified string

ISO_TIMESTAMP

criadas
created string

ISO TIMESTAMP

campaign_guid
campaign_guid string
bitlink_id
bitlink_id string

Retornos

Channel
Channel

Criar webhook

Cria um webhook.

Parâmetros

Nome Chave Obrigatório Tipo Description
nome
name True string
url
url True string
group_guid
group_guid string
fetch_tags
fetch_tags boolean
is_active
is_active boolean
organization_guid
organization_guid True string
ID do cliente
client_id string
segredo_do_cliente
client_secret string
oauth_url
oauth_url string
evento
event True string

Retornos

Webhook
Webhook

Excluir webhook

Exclui um webhook.

Parâmetros

Nome Chave Obrigatório Tipo Description
Webhook GUID
webhook_guid True string

Um GUID para um webhook bitly

Retorna o link curto e a URL longa para o link especificado.

Parâmetros

Nome Chave Obrigatório Tipo Description
bitlink_id
bitlink_id string

Retornos

ExpandedBitlink
ExpandedBitlink

Retorna informações para o link especificado.

Parâmetros

Nome Chave Obrigatório Tipo Description
Bitlink
bitlink True string

Um Bitlink feito do domínio e do hash

Retornos

BitlinkBody
BitlinkBody

Retorna uma lista de Bitlinks classificados por grupo.

Parâmetros

Nome Chave Obrigatório Tipo Description
GUID de grupo
group_guid True string

Um GUID para um grupo Bitly

Classificar
sort True string

O tipo de classificação que você gostaria de fazer

Unidade
unit string

Uma unidade de tempo

Unidades
units integer

Um inteiro que representa as unidades de tempo para as quais consultar dados. passe -1 para retornar todas as unidades de tempo.

Referência de unidade
unit_reference string

Um carimbo de data/hora ISO-8601, indicando o momento mais recente para o qual efetuar pull de métricas. O padrão será a hora atual.

Tamanho
size integer

A quantidade de itens a serem retornados

Retornos

SortedLinks
SortedLinks

Obtém bitlinks personalizados para uma organização filtrada por BSD(s).

Parâmetros

Nome Chave Obrigatório Tipo Description
GUID de grupo
group_guid True string

Um GUID para um grupo Bitly

Criado após
created_after integer

Carimbo de data/hora como uma época unix inteiro

Limit
limit integer

limitar a quantidade de resultados retornados

Offset
offset integer

definir o índice inicial do conjunto de resultados

BSD
bsd array

um domínio curto de marca para filtrar resultados

Retornos

BitlinkOverridesData
BitlinkOverridesData

Retorna uma coleção paginada de Bitlinks para um grupo.

Parâmetros

Nome Chave Obrigatório Tipo Description
GUID de grupo
group_guid True string

Um GUID para um grupo Bitly

Tamanho
size integer

A quantidade de itens a serem retornados

Página
page integer

Inteiro especificando o resultado numerado no qual iniciar

Keyword
keyword string

Palavra-chave personalizada para filtrar em entradas de histórico

Query
query string

O valor que você gostaria de pesquisar

Criado antes
created_before integer

Carimbo de data/hora como uma época unix inteiro

Criado após
created_after integer

Carimbo de data/hora como uma época unix inteiro

Modificado após
modified_after integer

Carimbo de data/hora como uma época unix inteiro

Arquivados
archived string

Incluir ou não bitlinks arquivados

Deeplinks
deeplinks string

Filtrar somente para Bitlinks que contêm deeplinks

Deeplinks de domínio
domain_deeplinks string

Filtrar somente para Bitlinks que contêm deeplinks configurados com um domínio personalizado

GUID de campanha
campaign_guid string

Filtro para retornar apenas links para o GUID de campanha fornecido, pode ser fornecido

CANAL GUILD
channel_guid string

Filtrar para retornar apenas links para o GUID de canal fornecido, pode ser fornecido, substitui todos os outros parâmetros

Bitlink personalizado
custom_bitlink string

Um Bitlink personalizado feito do domínio e da palavra-chave

Etiquetas
tags array

filtrar por determinadas marcas

Launchpad IDs
launchpad_ids array

filtrar por id do launchpad

Logon de codificação
encoding_login array

Filtrar pelo logon do usuário autenticado que criou o Bitlink

Retornos

Bitlinks
Bitlinks

Obter BSDs

Buscar todos os domínios curtos de marca.

Retornos

BSDsResponse
BSDsResponse

Obter campanha

Retorna detalhes de uma campanha.

Parâmetros

Nome Chave Obrigatório Tipo Description
GUID de campanha
campaign_guid True string

Um GUID para uma campanha bitly

Retornos

Campanha
Campaign

Obter campanhas

Retorna as campanhas para o usuário autenticado atual.

Parâmetros

Nome Chave Obrigatório Tipo Description
GUID de grupo
group_guid string

Um GUID para um grupo Bitly

Retornos

Campaigns
Campaigns

Obter canais

Retorna os canais disponíveis para um usuário.

Parâmetros

Nome Chave Obrigatório Tipo Description
GUID de grupo
group_guid string

Um GUID para um grupo Bitly

GUID de campanha
campaign_guid string

Um GUID para uma campanha bitly

Retornos

Canais
Channels

Obter canal

Retorna os detalhes de um canal.

Parâmetros

Nome Chave Obrigatório Tipo Description
GUID do Canal
channel_guid True string

Um GUID para um canal bitly

Retornos

Channel
Channel

Obter cliques em grupo

Obtenha o número de cliques em Bitlinks em um grupo.

Parâmetros

Nome Chave Obrigatório Tipo Description
GUID de grupo
group_guid True string

Um GUID para um grupo Bitly

Unidade
unit True string

Uma unidade de tempo

Unidades
units True integer

Um inteiro que representa as unidades de tempo para as quais consultar dados. passe -1 para retornar todas as unidades de tempo.

Referência de unidade
unit_reference string

Um carimbo de data/hora ISO-8601, indicando o momento mais recente para o qual efetuar pull de métricas. O padrão será a hora atual.

Retornos

GroupClicks
GroupClicks

Retorna as contagens de cliques para o link especificado em uma matriz com base em uma data.

Parâmetros

Nome Chave Obrigatório Tipo Description
Bitlink
bitlink True string

Um Bitlink feito do domínio e do hash

Unidade
unit True string

Uma unidade de tempo

Unidades
units True integer

Um inteiro que representa as unidades de tempo para as quais consultar dados. passe -1 para retornar todas as unidades de tempo.

Referência de unidade
unit_reference string

Um carimbo de data/hora ISO-8601, indicando o momento mais recente para o qual efetuar pull de métricas. O padrão será a hora atual.

Retornos

Cliques
Clicks

Retorna as contagens de cliques para o link especificado. Isso retorna uma matriz com cliques com base em uma data.

Parâmetros

Nome Chave Obrigatório Tipo Description
Bitlink personalizado
custom_bitlink True string

Um Bitlink personalizado feito do domínio e da palavra-chave

Unidade
unit True string

Uma unidade de tempo

Unidades
units True integer

Um inteiro que representa as unidades de tempo para as quais consultar dados. passe -1 para retornar todas as unidades de tempo.

Referência de unidade
unit_reference string

Um carimbo de data/hora ISO-8601, indicando o momento mais recente para o qual efetuar pull de métricas. O padrão será a hora atual.

Retornos

Cliques
Clicks

Obter contagens de redução de grupo

Retorna todas as contagens de redução para um grupo.

Parâmetros

Nome Chave Obrigatório Tipo Description
GUID de grupo
group_guid True string

Um GUID para um grupo Bitly

Unidade
unit True string

Uma unidade de tempo

Unidades
units True integer

Um inteiro que representa as unidades de tempo para as quais consultar dados. passe -1 para retornar todas as unidades de tempo.

Referência de unidade
unit_reference string

Um carimbo de data/hora ISO-8601, indicando o momento mais recente para o qual efetuar pull de métricas. O padrão será a hora atual.

Retornos

Métricas
Metrics

Obter contagens de redução de organização

Retorna as contagens de redução para uma organização específica durante um período de tempo especificado.

Parâmetros

Nome Chave Obrigatório Tipo Description
GUID da organização
organization_guid True string

Um GUID para uma organização bitly

Unidade
unit True string

Uma unidade de tempo

Unidades
units True integer

Um inteiro que representa as unidades de tempo para as quais consultar dados. passe -1 para retornar todas as unidades de tempo.

Referência de unidade
unit_reference string

Um carimbo de data/hora ISO-8601, indicando o momento mais recente para o qual efetuar pull de métricas. O padrão será a hora atual.

Retornos

Métricas
Metrics

Gera um código QR para um Bitlink.

Parâmetros

Nome Chave Obrigatório Tipo Description
Bitlink
bitlink True string

Um Bitlink feito do domínio e do hash

Cor
color string

Uma cor indicada no formato RGB hexidecimal

Excluir logotipo bitly
exclude_bitly_logo boolean

Remove o logotipo bitly do centro da imagem QR gerada

Formato de imagem
image_format string

Determina o formato de imagem do código QR retornado

Retornos

BitlinkQR
BitlinkQR

Obter grupo

Retorna detalhes de um grupo.

Parâmetros

Nome Chave Obrigatório Tipo Description
GUID de grupo
group_guid True string

Um GUID para um grupo Bitly

Retornos

Grupo
Group

Obter grupos

Retorna uma lista de grupos na organização.

Parâmetros

Nome Chave Obrigatório Tipo Description
GUID da organização
organization_guid string

Um GUID para uma organização bitly

Retornos

Groups
Groups

Obter limites de plano

Retorna todos os limites e contagens de plano disponíveis para uma organização.

Parâmetros

Nome Chave Obrigatório Tipo Description
GUID da organização
organization_guid True string

Um GUID para uma organização bitly

Retornos

PlanLimits
PlanLimits

Obter limites de plataforma

Buscar todos os limites e contagens de plataforma disponíveis para uma organização

Parâmetros

Nome Chave Obrigatório Tipo Description
Caminho
path string

O caminho específico para o qual as informações são solicitadas

Retornos

PlatformLimits
PlatformLimits

Obter marcas de grupo

Retorna as marcas usadas atualmente no grupo especificado. Máximo de 1000.

Parâmetros

Nome Chave Obrigatório Tipo Description
GUID de grupo
group_guid True string

Um GUID para um grupo Bitly

Retornos

Etiquetas
Tags

Retorna métricas de clique para o link especificado por seus destinos históricos.

Parâmetros

Nome Chave Obrigatório Tipo Description
Bitlink personalizado
custom_bitlink True string

Um Bitlink personalizado feito do domínio e da palavra-chave

Unidade
unit True string

Uma unidade de tempo

Unidades
units True integer

Um inteiro que representa as unidades de tempo para as quais consultar dados. passe -1 para retornar todas as unidades de tempo.

Referência de unidade
unit_reference string

Um carimbo de data/hora ISO-8601, indicando o momento mais recente para o qual efetuar pull de métricas. O padrão será a hora atual.

Retornos

ClickMetrics
ClickMetrics

Obter métricas de grupo por cidades

Retorna as origens geográficas do tráfego de clique por cidade para o grupo especificado.

Parâmetros

Nome Chave Obrigatório Tipo Description
GUID de grupo
group_guid True string

Um GUID para um grupo Bitly

Unidade
unit True string

Uma unidade de tempo

Unidades
units True integer

Um inteiro que representa as unidades de tempo para as quais consultar dados. passe -1 para retornar todas as unidades de tempo.

Tamanho
size integer

A quantidade de itens a serem retornados

Referência de unidade
unit_reference string

Um carimbo de data/hora ISO-8601, indicando o momento mais recente para o qual efetuar pull de métricas. O padrão será a hora atual.

Retornos

CityMetrics
CityMetrics

Obter métricas de grupo por dispositivos

Retorna os tipos de dispositivo que geram o tráfego de cliques para os links do grupo especificado.

Parâmetros

Nome Chave Obrigatório Tipo Description
GUID de grupo
group_guid True string

Um GUID para um grupo Bitly

Unidade
unit True string

Uma unidade de tempo

Unidades
units True integer

Um inteiro que representa as unidades de tempo para as quais consultar dados. passe -1 para retornar todas as unidades de tempo.

Tamanho
size integer

A quantidade de itens a serem retornados

Referência de unidade
unit_reference string

Um carimbo de data/hora ISO-8601, indicando o momento mais recente para o qual efetuar pull de métricas. O padrão será a hora atual.

Retornos

DeviceMetrics
DeviceMetrics

Obter métricas de grupo por países

Retorna as origens geográficas do tráfego de clique por país para o grupo especificado.

Parâmetros

Nome Chave Obrigatório Tipo Description
GUID de grupo
group_guid True string

Um GUID para um grupo Bitly

Unidade
unit True string

Uma unidade de tempo

Unidades
units True integer

Um inteiro que representa as unidades de tempo para as quais consultar dados. passe -1 para retornar todas as unidades de tempo.

Tamanho
size integer

A quantidade de itens a serem retornados

Referência de unidade
unit_reference string

Um carimbo de data/hora ISO-8601, indicando o momento mais recente para o qual efetuar pull de métricas. O padrão será a hora atual.

Retornos

ClickMetrics
ClickMetrics

Obter métricas de grupo referenciando redes

Retorna métricas referenciando redes para os links do grupo especificado.

Parâmetros

Nome Chave Obrigatório Tipo Description
GUID de grupo
group_guid True string

Um GUID para um grupo Bitly

Retornos

ClickMetrics
ClickMetrics

Retorna os tipos de dispositivo que geram o tráfego de clique para o link especificado.

Parâmetros

Nome Chave Obrigatório Tipo Description
Bitlink
bitlink True string

Um Bitlink feito do domínio e do hash

Unidade
unit True string

Uma unidade de tempo

Unidades
units True integer

Um inteiro que representa as unidades de tempo para as quais consultar dados. passe -1 para retornar todas as unidades de tempo.

Tamanho
size integer

A quantidade de itens a serem retornados

Referência de unidade
unit_reference string

Um carimbo de data/hora ISO-8601, indicando o momento mais recente para o qual efetuar pull de métricas. O padrão será a hora atual.

Retornos

DeviceMetrics
DeviceMetrics

Retorna as origens do país do tráfego de clique para o link especificado.

Parâmetros

Nome Chave Obrigatório Tipo Description
Bitlink
bitlink True string

Um Bitlink feito do domínio e do hash

Unidade
unit True string

Uma unidade de tempo

Unidades
units True integer

Um inteiro que representa as unidades de tempo para as quais consultar dados. passe -1 para retornar todas as unidades de tempo.

Tamanho
size integer

A quantidade de itens a serem retornados

Referência de unidade
unit_reference string

Um carimbo de data/hora ISO-8601, indicando o momento mais recente para o qual efetuar pull de métricas. O padrão será a hora atual.

Retornos

ClickMetrics
ClickMetrics

Retorna contagens de cliques do referenciador para o link especificado.

Parâmetros

Nome Chave Obrigatório Tipo Description
Bitlink
bitlink True string

Um Bitlink feito do domínio e do hash

Unidade
unit True string

Uma unidade de tempo

Unidades
units True integer

Um inteiro que representa as unidades de tempo para as quais consultar dados. passe -1 para retornar todas as unidades de tempo.

Tamanho
size integer

A quantidade de itens a serem retornados

Referência de unidade
unit_reference string

Um carimbo de data/hora ISO-8601, indicando o momento mais recente para o qual efetuar pull de métricas. O padrão será a hora atual.

Retornos

ClickMetrics
ClickMetrics

Retorna métricas de clique agrupadas por referenciadores para o link especificado.

Parâmetros

Nome Chave Obrigatório Tipo Description
Bitlink
bitlink True string

Um Bitlink feito do domínio e do hash

Unidade
unit True string

Uma unidade de tempo

Unidades
units True integer

Um inteiro que representa as unidades de tempo para as quais consultar dados. passe -1 para retornar todas as unidades de tempo.

Tamanho
size integer

A quantidade de itens a serem retornados

Referência de unidade
unit_reference string

Um carimbo de data/hora ISO-8601, indicando o momento mais recente para o qual efetuar pull de métricas. O padrão será a hora atual.

Retornos

ReferrersByDomains
ReferrersByDomains

Retorna as origens da cidade do tráfego de clique para o link especificado.

Parâmetros

Nome Chave Obrigatório Tipo Description
Bitlink
bitlink True string

Um Bitlink feito do domínio e do hash

Unidade
unit True string

Uma unidade de tempo

Unidades
units True integer

Um inteiro que representa as unidades de tempo para as quais consultar dados. passe -1 para retornar todas as unidades de tempo.

Tamanho
size integer

A quantidade de itens a serem retornados

Referência de unidade
unit_reference string

Um carimbo de data/hora ISO-8601, indicando o momento mais recente para o qual efetuar pull de métricas. O padrão será a hora atual.

Retornos

CityMetrics
CityMetrics

Retorna as contagens de cliques de domínio de referência para o link especificado.

Parâmetros

Nome Chave Obrigatório Tipo Description
Bitlink
bitlink True string

Um Bitlink feito do domínio e do hash

Unidade
unit True string

Uma unidade de tempo

Unidades
units True integer

Um inteiro que representa as unidades de tempo para as quais consultar dados. passe -1 para retornar todas as unidades de tempo.

Tamanho
size integer

A quantidade de itens a serem retornados

Referência de unidade
unit_reference string

Um carimbo de data/hora ISO-8601, indicando o momento mais recente para o qual efetuar pull de métricas. O padrão será a hora atual.

Retornos

ClickMetrics
ClickMetrics

Obter o aplicativo OAuth

Recupere os detalhes da ID do cliente do Aplicativo OAuth fornecida.

Parâmetros

Nome Chave Obrigatório Tipo Description
Clique em ID
client_id True string

A ID do cliente de um aplicativo OAuth

Retornos

OAuthApp
OAuthApp

Retorna os detalhes e o histórico do link especificado.

Parâmetros

Nome Chave Obrigatório Tipo Description
Bitlink personalizado
custom_bitlink True string

Um Bitlink personalizado feito do domínio e da palavra-chave

Retornos

CustomBitlink
CustomBitlink

Obter organização

Recupere os detalhes da organização especificada.

Parâmetros

Nome Chave Obrigatório Tipo Description
GUID da organização
organization_guid True string

Um GUID para uma organização bitly

Retornos

Organização
Organization

Obter organizações

Recupere uma lista de organizações.

Retornos

Organizations
Organizations

Obter preferências de grupo

Retorna preferências para o grupo especificado.

Parâmetros

Nome Chave Obrigatório Tipo Description
GUID de grupo
group_guid True string

Um GUID para um grupo Bitly

Retornos

GroupPreferences
GroupPreferences

Retorna as contagens de cliques para o link especificado acumulado em um único campo.

Parâmetros

Nome Chave Obrigatório Tipo Description
Bitlink
bitlink True string

Um Bitlink feito do domínio e do hash

Unidade
unit True string

Uma unidade de tempo

Unidades
units True integer

Um inteiro que representa as unidades de tempo para as quais consultar dados. passe -1 para retornar todas as unidades de tempo.

Referência de unidade
unit_reference string

Um carimbo de data/hora ISO-8601, indicando o momento mais recente para o qual efetuar pull de métricas. O padrão será a hora atual.

Retornos

ClicksSummary
ClicksSummary

Obter usuário

Retorna informações para o usuário autenticado atual.

Retornos

Utilizador
User

Obter webhook

Retorna um webhook.

Parâmetros

Nome Chave Obrigatório Tipo Description
Webhook GUID
webhook_guid True string

Um GUID para um webhook bitly

Retornos

Webhook
Webhook

Obter webhooks

Buscar todos os webhooks disponíveis para uma organização

Parâmetros

Nome Chave Obrigatório Tipo Description
GUID da organização
organization_guid True string

Um GUID para uma organização bitly

Retornos

Webhooks
Webhooks

Verificar webhook

Envia o evento de ping para testar a configuração do webhook.

Parâmetros

Nome Chave Obrigatório Tipo Description
Webhook GUID
webhook_guid True string

Um GUID para um webhook bitly

Retornos

Webhook
Webhook

Definições

Organização

Nome Caminho Tipo Description
Referências
references object
nome
name string
bsds
bsds array of string
criadas
created string
is_active
is_active boolean
modificado
modified string
tier_display_name
tier_display_name string
tier_family
tier_family string
nível
tier string
função
role string
guid
guid string

Cliques

Nome Caminho Tipo Description
Unidades
units integer
unit_reference
unit_reference string
Unidade
unit Unit
link_clicks
link_clicks array of LinkClicks

CustomBitlinkHistory

Nome Caminho Tipo Description
hash
hash string
identificador único universal (UUID)
uuid string
palavra-chave
keyword string
criadas
created string
group_guid
group_guid string
first_created
first_created string
is_active
is_active boolean
long_url
long_url string
desativado
deactivated string
Bsd
bsd string
login
login string

OtherMetrics

Nome Caminho Tipo Description
other_city_clicks
other_city_clicks integer
no_city_clicks
no_city_clicks integer

Webhooks

Nome Caminho Tipo Description
Webhooks
webhooks array of Webhook

Organizations

Nome Caminho Tipo Description
organizações
organizations array of Organization

LinkClicks

Nome Caminho Tipo Description
date
date string
Cliques
clicks integer

PlanLimit

Nome Caminho Tipo Description
count
count integer
limit
limit integer
nome
name string
descrição
description string

DeeplinkRule

Nome Caminho Tipo Description
bitlink
bitlink string
install_url
install_url string
criadas
created string

Carimbo de data/hora ISO

app_uri_path
app_uri_path string
modificado
modified string

Carimbo de data/hora ISO

install_type
install_type string
app_guid
app_guid string
guid
guid string
os
os string
brand_guid
brand_guid string

Campanha

Nome Caminho Tipo Description
Referências
references object
nome
name string
criadas
created string

Carimbo de data/hora ISO

group_guid
group_guid string
modificado
modified string

Carimbo de data/hora ISO

created_by
created_by string
guid
guid string
descrição
description string

OAuthApp

Nome Caminho Tipo Description
link
link string
nome
name string
ID do cliente
client_id string
descrição
description string

Canais

Nome Caminho Tipo Description
canais
channels array of Channel

PlatformLimits

Nome Caminho Tipo Description
platform_limits
platform_limits array of PlatformLimit

Paginação

Nome Caminho Tipo Description
total
total integer
size
size integer
Prev
prev string
página
page integer
próximo
next string

BSDsResponse

Nome Caminho Tipo Description
bsds
bsds array of string

GroupPreferences

Nome Caminho Tipo Description
group_guid
group_guid string
domain_preference
domain_preference string

ClicksSummary

Nome Caminho Tipo Description
Unidades
units integer
Unidade
unit Unit
total_clicks
total_clicks integer
unit_reference
unit_reference string

Email

Nome Caminho Tipo Description
is_primary
is_primary boolean
is_verified
is_verified boolean
email
email string

Campaigns

Nome Caminho Tipo Description
campanhas
campaigns array of Campaign
Nome Caminho Tipo Description
long_url
long_url string
criado_em
created_at string
link
link string
id
id string
Nome Caminho Tipo Description
BitlinkBody
bitlink BitlinkBody
bitlink_history
bitlink_history array of CustomBitlinkHistory
custom_bitlink
custom_bitlink string
Nome Caminho Tipo Description
sorted_links
sorted_links array of ClickLink
links
links array of BitlinkBody
Nome Caminho Tipo Description
Cliques
clicks integer
id
id string

PlatformLimit

Nome Caminho Tipo Description
ponto de extremidade
endpoint string
Métodos
methods array of MethodLimit

Métrica

Nome Caminho Tipo Description
value
value integer
chave
key string

BitlinkOverridesData

Nome Caminho Tipo Description
total_count
total_count integer
substituições
overrides array of BitlinkOverrides

ReferrersByDomains

Nome Caminho Tipo Description
Unidades
units integer
Faceta2
facet Facet2
referrers_by_domain
referrers_by_domain array of ReferrersByDomain
unit_reference
unit_reference string
unidade
unit string

CityMetric

Nome Caminho Tipo Description
city
city string
região
region string
Sub-região
subregion string
Cliques
clicks integer
country
country string

Grupo

Nome Caminho Tipo Description
Referências
references object
nome
name string
bsds
bsds array of string
criadas
created string
is_active
is_active boolean
modificado
modified string
organization_guid
organization_guid string
função
role string
guid
guid string

ShortenBitlinkBody

Nome Caminho Tipo Description
Referências
references object
Arquivados
archived boolean
tags
tags array of string
criado_em
created_at string
deeplinks
deeplinks array of DeeplinkRule
long_url
long_url string
custom_bitlinks
custom_bitlinks array of string
link
link string
id
id string
Nome Caminho Tipo Description
Paginação
pagination Pagination
links
links array of BitlinkBody

Etiquetas

Nome Caminho Tipo Description
tags
tags array of string

Webhook

Nome Caminho Tipo Description
Referências
references object
status
status string
modified_by
modified_by string
nome
name string
criadas
created string
url
url string
desativado
deactivated string
fetch_tags
fetch_tags boolean
is_active
is_active boolean
modificado
modified string
organization_guid
organization_guid string
ID do cliente
client_id string
group_guid
group_guid string
segredo_do_cliente
client_secret string
oauth_url
oauth_url string
guid
guid string
evento
event string

GroupClicks

Nome Caminho Tipo Description
Unidades
units integer
dados
data array of CountItem
unit_reference
unit_reference string
unidade
unit string

Groups

Nome Caminho Tipo Description
groups
groups array of Group

Utilizador

Nome Caminho Tipo Description
default_group_guid
default_group_guid string
nome
name string
criadas
created string
is_active
is_active boolean
modificado
modified string
is_sso_user
is_sso_user boolean
is_2fa_enabled
is_2fa_enabled boolean
login
login string
e-mails
emails array of Email

BulkAddResponse

Nome Caminho Tipo Description
mensagem
message string
Data1
data Data1

BitlinkQR

Nome Caminho Tipo Description
qr_code
qr_code string

URI de dados da imagem de código QR

link
link string
id
id string

CityMetrics

Nome Caminho Tipo Description
Unidades
units integer
Faceta1
facet Facet1
unit_reference
unit_reference string
unidade
unit string
métricas
metrics array of CityMetric
OtherMetrics
other_metrics OtherMetrics

BulkUpdate

Nome Caminho Tipo Description
links
links array of string

MethodLimit

Nome Caminho Tipo Description
count
count integer
limit
limit integer
nome
name string

DeviceMetrics

Nome Caminho Tipo Description
Unidades
units integer
Faceta1
facet Facet1
unit_reference
unit_reference string
unidade
unit string
métricas
metrics array of DeviceMetric

BitlinkBody

Nome Caminho Tipo Description
Referências
references object
Arquivados
archived boolean
tags
tags array of string
criado_em
created_at string
title
title string
deeplinks
deeplinks array of DeeplinkRule
created_by
created_by string
long_url
long_url string
ID do cliente
client_id string
custom_bitlinks
custom_bitlinks array of string
link
link string
launchpad_ids
launchpad_ids array of string
id
id string

ClickMetrics

Nome Caminho Tipo Description
Unidades
units integer
Faceta1
facet Facet1
unit_reference
unit_reference string
unidade
unit string
métricas
metrics array of ClickMetric

Channel

Nome Caminho Tipo Description
group_guid
group_guid string
guid
guid string
nome
name string
modificado
modified string

ISO_TIMESTAMP

criadas
created string

ISO TIMESTAMP

Referências
references object

DeviceMetric

Nome Caminho Tipo Description
Cliques
clicks integer
device_type
device_type string

Métricas

Nome Caminho Tipo Description
Unidades
units integer
Faceta1
facet Facet1
unit_reference
unit_reference string
unidade
unit string
métricas
metrics array of Metric

ClickMetric

Nome Caminho Tipo Description
Cliques
clicks integer
value
value string

CountItem

Nome Caminho Tipo Description
count
count integer
Ts
ts string

ReferrersByDomain

Nome Caminho Tipo Description
Referrers
referrers array of Metric
rede
network string

PlanLimits

Nome Caminho Tipo Description
Referências
references object
organization_guid
organization_guid string
plan_limits
plan_limits array of PlanLimit

BitlinkOverrides

Nome Caminho Tipo Description
Referências
references object
criadas
created string
regras
rules string
group_guid
group_guid string
modificado
modified string
versão
version integer
link
link string

A URL totalmente qualificada para a substituição que é o link bitly a ser usado. Por exemplo: https://foo.com/bar

id
id string

Data1

Nome Caminho Tipo Description
link_save_failures
link_save_failures integer
keyword_failures
keyword_failures integer
results
results array of string
Sucessos
successes integer
channel_bitlink_failures
channel_bitlink_failures integer
csv_format_failures
csv_format_failures integer

Faceta1

Faceta1
string

Faceta2

Faceta2
string

Unidade

Unidade
string