User intergrations

Connect User to Review Management Tool.

If any erros occur you can access the errors guide.

Parameters
  • idpath integerRequired

    Connect specific User to Review Management Tool with provided User id.

POST/api/v1/users/{id}/integrations/partoo

  {
    const res = await fetch(`${BASE_URL}/api/v1/users/${id}/integrations/partoo`, {
      method: 'POST',
      headers: {
        'Content-Type': 'application/json'
      }});
    const data = await res.json();
  }

RESPONSE

{
  "data": {
      "id": "aa8d3e35-6907-4566-8d7b-977564028b94",
      "type": "partoo_integrations",
      "attributes": {
          "partoo_key": "63be7fd2371cc984f203e466"
      }
  }
}

Disconnect User

Disconnect the User from Review Management Tool.

Parameters
  • idpath integerRequired

    Disconnect specific User from Review Management Tool with provided User id.

DELETE/api/v1/users/{id}/integrations/partoo

{
  const res = await fetch(`${BASE_URL}/api/v1/users/${id}/integrations/partoo`, {
    method: 'DELETE',
    headers: {
      'Content-Type': 'application/json'
    }});

  const data = await res.json();
}

RESPONSE

{
  "data": {
      "id": "aa8d3e35-6907-4566-8d7b-977564028b94",
      "type": "partoo_integrations",
      "attributes": {
          "partoo_key": null
      }
  }
}

Business reviews

Search for the reviews of your businesses on Review Management Tool.

Parameters
  • partoo_business_idsString[]Required

    Reviews for given business ids. You can provide multiple business id's.

  • pagequery integer

    Default: 1, page number.

  • per_pagequery integer

    Default: 30, number of items to return per page. Currently limited to 100.

  • includequery string

    Include associations (delimited with comma). Available associations: addresses, groups, menus, open_periods, order_periods, orders, partners, pictures, products, reviews

    Example: orders,pictures

  • languagequery string

    Return results of Business by language ISO 639‑1 code.

GET/api/v1/users/integrations/partoo/reviews

  {
    const res = await fetch(`${BASE_URL}/api/v1/users/integrations/partoo/reviews`, {
      method: 'GET',
      headers: {
        'Content-Type': 'application/json'
      }});
    const data = await res.json();
  }

RESPONSE

{
  "data": [
    {
      "date": "2021-09-06",
      "business_id": "636120f0588c2e6ef800d072",
      "queries_direct": 0,
      "queries_indirect": 0,
      "views_maps": 0,
      "views_search": 0,
      "actions_website": 0,
      "actions_phone": 0,
      "actions_driving_directions": 0,
      "bucket": "week"
    }
  ]
}