Skip to content
This repository has been archived by the owner on Jun 10, 2020. It is now read-only.
/ ComagicAPI Public archive

Простой класс для работы с API сервиса Comagic на языке Python

Notifications You must be signed in to change notification settings

hexeh/ComagicAPI

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 

Repository files navigation

ComagicAPI

Простой класс для работы с API сервиса Comagic на языке Python


Документация по API Comagic


Использование

Авторизация

Авторизация запросов к API Comagic происходит при помощи ключа сессии, получаемого в обмен на логин/пароль пользователя системы. Для каждой инициализации класса создаётся новая сессия. После завершения работы с API необходимо вызывать метод endSession, который завершает сессию в соответствии с документацией

Список методов

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

  • getClientsОписание

  • getSites. Описание

  • getTags. Описание

  • getSummaryStats. Описание

    Входные параметры:

    siteId - идентификатор сайта,

    dateFrom - стартовая дата подсчёта статистики,

    dateTo - последняя дата подсчёта статистики,

    acId - идентификатор кампании (необязательный),

    customerId - идентификатор пользователя (необязательный),

    byDate - получить суммарную статистику за период или в разбивке по дням (необязательный, по умолчанию - получение суммарной статистики).

  • getCommunicationStats. Описание

    Входные параметры:

    siteId - идентификатор сайта,

    dateFrom - стартовая дата подсчёта статистики,

    dateTo - последняя дата подсчёта статистики,

    acId - идентификатор кампании (необязательный),

    customerId - идентификатор пользователя (необязательный),

    showNotGoal - возвращать все обращения или только не "нецелевые" (необязательный),

    onlyFirst - возвращать все обращения или только первичные.

  • getGoalStats. Описание

    Входные параметры:

    siteId - идентификатор сайта,

    dateFrom - стартовая дата подсчёта статистики,

    dateTo - последняя дата подсчёта статистики,

    acId - идентификатор кампании (необязательный),

    customerId - идентификатор пользователя (необязательный),

    goalId - идентификатор цели (необязательный),

    visitorId - идентификатор посетителя (необязательный),

    tagId - идентификатор тега (необязательный).

  • getCallStats. Описание

    Входные параметры:

    siteId - идентификатор сайта,

    dateFrom - стартовая дата подсчёта статистики,

    dateTo - последняя дата подсчёта статистики,

    acId - идентификатор кампании (необязательный),

    customerId - идентификатор пользователя (необязательный),

    callId - идентификатор звонка (необязательный),

    visitorId - идентификатор посетителя (необязательный),

    tagId - идентификатор тега (необязательный),

    callId - идентификатор звонка (необязательный),

    direction - направление звонка (необязательный),

    numa - номер звонившего (необязательный),

    numb - номер принимавшего (необязательный),

    returnRecordUrls - возвращать ли дополнительный справочник с Id звонка и ссылкой на его запись (необязательный).

  • endSession. Описание

Зависимости

  • Python3+
  • Модули:
    • urllib
    • json
    • requests

About

Простой класс для работы с API сервиса Comagic на языке Python

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages