Back to top

Необходимые расширения и доработки по API можно обсудить на форуме Rankinity.

Адрес доступа к API - http://my.rankinity.com/api/v1

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

Основные функции 

Список проектов 

/projects.json{?token,shared,search,sort_property,sort_ascending}

Проект это базовая структура Rankinity которая содержит общие настройки проекта и список поисковых систем.

Получить список всех проектов пользователя. Пример:

http://my.rankinity.com/api/v1/projects.json?token=049d62336ad1dc050e78484733d57af2
  • Parameters
  • shared
    boolean (optional) Example: true

    Фильтр проектов пользователя. true - возвращает проекты к которым пользователь имеет доступ, но не является владельцем, false - возвращает проекты для которых пользователь является владельцем. В случае если данный параметер не указан, результат будет содержать все проекты доступные пользователю.

    search
    string (optional) Example: project 1

    Поиск по названию и ссылке проекта.

    sort_property
    string (optional) Example: name

    Название поля для сортировки.

    sort_ascending
    boolean (optional) Default: true Example: true

    Порядок сортировки: true - по возрастанию, false - по убыванию.

  • Response  200
  • Headers
    Content-Type: application/json
    Body
    {
      "projects": [
        {
          "id": "52f4a094f088429e26000013",
          "name": "My First Site",
          "link": "myfirstsite.com",
          "screenshot": "http://s3.amazonaws.com/rankinity/screenshots/52d0283fc9268eb0a4000008/medium.jpg?1396142993",
          "period": 86400,
          "created_at": 1391763604000,
          "owner_info": {
            "name": "John Doe",
            "email": "john_doe@rankinity.com"
          },
          "visibility_infos": [
            {
              "value": 32,
              "boost": -6,
              "search_engine_id": "52f4a095f088429e26000016",
              "search_engine_name": "google",
              "search_engine_title": "Russia"
            },
            {
              "value": 43,
              "boost": -5,
              "search_engine_id": "52f4a095f088429e2600001a",
              "search_engine_name": "yandex",
              "search_engine_title": "Russia"
            }
          ]
        }
      ]
    }

Список конкурентов 

/projects/{project_id}/competitors.json{?token,search,sort_property,sort_ascending}

Получить список всех конкурентов по проекту. Пример:

http://my.rankinity.com/api/v1/projects/52f4a094f088429e26000013/competitors.json?token=049d62336ad1dc050e78484733d57af2
  • Parameters
  • project_id
    string (required) Example: 52f4a094f088429e26000013

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

    search
    string (optional) Example: competitor 1

    Поиск по названию и ссылке конкурента.

    sort_property
    string (optional) Example: name

    Название поля для сортировки.

    sort_ascending
    boolean (optional) Default: true Example: true

    Порядок сортировки: true - по возрастанию, false - по убыванию.

  • Response  200
  • Headers
    Content-Type: application/json
    Body
    {
        "competitors": [
            {
                "id": "54104b026b170b2745000047",
                "name": "competitor-url.com",
                "link": "competitor-url.com",
                "screenshot": "http://s3.amazonaws.com/rankinity/screenshots/52d0283fc9268eb0a4000008/medium.jpg?1396142993"
                "created_at": 1410353922000
            },
            {
                "id": "54104b036b170b274500004e",
                "name": "competitor1-url.com",
                "link": "competitor1-url.com",
                "screenshot": "http://s3.amazonaws.com/rankinity/screenshots/52d0283fc9268eb0a4000008/medium.jpg?1396142994"
                "created_at": 1410353922000
            }
        ]
    }

Список ключевых слов 

/projects/{project_id}/keywords.json{?token,group,search,sort_property,sort_ascending}

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

Получить список ключевых слов проекта. Пример:

http://my.rankinity.com/api/v1/projects/52f4a094f088429e26000013/keywords.json?token=049d62336ad1dc050e78484733d57af2
  • Parameters
  • project_id
    string (required) Example: 52f4a094f088429e26000013

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

    group
    string (optional) Example: group 1

    Название группы ключевых слов.

    search
    string (optional) Example: keyword 1

    Поиск по ключевому слову.

    sort_property
    string (optional) Example: name

    Название поля для сортировки.

    sort_ascending
    boolean (optional) Default: true Example: true

    Порядок сортировки: true - по возрастанию, false - по убыванию.

  • Response  200
  • Headers
    Content-Type: application/json
    Body
    {
      "keywords": [
        {
          "name": "keyword 1",
          "group": "group 1",
          "weight": 1
        },
        {
          "name": "keyword 2",
          "group": "group 1",
          "weight": 1
        },
        {
          "name": "keyword 3",
          "group": "group 1",
          "weight": 1
        }
      ]
    }

Список групп ключевых слов 

/projects/{project_id}/groups.json{?token,search,sort_property,sort_ascending}

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

Получить список групп ключевых слов проекта. Пример:

http://my.rankinity.com/api/v1/projects/52f4a094f088429e26000013/keywords.json?token=049d62336ad1dc050e78484733d57af2
  • Parameters
  • project_id
    string (required) Example: 52f4a094f088429e26000013

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

    search
    string (optional) Example: group 1

    Поиск по названию группы.

    sort_property
    string (optional) Example: name

    Название поля для сортировки.

    sort_ascending
    boolean (optional) Default: true Example: true

    Порядок сортировки: true - по возрастанию, false - по убыванию.

  • Response  200
  • Headers
    Content-Type: application/json
    Body
    {
      "groups": [
        {
          "name": "group 1",
          "keywords_count": 2
        },
        {
          "name": "group 2",
          "keywords_count": 5
        }
      ]
    }

Список ранков 

/projects/{project_id}/search_engines/{search_engine_id}/ranks.json{?token,group,search,sort_property,sort_ascending,page}

Ранк содержит результат анализа выдачи поисковой системы по ключевому слову, а также историю позиций.

Получить список ранков проекта по поисковой системе. Пример:

http://my.rankinity.com/api/v1/projects/52f4a094f088429e26000013/search_engines/52f4a095f088429e26000016/ranks.json?token=049d62336ad1dc050e78484733d57af2
  • Parameters
  • project_id
    string (required) Example: 52f4a094f088429e26000013

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

    search_engine_id
    string (required) Example: 52f4a095f088429e26000016

    Идентификатор поисковой системы.

    group
    string (optional) Example: group 1

    Название группы ключевых слов.

    search
    string (optional) Example: project 1

    Поиск по ключевому слову.

    sort_property
    string (optional) Example: keyword

    Название поля для сортировки.

    sort_ascending
    boolean (optional) Default: true Example: true

    Порядок сортировки: true - по возрастанию, false - по убыванию.

    page
    integer (optional) Example: 1

    Номер страницы.

  • Response  200
  • Headers
    Content-Type: application/json
    Body
    {
      "ranks": [
        {
          "keyword": "keyword 1",
          "value": 85,
          "boost": 5,
          "page": "http://my.site.ru",
          "history": [
            [
              1390986004000,
              null
            ],
            [
              1391072404000,
              null
            ],
            [
              1391158804000,
              null
            ],
            [
              1391245204000,
              null
            ],
            [
              1391331604000,
              null
            ],
            [
              1391418004000,
              null
            ],
            [
              1391504404000,
              null
            ],
            [
              1391590804000,
              null
            ],
            [
              1391677204000,
              null
            ],
            [
              1391763604000,
              5
            ],
            [
              1391850004000,
              16
            ],
            [
              1391936404000,
              101
            ],
            [
              1392022804000,
              13
            ],
            [
              1392109204000,
              17
            ],
            [
              1392195604000,
              101
            ],
            [
              1392282004000,
              14
            ],
            [
              1392368404000,
              64
            ],
            [
              1392454804000,
              101
            ],
            [
              1392541204000,
              22
            ],
            [
              1392627604000,
              25
            ],
            [
              1392714004000,
              101
            ],
            [
              1392800404000,
              26
            ],
            [
              1392886804000,
              101
            ],
            [
              1392973204000,
              40
            ],
            [
              1393059604000,
              19
            ],
            [
              1393146004000,
              12
            ],
            [
              1393232404000,
              101
            ],
            [
              1393318804000,
              101
            ],
            [
              1393405204000,
              90
            ],
            [
              1393491604000,
              85
            ]
          ],
          "best": 5,
          "best_date": 1391763604000,
          "lowest": 101,
          "lowest_date": 1391936404000,
          "pages_count": 1,
          "pages_boost": 0,
          "updated_at": 1393492684000
        }
      ]
    }

Generated by aglio on 09 Dec 2015