Udostępnij przez


BitlyIP (niezależny wydawca)

Bitly jest najbardziej zaufaną platformą zarządzania linkami na świecie. Korzystając z interfejsu API Bitly, będziesz wykonywać pełne możliwości linków za pomocą automatycznego dostosowywania linków, łączenia bezpośredniego dla urządzeń przenośnych i klikania analiz.

Ten łącznik jest dostępny w następujących produktach i regionach:

Usługa Class Regions
Copilot Studio Premium Wszystkie regiony usługi Power Automate z wyjątkiem następujących:
     - Rząd USA (GCC)
     - Rząd USA (GCC High)
     - China Cloud obsługiwane przez firmę 21Vianet
     - Departament Obrony USA (DoD)
Logic Apps Standard Wszystkie regiony usługi Logic Apps z wyjątkiem następujących:
     — Regiony platformy Azure Government
     — Regiony platformy Azure (Chiny)
     - Departament Obrony USA (DoD)
Power Apps Premium Wszystkie regiony usługi Power Apps z wyjątkiem następujących:
     - Rząd USA (GCC)
     - Rząd USA (GCC High)
     - China Cloud obsługiwane przez firmę 21Vianet
     - Departament Obrony USA (DoD)
Power Automate Premium Wszystkie regiony usługi Power Automate z wyjątkiem następujących:
     - Rząd USA (GCC)
     - Rząd USA (GCC High)
     - China Cloud obsługiwane przez firmę 21Vianet
     - Departament Obrony USA (DoD)
Kontakt
Name Troy Taylor
adres URL https://www.hitachisolutions.com
Email ttaylor@hitachisolutions.com
Metadane łącznika
Publisher Troy Taylor
Witryna internetowa https://bitly.com/
Zasady ochrony prywatności https://bitly.com/pages/privacy
Kategorie Media społecznościowe; Witryna internetowa

Tworzenie połączenia

Łącznik obsługuje następujące typy uwierzytelniania:

Wartość domyślna Parametry tworzenia połączenia. Wszystkie regiony Nie można udostępniać

Domyślny

Dotyczy: wszystkie regiony

Parametry tworzenia połączenia.

Nie jest to możliwe do udostępnienia połączenie. Jeśli aplikacja power zostanie udostępniona innemu użytkownikowi, zostanie wyświetlony monit o jawne utworzenie nowego połączenia.

Name Typ Description Wymagane
Klucz interfejsu API securestring Klucz interfejsu API dla tego interfejsu API Prawda

Limity ograniczania

Nazwa Wywołania Okres odnowienia
Wywołania interfejsu API na połączenie 100 60 sekund

Akcje

Aktualizowanie elementu webhook

Aktualizacja elementu webhook

Aktualizowanie grupy

Aktualizuje szczegóły grupy.

Aktualizowanie kampanii

Aktualizuje szczegóły kampanii.

Aktualizowanie kanału

Aktualizuje istniejący kanał.

Aktualizowanie linku bitowego

Aktualizuje pola w określonym linku.

Aktualizowanie linków bitowych według grupy

Aktualizacja zbiorcza może jednocześnie dodawać lub usuwać tagi lub archiwizować maksymalnie 100 łączy; Odpowiedź zawiera listę zaktualizowanych identyfikatorów linku bitowego.

Aktualizowanie niestandardowego linku bitowego

Przenieś słowo kluczowe (lub niestandardową połowę) do innego linku bitowego.

Aktualizowanie preferencji grupy

Aktualizuje preferencje dla grupy.

Aktualizowanie użytkownika

Aktualizowanie pól w użytkowniku

Dodawanie niestandardowego linku bitowego

Dodaj słowo kluczowe (lub niestandardową połowę wsteczną) do linku bitowego z domeną niestandardową. Ten punkt końcowy może być również używany do początkowych przekierowań do linku.

Pobieranie dysków BSD

Pobierz wszystkie znakowania krótkich domen.

Pobieranie elementu webhook

Zwraca element webhook.

Pobieranie elementów webhook

Pobieranie wszystkich elementów webhook dostępnych dla organizacji

Pobieranie grup

Zwraca listę grup w organizacji.

Pobieranie grupy

Zwraca szczegóły dla grupy.

Pobieranie kanału

Zwraca szczegóły kanału.

Pobieranie kanałów

Zwraca kanały dostępne dla użytkownika.

Pobieranie kliknięć dla linku bitowego

Zwraca liczbę kliknięć dla określonego łącza w tablicy na podstawie daty.

Pobieranie kliknięć dla niestandardowego linku bitowego

Zwraca liczbę kliknięć dla określonego linku. Zwraca tablicę z kliknięciami na podstawie daty.

Pobieranie kliknięć grup

Pobierz liczbę kliknięć na linkach bitowych w grupie.

Pobieranie liczby skrócenia liczby w organizacji

Zwraca liczbę skrócenia dla określonej organizacji w określonym przedziale czasu.

Pobieranie liczby skróconych grup

Zwraca wszystkie liczby skróconych dla grupy.

Pobieranie linków bitowych według grupy

Zwraca kolekcję bitów z podziałem na strony dla grupy.

Pobieranie metryk dla interfejsu Bitlink według miast

Zwraca źródła miasta dla określonego linku.

Pobieranie metryk dla linku Bitlink według odwołań

Zwraca liczbę kliknięć odwołań dla określonego linku.

Pobieranie metryk dla linku bitowego przez odwołanie do domen

Zwraca liczbę kliknięć w domenie odwołującej się dla określonego linku.

Pobieranie metryk dla linku bitowego według krajów

Zwraca pochodzenie kraju dla określonego linku.

Pobieranie metryk dla linku bitowego według odwołań według domen

Zwraca metryki kliknięć pogrupowane według odwołań dla określonego linku.

Pobieranie metryk dla linku bitowego według urządzeń

Zwraca typy urządzeń generujące ruch kliknięć do określonego linku.

Pobieranie metryk grup przez odwołania do sieci

Zwraca metryki, odwołując się do sieci dla łączy określonej grupy.

Pobieranie metryk grup według krajów

Zwraca pochodzenie geograficzne ruchu kliknięć według kraju dla określonej grupy.

Pobieranie metryk grup według miast

Zwraca geograficzne źródła ruchu kliknięć według miasta dla określonej grupy.

Pobieranie metryk grup według urządzeń

Zwraca typy urządzeń generujące ruch kliknięć do łączy określonej grupy.

Pobieranie niestandardowego linku bitowego

Zwraca szczegóły i historię określonego linku.

Pobieranie niestandardowych linków bitowych dla dysków BSD

Pobiera niestandardowe linki bitowe dla organizacji filtrowanej według identyfikatorów BSD.

Pobieranie niestandardowych metryk linku bitowego według miejsca docelowego

Zwraca metryki kliknięcia dla określonego linku według jego historycznych miejsc docelowych.

Pobieranie podsumowania kliknięć dla linku bitowego

Zwraca liczbę kliknięć dla określonego łącza zwiniętego w jedno pole.

Pobieranie posortowanych linków bitowych

Zwraca listę linków bitowych posortowanych według grupy.

Pobieranie preferencji grupy

Zwraca preferencje dla określonej grupy.

Pobieranie tagów grup

Zwraca tagi używane obecnie w określonej grupie. Maksymalnie 1000.

Pobieranie użytkownika

Zwraca informacje dla bieżącego uwierzytelnioowanego użytkownika.

Pobierz link bitowy

Zwraca informacje dla określonego linku.

Rozwiń link bitowy

Zwraca krótki link i długi adres URL dla określonego linku.

Tworzenie elementu webhook

Tworzy element webhook.

Tworzenie kampanii

Tworzy nową kampanię.

Tworzenie kanału

Tworzy nowy kanał.

Tworzenie linku bitowego

Konwertuje długi adres URL na link bitowy.

Tworzenie pełnego linku bitowego

Konwertuje długi adres URL na link bitowy i ustawia dodatkowe parametry.

Usuwanie elementu webhook

Usuwa element webhook.

Uzyskiwanie aplikacji OAuth

Pobierz szczegóły podanego identyfikatora klienta aplikacji OAuth.

Uzyskiwanie kampanii

Zwraca szczegóły kampanii.

Uzyskiwanie kampanii

Zwraca kampanie dla bieżącego uwierzytelnioowanego użytkownika.

Uzyskiwanie kodu QR linku bitowego

Generuje kod QR dla linku bitowego.

Uzyskiwanie limitów planu

Zwraca wszystkie limity i liczby planów dostępne dla organizacji.

Uzyskiwanie limitów platformy

Pobierz wszystkie limity i liczby platform dostępne dla organizacji

Uzyskiwanie organizacji

Pobierz szczegóły dla określonej organizacji.

Uzyskiwanie organizacji

Pobieranie listy organizacji.

Weryfikowanie elementu webhook

Wysyła zdarzenie ping w celu przetestowania konfiguracji elementu webhook.

Zbiorcze dodawanie linków bitowych do kanałów

Zbiorcze dodawanie linków bitowych do wielu kanałów kampanii

Aktualizowanie elementu webhook

Aktualizacja elementu webhook

Parametry

Nazwa Klucz Wymagane Typ Opis
Webhook GUID
webhook_guid True string

Identyfikator GUID elementu webhook bitly

nazwa
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
identyfikator_klienta
client_id string
client_secret
client_secret string
oauth_url
oauth_url string
przewodnik
guid True string
wydarzenie
event string

Zwraca

Webhook
Webhook

Aktualizowanie grupy

Aktualizuje szczegóły grupy.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator GUID grupy
group_guid True string

Identyfikator GUID dla grupy Bitly

bsds
bsds array of string
nazwa
name string
organization_guid
organization_guid string

Zwraca

Grupa
Group

Aktualizowanie kampanii

Aktualizuje szczegóły kampanii.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator GUID kampanii
campaign_guid True string

Identyfikator GUID dla nieco kampanii

group_guid
group_guid string
channel_guids
channel_guids array of string
opis
description string
nazwa
name string

Zwraca

Campaign
Campaign

Aktualizowanie kanału

Aktualizuje istniejący kanał.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator GUID kanału
channel_guid True string

Identyfikator GUID dla kanału bitowego

group_guid
group_guid string
przewodnik
guid string
nazwa
name string
modified
modified string

ISO_TIMESTAMP

utworzone
created string

ZNACZNIK CZASU ISO

campaign_guid
campaign_guid string
bitlink_id
bitlink_id string

Zwraca

Channel
Channel

Aktualizowanie linku bitowego

Aktualizuje pola w określonym linku.

Parametry

Nazwa Klucz Wymagane Typ Opis
Link bitowy
bitlink True string

Link bitowy wykonany z domeny i skrótu

Odwołania
references object
Archiwizowane
archived boolean
tags
tags array of string
utworzono_o
created_at string
title
title string
bitlink
bitlink string
install_url
install_url string
utworzone
created string

Sygnatura czasowa ISO

app_uri_path
app_uri_path string
modified
modified string

Sygnatura czasowa ISO

install_type
install_type string
app_guid
app_guid string
przewodnik
guid string
os
os string
brand_guid
brand_guid string
utworzone_przez
created_by string
long_url
long_url string
identyfikator_klienta
client_id string
custom_bitlinks
custom_bitlinks array of string
łącze
link string
launchpad_ids
launchpad_ids array of string
id
id string

Zwraca

BitlinkBody
BitlinkBody

Aktualizowanie linków bitowych według grupy

Aktualizacja zbiorcza może jednocześnie dodawać lub usuwać tagi lub archiwizować maksymalnie 100 łączy; Odpowiedź zawiera listę zaktualizowanych identyfikatorów linku bitowego.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator GUID grupy
group_guid True string

Identyfikator GUID dla grupy Bitly

Akcja
action string
remove_tags
remove_tags array of string
archiwizować
archive boolean
links
links array of string

Jest to ograniczone do 100 identyfikatorów linków bitowych

add_tags
add_tags array of string

Zwraca

BulkUpdate
BulkUpdate

Aktualizowanie niestandardowego linku bitowego

Przenieś słowo kluczowe (lub niestandardową połowę) do innego linku bitowego.

Parametry

Nazwa Klucz Wymagane Typ Opis
Niestandardowy link bitowy
custom_bitlink True string

Niestandardowy link bitowy wykonany z domeny i słowa kluczowego

bitlink_id
bitlink_id string

Zwraca

CustomBitlink
CustomBitlink

Aktualizowanie preferencji grupy

Aktualizuje preferencje dla grupy.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator GUID grupy
group_guid True string

Identyfikator GUID dla grupy Bitly

group_guid
group_guid string
domain_preference
domain_preference string

Zwraca

GroupPreferences
GroupPreferences

Aktualizowanie użytkownika

Aktualizowanie pól w użytkowniku

Parametry

Nazwa Klucz Wymagane Typ Opis
default_group_guid
default_group_guid string
nazwa
name string

Zwraca

User
User

Dodawanie niestandardowego linku bitowego

Dodaj słowo kluczowe (lub niestandardową połowę wsteczną) do linku bitowego z domeną niestandardową. Ten punkt końcowy może być również używany do początkowych przekierowań do linku.

Parametry

Nazwa Klucz Wymagane Typ Opis
bitlink_id
bitlink_id string
custom_bitlink
custom_bitlink string

Zwraca

CustomBitlink
CustomBitlink

Pobieranie dysków BSD

Pobierz wszystkie znakowania krótkich domen.

Zwraca

BSDsResponse
BSDsResponse

Pobieranie elementu webhook

Zwraca element webhook.

Parametry

Nazwa Klucz Wymagane Typ Opis
Webhook GUID
webhook_guid True string

Identyfikator GUID elementu webhook bitly

Zwraca

Webhook
Webhook

Pobieranie elementów webhook

Pobieranie wszystkich elementów webhook dostępnych dla organizacji

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator GUID organizacji
organization_guid True string

Identyfikator GUID dla nieco organizacji

Zwraca

Webhooks
Webhooks

Pobieranie grup

Zwraca listę grup w organizacji.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator GUID organizacji
organization_guid string

Identyfikator GUID dla nieco organizacji

Zwraca

Groups
Groups

Pobieranie grupy

Zwraca szczegóły dla grupy.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator GUID grupy
group_guid True string

Identyfikator GUID dla grupy Bitly

Zwraca

Grupa
Group

Pobieranie kanału

Zwraca szczegóły kanału.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator GUID kanału
channel_guid True string

Identyfikator GUID dla kanału bitowego

Zwraca

Channel
Channel

Pobieranie kanałów

Zwraca kanały dostępne dla użytkownika.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator GUID grupy
group_guid string

Identyfikator GUID dla grupy Bitly

Identyfikator GUID kampanii
campaign_guid string

Identyfikator GUID dla nieco kampanii

Zwraca

Kanały
Channels

Pobieranie kliknięć dla linku bitowego

Zwraca liczbę kliknięć dla określonego łącza w tablicy na podstawie daty.

Parametry

Nazwa Klucz Wymagane Typ Opis
Link bitowy
bitlink True string

Link bitowy wykonany z domeny i skrótu

Unit
unit True string

Jednostka czasu

Units
units True integer

Liczba całkowita reprezentująca jednostki czasu do wykonywania zapytań o dane. przekaż -1, aby zwrócić wszystkie jednostki czasu.

Dokumentacja jednostki
unit_reference string

Sygnatura czasowa ISO-8601 wskazująca ostatni czas ściągnięcia metryk. Wartość domyślna to bieżąca godzina.

Zwraca

Kliknięć
Clicks

Pobieranie kliknięć dla niestandardowego linku bitowego

Zwraca liczbę kliknięć dla określonego linku. Zwraca tablicę z kliknięciami na podstawie daty.

Parametry

Nazwa Klucz Wymagane Typ Opis
Niestandardowy link bitowy
custom_bitlink True string

Niestandardowy link bitowy wykonany z domeny i słowa kluczowego

Unit
unit True string

Jednostka czasu

Units
units True integer

Liczba całkowita reprezentująca jednostki czasu do wykonywania zapytań o dane. przekaż -1, aby zwrócić wszystkie jednostki czasu.

Dokumentacja jednostki
unit_reference string

Sygnatura czasowa ISO-8601 wskazująca ostatni czas ściągnięcia metryk. Wartość domyślna to bieżąca godzina.

Zwraca

Kliknięć
Clicks

Pobieranie kliknięć grup

Pobierz liczbę kliknięć na linkach bitowych w grupie.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator GUID grupy
group_guid True string

Identyfikator GUID dla grupy Bitly

Unit
unit True string

Jednostka czasu

Units
units True integer

Liczba całkowita reprezentująca jednostki czasu do wykonywania zapytań o dane. przekaż -1, aby zwrócić wszystkie jednostki czasu.

Dokumentacja jednostki
unit_reference string

Sygnatura czasowa ISO-8601 wskazująca ostatni czas ściągnięcia metryk. Wartość domyślna to bieżąca godzina.

Zwraca

GrupyKliknij
GroupClicks

Pobieranie liczby skrócenia liczby w organizacji

Zwraca liczbę skrócenia dla określonej organizacji w określonym przedziale czasu.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator GUID organizacji
organization_guid True string

Identyfikator GUID dla nieco organizacji

Unit
unit True string

Jednostka czasu

Units
units True integer

Liczba całkowita reprezentująca jednostki czasu do wykonywania zapytań o dane. przekaż -1, aby zwrócić wszystkie jednostki czasu.

Dokumentacja jednostki
unit_reference string

Sygnatura czasowa ISO-8601 wskazująca ostatni czas ściągnięcia metryk. Wartość domyślna to bieżąca godzina.

Zwraca

Metrics
Metrics

Pobieranie liczby skróconych grup

Zwraca wszystkie liczby skróconych dla grupy.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator GUID grupy
group_guid True string

Identyfikator GUID dla grupy Bitly

Unit
unit True string

Jednostka czasu

Units
units True integer

Liczba całkowita reprezentująca jednostki czasu do wykonywania zapytań o dane. przekaż -1, aby zwrócić wszystkie jednostki czasu.

Dokumentacja jednostki
unit_reference string

Sygnatura czasowa ISO-8601 wskazująca ostatni czas ściągnięcia metryk. Wartość domyślna to bieżąca godzina.

Zwraca

Metrics
Metrics

Pobieranie linków bitowych według grupy

Zwraca kolekcję bitów z podziałem na strony dla grupy.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator GUID grupy
group_guid True string

Identyfikator GUID dla grupy Bitly

Rozmiar
size integer

Ilość elementów do zwrócenia

Strona
page integer

Liczba całkowita określająca numerowany wynik, na którym ma się rozpocząć

Keyword
keyword string

Niestandardowe słowo kluczowe do filtrowania wpisów historii

Query
query string

Wartość, którą chcesz wyszukać

Utworzone przed
created_before integer

Sygnatura czasowa jako liczba całkowita epoki unix

Utworzone po
created_after integer

Sygnatura czasowa jako liczba całkowita epoki unix

Zmodyfikowane po
modified_after integer

Sygnatura czasowa jako liczba całkowita epoki unix

Archiwizowane
archived string

Czy należy uwzględnić zarchiwizowane linki bitowe

Linki głębokie
deeplinks string

Filtruj tylko do linków bitowych zawierających linki głębokie

Linki głębokie domeny
domain_deeplinks string

Filtruj tylko do linków bitowych zawierających linki głębokie skonfigurowane za pomocą domeny niestandardowej

Identyfikator GUID kampanii
campaign_guid string

Filtruj, aby zwracać tylko linki dla danego identyfikatora GUID kampanii, można podać

GILDA kanału
channel_guid string

Filtr, aby zwracać tylko łącza dla danego identyfikatora GUID kanału, można podać, przesłania wszystkie inne parametry

Niestandardowy link bitowy
custom_bitlink string

Niestandardowy link bitowy wykonany z domeny i słowa kluczowego

Etykiety
tags array

filtruj według podanych tagów

Identyfikatory tabletu Launchpad
launchpad_ids array

filtruj według identyfikatora launchpad

Kodowanie logowania
encoding_login array

Filtruj według nazwy logowania uwierzytelnionego użytkownika, który utworzył link bitowy

Zwraca

Łącza bitowe
Bitlinks

Zwraca źródła miasta dla określonego linku.

Parametry

Nazwa Klucz Wymagane Typ Opis
Link bitowy
bitlink True string

Link bitowy wykonany z domeny i skrótu

Unit
unit True string

Jednostka czasu

Units
units True integer

Liczba całkowita reprezentująca jednostki czasu do wykonywania zapytań o dane. przekaż -1, aby zwrócić wszystkie jednostki czasu.

Rozmiar
size integer

Ilość elementów do zwrócenia

Dokumentacja jednostki
unit_reference string

Sygnatura czasowa ISO-8601 wskazująca ostatni czas ściągnięcia metryk. Wartość domyślna to bieżąca godzina.

Zwraca

Metryki miasta
CityMetrics

Zwraca liczbę kliknięć odwołań dla określonego linku.

Parametry

Nazwa Klucz Wymagane Typ Opis
Link bitowy
bitlink True string

Link bitowy wykonany z domeny i skrótu

Unit
unit True string

Jednostka czasu

Units
units True integer

Liczba całkowita reprezentująca jednostki czasu do wykonywania zapytań o dane. przekaż -1, aby zwrócić wszystkie jednostki czasu.

Rozmiar
size integer

Ilość elementów do zwrócenia

Dokumentacja jednostki
unit_reference string

Sygnatura czasowa ISO-8601 wskazująca ostatni czas ściągnięcia metryk. Wartość domyślna to bieżąca godzina.

Zwraca

Kliknij pozycję Metryki
ClickMetrics

Pobieranie metryk dla linku bitowego przez odwołanie do domen

Zwraca liczbę kliknięć w domenie odwołującej się dla określonego linku.

Parametry

Nazwa Klucz Wymagane Typ Opis
Link bitowy
bitlink True string

Link bitowy wykonany z domeny i skrótu

Unit
unit True string

Jednostka czasu

Units
units True integer

Liczba całkowita reprezentująca jednostki czasu do wykonywania zapytań o dane. przekaż -1, aby zwrócić wszystkie jednostki czasu.

Rozmiar
size integer

Ilość elementów do zwrócenia

Dokumentacja jednostki
unit_reference string

Sygnatura czasowa ISO-8601 wskazująca ostatni czas ściągnięcia metryk. Wartość domyślna to bieżąca godzina.

Zwraca

Kliknij pozycję Metryki
ClickMetrics

Pobieranie metryk dla linku bitowego według krajów

Zwraca pochodzenie kraju dla określonego linku.

Parametry

Nazwa Klucz Wymagane Typ Opis
Link bitowy
bitlink True string

Link bitowy wykonany z domeny i skrótu

Unit
unit True string

Jednostka czasu

Units
units True integer

Liczba całkowita reprezentująca jednostki czasu do wykonywania zapytań o dane. przekaż -1, aby zwrócić wszystkie jednostki czasu.

Rozmiar
size integer

Ilość elementów do zwrócenia

Dokumentacja jednostki
unit_reference string

Sygnatura czasowa ISO-8601 wskazująca ostatni czas ściągnięcia metryk. Wartość domyślna to bieżąca godzina.

Zwraca

Kliknij pozycję Metryki
ClickMetrics

Pobieranie metryk dla linku bitowego według odwołań według domen

Zwraca metryki kliknięć pogrupowane według odwołań dla określonego linku.

Parametry

Nazwa Klucz Wymagane Typ Opis
Link bitowy
bitlink True string

Link bitowy wykonany z domeny i skrótu

Unit
unit True string

Jednostka czasu

Units
units True integer

Liczba całkowita reprezentująca jednostki czasu do wykonywania zapytań o dane. przekaż -1, aby zwrócić wszystkie jednostki czasu.

Rozmiar
size integer

Ilość elementów do zwrócenia

Dokumentacja jednostki
unit_reference string

Sygnatura czasowa ISO-8601 wskazująca ostatni czas ściągnięcia metryk. Wartość domyślna to bieżąca godzina.

Zwraca

ReferersByDomains
ReferrersByDomains

Pobieranie metryk dla linku bitowego według urządzeń

Zwraca typy urządzeń generujące ruch kliknięć do określonego linku.

Parametry

Nazwa Klucz Wymagane Typ Opis
Link bitowy
bitlink True string

Link bitowy wykonany z domeny i skrótu

Unit
unit True string

Jednostka czasu

Units
units True integer

Liczba całkowita reprezentująca jednostki czasu do wykonywania zapytań o dane. przekaż -1, aby zwrócić wszystkie jednostki czasu.

Rozmiar
size integer

Ilość elementów do zwrócenia

Dokumentacja jednostki
unit_reference string

Sygnatura czasowa ISO-8601 wskazująca ostatni czas ściągnięcia metryk. Wartość domyślna to bieżąca godzina.

Zwraca

Metryki urządzeń
DeviceMetrics

Pobieranie metryk grup przez odwołania do sieci

Zwraca metryki, odwołując się do sieci dla łączy określonej grupy.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator GUID grupy
group_guid True string

Identyfikator GUID dla grupy Bitly

Zwraca

Kliknij pozycję Metryki
ClickMetrics

Pobieranie metryk grup według krajów

Zwraca pochodzenie geograficzne ruchu kliknięć według kraju dla określonej grupy.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator GUID grupy
group_guid True string

Identyfikator GUID dla grupy Bitly

Unit
unit True string

Jednostka czasu

Units
units True integer

Liczba całkowita reprezentująca jednostki czasu do wykonywania zapytań o dane. przekaż -1, aby zwrócić wszystkie jednostki czasu.

Rozmiar
size integer

Ilość elementów do zwrócenia

Dokumentacja jednostki
unit_reference string

Sygnatura czasowa ISO-8601 wskazująca ostatni czas ściągnięcia metryk. Wartość domyślna to bieżąca godzina.

Zwraca

Kliknij pozycję Metryki
ClickMetrics

Pobieranie metryk grup według miast

Zwraca geograficzne źródła ruchu kliknięć według miasta dla określonej grupy.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator GUID grupy
group_guid True string

Identyfikator GUID dla grupy Bitly

Unit
unit True string

Jednostka czasu

Units
units True integer

Liczba całkowita reprezentująca jednostki czasu do wykonywania zapytań o dane. przekaż -1, aby zwrócić wszystkie jednostki czasu.

Rozmiar
size integer

Ilość elementów do zwrócenia

Dokumentacja jednostki
unit_reference string

Sygnatura czasowa ISO-8601 wskazująca ostatni czas ściągnięcia metryk. Wartość domyślna to bieżąca godzina.

Zwraca

Metryki miasta
CityMetrics

Pobieranie metryk grup według urządzeń

Zwraca typy urządzeń generujące ruch kliknięć do łączy określonej grupy.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator GUID grupy
group_guid True string

Identyfikator GUID dla grupy Bitly

Unit
unit True string

Jednostka czasu

Units
units True integer

Liczba całkowita reprezentująca jednostki czasu do wykonywania zapytań o dane. przekaż -1, aby zwrócić wszystkie jednostki czasu.

Rozmiar
size integer

Ilość elementów do zwrócenia

Dokumentacja jednostki
unit_reference string

Sygnatura czasowa ISO-8601 wskazująca ostatni czas ściągnięcia metryk. Wartość domyślna to bieżąca godzina.

Zwraca

Metryki urządzeń
DeviceMetrics

Pobieranie niestandardowego linku bitowego

Zwraca szczegóły i historię określonego linku.

Parametry

Nazwa Klucz Wymagane Typ Opis
Niestandardowy link bitowy
custom_bitlink True string

Niestandardowy link bitowy wykonany z domeny i słowa kluczowego

Zwraca

CustomBitlink
CustomBitlink

Pobieranie niestandardowych linków bitowych dla dysków BSD

Pobiera niestandardowe linki bitowe dla organizacji filtrowanej według identyfikatorów BSD.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator GUID grupy
group_guid True string

Identyfikator GUID dla grupy Bitly

Utworzone po
created_after integer

Sygnatura czasowa jako liczba całkowita epoki unix

Ograniczenie
limit integer

ograniczenie ilości zwracanych wyników

Przesunięcie
offset integer

ustawianie indeksu początkowego zestawu wyników

BSD
bsd array

oznaczane krótkimi domenami do filtrowania wyników

Zwraca

BitlinkOverridesData
BitlinkOverridesData

Pobieranie niestandardowych metryk linku bitowego według miejsca docelowego

Zwraca metryki kliknięcia dla określonego linku według jego historycznych miejsc docelowych.

Parametry

Nazwa Klucz Wymagane Typ Opis
Niestandardowy link bitowy
custom_bitlink True string

Niestandardowy link bitowy wykonany z domeny i słowa kluczowego

Unit
unit True string

Jednostka czasu

Units
units True integer

Liczba całkowita reprezentująca jednostki czasu do wykonywania zapytań o dane. przekaż -1, aby zwrócić wszystkie jednostki czasu.

Dokumentacja jednostki
unit_reference string

Sygnatura czasowa ISO-8601 wskazująca ostatni czas ściągnięcia metryk. Wartość domyślna to bieżąca godzina.

Zwraca

Kliknij pozycję Metryki
ClickMetrics

Pobieranie podsumowania kliknięć dla linku bitowego

Zwraca liczbę kliknięć dla określonego łącza zwiniętego w jedno pole.

Parametry

Nazwa Klucz Wymagane Typ Opis
Link bitowy
bitlink True string

Link bitowy wykonany z domeny i skrótu

Unit
unit True string

Jednostka czasu

Units
units True integer

Liczba całkowita reprezentująca jednostki czasu do wykonywania zapytań o dane. przekaż -1, aby zwrócić wszystkie jednostki czasu.

Dokumentacja jednostki
unit_reference string

Sygnatura czasowa ISO-8601 wskazująca ostatni czas ściągnięcia metryk. Wartość domyślna to bieżąca godzina.

Zwraca

ClicksSummary
ClicksSummary

Pobieranie posortowanych linków bitowych

Zwraca listę linków bitowych posortowanych według grupy.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator GUID grupy
group_guid True string

Identyfikator GUID dla grupy Bitly

Sortuj
sort True string

Typ sortowania, który chcesz wykonać

Unit
unit string

Jednostka czasu

Units
units integer

Liczba całkowita reprezentująca jednostki czasu do wykonywania zapytań o dane. przekaż -1, aby zwrócić wszystkie jednostki czasu.

Dokumentacja jednostki
unit_reference string

Sygnatura czasowa ISO-8601 wskazująca ostatni czas ściągnięcia metryk. Wartość domyślna to bieżąca godzina.

Rozmiar
size integer

Ilość elementów do zwrócenia

Zwraca

SortedLinks
SortedLinks

Pobieranie preferencji grupy

Zwraca preferencje dla określonej grupy.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator GUID grupy
group_guid True string

Identyfikator GUID dla grupy Bitly

Zwraca

GroupPreferences
GroupPreferences

Pobieranie tagów grup

Zwraca tagi używane obecnie w określonej grupie. Maksymalnie 1000.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator GUID grupy
group_guid True string

Identyfikator GUID dla grupy Bitly

Zwraca

Etykiety
Tags

Pobieranie użytkownika

Zwraca informacje dla bieżącego uwierzytelnioowanego użytkownika.

Zwraca

User
User

Zwraca informacje dla określonego linku.

Parametry

Nazwa Klucz Wymagane Typ Opis
Link bitowy
bitlink True string

Link bitowy wykonany z domeny i skrótu

Zwraca

BitlinkBody
BitlinkBody

Zwraca krótki link i długi adres URL dla określonego linku.

Parametry

Nazwa Klucz Wymagane Typ Opis
bitlink_id
bitlink_id string

Zwraca

ExpandedBitlink
ExpandedBitlink

Tworzenie elementu webhook

Tworzy element webhook.

Parametry

Nazwa Klucz Wymagane Typ Opis
nazwa
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
identyfikator_klienta
client_id string
client_secret
client_secret string
oauth_url
oauth_url string
wydarzenie
event True string

Zwraca

Webhook
Webhook

Tworzenie kampanii

Tworzy nową kampanię.

Parametry

Nazwa Klucz Wymagane Typ Opis
group_guid
group_guid string
channel_guids
channel_guids array of string
opis
description string
nazwa
name string

Zwraca

Campaign
Campaign

Tworzenie kanału

Tworzy nowy kanał.

Parametry

Nazwa Klucz Wymagane Typ Opis
group_guid
group_guid string
przewodnik
guid string
nazwa
name string
modified
modified string

ISO_TIMESTAMP

utworzone
created string

ZNACZNIK CZASU ISO

campaign_guid
campaign_guid string
bitlink_id
bitlink_id string

Zwraca

Channel
Channel

Tworzenie linku bitowego

Konwertuje długi adres URL na link bitowy.

Parametry

Nazwa Klucz Wymagane Typ Opis
group_guid
group_guid string
domena
domain string
long_url
long_url True string

Zwraca

ShortenBitlinkBody
ShortenBitlinkBody

Tworzenie pełnego linku bitowego

Konwertuje długi adres URL na link bitowy i ustawia dodatkowe parametry.

Parametry

Nazwa Klucz Wymagane Typ Opis
domena
domain string
title
title string
group_guid
group_guid string

Zawsze dołączaj określoną grupę i domenę niestandardową do swoich skróconych wywołań.

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

Zwraca

BitlinkBody
BitlinkBody

Usuwanie elementu webhook

Usuwa element webhook.

Parametry

Nazwa Klucz Wymagane Typ Opis
Webhook GUID
webhook_guid True string

Identyfikator GUID elementu webhook bitly

Uzyskiwanie aplikacji OAuth

Pobierz szczegóły podanego identyfikatora klienta aplikacji OAuth.

Parametry

Nazwa Klucz Wymagane Typ Opis
Kliknij identyfikator
client_id True string

Identyfikator klienta aplikacji OAuth

Zwraca

OAuthApp
OAuthApp

Uzyskiwanie kampanii

Zwraca szczegóły kampanii.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator GUID kampanii
campaign_guid True string

Identyfikator GUID dla nieco kampanii

Zwraca

Campaign
Campaign

Uzyskiwanie kampanii

Zwraca kampanie dla bieżącego uwierzytelnioowanego użytkownika.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator GUID grupy
group_guid string

Identyfikator GUID dla grupy Bitly

Zwraca

Campaigns
Campaigns

Uzyskiwanie kodu QR linku bitowego

Generuje kod QR dla linku bitowego.

Parametry

Nazwa Klucz Wymagane Typ Opis
Link bitowy
bitlink True string

Link bitowy wykonany z domeny i skrótu

Kolor
color string

Kolor oznaczony formatem szesnastkowym RGB

Wyklucz logo bitowe
exclude_bitly_logo boolean

Usuwa logo Bitly z środka wygenerowanego obrazu QR

Format obrazu
image_format string

Określa format obrazu zwróconego kodu QR

Zwraca

BitlinkQR
BitlinkQR

Uzyskiwanie limitów planu

Zwraca wszystkie limity i liczby planów dostępne dla organizacji.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator GUID organizacji
organization_guid True string

Identyfikator GUID dla nieco organizacji

Zwraca

PlanLimits
PlanLimits

Uzyskiwanie limitów platformy

Pobierz wszystkie limity i liczby platform dostępne dla organizacji

Parametry

Nazwa Klucz Wymagane Typ Opis
Ścieżka
path string

Określona ścieżka, dla której żądane są informacje

Zwraca

PlatformLimits
PlatformLimits

Uzyskiwanie organizacji

Pobierz szczegóły dla określonej organizacji.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator GUID organizacji
organization_guid True string

Identyfikator GUID dla nieco organizacji

Zwraca

Organization
Organization

Uzyskiwanie organizacji

Pobieranie listy organizacji.

Zwraca

Organizations
Organizations

Weryfikowanie elementu webhook

Wysyła zdarzenie ping w celu przetestowania konfiguracji elementu webhook.

Parametry

Nazwa Klucz Wymagane Typ Opis
Webhook GUID
webhook_guid True string

Identyfikator GUID elementu webhook bitly

Zwraca

Webhook
Webhook

Zbiorcze dodawanie linków bitowych do kanałów

Zbiorcze dodawanie linków bitowych do wielu kanałów kampanii

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator GUID kampanii
campaign_guid True string

Identyfikator GUID dla nieco kampanii

Typ zawartości
Content-Type string

Typ zawartości.

File
file file

Plik.

Zwraca

BulkAddResponse
BulkAddResponse

Definicje

Organization

Nazwa Ścieżka Typ Opis
Odwołania
references object
nazwa
name string
bsds
bsds array of string
utworzone
created string
is_active
is_active boolean
modified
modified string
tier_display_name
tier_display_name string
tier_family
tier_family string
warstwa
tier string
rola
role string
przewodnik
guid string

Kliknięć

Nazwa Ścieżka Typ Opis
Jednostek
units integer
unit_reference
unit_reference string
Unit
unit Unit
link_clicks
link_clicks array of LinkClicks

CustomBitlinkHistory

Nazwa Ścieżka Typ Opis
skrót
hash string
UUID (Uniwersalnie Unikalny Identyfikator)
uuid string
słowo kluczowe
keyword string
utworzone
created string
group_guid
group_guid string
first_created
first_created string
is_active
is_active boolean
long_url
long_url string
Dezaktywowany
deactivated string
Bsd
bsd string
login
login string

Inne metryki

Nazwa Ścieżka Typ Opis
other_city_clicks
other_city_clicks integer
no_city_clicks
no_city_clicks integer

Webhooks

Nazwa Ścieżka Typ Opis
webhooks
webhooks array of Webhook

Organizations

Nazwa Ścieżka Typ Opis
organizations
organizations array of Organization

LinkKliknij

Nazwa Ścieżka Typ Opis
date
date string
Kliknięć
clicks integer

PlanLimit

Nazwa Ścieżka Typ Opis
count
count integer
limit
limit integer
nazwa
name string
opis
description string

DeeplinkRule

Nazwa Ścieżka Typ Opis
bitlink
bitlink string
install_url
install_url string
utworzone
created string

Sygnatura czasowa ISO

app_uri_path
app_uri_path string
modified
modified string

Sygnatura czasowa ISO

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

Campaign

Nazwa Ścieżka Typ Opis
Odwołania
references object
nazwa
name string
utworzone
created string

Sygnatura czasowa ISO

group_guid
group_guid string
modified
modified string

Sygnatura czasowa ISO

utworzone_przez
created_by string
przewodnik
guid string
opis
description string

OAuthApp

Nazwa Ścieżka Typ Opis
łącze
link string
nazwa
name string
identyfikator_klienta
client_id string
opis
description string

Kanały

Nazwa Ścieżka Typ Opis
Kanały
channels array of Channel

PlatformLimits

Nazwa Ścieżka Typ Opis
platform_limits
platform_limits array of PlatformLimit

Paginacja

Nazwa Ścieżka Typ Opis
łączny
total integer
size
size integer
Poprzedni
prev string
page
page integer
następny
next string

BSDsResponse

Nazwa Ścieżka Typ Opis
bsds
bsds array of string

GroupPreferences

Nazwa Ścieżka Typ Opis
group_guid
group_guid string
domain_preference
domain_preference string

ClicksSummary

Nazwa Ścieżka Typ Opis
Jednostek
units integer
Unit
unit Unit
total_clicks
total_clicks integer
unit_reference
unit_reference string

Email

Nazwa Ścieżka Typ Opis
is_primary
is_primary boolean
is_verified
is_verified boolean
e-mail
email string

Campaigns

Nazwa Ścieżka Typ Opis
Kampanie
campaigns array of Campaign
Nazwa Ścieżka Typ Opis
long_url
long_url string
utworzono_o
created_at string
łącze
link string
id
id string
Nazwa Ścieżka Typ Opis
BitlinkBody
bitlink BitlinkBody
bitlink_history
bitlink_history array of CustomBitlinkHistory
custom_bitlink
custom_bitlink string
Nazwa Ścieżka Typ Opis
sorted_links
sorted_links array of ClickLink
links
links array of BitlinkBody
Nazwa Ścieżka Typ Opis
Kliknięć
clicks integer
id
id string

PlatformaLimit

Nazwa Ścieżka Typ Opis
punkt końcowy
endpoint string
metody
methods array of MethodLimit

Wskaźnik

Nazwa Ścieżka Typ Opis
value
value integer
klucz
key string

BitlinkOverridesData

Nazwa Ścieżka Typ Opis
total_count
total_count integer
Zastępuje
overrides array of BitlinkOverrides

ReferersByDomains

Nazwa Ścieżka Typ Opis
Jednostek
units integer
Aspekt2
facet Facet2
referrers_by_domain
referrers_by_domain array of ReferrersByDomain
unit_reference
unit_reference string
jednostka
unit string

CityMetric

Nazwa Ścieżka Typ Opis
city
city string
region
region string
Podregionu
subregion string
Kliknięć
clicks integer
country
country string

Grupa

Nazwa Ścieżka Typ Opis
Odwołania
references object
nazwa
name string
bsds
bsds array of string
utworzone
created string
is_active
is_active boolean
modified
modified string
organization_guid
organization_guid string
rola
role string
przewodnik
guid string

ShortenBitlinkBody

Nazwa Ścieżka Typ Opis
Odwołania
references object
Archiwizowane
archived boolean
tags
tags array of string
utworzono_o
created_at string
deeplinks
deeplinks array of DeeplinkRule
long_url
long_url string
custom_bitlinks
custom_bitlinks array of string
łącze
link string
id
id string

Łącza bitowe

Nazwa Ścieżka Typ Opis
Paginacja
pagination Pagination
links
links array of BitlinkBody

Etykiety

Nazwa Ścieżka Typ Opis
tags
tags array of string

Webhook

Nazwa Ścieżka Typ Opis
Odwołania
references object
stan
status string
modified_by
modified_by string
nazwa
name string
utworzone
created string
URL
url string
Dezaktywowany
deactivated string
fetch_tags
fetch_tags boolean
is_active
is_active boolean
modified
modified string
organization_guid
organization_guid string
identyfikator_klienta
client_id string
group_guid
group_guid string
client_secret
client_secret string
oauth_url
oauth_url string
przewodnik
guid string
wydarzenie
event string

GrupyKliknij

Nazwa Ścieżka Typ Opis
Jednostek
units integer
dane
data array of CountItem
unit_reference
unit_reference string
jednostka
unit string

Groups

Nazwa Ścieżka Typ Opis
groups
groups array of Group

User

Nazwa Ścieżka Typ Opis
default_group_guid
default_group_guid string
nazwa
name string
utworzone
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
wiadomości e-mail
emails array of Email

BulkAddResponse

Nazwa Ścieżka Typ Opis
komunikat
message string
Dane1
data Data1

BitlinkQR

Nazwa Ścieżka Typ Opis
qr_code
qr_code string

Identyfikator URI danych obrazu kodu QR

łącze
link string
id
id string

Metryki miasta

Nazwa Ścieżka Typ Opis
Jednostek
units integer
Aspekt1
facet Facet1
unit_reference
unit_reference string
jednostka
unit string
metryki
metrics array of CityMetric
Inne metryki
other_metrics OtherMetrics

BulkUpdate

Nazwa Ścieżka Typ Opis
links
links array of string

MethodLimit

Nazwa Ścieżka Typ Opis
count
count integer
limit
limit integer
nazwa
name string

Metryki urządzeń

Nazwa Ścieżka Typ Opis
Jednostek
units integer
Aspekt1
facet Facet1
unit_reference
unit_reference string
jednostka
unit string
metryki
metrics array of DeviceMetric

BitlinkBody

Nazwa Ścieżka Typ Opis
Odwołania
references object
Archiwizowane
archived boolean
tags
tags array of string
utworzono_o
created_at string
title
title string
deeplinks
deeplinks array of DeeplinkRule
utworzone_przez
created_by string
long_url
long_url string
identyfikator_klienta
client_id string
custom_bitlinks
custom_bitlinks array of string
łącze
link string
launchpad_ids
launchpad_ids array of string
id
id string

Kliknij pozycję Metryki

Nazwa Ścieżka Typ Opis
Jednostek
units integer
Aspekt1
facet Facet1
unit_reference
unit_reference string
jednostka
unit string
metryki
metrics array of ClickMetric

Channel

Nazwa Ścieżka Typ Opis
group_guid
group_guid string
przewodnik
guid string
nazwa
name string
modified
modified string

ISO_TIMESTAMP

utworzone
created string

ZNACZNIK CZASU ISO

Odwołania
references object

DeviceMetric

Nazwa Ścieżka Typ Opis
Kliknięć
clicks integer
device_type
device_type string

Metrics

Nazwa Ścieżka Typ Opis
Jednostek
units integer
Aspekt1
facet Facet1
unit_reference
unit_reference string
jednostka
unit string
metryki
metrics array of Metric

Kliknij pozycję Metryka

Nazwa Ścieżka Typ Opis
Kliknięć
clicks integer
value
value string

CountItem

Nazwa Ścieżka Typ Opis
count
count integer
Ts
ts string

ReferersByDomain

Nazwa Ścieżka Typ Opis
Kierujących
referrers array of Metric
sieć
network string

PlanLimits

Nazwa Ścieżka Typ Opis
Odwołania
references object
organization_guid
organization_guid string
plan_limits
plan_limits array of PlanLimit

BitlinkOverrides

Nazwa Ścieżka Typ Opis
Odwołania
references object
utworzone
created string
zasady
rules string
group_guid
group_guid string
modified
modified string
wersja
version integer
łącze
link string

W pełni kwalifikowany adres URL do przesłonięcia, który jest linkem Bitly do użycia. Na przykład: https://foo.com/bar

id
id string

Dane1

Nazwa Ścieżka Typ Opis
link_save_failures
link_save_failures integer
keyword_failures
keyword_failures integer
results
results array of string
Sukcesów
successes integer
channel_bitlink_failures
channel_bitlink_failures integer
csv_format_failures
csv_format_failures integer

Aspekt1

Aspekt1
string

Aspekt2

Aspekt2
string

Unit

Unit
string