Partilhar via


BitlyIP (Editora Independente)

Bitly é a plataforma de gerenciamento de links mais confiável do mundo. Ao usar a API Bitly, você exercerá todo o poder de seus links por meio da personalização automatizada de links, deep linking móvel e análise de cliques.

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

Serviço Class Regiões
Estúdio Copiloto Premium Todas as regiões do Power Automatic , 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 do Azure Government
     - Regiões do Azure China
     - Departamento de Defesa dos EUA (DoD)
Aplicações Power Premium Todas as regiões do 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)
Automatize o poder Premium Todas as regiões do Power Automatic , exceto as seguintes:
     - Governo dos EUA (CCG)
     - Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Contato
Nome Troia Taylor
URL https://www.hitachisolutions.com
Email ttaylor@hitachisolutions.com
Metadados do conector
Editora Troia Taylor
Sítio Web https://bitly.com/
Política de privacidade https://bitly.com/pages/privacy
Categorias Redes Sociais; Sítio Web

A criar uma ligação

O conector suporta os seguintes tipos de autenticação:

Predefinição 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.

Esta conexão não é compartilhável. Se o aplicativo avançado 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

Limites de Limitação

Name Chamadas Período de Renovação
Chamadas de API por conexão 100 60 segundos

Ações

Adicionar Bitlink personalizado

Adicione uma palavra-chave (ou back-half personalizado) 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

Adicione Bitlinks em massa a vários canais de campanha

Atualizar Bitlink

Atualiza os campos no link especificado.

Atualizar Bitlink personalizado

Mova uma palavra-chave (ou back-half personalizado) para um Bitlink diferente.

Atualizar Bitlinks por grupo

A atualização em massa pode adicionar ou remover tags ou arquivar até 100 links de cada vez; A resposta inclui uma lista de ids Bitlink que foram atualizados.

Atualizar campanha

Atualiza os detalhes de uma campanha.

Atualizar grupo

Atualiza os detalhes de um grupo.

Atualizar preferências de grupo

Atualiza as preferências de um grupo.

Atualizar utilizador

Atualizar campos no usuário

Atualizar webhook

Atualizar um webhook

Canal de atualização

Atualiza um canal existente.

Criar Bitlink

Converte um URL longo em um Bitlink.

Criar Bitlink completo

Converte um URL longo 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 Bitlink

Retorna o link curto e o URL longo para o link especificado.

Obtenha Bitlink personalizado

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

Obtenha Bitlinks personalizados para BSDs

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

Obtenha métricas Bitlink personalizadas por destino

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

Obtenha métricas para Bitlink por cidades

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

Obtenha métricas para Bitlink por dispositivos

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

Obtenha métricas para Bitlink referindo domínios

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

Obtenha o aplicativo OAuth

Recupere os detalhes da ID do cliente do aplicativo OAuth fornecido.

Obtenha organização

Recupere detalhes da organização especificada.

Obter Bitlink

Retorna informações para o link especificado.

Obter Bitlinks classificados

Retorna uma lista de Bitlinks classificados por grupo.

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

Devolve detalhes de uma campanha.

Obter canais

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

Obter canal

Retorna os detalhes de um canal.

Obter cliques em grupos

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

Obter cliques para Bitlink

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

Obter cliques para 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 encurtamento de grupo

Devolve todas as contagens de encurtamento para um grupo.

Obter código QR 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 planos

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

Obter limites de plataforma

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

Obter métricas de grupo por cidades

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

Obter métricas de grupo por dispositivos

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

Obter métricas de grupo por países

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

Obter métricas de grupo por redes de referência

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

Obter métricas para Bitlink por países

Retorna o país de origem do tráfego de cliques 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 organização encurtar contagens

Devolve as contagens mais curtas para uma organização específica durante um período de tempo especificado.

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 Bitlink

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

Obter tags de grupo

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

Obter utilizador

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

Receba campanhas

Retorna as campanhas para o usuário autenticado atual.

Verificar webhook

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

Adicione uma palavra-chave (ou back-half personalizado) 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

Name Chave Necessário Tipo Description
bitlink_id
bitlink_id string
custom_bitlink
custom_bitlink string

Devoluções

CustomBitlink
CustomBitlink

Adicione Bitlinks em massa a vários canais de campanha

Parâmetros

Name Chave Necessário Tipo Description
GUID da Campanha
campaign_guid True string

Um GUID para uma campanha Bitly

Tipo de conteúdo
Content-Type string

O tipo de conteúdo.

Ficheiro
file file

O arquivo.

Devoluções

BulkAddResponse
BulkAddResponse

Atualiza os campos no link especificado.

Parâmetros

Name Chave Necessário Tipo Description
Ligação Bitlink
bitlink True string

Um Bitlink feito do domínio e hash

Referências
references object
arquivado
archived boolean
tags
tags array of string
criado_em
created_at string
title
title string
link de bits
bitlink string
install_url
install_url string
criado
created string

Carimbo de data/hora ISO

app_uri_path
app_uri_path string
modified
modified string

Carimbo de data/hora ISO

install_type
install_type string
app_guid
app_guid string
Identificador Globalmente Único (GUID)
guid string
os
os string
brand_guid
brand_guid string
criado_por
created_by string
long_url
long_url string
ID do cliente
client_id string
custom_bitlinks
custom_bitlinks array of string
ligação
link string
launchpad_ids
launchpad_ids array of string
id
id string

Devoluções

BitlinkBody
BitlinkBody

Mova uma palavra-chave (ou back-half personalizado) para um Bitlink diferente.

Parâmetros

Name Chave Necessário Tipo Description
Bitlink personalizado
custom_bitlink True string

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

bitlink_id
bitlink_id string

Devoluções

CustomBitlink
CustomBitlink

A atualização em massa pode adicionar ou remover tags ou arquivar até 100 links de cada vez; A resposta inclui uma lista de ids Bitlink que foram atualizados.

Parâmetros

Name Chave Necessário Tipo Description
GUID do 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 Bitlink

add_tags
add_tags array of string

Devoluções

BulkUpdate
BulkUpdate

Atualizar campanha

Atualiza os detalhes de uma campanha.

Parâmetros

Name Chave Necessário Tipo Description
GUID da 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

Devoluções

Campanha
Campaign

Atualizar grupo

Atualiza os detalhes de um grupo.

Parâmetros

Name Chave Necessário Tipo Description
GUID do Grupo
group_guid True string

Um GUID para um grupo Bitly

BSDs
bsds array of string
nome
name string
organization_guid
organization_guid string

Devoluções

Grupo
Group

Atualizar preferências de grupo

Atualiza as preferências de um grupo.

Parâmetros

Name Chave Necessário Tipo Description
GUID do Grupo
group_guid True string

Um GUID para um grupo Bitly

group_guid
group_guid string
domain_preference
domain_preference string

Devoluções

Preferências de Grupo
GroupPreferences

Atualizar utilizador

Atualizar campos no usuário

Parâmetros

Name Chave Necessário Tipo Description
default_group_guid
default_group_guid string
nome
name string

Devoluções

User
User

Atualizar webhook

Atualizar um webhook

Parâmetros

Name Chave Necessá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
client_secret
client_secret string
oauth_url
oauth_url string
Identificador Globalmente Único (GUID)
guid True string
evento
event string

Devoluções

webhook
Webhook

Canal de atualização

Atualiza um canal existente.

Parâmetros

Name Chave Necessário Tipo Description
GUID do canal
channel_guid True string

Um GUID para um canal Bitly

group_guid
group_guid string
Identificador Globalmente Único (GUID)
guid string
nome
name string
modified
modified string

ISO_TIMESTAMP

criado
created string

CARIMBO DE DATA/HORA ISO

campaign_guid
campaign_guid string
bitlink_id
bitlink_id string

Devoluções

Channel
Channel

Converte um URL longo em um Bitlink.

Parâmetros

Name Chave Necessário Tipo Description
group_guid
group_guid string
domínio
domain string
long_url
long_url True string

Devoluções

EncurtarBitlinkBody
ShortenBitlinkBody

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

Parâmetros

Name Chave Necessário Tipo Description
domínio
domain string
title
title string
group_guid
group_guid string

Inclua sempre um grupo específico e um domínio personalizado nas suas chamadas mais curtas.

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

Devoluções

BitlinkBody
BitlinkBody

Criar campanha

Cria uma nova campanha.

Parâmetros

Name Chave Necessário Tipo Description
group_guid
group_guid string
channel_guids
channel_guids array of string
descrição
description string
nome
name string

Devoluções

Campanha
Campaign

Criar canal

Cria um novo canal.

Parâmetros

Name Chave Necessário Tipo Description
group_guid
group_guid string
Identificador Globalmente Único (GUID)
guid string
nome
name string
modified
modified string

ISO_TIMESTAMP

criado
created string

CARIMBO DE DATA/HORA ISO

campaign_guid
campaign_guid string
bitlink_id
bitlink_id string

Devoluções

Channel
Channel

Criar webhook

Cria um webhook.

Parâmetros

Name Chave Necessá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
client_secret
client_secret string
oauth_url
oauth_url string
evento
event True string

Devoluções

webhook
Webhook

Excluir webhook

Exclui um webhook.

Parâmetros

Name Chave Necessário Tipo Description
Webhook GUID
webhook_guid True string

Um GUID para um webhook Bitly

Retorna o link curto e o URL longo para o link especificado.

Parâmetros

Name Chave Necessário Tipo Description
bitlink_id
bitlink_id string

Devoluções

ExpandedBitlink
ExpandedBitlink

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

Parâmetros

Name Chave Necessário Tipo Description
Bitlink personalizado
custom_bitlink True string

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

Devoluções

CustomBitlink
CustomBitlink

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

Parâmetros

Name Chave Necessário Tipo Description
GUID do Grupo
group_guid True string

Um GUID para um grupo Bitly

Criado após
created_after integer

Timestamp como uma época unix inteira

Limite
limit integer

limitar a quantidade de resultados retornados

Compensação
offset integer

Definir o índice inicial do conjunto de resultados

BSD
bsd array

um domínio curto de marca para filtrar resultados

Devoluções

BitlinkOverridesData
BitlinkOverridesData

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

Parâmetros

Name Chave Necessário Tipo Description
Bitlink personalizado
custom_bitlink True string

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

Unidade
unit True string

Uma unidade de tempo

Units
units True integer

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

Referência da Unidade
unit_reference string

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

Devoluções

ClickMetrics
ClickMetrics

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

Parâmetros

Name Chave Necessário Tipo Description
Ligação Bitlink
bitlink True string

Um Bitlink feito do domínio e hash

Unidade
unit True string

Uma unidade de tempo

Units
units True integer

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

Tamanho
size integer

A quantidade de artigos a devolver

Referência da Unidade
unit_reference string

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

Devoluções

CityMetrics
CityMetrics

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

Parâmetros

Name Chave Necessário Tipo Description
Ligação Bitlink
bitlink True string

Um Bitlink feito do domínio e hash

Unidade
unit True string

Uma unidade de tempo

Units
units True integer

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

Tamanho
size integer

A quantidade de artigos a devolver

Referência da Unidade
unit_reference string

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

Devoluções

DeviceMetrics
DeviceMetrics

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

Parâmetros

Name Chave Necessário Tipo Description
Ligação Bitlink
bitlink True string

Um Bitlink feito do domínio e hash

Unidade
unit True string

Uma unidade de tempo

Units
units True integer

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

Tamanho
size integer

A quantidade de artigos a devolver

Referência da Unidade
unit_reference string

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

Devoluções

ClickMetrics
ClickMetrics

Obtenha o aplicativo OAuth

Recupere os detalhes da ID do cliente do aplicativo OAuth fornecido.

Parâmetros

Name Chave Necessário Tipo Description
Clique em ID
client_id True string

A ID do cliente de um aplicativo OAuth

Devoluções

OAuthApp
OAuthApp

Obtenha organização

Recupere detalhes da organização especificada.

Parâmetros

Name Chave Necessário Tipo Description
GUID da Organização
organization_guid True string

Um GUID para uma organização Bitly

Devoluções

Organização
Organization

Retorna informações para o link especificado.

Parâmetros

Name Chave Necessário Tipo Description
Ligação Bitlink
bitlink True string

Um Bitlink feito do domínio e hash

Devoluções

BitlinkBody
BitlinkBody

Retorna uma lista de Bitlinks classificados por grupo.

Parâmetros

Name Chave Necessário Tipo Description
GUID do Grupo
group_guid True string

Um GUID para um grupo Bitly

Ordenar
sort True string

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

Unidade
unit string

Uma unidade de tempo

Units
units integer

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

Referência da Unidade
unit_reference string

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

Tamanho
size integer

A quantidade de artigos a devolver

Devoluções

SortedLinks
SortedLinks

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

Parâmetros

Name Chave Necessário Tipo Description
GUID do Grupo
group_guid True string

Um GUID para um grupo Bitly

Tamanho
size integer

A quantidade de artigos a devolver

Página
page integer

Inteiro especificando o resultado numerado no qual começar

Keyword
keyword string

Palavra-chave personalizada para filtrar entradas do histórico

Query
query string

O valor que você gostaria de pesquisar

Criado antes
created_before integer

Timestamp como uma época unix inteira

Criado após
created_after integer

Timestamp como uma época unix inteira

Modificado após
modified_after integer

Timestamp como uma época unix inteira

Arquivado
archived string

Inclusão ou não de bitlinks arquivados

Ligações profundas
deeplinks string

Filtrar apenas Bitlinks que contenham deeplinks

Deeplinks de Domínio
domain_deeplinks string

Filtrar apenas Bitlinks que contenham deeplinks configurados com um domínio personalizado

GUID da Campanha
campaign_guid string

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

GUILD do canal
channel_guid string

Filtro para retornar apenas links para o GUID do canal determinado, pode ser fornecido, substitui todos os outros parâmetros

Bitlink personalizado
custom_bitlink string

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

Etiquetas
tags array

filtrar por determinadas tags

IDs da Barra Inicial
launchpad_ids array

Filtrar por ID da Barra Inicial

Login de codificação
encoding_login array

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

Devoluções

Ligações de bits
Bitlinks

Obter BSDs

Buscar todos os Domínios Curtos de Marca.

Devoluções

BSDsResponse
BSDsResponse

Obter campanha

Devolve detalhes de uma campanha.

Parâmetros

Name Chave Necessário Tipo Description
GUID da Campanha
campaign_guid True string

Um GUID para uma campanha Bitly

Devoluções

Campanha
Campaign

Obter canais

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

Parâmetros

Name Chave Necessário Tipo Description
GUID do Grupo
group_guid string

Um GUID para um grupo Bitly

GUID da Campanha
campaign_guid string

Um GUID para uma campanha Bitly

Devoluções

Channels
Channels

Obter canal

Retorna os detalhes de um canal.

Parâmetros

Name Chave Necessário Tipo Description
GUID do canal
channel_guid True string

Um GUID para um canal Bitly

Devoluções

Channel
Channel

Obter cliques em grupos

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

Parâmetros

Name Chave Necessário Tipo Description
GUID do Grupo
group_guid True string

Um GUID para um grupo Bitly

Unidade
unit True string

Uma unidade de tempo

Units
units True integer

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

Referência da Unidade
unit_reference string

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

Devoluções

GroupClicks [en]
GroupClicks

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

Parâmetros

Name Chave Necessário Tipo Description
Ligação Bitlink
bitlink True string

Um Bitlink feito do domínio e hash

Unidade
unit True string

Uma unidade de tempo

Units
units True integer

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

Referência da Unidade
unit_reference string

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

Devoluções

Cliques
Clicks

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

Parâmetros

Name Chave Necessário Tipo Description
Bitlink personalizado
custom_bitlink True string

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

Unidade
unit True string

Uma unidade de tempo

Units
units True integer

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

Referência da Unidade
unit_reference string

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

Devoluções

Cliques
Clicks

Obter contagens de encurtamento de grupo

Devolve todas as contagens de encurtamento para um grupo.

Parâmetros

Name Chave Necessário Tipo Description
GUID do Grupo
group_guid True string

Um GUID para um grupo Bitly

Unidade
unit True string

Uma unidade de tempo

Units
units True integer

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

Referência da Unidade
unit_reference string

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

Devoluções

Metrics
Metrics

Gera um código QR para um Bitlink.

Parâmetros

Name Chave Necessário Tipo Description
Ligação Bitlink
bitlink True string

Um Bitlink feito do domínio e 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 devolvido

Devoluções

BitlinkQR
BitlinkQR

Obter grupo

Retorna detalhes de um grupo.

Parâmetros

Name Chave Necessário Tipo Description
GUID do Grupo
group_guid True string

Um GUID para um grupo Bitly

Devoluções

Grupo
Group

Obter grupos

Retorna uma lista de grupos na organização.

Parâmetros

Name Chave Necessário Tipo Description
GUID da Organização
organization_guid string

Um GUID para uma organização Bitly

Devoluções

Groups
Groups

Obter limites de planos

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

Parâmetros

Name Chave Necessário Tipo Description
GUID da Organização
organization_guid True string

Um GUID para uma organização Bitly

Devoluções

Limites do Plano
PlanLimits

Obter limites de plataforma

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

Parâmetros

Name Chave Necessário Tipo Description
Caminho
path string

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

Devoluções

Limites da plataforma
PlatformLimits

Obter métricas de grupo por cidades

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

Parâmetros

Name Chave Necessário Tipo Description
GUID do Grupo
group_guid True string

Um GUID para um grupo Bitly

Unidade
unit True string

Uma unidade de tempo

Units
units True integer

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

Tamanho
size integer

A quantidade de artigos a devolver

Referência da Unidade
unit_reference string

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

Devoluções

CityMetrics
CityMetrics

Obter métricas de grupo por dispositivos

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

Parâmetros

Name Chave Necessário Tipo Description
GUID do Grupo
group_guid True string

Um GUID para um grupo Bitly

Unidade
unit True string

Uma unidade de tempo

Units
units True integer

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

Tamanho
size integer

A quantidade de artigos a devolver

Referência da Unidade
unit_reference string

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

Devoluções

DeviceMetrics
DeviceMetrics

Obter métricas de grupo por países

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

Parâmetros

Name Chave Necessário Tipo Description
GUID do Grupo
group_guid True string

Um GUID para um grupo Bitly

Unidade
unit True string

Uma unidade de tempo

Units
units True integer

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

Tamanho
size integer

A quantidade de artigos a devolver

Referência da Unidade
unit_reference string

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

Devoluções

ClickMetrics
ClickMetrics

Obter métricas de grupo por redes de referência

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

Parâmetros

Name Chave Necessário Tipo Description
GUID do Grupo
group_guid True string

Um GUID para um grupo Bitly

Devoluções

ClickMetrics
ClickMetrics

Retorna o país de origem do tráfego de cliques para o link especificado.

Parâmetros

Name Chave Necessário Tipo Description
Ligação Bitlink
bitlink True string

Um Bitlink feito do domínio e hash

Unidade
unit True string

Uma unidade de tempo

Units
units True integer

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

Tamanho
size integer

A quantidade de artigos a devolver

Referência da Unidade
unit_reference string

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

Devoluções

ClickMetrics
ClickMetrics

Retorna contagens de cliques do referenciador para o link especificado.

Parâmetros

Name Chave Necessário Tipo Description
Ligação Bitlink
bitlink True string

Um Bitlink feito do domínio e hash

Unidade
unit True string

Uma unidade de tempo

Units
units True integer

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

Tamanho
size integer

A quantidade de artigos a devolver

Referência da Unidade
unit_reference string

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

Devoluções

ClickMetrics
ClickMetrics

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

Parâmetros

Name Chave Necessário Tipo Description
Ligação Bitlink
bitlink True string

Um Bitlink feito do domínio e hash

Unidade
unit True string

Uma unidade de tempo

Units
units True integer

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

Tamanho
size integer

A quantidade de artigos a devolver

Referência da Unidade
unit_reference string

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

Devoluções

ReferrersByDomains
ReferrersByDomains

Obter organização encurtar contagens

Devolve as contagens mais curtas para uma organização específica durante um período de tempo especificado.

Parâmetros

Name Chave Necessá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

Units
units True integer

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

Referência da Unidade
unit_reference string

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

Devoluções

Metrics
Metrics

Obter organizações

Recupere uma lista de organizações.

Devoluções

Organizations
Organizations

Obter preferências de grupo

Retorna preferências para o grupo especificado.

Parâmetros

Name Chave Necessário Tipo Description
GUID do Grupo
group_guid True string

Um GUID para um grupo Bitly

Devoluções

Preferências de Grupo
GroupPreferences

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

Parâmetros

Name Chave Necessário Tipo Description
Ligação Bitlink
bitlink True string

Um Bitlink feito do domínio e hash

Unidade
unit True string

Uma unidade de tempo

Units
units True integer

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

Referência da Unidade
unit_reference string

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

Devoluções

CliquesResumo
ClicksSummary

Obter tags de grupo

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

Parâmetros

Name Chave Necessário Tipo Description
GUID do Grupo
group_guid True string

Um GUID para um grupo Bitly

Devoluções

Etiquetas
Tags

Obter utilizador

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

Devoluções

User
User

Obter webhook

Retorna um webhook.

Parâmetros

Name Chave Necessário Tipo Description
Webhook GUID
webhook_guid True string

Um GUID para um webhook Bitly

Devoluções

webhook
Webhook

Obter webhooks

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

Parâmetros

Name Chave Necessário Tipo Description
GUID da Organização
organization_guid True string

Um GUID para uma organização Bitly

Devoluções

Webhooks
Webhooks

Receba campanhas

Retorna as campanhas para o usuário autenticado atual.

Parâmetros

Name Chave Necessário Tipo Description
GUID do Grupo
group_guid string

Um GUID para um grupo Bitly

Devoluções

Campaigns
Campaigns

Verificar webhook

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

Parâmetros

Name Chave Necessário Tipo Description
Webhook GUID
webhook_guid True string

Um GUID para um webhook Bitly

Devoluções

webhook
Webhook

Definições

Organização

Name Caminho Tipo Description
Referências
references object
nome
name string
BSDs
bsds array of string
criado
created string
is_active
is_active boolean
modified
modified string
tier_display_name
tier_display_name string
tier_family
tier_family string
escalão
tier string
função
role string
Identificador Globalmente Único (GUID)
guid string

Cliques

Name Caminho Tipo Description
unidades
units integer
unit_reference
unit_reference string
Unidade
unit Unit
link_clicks
link_clicks array of LinkClicks

CustomBitlinkHistory

Name Caminho Tipo Description
hash
hash string
Identificador Único Universal (UUID)
uuid string
palavra-chave
keyword string
criado
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

OutrosMetrics

Name Caminho Tipo Description
other_city_clicks
other_city_clicks integer
no_city_clicks
no_city_clicks integer

Webhooks

Name Caminho Tipo Description
webhooks
webhooks array of Webhook

Organizations

Name Caminho Tipo Description
organizations
organizations array of Organization

LinkCliques

Name Caminho Tipo Description
date
date string
cliques
clicks integer

PlanLimit

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

Regra DeeplinkRule

Name Caminho Tipo Description
link de bits
bitlink string
install_url
install_url string
criado
created string

Carimbo de data/hora ISO

app_uri_path
app_uri_path string
modified
modified string

Carimbo de data/hora ISO

install_type
install_type string
app_guid
app_guid string
Identificador Globalmente Único (GUID)
guid string
os
os string
brand_guid
brand_guid string

Campanha

Name Caminho Tipo Description
Referências
references object
nome
name string
criado
created string

Carimbo de data/hora ISO

group_guid
group_guid string
modified
modified string

Carimbo de data/hora ISO

criado_por
created_by string
Identificador Globalmente Único (GUID)
guid string
descrição
description string

OAuthApp

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

Channels

Name Caminho Tipo Description
channels
channels array of Channel

Limites da plataforma

Name Caminho Tipo Description
platform_limits
platform_limits array of PlatformLimit

Paginação

Name Caminho Tipo Description
total
total integer
size
size integer
anterior
prev string
página
page integer
next
next string

BSDsResponse

Name Caminho Tipo Description
BSDs
bsds array of string

Preferências de Grupo

Name Caminho Tipo Description
group_guid
group_guid string
domain_preference
domain_preference string

CliquesResumo

Name Caminho Tipo Description
unidades
units integer
Unidade
unit Unit
total_clicks
total_clicks integer
unit_reference
unit_reference string

Email

Name Caminho Tipo Description
is_primary
is_primary boolean
is_verified
is_verified boolean
e-mail
email string

Campaigns

Name Caminho Tipo Description
campanhas
campaigns array of Campaign
Name Caminho Tipo Description
long_url
long_url string
criado_em
created_at string
ligação
link string
id
id string
Name Caminho Tipo Description
BitlinkBody
bitlink BitlinkBody
bitlink_history
bitlink_history array of CustomBitlinkHistory
custom_bitlink
custom_bitlink string
Name Caminho Tipo Description
sorted_links
sorted_links array of ClickLink
links
links array of BitlinkBody
Name Caminho Tipo Description
cliques
clicks integer
id
id string

PlataformaLimite

Name Caminho Tipo Description
ponto final
endpoint string
Metodologia
methods array of MethodLimit

Métrico

Name Caminho Tipo Description
valor
value integer
chave
key string

BitlinkOverridesData

Name Caminho Tipo Description
total_count
total_count integer
sobrescrições
overrides array of BitlinkOverrides

ReferrersByDomains

Name 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

Name Caminho Tipo Description
city
city string
região
region string
sub-região
subregion string
cliques
clicks integer
country
country string

Grupo

Name Caminho Tipo Description
Referências
references object
nome
name string
BSDs
bsds array of string
criado
created string
is_active
is_active boolean
modified
modified string
organization_guid
organization_guid string
função
role string
Identificador Globalmente Único (GUID)
guid string

EncurtarBitlinkBody

Name Caminho Tipo Description
Referências
references object
arquivado
archived boolean
tags
tags array of string
criado_em
created_at string
Ligações profundas
deeplinks array of DeeplinkRule
long_url
long_url string
custom_bitlinks
custom_bitlinks array of string
ligação
link string
id
id string

Ligações de bits

Name Caminho Tipo Description
Paginação
pagination Pagination
links
links array of BitlinkBody

Etiquetas

Name Caminho Tipo Description
tags
tags array of string

webhook

Name Caminho Tipo Description
Referências
references object
estado
status string
modified_by
modified_by string
nome
name string
criado
created string
URL
url string
desativado
deactivated string
fetch_tags
fetch_tags boolean
is_active
is_active boolean
modified
modified string
organization_guid
organization_guid string
ID do cliente
client_id string
group_guid
group_guid string
client_secret
client_secret string
oauth_url
oauth_url string
Identificador Globalmente Único (GUID)
guid string
evento
event string

GroupClicks [en]

Name Caminho Tipo Description
unidades
units integer
dados
data array of CountItem
unit_reference
unit_reference string
unidade
unit string

Groups

Name Caminho Tipo Description
groups
groups array of Group

User

Name Caminho Tipo Description
default_group_guid
default_group_guid string
nome
name string
criado
created string
is_active
is_active boolean
modified
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

Name Caminho Tipo Description
mensagem
message string
Dados1
data Data1

BitlinkQR

Name Caminho Tipo Description
qr_code
qr_code string

URI de dados da imagem do QR Code

ligação
link string
id
id string

CityMetrics

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

BulkUpdate

Name Caminho Tipo Description
links
links array of string

MethodLimit

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

DeviceMetrics

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

BitlinkBody

Name Caminho Tipo Description
Referências
references object
arquivado
archived boolean
tags
tags array of string
criado_em
created_at string
title
title string
Ligações profundas
deeplinks array of DeeplinkRule
criado_por
created_by string
long_url
long_url string
ID do cliente
client_id string
custom_bitlinks
custom_bitlinks array of string
ligação
link string
launchpad_ids
launchpad_ids array of string
id
id string

ClickMetrics

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

Channel

Name Caminho Tipo Description
group_guid
group_guid string
Identificador Globalmente Único (GUID)
guid string
nome
name string
modified
modified string

ISO_TIMESTAMP

criado
created string

CARIMBO DE DATA/HORA ISO

Referências
references object

DeviceMetric

Name Caminho Tipo Description
cliques
clicks integer
device_type
device_type string

Metrics

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

ClickMetric

Name Caminho Tipo Description
cliques
clicks integer
valor
value string

CountItem

Name Caminho Tipo Description
count
count integer
TS
ts string

ReferrersByDomain

Name Caminho Tipo Description
referências
referrers array of Metric
rede
network string

Limites do Plano

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

BitlinkSubstitui

Name Caminho Tipo Description
Referências
references object
criado
created string
rules
rules string
group_guid
group_guid string
modified
modified string
versão
version integer
ligação
link string

O URL totalmente qualificado para a substituição, que é o link Bitly a ser usado. Por exemplo: https://foo.com/bar

id
id string

Dados1

Name 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