BitlyIP (независимый издатель)

Bitly является самой широко доверенной платформой управления ссылками в мире. Используя API Bitly, вы будете использовать полную силу ваших ссылок с помощью автоматической настройки ссылок, глубокого связывания мобильных устройств и щелчка по аналитике.

Этот соединитель доступен в следующих продуктах и регионах:

Услуга	Class	Регионы
Copilot Studio	Премия	Все регионы Power Automate , кроме следующих:      - Правительство США (GCC)      - Правительство США (GCC High)      — Облако Китая, управляемое 21Vianet      - Министерство обороны США (DoD)
Логические приложения	Стандарт	Все регионы Logic Apps , кроме следующих:      — Регионы Azure для государственных организаций      — Регионы Azure Для Китая      - Министерство обороны США (DoD)
Power Apps	Премия	Все регионы Power Apps , кроме следующих:      - Правительство США (GCC)      - Правительство США (GCC High)      — Облако Китая, управляемое 21Vianet      - Министерство обороны США (DoD)
Power Automate	Премия	Все регионы Power Automate , кроме следующих:      - Правительство США (GCC)      - Правительство США (GCC High)      — Облако Китая, управляемое 21Vianet      - Министерство обороны США (DoD)

Контакт
Имя	Трой Тейлор
URL	https://www.hitachisolutions.com
Адрес электронной почты	ttaylor@hitachisolutions.com

Метаданные соединителя
Publisher	Трой Тейлор
Веб-сайт	https://bitly.com/
Политика конфиденциальности	https://bitly.com/pages/privacy
Категории	Социальные медиа; Сайт

Создание подключения

Соединитель поддерживает следующие типы проверки подлинности:

По умолчанию	Параметры для создания подключения.	Все регионы	Недоступен для совместного использования

По умолчанию

Применимо: все регионы

Параметры для создания подключения.

Это недоступно для общего доступа. Если приложение power предоставляется другому пользователю, пользователю будет предложено явно создать новое подключение.

Имя	Тип	Description	Обязательно
Ключ API	securestring	Ключ API для этого API	True

Ограничения регулирования

Имя	Вызовы	Период обновления
Вызовы API для каждого подключения	100	60 секунд

Действия

Ветвь обновлений	Обновляет существующий канал.
Вывод группы	Возвращает сведения о группе.
Добавление настраиваемой ссылки Bitlink	Добавьте ключевое слово (или настраиваемую тайм-половину) в Bitlink с пользовательским доменом. Эту конечную точку также можно использовать для первоначальных перенаправлений по ссылке.
Массовое добавление битовых ссылок в каналы	Массовое добавление битовых ссылок на несколько каналов кампании
Обновление Bitlink	Обновляет поля в указанной ссылке.
Обновление битовых ссылок по группам	Массовое обновление может добавлять или удалять теги или архивировать до 100 ссылок за раз; Ответ содержит список обновленных идентификаторов Bitlink.
Обновление веб-перехватчика	Обновление веб-перехватчика
Обновление группы	Обновляет сведения о группе.
Обновление кампании	Обновляет сведения о кампании.
Обновление параметров группы	Обновляет параметры группы.
Обновление пользовательской bitlink	Переместите ключевое слово (или настраиваемую обратную половину) в другую битовую связь.
Обновление пользователя	Обновление полей пользователя
Получение Bitlink	Возвращает сведения для указанной ссылки.
Получение BSD	Получите все фирменные короткие домены.
Получение QR-кода Bitlink	Создает QR-код для Bitlink.
Получение битовых ссылок по группам	Возвращает коллекцию bitlinks с разбивкой на страницы для группы.
Получение веб-перехватчика	Возвращает веб-перехватчик.
Получение веб-перехватчиков	Получение всех веб-перехватчиков, доступных для организации
Получение групп	Возвращает список групп в организации.
Получение кампании	Возвращает сведения о кампании.
Получение кампаний	Возвращает кампании для текущего пользователя, прошедшего проверку подлинности.
Получение канала	Возвращает сведения о канале.
Получение каналов	Возвращает каналы, доступные пользователю.
Получение количества сокращений группы	Возвращает все сокращенные счетчики для группы.
Получение метрик группы по городам	Возвращает географические источники трафика по городу для указанной группы.
Получение метрик группы по странам	Возвращает географические источники трафика по странам для указанной группы.
Получение метрик группы по устройствам	Возвращает типы устройств, создающие трафик щелчка по ссылкам указанной группы.
Получение метрик группы путем ссылки на сети	Возвращает метрики, ссылаясь на сети для ссылок указанной группы.
Получение метрик для Bitlink на устройствах	Возвращает типы устройств, создающие трафик щелчка по указанной ссылке.
Получение метрик для Bitlink по городам	Возвращает источники города для трафика щелчка для указанной ссылки.
Получение метрик для Bitlink по ссылкам	Возвращает счетчики щелчков ссылок для указанной ссылки.
Получение метрик для Bitlink по ссылкам по доменам	Возвращает метрики щелчка, сгруппированные по ссылкам для указанной ссылки.
Получение метрик для Bitlink по странам	Возвращает происхождение страны для трафика щелчка для указанной ссылки.
Получение метрик для Bitlink путем ссылки на домены	Возвращает счетчики ссылок на домен для указанной ссылки.
Получение настраиваемой связи Bitlink	Возвращает сведения и журнал указанной ссылки.
Получение ограничений плана	Возвращает все ограничения плана и счетчики, доступные для организации.
Получение ограничений платформы	Получение всех ограничений и подсчетов платформ, доступных для организации
Получение организации	Получение сведений для указанной организации.
Получение организаций	Получение списка организаций.
Получение отсортированных битовых ссылок	Возвращает список битовых ссылок, отсортированных по группе.
Получение параметров группы	Возвращает предпочтения для указанной группы.
Получение пользовательских битовых ссылок для BSD	Получает пользовательские битовые ссылки для организации, отфильтрованной по BSD.S.
Получение пользовательских метрик Bitlink по назначению	Возвращает метрики щелчка для указанной ссылки по его историческим назначениям.
Получение пользователя	Возвращает сведения для текущего пользователя, прошедшего проверку подлинности.
Получение приложения OAuth	Получите сведения о предоставленном идентификаторе клиента приложения OAuth.
Получение сводки по щелчкам для Bitlink	Возвращает количество щелчков для указанной ссылки, свернутой в одно поле.
Получение сокращенных счетчиков организации	Возвращает сокращенное количество для определенной организации за указанный период времени.
Получение тегов группы	Возвращает теги, которые в настоящее время используются в указанной группе. Не более 1000.
Получение щелчков группы	Получение количества щелчков по bitlinks в группе.
Получение щелчков для Bitlink	Возвращает счетчики щелчков для указанной ссылки в массиве на основе даты.
Получение щелчков для пользовательской bitlink	Возвращает счетчики щелчков для указанной ссылки. Возвращает массив с щелчками на основе даты.
Проверка веб-перехватчика	Отправляет событие ping для тестирования конфигурации веб-перехватчика.
Разверните bitlink	Возвращает короткую ссылку и длинный URL-адрес указанной ссылки.
Создание Bitlink	Преобразует длинный URL-адрес в Bitlink.
Создание веб-перехватчика	Создает веб-перехватчик.
Создание кампании	Создает новую кампанию.
Создание канала	Создает новый канал.
Создание полной bitlink	Преобразует длинный URL-адрес в Bitlink и задает дополнительные параметры.
Удаление веб-перехватчика	Удаляет веб-перехватчик.

Ветвь обновлений

Идентификатор операции:

UpdateChannel

Обновляет существующий канал.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
GUID канала	channel_guid	True	string	GUID для битового канала
group_guid	group_guid		string
гид	guid		string
имя	name		string
изменено	modified		string	ISO_TIMESTAMP
создано	created		string	ISO TIMESTAMP
campaign_guid	campaign_guid		string
bitlink_id	bitlink_id		string

Возвращаемое значение

Channel

Channel

Вывод группы

Идентификатор операции:

GetGroup

Возвращает сведения о группе.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
GUID группы	group_guid	True	string	GUID для группы Bitly

Возвращаемое значение

Группа

Group

Добавление настраиваемой ссылки Bitlink

Идентификатор операции:

AddCustomBitlink

Добавьте ключевое слово (или настраиваемую тайм-половину) в Bitlink с пользовательским доменом. Эту конечную точку также можно использовать для первоначальных перенаправлений по ссылке.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
bitlink_id	bitlink_id		string
custom_bitlink	custom_bitlink		string

Возвращаемое значение

CustomBitlink

CustomBitlink

Массовое добавление битовых ссылок в каналы

Идентификатор операции:

BulkAdd

Массовое добавление битовых ссылок на несколько каналов кампании

Параметры

Имя	Ключ	Обязательно	Тип	Описание
GUID кампании	campaign_guid	True	string	GUID для кампании Bitly
Тип контента	Content-Type		string	Тип содержимого.
Файл	file		file	Файл.

Возвращаемое значение

BulkAddResponse

BulkAddResponse

Обновление Bitlink

Идентификатор операции:

UpdateBitlink

Обновляет поля в указанной ссылке.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Bitlink	bitlink	True	string	Bitlink, сделанный из домена и хэша
Ссылки	references		object
Архив	archived		boolean
tags	tags		array of string
создано_в	created_at		string
title	title		string
bitlink	bitlink		string
install_url	install_url		string
создано	created		string	Метка времени ISO
app_uri_path	app_uri_path		string
изменено	modified		string	Метка времени ISO
install_type	install_type		string
app_guid	app_guid		string
гид	guid		string
os	os		string
brand_guid	brand_guid		string
создано пользователем	created_by		string
long_url	long_url		string
идентификатор клиента	client_id		string
custom_bitlinks	custom_bitlinks		array of string
link	link		string
launchpad_ids	launchpad_ids		array of string
id	id		string

Возвращаемое значение

BitlinkBody

BitlinkBody

Обновление битовых ссылок по группам

Идентификатор операции:

UpdateBitlinksByGroup

Массовое обновление может добавлять или удалять теги или архивировать до 100 ссылок за раз; Ответ содержит список обновленных идентификаторов Bitlink.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
GUID группы	group_guid	True	string	GUID для группы Bitly
Действие	action		string
remove_tags	remove_tags		array of string
archive	archive		boolean
links	links		array of string	Это ограничено 100 идентификаторами Bitlink
add_tags	add_tags		array of string

Возвращаемое значение

BulkUpdate

BulkUpdate

Обновление веб-перехватчика

Идентификатор операции:

UpdateWebhook

Обновление веб-перехватчика

Параметры

Имя	Ключ	Обязательно	Тип	Описание
GUID веб-перехватчика	webhook_guid	True	string	GUID для веб-перехватчика Bitly
имя	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
идентификатор клиента	client_id		string
секрет_клиента	client_secret		string
oauth_url	oauth_url		string
гид	guid	True	string
событие	event		string

Возвращаемое значение

Webhook

Webhook

Обновление группы

Идентификатор операции:

UpdateGroup

Обновляет сведения о группе.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
GUID группы	group_guid	True	string	GUID для группы Bitly
bsds	bsds		array of string
имя	name		string
organization_guid	organization_guid		string

Возвращаемое значение

Группа

Group

Обновление кампании

Идентификатор операции:

UpdateCampaign

Обновляет сведения о кампании.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
GUID кампании	campaign_guid	True	string	GUID для кампании Bitly
group_guid	group_guid		string
channel_guids	channel_guids		array of string
описание	description		string
имя	name		string

Возвращаемое значение

кампания

Campaign

Обновление параметров группы

Идентификатор операции:

UpdateGroupPreferences

Обновляет параметры группы.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
GUID группы	group_guid	True	string	GUID для группы Bitly
group_guid	group_guid		string
domain_preference	domain_preference		string

Возвращаемое значение

GroupPreferences

GroupPreferences

Обновление пользовательской bitlink

Идентификатор операции:

UpdateCustomBitlink

Переместите ключевое слово (или настраиваемую обратную половину) в другую битовую связь.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Настраиваемая bitlink	custom_bitlink	True	string	Настраиваемая битовая ссылка, созданная в домене и ключевом слове
bitlink_id	bitlink_id		string

Возвращаемое значение

CustomBitlink

CustomBitlink

Обновление пользователя

Идентификатор операции:

UpdateUser

Обновление полей пользователя

Параметры

Имя	Ключ	Обязательно	Тип	Описание
default_group_guid	default_group_guid		string
имя	name		string

Возвращаемое значение

User

User

Получение Bitlink

Идентификатор операции:

GetBitlink

Возвращает сведения для указанной ссылки.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Bitlink	bitlink	True	string	Bitlink, сделанный из домена и хэша

Возвращаемое значение

BitlinkBody

BitlinkBody

Получение BSD

Идентификатор операции:

GetBSDs

Получите все фирменные короткие домены.

Возвращаемое значение

BSDsResponse

BSDsResponse

Получение QR-кода Bitlink

Идентификатор операции:

GetBitlinkQRCode

Создает QR-код для Bitlink.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Bitlink	bitlink	True	string	Bitlink, сделанный из домена и хэша
Цвет	color		string	Цвет, обозначающийся в шестнадцатеричном формате RGB
Исключение битового логотипа	exclude_bitly_logo		boolean	Удаляет логотип Bitly из центра созданного QR-изображения
Формат изображения	image_format		string	Определяет формат изображения возвращаемого QR-кода

Возвращаемое значение

BitlinkQR

BitlinkQR

Получение битовых ссылок по группам

Идентификатор операции:

GetBitlinksByGroup

Возвращает коллекцию bitlinks с разбивкой на страницы для группы.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
GUID группы	group_guid	True	string	GUID для группы Bitly
Size	size		integer	Количество возвращаемых элементов
Страница	page		integer	Целое число, указывающее нумерованный результат, с которого необходимо начать
Keyword	keyword		string	Настраиваемое ключевое слово для фильтрации записей журнала
Query	query		string	Значение, которое требуется выполнить поиск
Создано раньше	created_before		integer	Метка времени в виде целочисленной эпохи unix
Создано после	created_after		integer	Метка времени в виде целочисленной эпохи unix
Изменено после	modified_after		integer	Метка времени в виде целочисленной эпохи unix
Archived	archived		string	Независимо от того, следует ли включать архивные битовые ссылки
Глубокие ссылки	deeplinks		string	Фильтрация только по bitlinks, которые содержат глубокие ссылки
Глубокое связывание домена	domain_deeplinks		string	Фильтрация только битовых ссылок, содержащих глубокие ссылки, настроенные с помощью личного домена
GUID кампании	campaign_guid		string	Фильтр для возврата только ссылок для заданного GUID кампании можно указать
ГИЛЬДИ канала	channel_guid		string	Фильтрация для возврата только ссылок для заданного GUID канала, может быть предоставлена, переопределяет все остальные параметры.
Настраиваемая bitlink	custom_bitlink		string	Настраиваемая битовая ссылка, созданная в домене и ключевом слове
Метки	tags		array	фильтрация по заданным тегам
Идентификаторы панели запуска	launchpad_ids		array	фильтр по идентификатору панели запуска
Вход в кодировку	encoding_login		array	Фильтрация по имени входа прошедшего проверку подлинности пользователя, создавшего Bitlink

Возвращаемое значение

Битовые ссылки

Bitlinks

Получение веб-перехватчика

Идентификатор операции:

GetWebhook

Возвращает веб-перехватчик.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
GUID веб-перехватчика	webhook_guid	True	string	GUID для веб-перехватчика Bitly

Возвращаемое значение

Webhook

Webhook

Получение веб-перехватчиков

Идентификатор операции:

GetWebhooks

Получение всех веб-перехватчиков, доступных для организации

Параметры

Имя	Ключ	Обязательно	Тип	Описание
GUID организации	organization_guid	True	string	GUID для организации Bitly

Возвращаемое значение

Webhooks

Webhooks

Получение групп

Идентификатор операции:

GetGroups

Возвращает список групп в организации.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
GUID организации	organization_guid		string	GUID для организации Bitly

Возвращаемое значение

Groups

Groups

Получение кампании

Идентификатор операции:

GetCampaign

Возвращает сведения о кампании.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
GUID кампании	campaign_guid	True	string	GUID для кампании Bitly

Возвращаемое значение

кампания

Campaign

Получение кампаний

Идентификатор операции:

GetCampaigns

Возвращает кампании для текущего пользователя, прошедшего проверку подлинности.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
GUID группы	group_guid		string	GUID для группы Bitly

Возвращаемое значение

Кампании

Campaigns

Получение канала

Идентификатор операции:

GetChannel

Возвращает сведения о канале.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
GUID канала	channel_guid	True	string	GUID для битового канала

Возвращаемое значение

Channel

Channel

Получение каналов

Идентификатор операции:

GetChannels

Возвращает каналы, доступные пользователю.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
GUID группы	group_guid		string	GUID для группы Bitly
GUID кампании	campaign_guid		string	GUID для кампании Bitly

Возвращаемое значение

Каналы

Channels

Получение количества сокращений группы

Идентификатор операции:

GetGroupShortenCounts

Возвращает все сокращенные счетчики для группы.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
GUID группы	group_guid	True	string	GUID для группы Bitly
Единица	unit	True	string	Единица времени
Единицы	units	True	integer	Целое число, представляющее единицы времени для запроса данных. передайте -1, чтобы вернуть все единицы времени.
Справочник по единицам	unit_reference		string	Метка времени ISO-8601, указывающая самое последнее время для извлечения метрик. Значение по умолчанию — текущее время.

Возвращаемое значение

Metrics

Metrics

Получение метрик группы по городам

Идентификатор операции:

GetGroupMetricsByCities

Возвращает географические источники трафика по городу для указанной группы.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
GUID группы	group_guid	True	string	GUID для группы Bitly
Единица	unit	True	string	Единица времени
Единицы	units	True	integer	Целое число, представляющее единицы времени для запроса данных. передайте -1, чтобы вернуть все единицы времени.
Size	size		integer	Количество возвращаемых элементов
Справочник по единицам	unit_reference		string	Метка времени ISO-8601, указывающая самое последнее время для извлечения метрик. Значение по умолчанию — текущее время.

Возвращаемое значение

Городские метрики

CityMetrics

Получение метрик группы по странам

Идентификатор операции:

GetGroupMetricsByCountries

Возвращает географические источники трафика по странам для указанной группы.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
GUID группы	group_guid	True	string	GUID для группы Bitly
Единица	unit	True	string	Единица времени
Единицы	units	True	integer	Целое число, представляющее единицы времени для запроса данных. передайте -1, чтобы вернуть все единицы времени.
Size	size		integer	Количество возвращаемых элементов
Справочник по единицам	unit_reference		string	Метка времени ISO-8601, указывающая самое последнее время для извлечения метрик. Значение по умолчанию — текущее время.

Возвращаемое значение

ClickMetrics

ClickMetrics

Получение метрик группы по устройствам

Идентификатор операции:

GetGroupMetricsByDevices

Возвращает типы устройств, создающие трафик щелчка по ссылкам указанной группы.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
GUID группы	group_guid	True	string	GUID для группы Bitly
Единица	unit	True	string	Единица времени
Единицы	units	True	integer	Целое число, представляющее единицы времени для запроса данных. передайте -1, чтобы вернуть все единицы времени.
Size	size		integer	Количество возвращаемых элементов
Справочник по единицам	unit_reference		string	Метка времени ISO-8601, указывающая самое последнее время для извлечения метрик. Значение по умолчанию — текущее время.

Возвращаемое значение

Метрики устройств

DeviceMetrics

Получение метрик группы путем ссылки на сети

Идентификатор операции:

GetGroupMetricsByReferringNetworks

Возвращает метрики, ссылаясь на сети для ссылок указанной группы.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
GUID группы	group_guid	True	string	GUID для группы Bitly

Возвращаемое значение

ClickMetrics

ClickMetrics

Получение метрик для Bitlink на устройствах

Идентификатор операции:

GetMetricsForBitlinkByDevices

Возвращает типы устройств, создающие трафик щелчка по указанной ссылке.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Bitlink	bitlink	True	string	Bitlink, сделанный из домена и хэша
Единица	unit	True	string	Единица времени
Единицы	units	True	integer	Целое число, представляющее единицы времени для запроса данных. передайте -1, чтобы вернуть все единицы времени.
Size	size		integer	Количество возвращаемых элементов
Справочник по единицам	unit_reference		string	Метка времени ISO-8601, указывающая самое последнее время для извлечения метрик. Значение по умолчанию — текущее время.

Возвращаемое значение

Метрики устройств

DeviceMetrics

Получение метрик для Bitlink по городам

Идентификатор операции:

GetMetricsForBitlinkByCities

Возвращает источники города для трафика щелчка для указанной ссылки.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Bitlink	bitlink	True	string	Bitlink, сделанный из домена и хэша
Единица	unit	True	string	Единица времени
Единицы	units	True	integer	Целое число, представляющее единицы времени для запроса данных. передайте -1, чтобы вернуть все единицы времени.
Size	size		integer	Количество возвращаемых элементов
Справочник по единицам	unit_reference		string	Метка времени ISO-8601, указывающая самое последнее время для извлечения метрик. Значение по умолчанию — текущее время.

Возвращаемое значение

Городские метрики

CityMetrics

Получение метрик для Bitlink по ссылкам

Идентификатор операции:

GetMetricsForBitlinkByReferrers

Возвращает счетчики щелчков ссылок для указанной ссылки.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Bitlink	bitlink	True	string	Bitlink, сделанный из домена и хэша
Единица	unit	True	string	Единица времени
Единицы	units	True	integer	Целое число, представляющее единицы времени для запроса данных. передайте -1, чтобы вернуть все единицы времени.
Size	size		integer	Количество возвращаемых элементов
Справочник по единицам	unit_reference		string	Метка времени ISO-8601, указывающая самое последнее время для извлечения метрик. Значение по умолчанию — текущее время.

Возвращаемое значение

ClickMetrics

ClickMetrics

Получение метрик для Bitlink по ссылкам по доменам

Идентификатор операции:

GetMetricsForBitlinkByReferrersByDomains

Возвращает метрики щелчка, сгруппированные по ссылкам для указанной ссылки.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Bitlink	bitlink	True	string	Bitlink, сделанный из домена и хэша
Единица	unit	True	string	Единица времени
Единицы	units	True	integer	Целое число, представляющее единицы времени для запроса данных. передайте -1, чтобы вернуть все единицы времени.
Size	size		integer	Количество возвращаемых элементов
Справочник по единицам	unit_reference		string	Метка времени ISO-8601, указывающая самое последнее время для извлечения метрик. Значение по умолчанию — текущее время.

Возвращаемое значение

ReferrersByDomains

ReferrersByDomains

Получение метрик для Bitlink по странам

Идентификатор операции:

GetMetricsForBitlinkByCountries

Возвращает происхождение страны для трафика щелчка для указанной ссылки.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Bitlink	bitlink	True	string	Bitlink, сделанный из домена и хэша
Единица	unit	True	string	Единица времени
Единицы	units	True	integer	Целое число, представляющее единицы времени для запроса данных. передайте -1, чтобы вернуть все единицы времени.
Size	size		integer	Количество возвращаемых элементов
Справочник по единицам	unit_reference		string	Метка времени ISO-8601, указывающая самое последнее время для извлечения метрик. Значение по умолчанию — текущее время.

Возвращаемое значение

ClickMetrics

ClickMetrics

Получение метрик для Bitlink путем ссылки на домены

Идентификатор операции:

GetMetricsForBitlinkByReferringDomains

Возвращает счетчики ссылок на домен для указанной ссылки.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Bitlink	bitlink	True	string	Bitlink, сделанный из домена и хэша
Единица	unit	True	string	Единица времени
Единицы	units	True	integer	Целое число, представляющее единицы времени для запроса данных. передайте -1, чтобы вернуть все единицы времени.
Size	size		integer	Количество возвращаемых элементов
Справочник по единицам	unit_reference		string	Метка времени ISO-8601, указывающая самое последнее время для извлечения метрик. Значение по умолчанию — текущее время.

Возвращаемое значение

ClickMetrics

ClickMetrics

Получение настраиваемой связи Bitlink

Идентификатор операции:

GetCustomBitlink

Возвращает сведения и журнал указанной ссылки.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Настраиваемая bitlink	custom_bitlink	True	string	Настраиваемая битовая ссылка, созданная в домене и ключевом слове

Возвращаемое значение

CustomBitlink

CustomBitlink

Получение ограничений плана

Идентификатор операции:

GetPlanLimits

Возвращает все ограничения плана и счетчики, доступные для организации.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
GUID организации	organization_guid	True	string	GUID для организации Bitly

Возвращаемое значение

PlanLimits

PlanLimits

Получение ограничений платформы

Идентификатор операции:

GetPlatformLimits

Получение всех ограничений и подсчетов платформ, доступных для организации

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Путь	path		string	Конкретный путь, для которого запрашивается информация

Возвращаемое значение

PlatformLimits

PlatformLimits

Получение организации

Идентификатор операции:

GetOrganization

Получение сведений для указанной организации.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
GUID организации	organization_guid	True	string	GUID для организации Bitly

Возвращаемое значение

Организация

Organization

Получение организаций

Идентификатор операции:

GetOrganizations

Получение списка организаций.

Возвращаемое значение

Organizations

Organizations

Получение отсортированных битовых ссылок

Идентификатор операции:

GetSortedBitlinks

Возвращает список битовых ссылок, отсортированных по группе.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
GUID группы	group_guid	True	string	GUID для группы Bitly
Сортировать	sort	True	string	Тип сортировки, который вы хотите выполнить
Единица	unit		string	Единица времени
Единицы	units		integer	Целое число, представляющее единицы времени для запроса данных. передайте -1, чтобы вернуть все единицы времени.
Справочник по единицам	unit_reference		string	Метка времени ISO-8601, указывающая самое последнее время для извлечения метрик. Значение по умолчанию — текущее время.
Size	size		integer	Количество возвращаемых элементов

Возвращаемое значение

SortedLinks

SortedLinks

Получение параметров группы

Идентификатор операции:

GetGroupPreferences

Возвращает предпочтения для указанной группы.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
GUID группы	group_guid	True	string	GUID для группы Bitly

Возвращаемое значение

GroupPreferences

GroupPreferences

Получение пользовательских битовых ссылок для BSD

Идентификатор операции:

GetCustomBitlinksForBSDs

Получает пользовательские битовые ссылки для организации, отфильтрованной по BSD.S.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
GUID группы	group_guid	True	string	GUID для группы Bitly
Создано после	created_after		integer	Метка времени в виде целочисленной эпохи unix
Лимит	limit		integer	ограничение объема возвращаемых результатов
Смещение	offset		integer	Задайте начальный индекс результирующий набор
BSD	bsd		array	фирменные короткие домены для фильтрации результатов

Возвращаемое значение

BitlinkOverridesData

BitlinkOverridesData

Получение пользовательских метрик Bitlink по назначению

Идентификатор операции:

GetCustomBitlinkMetricsByDestination

Возвращает метрики щелчка для указанной ссылки по его историческим назначениям.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Настраиваемая bitlink	custom_bitlink	True	string	Настраиваемая битовая ссылка, созданная в домене и ключевом слове
Единица	unit	True	string	Единица времени
Единицы	units	True	integer	Целое число, представляющее единицы времени для запроса данных. передайте -1, чтобы вернуть все единицы времени.
Справочник по единицам	unit_reference		string	Метка времени ISO-8601, указывающая самое последнее время для извлечения метрик. Значение по умолчанию — текущее время.

Возвращаемое значение

ClickMetrics

ClickMetrics

Получение пользователя

Идентификатор операции:

GetUser

Возвращает сведения для текущего пользователя, прошедшего проверку подлинности.

Возвращаемое значение

User

User

Получение приложения OAuth

Идентификатор операции:

GetOAuthApp

Получите сведения о предоставленном идентификаторе клиента приложения OAuth.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Щелкните Идентификатор	client_id	True	string	Идентификатор клиента приложения OAuth

Возвращаемое значение

OAuthApp

OAuthApp

Получение сводки по щелчкам для Bitlink

Идентификатор операции:

GetClicksSummaryForBitlink

Возвращает количество щелчков для указанной ссылки, свернутой в одно поле.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Bitlink	bitlink	True	string	Bitlink, сделанный из домена и хэша
Единица	unit	True	string	Единица времени
Единицы	units	True	integer	Целое число, представляющее единицы времени для запроса данных. передайте -1, чтобы вернуть все единицы времени.
Справочник по единицам	unit_reference		string	Метка времени ISO-8601, указывающая самое последнее время для извлечения метрик. Значение по умолчанию — текущее время.

Возвращаемое значение

ClicksSummary

ClicksSummary

Получение сокращенных счетчиков организации

Идентификатор операции:

GetOrganizationShortenCounts

Возвращает сокращенное количество для определенной организации за указанный период времени.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
GUID организации	organization_guid	True	string	GUID для организации Bitly
Единица	unit	True	string	Единица времени
Единицы	units	True	integer	Целое число, представляющее единицы времени для запроса данных. передайте -1, чтобы вернуть все единицы времени.
Справочник по единицам	unit_reference		string	Метка времени ISO-8601, указывающая самое последнее время для извлечения метрик. Значение по умолчанию — текущее время.

Возвращаемое значение

Metrics

Metrics

Получение тегов группы

Идентификатор операции:

GetGroupTags

Возвращает теги, которые в настоящее время используются в указанной группе. Не более 1000.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
GUID группы	group_guid	True	string	GUID для группы Bitly

Возвращаемое значение

Метки

Tags

Получение щелчков группы

Идентификатор операции:

GetGroupClicks

Получение количества щелчков по bitlinks в группе.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
GUID группы	group_guid	True	string	GUID для группы Bitly
Единица	unit	True	string	Единица времени
Единицы	units	True	integer	Целое число, представляющее единицы времени для запроса данных. передайте -1, чтобы вернуть все единицы времени.
Справочник по единицам	unit_reference		string	Метка времени ISO-8601, указывающая самое последнее время для извлечения метрик. Значение по умолчанию — текущее время.

Возвращаемое значение

GroupClicks

GroupClicks

Получение щелчков для Bitlink

Идентификатор операции:

GetClicksForBitlink

Возвращает счетчики щелчков для указанной ссылки в массиве на основе даты.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Bitlink	bitlink	True	string	Bitlink, сделанный из домена и хэша
Единица	unit	True	string	Единица времени
Единицы	units	True	integer	Целое число, представляющее единицы времени для запроса данных. передайте -1, чтобы вернуть все единицы времени.
Справочник по единицам	unit_reference		string	Метка времени ISO-8601, указывающая самое последнее время для извлечения метрик. Значение по умолчанию — текущее время.

Возвращаемое значение

Клики

Clicks

Получение щелчков для пользовательской bitlink

Идентификатор операции:

GetClicksForCustomBitlink

Возвращает счетчики щелчков для указанной ссылки. Возвращает массив с щелчками на основе даты.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Настраиваемая bitlink	custom_bitlink	True	string	Настраиваемая битовая ссылка, созданная в домене и ключевом слове
Единица	unit	True	string	Единица времени
Единицы	units	True	integer	Целое число, представляющее единицы времени для запроса данных. передайте -1, чтобы вернуть все единицы времени.
Справочник по единицам	unit_reference		string	Метка времени ISO-8601, указывающая самое последнее время для извлечения метрик. Значение по умолчанию — текущее время.

Возвращаемое значение

Клики

Clicks

Проверка веб-перехватчика

Идентификатор операции:

VerifyWebhook

Отправляет событие ping для тестирования конфигурации веб-перехватчика.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
GUID веб-перехватчика	webhook_guid	True	string	GUID для веб-перехватчика Bitly

Возвращаемое значение

Webhook

Webhook

Разверните bitlink

Идентификатор операции:

ExpandBitlink

Возвращает короткую ссылку и длинный URL-адрес указанной ссылки.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
bitlink_id	bitlink_id		string

Возвращаемое значение

ExpandedBitlink

ExpandedBitlink

Создание Bitlink

Идентификатор операции:

CreateBitlink

Преобразует длинный URL-адрес в Bitlink.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
group_guid	group_guid		string
domain	domain		string
long_url	long_url	True	string

Возвращаемое значение

ShortenBitlinkBody

ShortenBitlinkBody

Создание веб-перехватчика

Идентификатор операции:

CreateWebhook

Создает веб-перехватчик.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
имя	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
идентификатор клиента	client_id		string
секрет_клиента	client_secret		string
oauth_url	oauth_url		string
событие	event	True	string

Возвращаемое значение

Webhook

Webhook

Создание кампании

Идентификатор операции:

CreateCampaign

Создает новую кампанию.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
group_guid	group_guid		string
channel_guids	channel_guids		array of string
описание	description		string
имя	name		string

Возвращаемое значение

кампания

Campaign

Создание канала

Идентификатор операции:

CreateChannel

Создает новый канал.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
group_guid	group_guid		string
гид	guid		string
имя	name		string
изменено	modified		string	ISO_TIMESTAMP
создано	created		string	ISO TIMESTAMP
campaign_guid	campaign_guid		string
bitlink_id	bitlink_id		string

Возвращаемое значение

Channel

Channel

Создание полной bitlink

Идентификатор операции:

CreateFullBitlink

Преобразует длинный URL-адрес в Bitlink и задает дополнительные параметры.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
domain	domain		string
title	title		string
group_guid	group_guid		string	Всегда включать определенную группу и личный домен в сокращенные вызовы.
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

Возвращаемое значение

BitlinkBody

BitlinkBody

Удаление веб-перехватчика

Идентификатор операции:

DeleteWebhook

Удаляет веб-перехватчик.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
GUID веб-перехватчика	webhook_guid	True	string	GUID для веб-перехватчика Bitly

Определения

Организация

Имя	Путь	Тип	Описание
Ссылки	references	object
имя	name	string
bsds	bsds	array of string
создано	created	string
is_active	is_active	boolean
изменено	modified	string
tier_display_name	tier_display_name	string
tier_family	tier_family	string
tier	tier	string
роль	role	string
гид	guid	string

Клики

Имя	Путь	Тип	Описание
Единиц	units	integer
unit_reference	unit_reference	string
Единица	unit	Unit
link_clicks	link_clicks	array of LinkClicks

CustomBitlinkHistory

Имя	Путь	Тип	Описание
hash	hash	string
UUID (Универсальный уникальный идентификатор)	uuid	string
ключевое слово	keyword	string
создано	created	string
group_guid	group_guid	string
first_created	first_created	string
is_active	is_active	boolean
long_url	long_url	string
Отключить	deactivated	string
BSD	bsd	string
login	login	string

Другие метрики

Имя	Путь	Тип	Описание
other_city_clicks	other_city_clicks	integer
no_city_clicks	no_city_clicks	integer

Webhooks

Имя	Путь	Тип	Описание
Объекты Webhook	webhooks	array of Webhook

Organizations

Имя	Путь	Тип	Описание
organizations	organizations	array of Organization

LinkClicks

Имя	Путь	Тип	Описание
date	date	string
Кликов	clicks	integer

PlanLimit

Имя	Путь	Тип	Описание
count	count	integer
limit	limit	integer
имя	name	string
описание	description	string

DeeplinkRule

Имя	Путь	Тип	Описание
bitlink	bitlink	string
install_url	install_url	string
создано	created	string	Метка времени ISO
app_uri_path	app_uri_path	string
изменено	modified	string	Метка времени ISO
install_type	install_type	string
app_guid	app_guid	string
гид	guid	string
os	os	string
brand_guid	brand_guid	string

кампания

Имя	Путь	Тип	Описание
Ссылки	references	object
имя	name	string
создано	created	string	Метка времени ISO
group_guid	group_guid	string
изменено	modified	string	Метка времени ISO
создано пользователем	created_by	string
гид	guid	string
описание	description	string

OAuthApp

Имя	Путь	Тип	Описание
link	link	string
имя	name	string
идентификатор клиента	client_id	string
описание	description	string

Каналы

Имя	Путь	Тип	Описание
channels	channels	array of Channel

PlatformLimits

Имя	Путь	Тип	Описание
platform_limits	platform_limits	array of PlatformLimit

Постраничная разбивка

Имя	Путь	Тип	Описание
итог	total	integer
size	size	integer
Предыдущая	prev	string
page	page	integer
next	next	string

BSDsResponse

Имя	Путь	Тип	Описание
bsds	bsds	array of string

GroupPreferences

Имя	Путь	Тип	Описание
group_guid	group_guid	string
domain_preference	domain_preference	string

ClicksSummary

Имя	Путь	Тип	Описание
Единиц	units	integer
Единица	unit	Unit
total_clicks	total_clicks	integer
unit_reference	unit_reference	string

Адрес электронной почты

Имя	Путь	Тип	Описание
is_primary	is_primary	boolean
is_verified	is_verified	boolean
электронная почта	email	string

Кампании

Имя	Путь	Тип	Описание
Кампании	campaigns	array of Campaign

ExpandedBitlink

Имя	Путь	Тип	Описание
long_url	long_url	string
создано_в	created_at	string
link	link	string
id	id	string

CustomBitlink

Имя	Путь	Тип	Описание
BitlinkBody	bitlink	BitlinkBody
bitlink_history	bitlink_history	array of CustomBitlinkHistory
custom_bitlink	custom_bitlink	string

SortedLinks

Имя	Путь	Тип	Описание
sorted_links	sorted_links	array of ClickLink
links	links	array of BitlinkBody

ClickLink

Имя	Путь	Тип	Описание
Кликов	clicks	integer
id	id	string

PlatformLimit

Имя	Путь	Тип	Описание
endpoint	endpoint	string
методы	methods	array of MethodLimit

Единица измерения

Имя	Путь	Тип	Описание
value	value	integer
key	key	string

BitlinkOverridesData

Имя	Путь	Тип	Описание
total_count	total_count	integer
Переопределения	overrides	array of BitlinkOverrides

ReferrersByDomains

Имя	Путь	Тип	Описание
Единиц	units	integer
Аспект2	facet	Facet2
referrers_by_domain	referrers_by_domain	array of ReferrersByDomain
unit_reference	unit_reference	string
единица	unit	string

CityMetric

Имя	Путь	Тип	Описание
city	city	string
region	region	string
Субрегионе	subregion	string
Кликов	clicks	integer
country	country	string

Группа

Имя	Путь	Тип	Описание
Ссылки	references	object
имя	name	string
bsds	bsds	array of string
создано	created	string
is_active	is_active	boolean
изменено	modified	string
organization_guid	organization_guid	string
роль	role	string
гид	guid	string

ShortenBitlinkBody

Имя	Путь	Тип	Описание
Ссылки	references	object
Архив	archived	boolean
tags	tags	array of string
создано_в	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

Битовые ссылки

Имя	Путь	Тип	Описание
Постраничная разбивка	pagination	Pagination
links	links	array of BitlinkBody

Метки

Имя	Путь	Тип	Описание
tags	tags	array of string

Webhook

Имя	Путь	Тип	Описание
Ссылки	references	object
статус	status	string
modified_by	modified_by	string
имя	name	string
создано	created	string
URL-адрес	url	string
Отключить	deactivated	string
fetch_tags	fetch_tags	boolean
is_active	is_active	boolean
изменено	modified	string
organization_guid	organization_guid	string
идентификатор клиента	client_id	string
group_guid	group_guid	string
секрет_клиента	client_secret	string
oauth_url	oauth_url	string
гид	guid	string
событие	event	string

GroupClicks

Имя	Путь	Тип	Описание
Единиц	units	integer
данные	data	array of CountItem
unit_reference	unit_reference	string
единица	unit	string

Groups

Имя	Путь	Тип	Описание
groups	groups	array of Group

User

Имя	Путь	Тип	Описание
default_group_guid	default_group_guid	string
имя	name	string
создано	created	string
is_active	is_active	boolean
изменено	modified	string
is_sso_user	is_sso_user	boolean
is_2fa_enabled	is_2fa_enabled	boolean
login	login	string
сообщения электронной почты	emails	array of Email

BulkAddResponse

Имя	Путь	Тип	Описание
сообщение	message	string
Data1	data	Data1

BitlinkQR

Имя	Путь	Тип	Описание
qr_code	qr_code	string	URI данных изображения QR-кода
link	link	string
id	id	string

Городские метрики

Имя	Путь	Тип	Описание
Единиц	units	integer
Аспект1	facet	Facet1
unit_reference	unit_reference	string
единица	unit	string
metrics	metrics	array of CityMetric
Другие метрики	other_metrics	OtherMetrics

BulkUpdate

Имя	Путь	Тип	Описание
links	links	array of string

MethodLimit

Имя	Путь	Тип	Описание
count	count	integer
limit	limit	integer
имя	name	string

Метрики устройств

Имя	Путь	Тип	Описание
Единиц	units	integer
Аспект1	facet	Facet1
unit_reference	unit_reference	string
единица	unit	string
metrics	metrics	array of DeviceMetric

BitlinkBody

Имя	Путь	Тип	Описание
Ссылки	references	object
Архив	archived	boolean
tags	tags	array of string
создано_в	created_at	string
title	title	string
deeplinks	deeplinks	array of DeeplinkRule
создано пользователем	created_by	string
long_url	long_url	string
идентификатор клиента	client_id	string
custom_bitlinks	custom_bitlinks	array of string
link	link	string
launchpad_ids	launchpad_ids	array of string
id	id	string

ClickMetrics

Имя	Путь	Тип	Описание
Единиц	units	integer
Аспект1	facet	Facet1
unit_reference	unit_reference	string
единица	unit	string
metrics	metrics	array of ClickMetric

Channel

Имя	Путь	Тип	Описание
group_guid	group_guid	string
гид	guid	string
имя	name	string
изменено	modified	string	ISO_TIMESTAMP
создано	created	string	ISO TIMESTAMP
Ссылки	references	object

DeviceMetric

Имя	Путь	Тип	Описание
Кликов	clicks	integer
device_type	device_type	string

Metrics

Имя	Путь	Тип	Описание
Единиц	units	integer
Аспект1	facet	Facet1
unit_reference	unit_reference	string
единица	unit	string
metrics	metrics	array of Metric

ClickMetric

Имя	Путь	Тип	Описание
Кликов	clicks	integer
value	value	string

CountItem

Имя	Путь	Тип	Описание
count	count	integer
ts	ts	string

ReferrersByDomain

Имя	Путь	Тип	Описание
Рефереры	referrers	array of Metric
сеть	network	string

PlanLimits

Имя	Путь	Тип	Описание
Ссылки	references	object
organization_guid	organization_guid	string
plan_limits	plan_limits	array of PlanLimit

BitlinkOverrides

Имя	Путь	Тип	Описание
Ссылки	references	object
создано	created	string
правила	rules	string
group_guid	group_guid	string
изменено	modified	string
version	version	integer
link	link	string	Полный URL-адрес переопределения, который является ссылкой Bitly для использования. Бывший: https://foo.com/bar
id	id	string

Data1

Имя	Путь	Тип	Описание
link_save_failures	link_save_failures	integer
keyword_failures	keyword_failures	integer
results	results	array of string
Успехи	successes	integer
channel_bitlink_failures	channel_bitlink_failures	integer
csv_format_failures	csv_format_failures	integer

Аспект1

Аспект1

string

Аспект2

Аспект2

string

Единица

Единица

string