API методы для получения списка сущностей

Общий endpoint https://api.primegate.io/v2/

Общие GET параметры: 

site_id - id сайта

key - берется здесь https://cloud.primegate.io/projects/settings/base

Пример запроса: https://api.primegate.io/v2/lead/get?site_id=Ваш id проекта&key=Ваш API ключ проект

‍

Лиды(POST): lead/get

Параметры:

limit - количество записей на странице(максимум 500)

offset - смещение

select - список выводимых свойств, передаются через запятую или пробел (доступны: 'id', 'site_id', 'out_id', 'contact_id', 'session_id', 'visitor_id', 'channel', 'lead_name', 'phone', 'email', 'skype', 'facebook', 'site', 'city', 'note', 'source_type', 'source', 'traffic_channel', 'ad_campaign', 'ad_content', 'keyword', 'pageUrl', 'start_page_url', 'create_at', 'update_at')

query - запрос, пример (query[channel]=1 - будут выведены все звонки) если не передавать параметр select то будут выведены все доступные поля для фильтра, для фильтра, если необходимо фильтровать по прямому совпадению значения то запрос будет таким query[channel]=1, если нужны лиды после определенного периода то query[create_at][0]=>&query[create_at][1]={timestamp}

Пример вывода:

{

  "success": true,

  "data": {

    "count": 12502,

    "rows": [

      {

        "id": 6,

        "site_id": 48,

        "out_id": null,

        "contact_id": null,

        "session_id": null,

        "visitor_id": null,

        "channel": 0,

        "lead_name": "денис",

        "phone": "423423424",

        "email": "t@fdsfdsf.ru",

        "skype": "fdsfsdf",

        "facebook": null,

        "site": "http://fdsfdsf.ru/",

        "city": "Питер",

        "note": null,

        "source_type": 9,

        "source": null,

        "traffic_channel": null,

        "ad_campaign": null,

        "ad_content": null,

        "keyword": null,

        "pageUrl": null,

        "start_page_url": null,

        "create_at": 1482154754,

        "update_at": 1482154754

      }

    ]

  }

}

Контакты(POST): contact/get

Параметры:

limit - количество записей на странице(максимум 500)

offset - смещение

select - список выводимых свойств, передаются через запятую или пробел (доступны: 'id', 'site_id', 'out_id', 'session_id', 'visitor_id', 'channel', 'phone', 'email', 'city', 'source_type', 'source', 'traffic_channel', 'ad_campaign', 'ad_content', 'keyword', 'pageUrl', 'start_page_url', 'created_at', 'updated_at'

)

query - запрос, описание как использовать в разделе лидов

Пример вывода:

{

  "success": true,

  "data": {

    "count": 8141,

    "rows": [

      {

        "id": 485746,

        "site_id": 48,

        "out_id": null,

        "session_id": 574705302,

        "visitor_id": 794416962,

        "channel": 7,

        "phone": "5345435345345",

        "email": null,

        "city": "St Petersburg",

        "source_type": 2,

        "source": "yandex",

        "traffic_channel": "organic",

        "ad_campaign": "(not set)",

        "ad_content": "(not set)",

        "keyword": "(not set)",

        "pageUrl": "https://www.primegate.io/",

        "start_page_url": "https://www.primegate.io/",

        "created_at": 1594279569,

        "updated_at": 1594279957

      }

    ]

  }

}

Сделки(POST): deal/get

Параметры:

limit - количество записей на странице(максимум 500)

offset - смещение

select - список выводимых свойств, передаются через запятую или пробел (доступны: 'id','site_id','out_id','lead_id','pipeline_id','stage_id','description','budget','create_at','update_at')

query - запрос, описание как использовать в разделе лидов

Пример вывода:

{

  "success": true,

  "data": {

    "count": 683,

    "rows": [

      {

        "id": 115561,

        "site_id": 48,

        "out_id": null,

        "lead_id": 492893,

        "pipeline_id": 10277,

        "stage_id": 85933,

        "description": "Новый контакт",

        "budget": "3500",

        "create_at": 1594192032,

        "update_at": 1594278360

      }

    ]

  }

}