Linkly (предварительная версия)
Linkly — это шортизатор ссылок и средство отслеживания щелчков. Создайте фирменные короткие ссылки с настраиваемыми доменами, добавьте параметры UTM и пиксели перенацеливания, преобразования отчетов и вытягивание аналитики, сгруппированные по стране, платформе, ссылке или кампании.
Этот соединитель доступен в следующих продуктах и регионах:
| Услуга | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Все регионы Power Automate , кроме следующих: - Правительство США (GCC) - Правительство США (GCC High) — Облако Китая, управляемое 21Vianet - Министерство обороны США (DoD) |
| Логические приложения | Standard | Все регионы Logic Apps , кроме следующих: — Регионы Azure для государственных организаций — Регионы Azure Для Китая - Министерство обороны США (DoD) |
| Power Apps | Premium | Все регионы Power Apps , кроме следующих: - Правительство США (GCC) - Правительство США (GCC High) — Облако Китая, управляемое 21Vianet - Министерство обороны США (DoD) |
| Power Automate | Premium | Все регионы Power Automate , кроме следующих: - Правительство США (GCC) - Правительство США (GCC High) — Облако Китая, управляемое 21Vianet - Министерство обороны США (DoD) |
| Контакт | |
|---|---|
| Name | Поддержка ссылок |
| URL-адрес | https://linklyhq.com/support |
| Электронная почта | support@linklyhq.com |
| Метаданные соединителя | |
|---|---|
| Publisher | Ссылка |
| Веб-сайт | https://linklyhq.com |
| Политика конфиденциальности | https://linklyhq.com/support/privacy |
| Categories | Маркетинг; Сайт |
Ссылка
Linkly — это шортизатор ссылок и средство отслеживания щелчков. Он создает фирменные короткие ссылки в собственном домене, отслеживает каждый щелчок с разбивкой страны, платформы и ссылки, перенацеливает пиксели и записывает преобразования обратно в созданную ссылку. Этот соединитель позволяет потокам создавать ссылки и управлять ими, извлекать аналитические данные и преобразования отчетов в рабочей области Linkly.
Publisher: Linkly
Prerequisites
Учетная запись Linkly . Бесплатный план достаточно для использования каждого действия в этом соединителе. Для создания отчетов и перечисления преобразований также требуется включить функцию отслеживания ссылок в рабочей области.
Поддерживаемые операции
Список рабочих пространств
Возвращает рабочие области, доступные для этого подключения. Используйте его для поиска рабочей области, которую требуют другие действия.
Создание или обновление ссылки
Создает новую короткую ссылку или обновляет существующую при указании идентификатора ссылки. Поддерживает пользовательские домены и slugs, параметры UTM, перенацеливание пикселей и метаданные Open Graph.
Получение ссылки
Извлекает одну ссылку по идентификатору, включая назначение, короткий URL-адрес и конфигурацию.
Список ссылок
Возвращает список ссылок в рабочей области с разбивкой на страницы с статистикой щелчков. Поддерживает поиск и сортировку.
Удаление ссылки
Перемещает ссылку на корзину. Его короткий URL-адрес останавливает перенаправление, и ссылка может быть восстановлена позже из корзины.
Получение аналитики щелчков
Возвращает количество щелчков с течением времени для рабочей области или для определенных ссылок, необязательно отфильтрованных по диапазону дат, стране, браузеру, платформе, ссылке или ISP.
Получение счетчиков щелчков по измерению
Возвращает счетчики щелчков, сгруппированные по измерению, например страна, город, платформа, ссылка или параметр UTM, упорядоченные по убыванию.
Перечисление настраиваемых доменов
Возвращает настраиваемые домены, настроенные для рабочей области. Эти доменные имена можно использовать при создании ссылок.
Отчет о преобразовании
Записывает преобразование, например покупку, регистрацию или пользовательское событие, и атрибуты его ссылке, которая была щелкнуна при указании маркера атрибуции.
Перечисление преобразований
Возвращает последние преобразования, записанные в рабочей области.
Получение учетных данных
Этот соединитель использует OAuth 2.0. Ключ API не нужен.
- Если у вас еще нет учетной записи Linkly, зарегистрируйтесь по адресу https://linklyhq.com. Бесплатный план работает.
- При создании подключения выберите "Войти с помощью Linkly " и войдите с помощью учетной записи Linkly.
- Выберите рабочую область, используемую при появлении запроса, а затем утвердить запрос.
Подключение привязано к выбранной рабочей области. Чтобы работать в другой рабочей области, создайте второе подключение.
Getting Started
- Создайте подключение, как описано выше.
- Добавьте действие создания или обновления ссылки в поток, введите URL-адрес назначения и, при необходимости, личный домен и slug. Действие возвращает короткий URL-адрес и идентификатор ссылки.
- Используйте ссылки "Список", "Получить аналитику " или "Получить счетчики щелчков по измерению " для чтения данных щелчка. Действия, которые принимают рабочую область , позволяют выбрать ее из списка, который заполняется рабочими областями списка.
- Чтобы атрибутировать покупки или регистрации для ссылок, передайте
linkly_cidзначение из URL-адреса целевой страницы в отчет о преобразовании в качестве маркера атрибуции.
Известные проблемы и ограничения
- Подключение привязано к одной рабочей области Linkly, выбранной при входе. Создайте одно подключение для каждой рабочей области.
- Для отчетов о преобразовании и преобразованиях списка требуется функция отслеживания ссылок. Рабочие области без них получают ошибку от этих действий.
- В режиме реального времени веб-перехватчики не предоставляются в качестве триггеров. Вместо этого используйте функцию веб-перехватчика Linkly с потоком с триггером HTTP.
- Создание массовых ссылок, экспорт ссылок и управление доменами доступны в API Linkly, но не включены в этот соединитель.
- API ограничена скоростью. Получение счетчиков щелчков по измерению возвращает ошибку ограничения скорости при превышении ограничения; Повторите попытку после короткой задержки.
Часто задаваемые вопросы
В какой рабочей области выполняются мои действия?
Действия, которые выполняют параметр рабочей области , отображают список рабочих областей, доступных для подключения. Действия без одного, например Получение ссылки, отчет о преобразовании и преобразованияхсписка, используйте рабочую область, привязанную к соединению.
Как использовать личный домен?
Сначала добавьте домен в Linkly, а затем передайте его имя в поле "Домен " создания или обновления ссылки. Список настраиваемых доменов возвращает имена, доступные в рабочей области.
Удаляет ли ссылка окончательно?
No. Ссылка перемещается в корзину и останавливает перенаправление. Его можно восстановить из корзины в Linkly.
Инструкции по развертыванию
- На портале разработчика откройте настраиваемые соединители, выберите новый настраиваемый соединитель и импортируйте файл OpenAPI. Выберите параметр
apiDefinition.swagger.json. - На вкладке "Безопасность " выберите OAuth 2.0 с поставщиком удостоверений Универсального поставщика удостоверений Oauth 2 . Введите идентификатор клиента и секрет клиента, выданный Linkly, задайте URL-адрес авторизации и задайте URL-адрес
https://app.linklyhq.com/oauth/authorizeмаркера и URL-адресhttps://app.linklyhq.com/oauth/tokenобновления. - Создайте соединитель, а затем скопируйте URL-адрес перенаправления, отображаемый на вкладке "Безопасность" и зарегистрируйте его в Linkly для этого идентификатора клиента.
- Создайте подключение, выполнив вход с помощью учетной записи Linkly, а затем протестируйте действие, например рабочие области списка.
Действия
| Отчет о преобразовании |
Записывает преобразование, например покупку, регистрацию или пользовательское событие, и атрибуты его ссылке, которая была щелкнуна при указании маркера атрибуции. |
| Перечисление настраиваемых доменов |
Возвращает настраиваемые домены, настроенные для рабочей области. Эти доменные имена можно использовать при создании ссылок. |
| Перечисление преобразований |
Возвращает последние преобразования, записанные в рабочей области. |
| Получение аналитики щелчков |
Возвращает количество щелчков с течением времени для рабочей области или для определенных ссылок, необязательно отфильтрованных по диапазону дат, стране, браузеру, платформе, ссылке или ISP. |
| Получение ссылки |
Извлекает одну ссылку по идентификатору, включая назначение, короткий URL-адрес и конфигурацию. |
| Получение счетчиков щелчков по измерению |
Возвращает счетчики щелчков, сгруппированные по измерению, например страна, город, платформа, ссылка или параметр UTM, упорядоченные по убыванию. |
| Создание или обновление ссылки |
Создает новую короткую ссылку или обновляет существующую при указании идентификатора ссылки. Поддерживает пользовательские домены и slugs, параметры UTM, перенацеливание пикселей и метаданные Open Graph. |
| Список рабочих пространств |
Возвращает рабочие области, доступные для этого подключения. Используйте его для поиска рабочей области, которую требуют другие действия. |
| Список ссылок |
Возвращает список ссылок в рабочей области с разбивкой на страницы с статистикой щелчков. Поддерживает поиск и сортировку. |
| Удаление ссылки |
Перемещает ссылку на корзину. Его короткий URL-адрес останавливает перенаправление, и ссылка может быть восстановлена позже из корзины. |
Отчет о преобразовании
Записывает преобразование, например покупку, регистрацию или пользовательское событие, и атрибуты его ссылке, которая была щелкнуна при указании маркера атрибуции.
Параметры
| Имя. | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Сумма (центы)
|
amount_cents | integer |
Значение в наименьшей денежной единице. Может оказаться отрицательным для записи возврата или обратной оплаты, которая за nets по отношению к более ранним доходам. |
|
|
Country
|
country | string |
Двухбуквенный код страны для преобразования. Вывод для вызовов на стороне браузера; предоставьте его явным образом из серверной интеграции, где адрес подключения является вашей собственной инфраструктурой, а не клиентом. |
|
|
Валюта
|
currency | string |
Код валюты ISO 4217. По умолчанию — USD. |
|
|
Идентификатор события
|
event_id | string |
Идентификатор этого события. Используется в качестве ключа идемпотентности; сообщая одно и то же значение дважды, не будет создавать второе преобразование. Применяется к любому типу событий, а не только к покупкам. |
|
|
Название мероприятия
|
event_name | True | string |
Что произошло, например покупка, регистрация, trial_started. |
|
Тип события
|
event_type | string |
Грубый тип вождения воронки. свинца устанавливает удостоверение клиента, выручка от продаж. По умолчанию настраивается. |
|
|
Идентификатор клиента
|
external_id | string |
Идентификатор клиента. Отправьте его на каждое событие: это то, что связывает более позднюю продажу на стороне сервера обратно с щелчком, который создал регистрацию. |
|
|
Токен атрибуции
|
linkly_cid | string |
Маркер атрибуции, захваченный из URL-адреса целевой страницы. Опустить, если недоступно; Затем преобразование записывается без присвоения ссылки. |
|
|
Metadata
|
metadata | object |
Произвольный код JSON— до 10 000 байтов. |
|
|
Произошло в
|
occurred_at | date-time |
Когда произошло преобразование. По умолчанию сейчас. |
|
|
IP-адрес посетителя
|
visitor_ip | string |
IP-адрес конечного клиента, когда он имеется на вашем сервере. Опустить, если вы не делаете; для вызовов на стороне сервера Linkly в противном случае записывает адрес подключения как сервер, а не клиент, и исключает его из географических отчетов. Отправляя это утверждение, вы имеете законную основу для совместного использования. Никогда не возвращается API. |
Возвращаемое значение
| Имя. | Путь | Тип | Описание |
|---|---|---|---|
|
Сумма (центы)
|
amount_cents | integer |
Значение в наименьшей денежной единице. Может оказаться отрицательным для записи возврата средств. |
|
Щелкните Идентификатор
|
click_id | string |
Идентификатор щелчка атрибута. |
|
Country
|
country | string |
Двухбуквенный код страны ISO 3166-1, например США. |
|
Валюта
|
currency | string |
Код ISO 4217 валюты. По умолчанию — USD. |
|
Идентификатор события
|
event_id | string |
Идентификатор события. Сообщая одно и то же значение дважды, не создает второе преобразование. |
|
Название мероприятия
|
event_name | string |
Что произошло, например покупка, регистрация или trial_started. |
|
Тип события
|
event_type | string |
Тип события грубого типа. Используйте свинца, чтобы установить удостоверение клиента и продажу для записи доходов. По умолчанию настраивается. |
|
Идентификатор клиента
|
external_id | string |
Идентификатор клиента. Отправьте его на каждое событие, чтобы последующие продажи могли быть связаны с исходным щелчком мыши. |
|
Идентификатор преобразования
|
id | string |
Уникальный идентификатор преобразования. Идентификаторы сортируются в хронологическом порядке. |
|
Вставлено в
|
inserted_at | date-time |
Когда преобразование было записано. |
|
Источник IP-адресов
|
ip_source | string |
Адрес которого записан: посетитель, сервер или неизвестный. Сервер означает, что адрес подключения принадлежит серверной части или ретранслятору платформы, поэтому он исключается из географических отчетов. |
|
Идентификатор ссылки
|
link_id | integer |
Идентификатор ссылки атрибута или null, если преобразование не может быть присвоено ссылке. |
|
Metadata
|
metadata | object |
Произвольные метаданные JSON до 10 000 байт. |
|
Произошло в
|
occurred_at | date-time |
Когда произошло преобразование, в формате ISO 8601. По умолчанию сейчас. |
|
Source
|
source | string |
Какая интеграция сообщила об этом. |
Перечисление настраиваемых доменов
Возвращает настраиваемые домены, настроенные для рабочей области. Эти доменные имена можно использовать при создании ссылок.
Параметры
| Имя. | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Workspace
|
workspace_id | True | string |
Рабочая область для работы. Выберите его из списка или введите его идентификатор. |
Возвращаемое значение
| Имя. | Путь | Тип | Описание |
|---|---|---|---|
|
Domains
|
domains | array of object |
Личные домены в рабочей области. |
|
Имя домена
|
domains.name | string |
Например, доменное имя go.yourcompany.com. |
Перечисление преобразований
Возвращает последние преобразования, записанные в рабочей области.
Параметры
| Имя. | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Limit
|
limit | integer |
Максимальное количество преобразований, возвращаемых в диапазоне от 1 до 1000. |
Возвращаемое значение
| Имя. | Путь | Тип | Описание |
|---|---|---|---|
|
Conversions
|
conversions | array of object |
Преобразования, самые последние. |
|
Сумма (центы)
|
conversions.amount_cents | integer |
Значение в наименьшей денежной единице. Может оказаться отрицательным для записи возврата средств. |
|
Щелкните Идентификатор
|
conversions.click_id | string |
Идентификатор щелчка атрибута. |
|
Country
|
conversions.country | string |
Двухбуквенный код страны ISO 3166-1, например США. |
|
Валюта
|
conversions.currency | string |
Код ISO 4217 валюты. По умолчанию — USD. |
|
Идентификатор события
|
conversions.event_id | string |
Идентификатор события. Сообщая одно и то же значение дважды, не создает второе преобразование. |
|
Название мероприятия
|
conversions.event_name | string |
Что произошло, например покупка, регистрация или trial_started. |
|
Тип события
|
conversions.event_type | string |
Тип события грубого типа. Используйте свинца, чтобы установить удостоверение клиента и продажу для записи доходов. По умолчанию настраивается. |
|
Идентификатор клиента
|
conversions.external_id | string |
Идентификатор клиента. Отправьте его на каждое событие, чтобы последующие продажи могли быть связаны с исходным щелчком мыши. |
|
Идентификатор преобразования
|
conversions.id | string |
Уникальный идентификатор преобразования. Идентификаторы сортируются в хронологическом порядке. |
|
Вставлено в
|
conversions.inserted_at | date-time |
Когда преобразование было записано. |
|
Источник IP-адресов
|
conversions.ip_source | string |
Адрес которого записан: посетитель, сервер или неизвестный. Сервер означает, что адрес подключения принадлежит серверной части или ретранслятору платформы, поэтому он исключается из географических отчетов. |
|
Идентификатор ссылки
|
conversions.link_id | integer |
Идентификатор ссылки атрибута или null, если преобразование не может быть присвоено ссылке. |
|
Metadata
|
conversions.metadata | object |
Произвольные метаданные JSON до 10 000 байт. |
|
Произошло в
|
conversions.occurred_at | date-time |
Когда произошло преобразование, в формате ISO 8601. По умолчанию сейчас. |
|
Source
|
conversions.source | string |
Какая интеграция сообщила об этом. |
Получение аналитики щелчков
Возвращает количество щелчков с течением времени для рабочей области или для определенных ссылок, необязательно отфильтрованных по диапазону дат, стране, браузеру, платформе, ссылке или ISP.
Параметры
| Имя. | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Workspace
|
workspace_id | True | string |
Рабочая область для работы. Выберите его из списка или введите его идентификатор. |
|
Идентификатор ссылки
|
link_id | string |
Идентификатор одной ссылки для фильтрации. |
|
|
Идентификаторы ссылок
|
link_ids | string |
Разделенный дефисом список идентификаторов ссылок для фильтрации по. |
|
|
Дата начала
|
start | string |
Начало диапазона дат в формате YYY-MM-DD. |
|
|
Дата окончания
|
end | string |
Конец диапазона дат в формате YYY-MM-DD. |
|
|
Country
|
country | string |
Двухбуквенный код страны ISO 3166-1, например США. |
|
|
Browser
|
browser | string |
Имя браузера для фильтрации, например Chrome, Firefox или Safari. |
|
|
Platform
|
platform | string |
Платформа или операционная система для фильтрации, например Windows, Mac, iOS или Android. |
|
|
Источник перехода
|
referer | string |
Ссылающийся домен для фильтрации по. |
|
|
интернет-провайдер
|
isp | string |
Имя поставщика услуг Интернета для фильтрации по. |
|
|
Включение ботов
|
bots | boolean |
Следует ли включать щелчки, определенные как боты. Установите значение false, чтобы исключить их. |
|
|
Только уникальные
|
unique | boolean |
Следует ли подсчитать только уникальные щелчки. |
|
|
Часовой пояс
|
timezone | string |
Часовой пояс IANA, используемый для вычислений дат, например Европа или Лондон. |
|
|
Периодичность
|
frequency | string |
Степень детализации временных рядов в день или час. |
Возвращаемое значение
| Имя. | Путь | Тип | Описание |
|---|---|---|---|
|
Traffic
|
traffic | array of object |
С течением времени щелчок учитывается. |
|
Запуск контейнера
|
traffic.t | string |
Начало контейнера: ГГГГ-MM-DD для ежедневных контейнеров или ГГГГ-ММ-ДДTHH:ММ:СС для почасовых контейнеров. |
|
Щелчки
|
traffic.y | integer |
Количество щелчков в контейнере. |
Получение ссылки
Извлекает одну ссылку по идентификатору, включая назначение, короткий URL-адрес и конфигурацию.
Параметры
| Имя. | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор ссылки
|
id | True | string |
Идентификатор ссылки. |
Возвращаемое значение
| Имя. | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор мета пикселя
|
fb_pixel_id | string |
Идентификатор пикселя мета (Facebook) для срабатывания при щелчке ссылки. |
|
идентификатор партнера LinkedIn
|
linkedin_partner_id | string |
Идентификатор партнера LinkedIn Insights Tag, который будет срабачен при щелчке ссылки. |
|
Microsoft идентификатор тега UET
|
microsoft_uet_tag_id | string |
Идентификатор тега UET Microsoft Advertising при щелчке ссылки. |
|
Идентификатор пикселя Reddit
|
reddit_pixel_id | string |
Идентификатор пикселя Reddit для запуска при щелчке ссылки. |
|
Идентификатор пикселя TikTok
|
tiktok_pixel_id | string |
Идентификатор пикселя TikTok для запуска при щелчке ссылки. |
|
Скрытие ссылок
|
hide_referrer | boolean |
Следует ли скрыть ссылку на целевом сайте. |
|
Дата окончания срока действия
|
expiry_datetime | string |
Когда ссылка перестает работать, в формате ISO 8601. |
|
Назначение с истекшим сроком действия
|
expiry_destination | uri |
URL-адрес для перенаправления после истечения срока действия ссылки. Оставьте пустым, чтобы вернуть не найденную страницу. |
|
Идентификатор пикселя X
|
twitter_pixel_id | string |
Идентификатор пикселя X (Twitter) для срабатывания при щелчке ссылки. |
|
Маскировка
|
cloaking | boolean |
Следует ли скрыть место назначения, открыв его внутри кадра. |
|
Короткий URL-адрес
|
full_url | uri |
Полный URL-адрес короткой ссылки. |
|
Открытие описания Графа
|
og_description | string |
Описание, показанное при совместном использовании ссылки в социальных сетях. |
|
Пропуск отслеживания социального обходчика
|
skip_social_crawler_tracking | boolean |
Следует ли исключить сканеры предварительной версии социальных сетей из отслеживания щелчков. |
|
Теги текста
|
body_tags | string |
Пользовательские теги HTML или отслеживания, вставленные в текст страницы перенаправления. |
|
Открытие заголовка графа
|
og_title | string |
Заголовок, показанный при совместном использовании ссылки в социальных сетях. |
|
Note
|
note | string |
Частная заметка о ссылке. |
|
Name
|
name | string |
Псевдоним ссылки, показанный на панели мониторинга. |
|
Идентификатор ссылки
|
id | integer |
Уникальный идентификатор ссылки. |
|
Идентификатор диспетчера тегов Google
|
gtm_id | string |
Идентификатор контейнера Диспетчера тегов Google для загрузки при щелчке ссылки. |
|
Открытие образа Graph
|
og_image | string |
URL-адрес изображения, показанный при совместном использовании ссылки в социальных сетях. |
|
Блокировать боты
|
block_bots | boolean |
Блокировать ли известные боты по ссылке. |
|
Идентификатор пикселя Snapchat
|
snapchat_pixel_id | string |
Идентификатор пикселя Snapchat для запуска при щелчке ссылки. |
|
Содержимое UTM
|
utm_content | string |
Параметр utm_content, добавленный к URL-адресу назначения. |
|
Enabled
|
enabled | boolean |
Является ли ссылка активной. |
|
URL-адрес назначения
|
url | uri |
URL-адрес назначения, на который перенаправляется короткая ссылка. |
|
Удалено
|
deleted | boolean |
Указывает, находится ли ссылка в корзине. |
|
Webhooks
|
webhooks | array of string |
URL-адреса веб-перехватчика, подписанные на щелчки по этой ссылке. |
|
Срок действия щелчков
|
expiry_clicks | integer |
Количество щелчков, после которого ссылка перестает работать. |
|
Уведомление Slack
|
notify_slack | boolean |
Следует ли отправлять уведомление Slack при щелчке ссылки. |
|
Идентификатор рабочей области
|
workspace_id | integer |
Идентификатор рабочей области. |
|
Общедоступная аналитика
|
public_analytics | boolean |
Можно ли просматривать страницу аналитики для ссылки. |
|
Идентификатор тега Pinterest
|
pinterest_tag_id | string |
Идентификатор тега Pinterest для запуска при щелчке ссылки. |
|
Источник UTM
|
utm_source | string |
Параметр utm_source, добавленный к URL-адресу назначения. |
|
Поле динамических данных
|
slug | string |
Пользовательский путь для короткой ссылки. Он должен начинаться с косой черты. |
|
Домен
|
domain | string |
Личный домен, используемый для короткой ссылки, без косой черты. |
|
Параметры пересылки
|
forward_params | boolean |
Следует ли пересылать параметры запроса из короткой ссылки на место назначения. |
|
Средний UTM
|
utm_medium | string |
Параметр utm_medium, добавленный к URL-адресу назначения. |
|
Теги головы
|
head_tags | string |
Настраиваемые теги HTML или отслеживания, вставленные в голову страницы перенаправления. |
|
Идентификатор тега Google Analytics 4
|
ga4_tag_id | string |
Идентификатор измерения Google Analytics 4 для запуска при щелчке ссылки. |
|
Термин UTM
|
utm_term | string |
Параметр utm_term, добавленный к URL-адресу назначения. |
|
Кампания UTM
|
utm_campaign | string |
Параметр utm_campaign, добавленный к URL-адресу назначения. |
Получение счетчиков щелчков по измерению
Возвращает счетчики щелчков, сгруппированные по измерению, например страна, город, платформа, ссылка или параметр UTM, упорядоченные по убыванию.
Параметры
| Имя. | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Workspace
|
workspace_id | True | string |
Рабочая область для работы. Выберите его из списка или введите его идентификатор. |
|
Dimension
|
counter | True | string |
Измерение для группировки щелкает, например страну, город, платформу, реферер или utm_campaign. |
|
Идентификатор ссылки
|
link_id | string |
Идентификатор одной ссылки для фильтрации. |
|
|
Идентификаторы ссылок
|
link_ids | string |
Разделенный дефисом список идентификаторов ссылок для фильтрации по. |
|
|
Дата начала
|
start | string |
Начало диапазона дат в формате YYY-MM-DD. |
|
|
Дата окончания
|
end | string |
Конец диапазона дат в формате YYY-MM-DD. |
|
|
Country
|
country | string |
Двухбуквенный код страны ISO 3166-1, например США. |
|
|
Включение ботов
|
bots | boolean |
Следует ли включать щелчки, определенные как боты. Установите значение false, чтобы исключить их. |
|
|
Только уникальные
|
unique | boolean |
Следует ли подсчитать только уникальные щелчки. |
Возвращаемое значение
| Имя. | Путь | Тип | Описание |
|---|---|---|---|
|
Total
|
total | integer |
Всего щелчков по всем группам, включая любые не возвращенные значения. Если результат усечен, это больше суммы подсчета значений, поэтому счетчик / общее значение по-прежнему дает точный процент. |
|
Ценности
|
values | array of object |
Сгруппированные счетчики, упорядоченные по убыванию. Усечено до 10 000 значений; Если измерение имеет более уникальные значения, чем это, остальные не возвращаются. |
|
Счетч.
|
values.count | integer |
Количество щелчков для этого значения. |
|
Value
|
values.value | string |
Значение измерения, например код страны. |
Создание или обновление ссылки
Создает новую короткую ссылку или обновляет существующую при указании идентификатора ссылки. Поддерживает пользовательские домены и slugs, параметры UTM, перенацеливание пикселей и метаданные Open Graph.
Параметры
| Имя. | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
URL-адрес назначения
|
url | uri |
URL-адрес назначения, на который перенаправляется короткая ссылка. Требуется создать новую ссылку. |
|
|
Идентификатор ссылки
|
id | integer |
Идентификатор существующей ссылки для обновления. Оставьте пустым, чтобы создать новую ссылку. |
|
|
Name
|
name | string |
Псевдоним ссылки, показанный на панели мониторинга. |
|
|
Домен
|
domain | string |
Личный домен, используемый для короткой ссылки, без косой черты. |
|
|
Поле динамических данных
|
slug | string |
Пользовательский путь для короткой ссылки. Он должен начинаться с косой черты. |
|
|
Enabled
|
enabled | boolean |
Является ли ссылка активной. |
|
|
Note
|
note | string |
Частная заметка о ссылке. |
|
|
Источник UTM
|
utm_source | string |
Параметр utm_source, добавленный к URL-адресу назначения. |
|
|
Средний UTM
|
utm_medium | string |
Параметр utm_medium, добавленный к URL-адресу назначения. |
|
|
Кампания UTM
|
utm_campaign | string |
Параметр utm_campaign, добавленный к URL-адресу назначения. |
|
|
Содержимое UTM
|
utm_content | string |
Параметр utm_content, добавленный к URL-адресу назначения. |
|
|
Термин UTM
|
utm_term | string |
Параметр utm_term, добавленный к URL-адресу назначения. |
|
|
Идентификатор мета пикселя
|
fb_pixel_id | string |
Идентификатор пикселя мета (Facebook) для срабатывания при щелчке ссылки. |
|
|
Идентификатор тега Google Analytics 4
|
ga4_tag_id | string |
Идентификатор измерения Google Analytics 4 для запуска при щелчке ссылки. |
|
|
Идентификатор диспетчера тегов Google
|
gtm_id | string |
Идентификатор контейнера Диспетчера тегов Google для загрузки при щелчке ссылки. |
|
|
Блокировать боты
|
block_bots | boolean |
Блокировать ли известные боты по ссылке. |
|
|
Теги текста
|
body_tags | string |
Пользовательские теги HTML или отслеживания, вставленные в текст страницы перенаправления. |
|
|
Маскировка
|
cloaking | boolean |
Следует ли скрыть место назначения, открыв его внутри кадра. |
|
|
Параметры пересылки
|
forward_params | boolean |
Следует ли пересылать параметры запроса из короткой ссылки на место назначения. |
|
|
Теги головы
|
head_tags | string |
Настраиваемые теги HTML или отслеживания, вставленные в голову страницы перенаправления. |
|
|
Скрытие ссылок
|
hide_referrer | boolean |
Следует ли скрыть ссылку на целевом сайте. |
|
|
Открытие описания Графа
|
og_description | string |
Описание, показанное при совместном использовании ссылки в социальных сетях. |
|
|
Открытие образа Graph
|
og_image | string |
URL-адрес изображения, показанный при совместном использовании ссылки в социальных сетях. |
|
|
Открытие заголовка графа
|
og_title | string |
Заголовок, показанный при совместном использовании ссылки в социальных сетях. |
|
|
Идентификатор пикселя TikTok
|
tiktok_pixel_id | string |
Идентификатор пикселя TikTok для запуска при щелчке ссылки. |
Возвращаемое значение
| Имя. | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор мета пикселя
|
fb_pixel_id | string |
Идентификатор пикселя мета (Facebook) для срабатывания при щелчке ссылки. |
|
идентификатор партнера LinkedIn
|
linkedin_partner_id | string |
Идентификатор партнера LinkedIn Insights Tag, который будет срабачен при щелчке ссылки. |
|
Microsoft идентификатор тега UET
|
microsoft_uet_tag_id | string |
Идентификатор тега UET Microsoft Advertising при щелчке ссылки. |
|
Идентификатор пикселя Reddit
|
reddit_pixel_id | string |
Идентификатор пикселя Reddit для запуска при щелчке ссылки. |
|
Идентификатор пикселя TikTok
|
tiktok_pixel_id | string |
Идентификатор пикселя TikTok для запуска при щелчке ссылки. |
|
Скрытие ссылок
|
hide_referrer | boolean |
Следует ли скрыть ссылку на целевом сайте. |
|
Дата окончания срока действия
|
expiry_datetime | string |
Когда ссылка перестает работать, в формате ISO 8601. |
|
Назначение с истекшим сроком действия
|
expiry_destination | uri |
URL-адрес для перенаправления после истечения срока действия ссылки. Оставьте пустым, чтобы вернуть не найденную страницу. |
|
Идентификатор пикселя X
|
twitter_pixel_id | string |
Идентификатор пикселя X (Twitter) для срабатывания при щелчке ссылки. |
|
Маскировка
|
cloaking | boolean |
Следует ли скрыть место назначения, открыв его внутри кадра. |
|
Короткий URL-адрес
|
full_url | uri |
Полный URL-адрес короткой ссылки. |
|
Открытие описания Графа
|
og_description | string |
Описание, показанное при совместном использовании ссылки в социальных сетях. |
|
Пропуск отслеживания социального обходчика
|
skip_social_crawler_tracking | boolean |
Следует ли исключить сканеры предварительной версии социальных сетей из отслеживания щелчков. |
|
Теги текста
|
body_tags | string |
Пользовательские теги HTML или отслеживания, вставленные в текст страницы перенаправления. |
|
Открытие заголовка графа
|
og_title | string |
Заголовок, показанный при совместном использовании ссылки в социальных сетях. |
|
Note
|
note | string |
Частная заметка о ссылке. |
|
Name
|
name | string |
Псевдоним ссылки, показанный на панели мониторинга. |
|
Идентификатор ссылки
|
id | integer |
Идентификатор существующей ссылки для обновления. Оставьте пустым, чтобы создать новую ссылку. |
|
Идентификатор диспетчера тегов Google
|
gtm_id | string |
Идентификатор контейнера Диспетчера тегов Google для загрузки при щелчке ссылки. |
|
Открытие образа Graph
|
og_image | string |
URL-адрес изображения, показанный при совместном использовании ссылки в социальных сетях. |
|
Блокировать боты
|
block_bots | boolean |
Блокировать ли известные боты по ссылке. |
|
Идентификатор пикселя Snapchat
|
snapchat_pixel_id | string |
Идентификатор пикселя Snapchat для запуска при щелчке ссылки. |
|
Содержимое UTM
|
utm_content | string |
Параметр utm_content, добавленный к URL-адресу назначения. |
|
Enabled
|
enabled | boolean |
Является ли ссылка активной. |
|
URL-адрес назначения
|
url | uri |
URL-адрес назначения, на который перенаправляется короткая ссылка. Требуется создать новую ссылку. |
|
Удалено
|
deleted | boolean |
Указывает, находится ли ссылка в корзине. |
|
Webhooks
|
webhooks | array of string |
URL-адреса веб-перехватчика, подписанные на щелчки по этой ссылке. |
|
Срок действия щелчков
|
expiry_clicks | integer |
Количество щелчков, после которого ссылка перестает работать. |
|
Уведомление Slack
|
notify_slack | boolean |
Следует ли отправлять уведомление Slack при щелчке ссылки. |
|
Идентификатор рабочей области
|
workspace_id | integer |
Идентификатор рабочей области. |
|
Общедоступная аналитика
|
public_analytics | boolean |
Можно ли просматривать страницу аналитики для ссылки. |
|
Идентификатор тега Pinterest
|
pinterest_tag_id | string |
Идентификатор тега Pinterest для запуска при щелчке ссылки. |
|
Источник UTM
|
utm_source | string |
Параметр utm_source, добавленный к URL-адресу назначения. |
|
Поле динамических данных
|
slug | string |
Пользовательский путь для короткой ссылки. Он должен начинаться с косой черты. |
|
Домен
|
domain | string |
Личный домен, используемый для короткой ссылки, без косой черты. |
|
Параметры пересылки
|
forward_params | boolean |
Следует ли пересылать параметры запроса из короткой ссылки на место назначения. |
|
Средний UTM
|
utm_medium | string |
Параметр utm_medium, добавленный к URL-адресу назначения. |
|
Теги головы
|
head_tags | string |
Настраиваемые теги HTML или отслеживания, вставленные в голову страницы перенаправления. |
|
Идентификатор тега Google Analytics 4
|
ga4_tag_id | string |
Идентификатор измерения Google Analytics 4 для запуска при щелчке ссылки. |
|
Термин UTM
|
utm_term | string |
Параметр utm_term, добавленный к URL-адресу назначения. |
|
Кампания UTM
|
utm_campaign | string |
Параметр utm_campaign, добавленный к URL-адресу назначения. |
Список рабочих пространств
Возвращает рабочие области, доступные для этого подключения. Используйте его для поиска рабочей области, которую требуют другие действия.
Возвращаемое значение
| Имя. | Путь | Тип | Описание |
|---|---|---|---|
|
|
array of object | ||
|
Идентификатор рабочей области
|
id | integer |
Уникальный идентификатор рабочей области. |
|
Имя рабочей области
|
name | string |
Имя рабочей области. |
Список ссылок
Возвращает список ссылок в рабочей области с разбивкой на страницы с статистикой щелчков. Поддерживает поиск и сортировку.
Параметры
| Имя. | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Workspace
|
workspace_id | True | string |
Рабочая область для работы. Выберите его из списка или введите его идентификатор. |
|
Search
|
search | string |
Поисковый термин для фильтрации ссылок по имени, URL-адресу или slug. |
|
|
Страница
|
page | integer |
Номер страницы, возвращаемый начиная с 1. |
|
|
Размер страницы
|
page_size | integer |
Количество ссылок, возвращаемых на страницу. |
|
|
Сортировка по
|
sort_by | string |
Поле для сортировки по, например clicks_total, имени или inserted_at. |
|
|
Направление сортировки
|
sort_dir | string |
Направление сортировки либо asc, либо desc. |
|
|
Удалено
|
deleted | boolean |
Следует ли возвращать ссылки, которые находятся в корзине вместо активных ссылок. |
Возвращаемое значение
| Имя. | Путь | Тип | Описание |
|---|---|---|---|
|
Links
|
links | array of object |
Ссылки на этой странице. |
|
Идентификатор мета пикселя
|
links.fb_pixel_id | string |
Идентификатор пикселя мета (Facebook) для срабатывания при щелчке ссылки. |
|
Всего щелчков человека
|
links.human_clicks_total | integer |
Время существования щелчков без сигнала бота; подмножество clicks_total, где не обнаружен ни пользователь-агент бота, ни категория проверенного бота. Записано начиная с 2019 года. |
|
Щелчки (30 дней)
|
links.clicks_thirty_days | integer |
Щелкает за последние 30 дней, включая трафик бота. |
|
Идентификатор пикселя TikTok
|
links.tiktok_pixel_id | string |
Идентификатор пикселя TikTok для запуска при щелчке ссылки. |
|
Скрытие ссылок
|
links.hide_referrer | boolean |
Следует ли скрыть ссылку на целевом сайте. |
|
Маскировка
|
links.cloaking | boolean |
Следует ли скрыть место назначения, открыв его внутри кадра. |
|
Короткий URL-адрес
|
links.full_url | uri |
Полный URL-адрес короткой ссылки. |
|
Щелкает сегодня
|
links.clicks_today | integer |
Щелкает до сих пор (UTC), включая трафик бота. |
|
Открытие описания Графа
|
links.og_description | string |
Описание, показанное при совместном использовании ссылки в социальных сетях. |
|
Теги текста
|
links.body_tags | string |
Пользовательские теги HTML или отслеживания, вставленные в текст страницы перенаправления. |
|
Открытие заголовка графа
|
links.og_title | string |
Заголовок, показанный при совместном использовании ссылки в социальных сетях. |
|
Note
|
links.note | string |
Частная заметка о ссылке. |
|
Name
|
links.name | string |
Псевдоним ссылки, показанный на панели мониторинга. |
|
Идентификатор ссылки
|
links.id | integer |
Уникальный идентификатор ссылки. |
|
Идентификатор диспетчера тегов Google
|
links.gtm_id | string |
Идентификатор контейнера Диспетчера тегов Google для загрузки при щелчке ссылки. |
|
Открытие образа Graph
|
links.og_image | string |
URL-адрес изображения, показанный при совместном использовании ссылки в социальных сетях. |
|
Блокировать боты
|
links.block_bots | boolean |
Блокировать ли известные боты по ссылке. |
|
Всего щелчков
|
links.clicks_total | integer |
Время существования щелчков, включая трафик бота. |
|
Щелчки человека (30 дней)
|
links.human_clicks_thirty_days | integer |
Щелкает за последние 30 дней без сигнала бота; подмножество clicks_thirty_days. |
|
Содержимое UTM
|
links.utm_content | string |
Параметр utm_content, добавленный к URL-адресу назначения. |
|
Люди щелкают сегодня
|
links.human_clicks_today | integer |
Щелкает до сих пор (UTC) без сигнала бота. |
|
Enabled
|
links.enabled | boolean |
Является ли ссылка активной. |
|
URL-адрес назначения
|
links.url | uri |
URL-адрес назначения, на который перенаправляется короткая ссылка. |
|
Удалено
|
links.deleted | boolean |
Указывает, находится ли ссылка в корзине. |
|
Идентификатор рабочей области
|
links.workspace_id | integer |
Идентификатор рабочей области. |
|
Общедоступная аналитика
|
links.public_analytics | boolean |
Можно ли просматривать страницу аналитики для ссылки. |
|
Источник UTM
|
links.utm_source | string |
Параметр utm_source, добавленный к URL-адресу назначения. |
|
Поле динамических данных
|
links.slug | string |
Пользовательский путь для короткой ссылки. Он должен начинаться с косой черты. |
|
Домен
|
links.domain | string |
Личный домен, используемый для короткой ссылки, без косой черты. |
|
Параметры пересылки
|
links.forward_params | boolean |
Следует ли пересылать параметры запроса из короткой ссылки на место назначения. |
|
Средний UTM
|
links.utm_medium | string |
Параметр utm_medium, добавленный к URL-адресу назначения. |
|
Теги головы
|
links.head_tags | string |
Настраиваемые теги HTML или отслеживания, вставленные в голову страницы перенаправления. |
|
Идентификатор тега Google Analytics 4
|
links.ga4_tag_id | string |
Идентификатор измерения Google Analytics 4 для запуска при щелчке ссылки. |
|
Термин UTM
|
links.utm_term | string |
Параметр utm_term, добавленный к URL-адресу назначения. |
|
Кампания UTM
|
links.utm_campaign | string |
Параметр utm_campaign, добавленный к URL-адресу назначения. |
|
Человек щелкает вчера
|
links.human_clicks_previous_day | integer |
Щелкает вчера (UTC) без сигнала бота. |
|
Номер страницы
|
page_number | integer |
Текущий номер страницы. |
|
Размер страницы
|
page_size | integer |
Количество ссылок, возвращаемых на страницу. |
|
Всего записей
|
total_entries | integer |
Общее количество ссылок, соответствующих запросу. |
|
Всего страниц
|
total_pages | integer |
Общее количество доступных страниц. |
|
Всего строк
|
total_rows | integer |
Общее количество строк. |
|
Число ссылок рабочей области
|
workspace_link_count | integer |
Общее количество ссылок в рабочей области. |
Удаление ссылки
Перемещает ссылку на корзину. Его короткий URL-адрес останавливает перенаправление, и ссылка может быть восстановлена позже из корзины.
Параметры
| Имя. | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Workspace
|
workspace_id | True | string |
Рабочая область для работы. Выберите его из списка или введите его идентификатор. |
|
Идентификатор ссылки
|
id | True | integer |
Идентификатор ссылки. |
Возвращаемое значение
Сообщение подтверждения.
- response
- string
Определения
string
Это базовый тип данных string.