{"info":{"_postman_id":"ff2cdced-2c35-4b2d-ab68-f890977c793e","name":"Localyser API Documentation","description":"

The Localyser API is designed for clients and partners to leverage the different functionality of our Online Reputation Management tool.

\n

For Clients, you can pull all of your review data into your own CRM system or BI tool.

\n

For Partners, you can deliver different review management functionality into your own dashboard.

\n

Authentication: you will be provided with an API Key when an account is created for you.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"3481387","collectionId":"ff2cdced-2c35-4b2d-ab68-f890977c793e","publishedId":"SzzoavV2","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2020-06-26T10:04:45.000Z"},"item":[{"name":"Company","item":[{"name":"POST company","id":"fad49d01-2a6c-422e-abe7-6fd85c087bb5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"api_key_value","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"companyName\": \"Your company name\",\r\n \"companyType\": \"Your company type\",\r\n \"status\": \"Active\",\r\n \"package\": \"Standard\",\r\n \"locationsLimit\": 50,\r\n \"address1\": \"Your company adress\",\r\n \"address2\": \"Your company additional adress\",\r\n \"city\": \"Your company home city\",\r\n \"state\": \"Your company state\",\r\n \"country\": \"Your company country\",\r\n \"zip\": 555555\r\n}","options":{"raw":{"language":"json"}}},"url":"/v3/api/company","description":"

Post new company URL

\n

Fields:

\n\n","urlObject":{"path":["v3","api","company"],"query":[],"variable":[]}},"response":[{"id":"5be6436c-0c31-4469-a6cb-5204f1b83135","name":"400 Error","originalRequest":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"api_key_value"}],"body":{"mode":"raw","raw":"{\r\n \"companyType\" : \"Your company type\",\r\n \"status\": \"Active\",\r\n \"package\": \"Standard\",\r\n \"locationsLimit\": 50,\r\n \"address1\" : \"Your company adress\",\r\n \"address2\" : \"Your company additional adress\",\r\n \"city\" : \"Your company home city\",\r\n \"state\" : \"Your company state\",\r\n \"country\" : \"Your company country\",\r\n \"zip\": 555555\r\n}","options":{"raw":{"language":"json"}}},"url":"/v3/api/company"},"code":400,"_postman_previewlanguage":"Text","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"details\": \"Company name parameter missing\"\r\n}"},{"id":"7557a4b9-7d48-4aea-bb14-8e3511e38e43","name":"200 OK","originalRequest":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"api_key_value"},{"key":"Content-Type","value":"application/json","type":"text","disabled":true}],"body":{"mode":"raw","raw":"{\r\n \"companyName\" : \"Your company name\",\r\n \"companyType\" : \"Cafe\",\r\n \"address1\" : \"Your company adress\",\r\n \"address2\" : \"Your company additional adress\",\r\n \"city\" : \"Your company home city\",\r\n \"state\" : \"Your company state\",\r\n \"country\" : \"Your company country\",\r\n \"zip\": 555555\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.localyser.com/v2/api/company"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"id\": 1,\r\n \"companyName\": \"Your company name\",\r\n \"status\": \"Active\",\r\n \"package\": \"Standard\",\r\n \"locationsLimit\":50,\r\n \"sources\": [\"Facebook\", \"Google\", \"TripAdvisor\", \"Zomato\"],\r\n \"companyType\": \"Cafe\"\r\n}"}],"_postman_id":"fad49d01-2a6c-422e-abe7-6fd85c087bb5"},{"name":"PATCH company","id":"8b71b2d9-8abf-4d00-b863-f3f2ea374020","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Authorization","type":"text","value":"api_key_value"}],"body":{"mode":"raw","raw":"{\r\n \"id\": 1,\r\n \"companyName\" : \"Your company name\",\r\n \"companyType\" : \"Your company type\",\r\n \"sources\": [\"Facebook\", \"Google\", \"TripAdvisor\", \"Zomato\"],\r\n \"status\": \"Active\",\r\n \"package\": \"Standard\",\r\n \"locationsLimit\": 60,\r\n \"address1\" : \"Your company adress\",\r\n \"address2\" : \"Your company additional adress\",\r\n \"city\" : \"Your company home city\",\r\n \"state\" : \"Your company state\",\r\n \"country\" : \"Your company country\",\r\n \"zip\": 555555,\r\n \"isArchived\": false\r\n}","options":{"raw":{"language":"json"}}},"url":"/v3/api/company","description":"

Patch company URL

\n

Fields:

\n\n","urlObject":{"path":["v3","api","company"],"query":[],"variable":[]}},"response":[{"id":"21658f84-8eb9-4a40-8719-074361d9c50f","name":"400 Error","originalRequest":{"method":"PATCH","header":[{"key":"Authorization","type":"text","value":"api_key_value"}],"body":{"mode":"raw","raw":"{\r\n \"id\": 1,\r\n \"zip\": \"test\"\r\n}","options":{"raw":{"language":"json"}}},"url":"/v3/api/company"},"_postman_previewlanguage":"Text","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"details\": \"Zip code is not an integer\"\r\n}"},{"id":"7ea2e277-7714-4093-b051-aabe277d1b1d","name":"200 OK","originalRequest":{"method":"PATCH","header":[{"key":"Authorization","type":"text","value":"api_key_value"}],"body":{"mode":"raw","raw":"{\r\n \"companyName\" : \"Your company name\",\r\n \"companyType\" : \"Your company type\",\r\n \"address1\" : \"Your company adress\",\r\n \"address2\" : \"Your company additional adress\",\r\n \"city\" : \"Your company home city\",\r\n \"state\" : \"Your company state\",\r\n \"country\" : \"Your company country\",\r\n \"zip\": 555555\r\n}","options":{"raw":{"language":"json"}}},"url":"/v3/api/company"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"id\": 1,\r\n \"companyName\": \"Your company name\",\r\n \"companyType\": \"Cafe\",\r\n \"status\": \"Active\",\r\n \"package\": \"Standart\",\r\n \"locationsLimit\": 60,\r\n \"sources\": [\"Facebook\", \"Google\", \"TripAdvisor\", \"Zomato\"]\r\n}"}],"_postman_id":"8b71b2d9-8abf-4d00-b863-f3f2ea374020"},{"name":"DELETE company","id":"7155de62-18b0-4375-93e4-453309918511","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Authorization","value":"api_key_value","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"id\" : 1\r\n}","options":{"raw":{"language":"json"}}},"url":"/v3/api/company","description":"

Delete company URL

\n

Fields:

\n\n

Id parameter can be added either to request body or request url.

\n","urlObject":{"path":["v3","api","company"],"query":[],"variable":[]}},"response":[{"id":"14d9ee11-6564-450b-8a36-72082c70e555","name":"200 OK","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"api_key_value","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"id\" : 1\r\n}","options":{"raw":{"language":"json"}}},"url":"/v3/api/company"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"id\": 1,\r\n \"companyName\": \"Your company name\",\r\n \"companyType\": \"Cafe\"\r\n}"},{"id":"cf0a6bf1-f068-4337-92e2-e8a1037252bb","name":"400 Error","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"api_key_value","type":"text"}],"body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}},"url":"/v3/api/company"},"_postman_previewlanguage":"Text","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"details\": \"Id parameter missing\"\r\n}"}],"_postman_id":"7155de62-18b0-4375-93e4-453309918511"},{"name":"GET companies","id":"ef14ae06-3f39-4145-915d-70a99bdf10f7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"api_key_value","type":"text"}],"url":"/v3/api/company","description":"

GET all companies URL

\n

Params:

\n\n","urlObject":{"path":["v3","api","company"],"query":[{"disabled":true,"key":"search","value":"Company name we are looking for"}],"variable":[]}},"response":[{"id":"48216953-49d8-46c5-8825-12319c5bb3e5","name":"400 Error","originalRequest":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"api_key_value"}],"url":{"raw":"/v3/api/company","path":["v3","api","company"],"query":[{"key":"search","value":"Company name we are looking for","type":"text","disabled":true}]}},"code":400,"_postman_previewlanguage":"Text","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"details\": \"Some data base error\"\r\n}"},{"id":"a50a3cdf-f0b7-4076-b0ca-0da105641e17","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"api_key_value","type":"text"}],"url":{"raw":"/v3/api/company","path":["v3","api","company"],"query":[{"key":"API_KEY","value":"api_key_value","disabled":true}]}},"_postman_previewlanguage":"Text","header":null,"cookie":[],"responseTime":null,"body":"[\r\n {\r\n \"createdAt\": 1704067200000,\r\n \"updatedAt\": 1704153600000,\r\n \"id\": 150,\r\n \"companyName\": \"Gourmet Delights Restaurant Group\",\r\n \"email\": \"admin@gourmetdelights.com\",\r\n \"notificationTime\": \"18:00\",\r\n \"accessToken\": \"a1b2c3d4e5f67890\",\r\n \"status\": \"Active\",\r\n \"period\": \"2025-02-15\",\r\n \"companyType\": \"Restaurants\",\r\n \"address1\": \"123 Business Bay Tower\",\r\n \"address2\": \"Suite 450\",\r\n \"city\": \"Dubai\",\r\n \"state\": \"Dubai\",\r\n \"country\": \"United Arab Emirates\",\r\n \"timeZone\": \"Asia/Dubai\",\r\n \"zip\": \"12345\",\r\n \"sourcesCount\": 9,\r\n \"sources\": [\r\n \"Google\",\r\n \"Facebook\",\r\n \"Foursquare\",\r\n \"Zomato\",\r\n \"TripAdvisor\",\r\n \"Talabat\",\r\n \"HungerStation\",\r\n \"ReserveOut\",\r\n \"Deliveroo\"\r\n ],\r\n \"competitorsSources\": [\r\n \"Google\",\r\n \"Facebook\",\r\n \"TripAdvisor\"\r\n ],\r\n \"isArchived\": false,\r\n \"parsingFromDate\": 1704067200000,\r\n \"locationsLimit\": 50,\r\n \"packageChangeDate\": \"2025-01-01\",\r\n \"isParsingEnabled\": true,\r\n \"package\": \"Premium\",\r\n \"settings\": {\r\n \"hasLocation\": true,\r\n \"defaultLanguage\": \"en\",\r\n \"responseLanguages\": [\"en\", \"ar\"]\r\n },\r\n \"isOAuthChecking\": null,\r\n \"isGBPChecking\": null,\r\n \"partner\": 5,\r\n \"brands\": [\r\n {\r\n \"id\": 301,\r\n \"title\": \"Gourmet Kitchen\",\r\n \"isDefault\": false,\r\n \"photoUrl\": \"https://cdn.localyser.com/brands/gourmet-kitchen.png\",\r\n \"locationsCount\": 12,\r\n \"states\": [\r\n {\r\n \"id\": 501,\r\n \"title\": \"Dubai\",\r\n \"isDefault\": false\r\n },\r\n {\r\n \"id\": 502,\r\n \"title\": \"Abu Dhabi\",\r\n \"isDefault\": false\r\n },\r\n {\r\n \"id\": 503,\r\n \"title\": \"Sharjah\",\r\n \"isDefault\": false\r\n }\r\n ]\r\n },\r\n {\r\n \"id\": 302,\r\n \"title\": \"Urban Bites\",\r\n \"isDefault\": false,\r\n \"photoUrl\": \"https://cdn.localyser.com/brands/urban-bites.png\",\r\n \"locationsCount\": 8,\r\n \"states\": [\r\n {\r\n \"id\": 504,\r\n \"title\": \"Dubai Marina\",\r\n \"isDefault\": false\r\n },\r\n {\r\n \"id\": 505,\r\n \"title\": \"JBR\",\r\n \"isDefault\": false\r\n }\r\n ]\r\n },\r\n {\r\n \"id\": 303,\r\n \"title\": \"Other\",\r\n \"isDefault\": true,\r\n \"photoUrl\": null,\r\n \"locationsCount\": 2,\r\n \"states\": [\r\n {\r\n \"id\": 506,\r\n \"title\": \"Other\",\r\n \"isDefault\": true\r\n }\r\n ]\r\n }\r\n ]\r\n }\r\n]"}],"_postman_id":"ef14ae06-3f39-4145-915d-70a99bdf10f7"},{"name":"request to Localyser owner create company and admin user","id":"122aad20-4349-4d86-bee9-7e71df4a27ab","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"api_key_value"}],"body":{"mode":"raw","raw":"{\r\n \"companyName\": \"Your company name\",\r\n \"package\": \"Standard\",\r\n \"firstName\": \"Test\",\r\n \"lastName\": \"Test\",\r\n \"locationsLimit\": 50,\r\n \"email\": \"testuser@gmail.com\",\r\n \"mobile\": \"8065645465\"\r\n}","options":{"raw":{"language":"json"}}},"url":"/v3/api/company/byOwner","description":"

Post the request to the Localyser owner to create a new company and admin user

\n

Fields:

\n\n

The system validates the company user email, check the value uniqueness.

\n","urlObject":{"path":["v3","api","company","byOwner"],"query":[],"variable":[]}},"response":[{"id":"0620aca5-2eeb-4b59-99ea-a2c9d7fcc8ad","name":"200 OK","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"api_key_value","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"companyName\": \"Your company name\",\r\n \"package\": \"Standard\",\r\n \"firstName\": \"Test\",\r\n \"lastName\": \"Test\",\r\n \"locationsLimit\": 50,\r\n \"email\": \"testuser@gmail.com\",\r\n \"mobile\": \"8065645465\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"/v3/api/company/byOwner","path":["v3","api","company","byOwner"],"query":[{"key":"API_KEY","value":"api_key_value","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"id\": 169,\r\n \"companyName\": \"Test company#155\",\r\n \"package\": \"Standard\"\r\n}\r\n"},{"id":"e72f347a-bf33-4c9b-bd84-dba8809dbdfb","name":"400 Error","originalRequest":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"api_key_value"}],"body":{"mode":"raw","raw":"{\r\n \"package\": \"Standard\",\r\n \"firstName\": \"Test\",\r\n \"lastName\": \"Test\",\r\n \"locationsLimit\": 50,\r\n \"email\": \"testuser@gmail.com\",\r\n \"mobile\": \"8065645465\"\r\n}","options":{"raw":{"language":"json"}}},"url":"/v3/api/company/byOwner"},"code":400,"_postman_previewlanguage":"Text","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"details\": \"Company name parameter missing\"\r\n}"}],"_postman_id":"122aad20-4349-4d86-bee9-7e71df4a27ab"},{"name":"GET company by id","id":"b0975417-f980-4ef2-856a-850ef989418d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"api_key_value","type":"text"}],"url":"/v3/api/company/:id","urlObject":{"path":["v3","api","company",":id"],"query":[],"variable":[{"type":"any","value":"","key":"id"}]}},"response":[{"id":"4e6c3a11-1f7c-4c2b-8534-5a34051d7623","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"api_key_value","type":"text"}],"url":{"raw":"/v3/api/company/:id","path":["v3","api","company",":id"],"variable":[{"key":"id","value":""}]}},"code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":" {\r\n \"id\": 1,\r\n \"companyName\": \"Your company name\",\r\n \"accessToken\": \"\",\r\n \"status\": \"Active\",\r\n \"companyType\": \"Cafe\",\r\n \"address1\": \"\",\r\n \"address2\": \"\",\r\n \"city\": \"\",\r\n \"state\": \"\",\r\n \"country\": \"\",\r\n \"timeZone\": \"UTC\",\r\n \"zip\": null, \r\n \"sources\": [\"Google\"],\r\n \"competitorsSources\": [\"Google\"],\r\n \"isArchived\": false,\r\n \"package\": \"Standard\",\r\n \"locationsLimit\": 50,\r\n \"locationsInUse\": 10,\r\n \"createdAt\": 1592998609548,\r\n \"updatedAt\": 1592998609548,\r\n \"users\": [\r\n {\r\n \"id\":1,\r\n \"firstName\":\"User first name\",\r\n \"lastName\":\"User last name\",\r\n \"email\": \"useremail@gmail.com\",\r\n \"mobile\": 654654654,\r\n \"role\": \"Master Admin\"\r\n\r\n }\r\n ],\r\n \"brands\": [\r\n {\r\n \"id\": 1,\r\n \"title\": \"Brand Title\",\r\n \"isDefault\": true,\r\n \"photoUrl\": \"\",\r\n \"locationsCount\": 1,\r\n \"states\": [\r\n {\r\n \"id\": 40514,\r\n \"title\": \"State Title\",\r\n \"isDefault\": true\r\n }\r\n ]\r\n }\r\n ]\r\n } "},{"id":"a9745c3c-9049-421a-9067-5ddff0f35365","name":"400 Error","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"api_key_value","type":"text"}],"url":{"raw":"/v3/api/company/:id","path":["v3","api","company",":id"],"variable":[{"key":"id","value":"10000"}]}},"_postman_previewlanguage":"Text","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"details\": \"There is no company with such id = 10000 or you have no access\"\r\n}\r\n"}],"_postman_id":"b0975417-f980-4ef2-856a-850ef989418d"},{"name":"POST check email uniqueness","id":"483dbe55-f348-4b32-bbd0-0552bd9a6421","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"api_key_value","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"email\" : \"test_email@gmail.com\"\r\n}"},"url":"/v3/api/email/check","description":"

Post request to check email uniqueness

\n

Fields:

\n
    \n
  • email field is required, type 'string';
    • \n
\n

The response can have two values: \"You can use this email\" or \"Email already in use\"

\n","urlObject":{"path":["v3","api","email","check"],"query":[],"variable":[]}},"response":[{"id":"7c22b082-4f4b-47d2-a4b9-a45a012d6fad","name":"202 OK","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"api_key_value","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"email\" : \"test_email@gmail.com\"\r\n}"},"url":"/v3/api/email/check"},"code":202,"_postman_previewlanguage":"Text","header":null,"cookie":[],"responseTime":null,"body":"{\r\n message: \"Email already in use\"\r\n}"},{"id":"deed63c5-531f-46f7-a98c-f831efb387a0","name":"400 Error","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"api_key_value","type":"text"}],"body":{"mode":"raw","raw":"{}"},"url":"/v3/api/email/check"},"code":400,"_postman_previewlanguage":"Text","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"details\": \"Email parameter missing\"\r\n}"},{"id":"e1e5af2a-3a16-486e-8efa-067a843327b0","name":"200 OK","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"api_key_value","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"email\" : \"test_email@gmail.com\"\r\n}","options":{"raw":{"language":"json"}}},"url":"/v3/api/email/check"},"code":200,"_postman_previewlanguage":"Text","header":null,"cookie":[],"responseTime":null,"body":"{\r\n message: \"You can use this email\"\r\n}"}],"_postman_id":"483dbe55-f348-4b32-bbd0-0552bd9a6421"}],"id":"bc76b54b-0c72-40fa-9135-4fdd72a13f9c","description":"

For Partners Only: A Company is required for each client which is organized by Brand and region (suitable for multi-location clients). You can add, patch, delete or get Company accounts.

\n","_postman_id":"bc76b54b-0c72-40fa-9135-4fdd72a13f9c"},{"name":"Reviews","item":[{"name":"GET reviews","id":"75a40b49-bd83-471a-ab0a-a8570369604f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"api_key_value"}],"url":"/v3/api/reviews","description":"

GET all reviews info URL

\n

Params:

\n
    \n
  • page parameter is optional, by default page = 1;
    • \n
  • services parameter is optional, comma separated services names;
    • \n
  • locations parameter is optional, comma separated locations ids;
    • \n
  • states parameter is optional, comma separated states ids;
    • \n
  • date_from parameter is optional, format yyyy-mm-dd;
    • \n
  • date_to parameter is optional, format yyyy-mm-dd;
    • \n
  • rating parameter is optional, comma separated review rating from 1 to 5;
    • \n
  • direction parameter is optional, sort direction 'asc' 'desc';
    • \n
  • order parameter is optional, sort by \"date\", \"sentiment\", \"length\";
    • \n
\n

Request return 20 reviews per page, by default review ordered by date from new to old.

\n

If you set the page parameter to value that not exist, system return empty array.

\n","urlObject":{"path":["v3","api","reviews"],"query":[{"disabled":true,"key":"page","value":"1"},{"disabled":true,"key":"services","value":"google,facebook"},{"disabled":true,"key":"locations","value":"1,2"},{"disabled":true,"key":"states","value":"1,2"},{"disabled":true,"key":"date_from","value":"2020-03-01"},{"disabled":true,"key":"date_to","value":"2020-06-20"},{"disabled":true,"key":"rating","value":"4"},{"disabled":true,"key":"direction","value":"desc"},{"disabled":true,"key":"order","value":"date"}],"variable":[]}},"response":[{"id":"8c1c6971-2bab-4b5a-8c11-d81e4d4f06be","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"api_key_value","type":"text"}],"url":{"raw":"/v3/api/reviews?page=1","path":["v3","api","reviews"],"query":[{"key":"page","value":"1"}]}},"code":200,"_postman_previewlanguage":"Text","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"page\": 1,\r\n \"per_page\": 20,\r\n \"total_pages\": 1,\r\n \"reviews\": [\r\n { \"id\": 1,\r\n \"serviceName\": \"google\",\r\n \"name\": \"Reviewer name\",\r\n \"date\": \"Reviewe date\",\r\n \"ratingValue\": \"Review rating value\",\r\n \"reviewText\": \"Review text\",\r\n \"url\": \"Review url\",\r\n \"location\": 2000\r\n }\r\n ]\r\n}"},{"id":"ba159f73-790d-4f1a-975a-05c86a1a88b6","name":"400 Error","originalRequest":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"api_key_value"}],"url":{"raw":"/v3/api/reviews","path":["v3","api","reviews"],"query":[{"key":"page","value":"1","disabled":true},{"key":"services","value":"google,facebook","disabled":true},{"key":"locations","value":"1,2","disabled":true},{"key":"states","value":"1,2","disabled":true},{"key":"date_from","value":"2020-03-01","disabled":true},{"key":"date_to","value":"2020-06-20","disabled":true},{"key":"rating","value":"4","disabled":true},{"key":"direction","value":"desc","disabled":true},{"key":"order","value":"date","disabled":true}]}},"_postman_previewlanguage":"Text","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"details\": \"Some data base error\"\r\n}"}],"_postman_id":"75a40b49-bd83-471a-ab0a-a8570369604f"},{"name":"GET info","id":"8e9a37c1-8b35-4253-b412-1555a890b23a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"api_key_value","type":"text"}],"url":"/v3/api/locations/reviews","description":"

GET all locations average star rating and number of reviews info URL

\n

Params:

\n
    \n
  • page parameter is optional, by default page = 1;
    • \n
\n

Request return 20 reviews per page.

\n

If you set the page parameter to value that not exist, system return empty array.

\n","urlObject":{"path":["v3","api","locations","reviews"],"query":[{"disabled":true,"key":"page","value":"1"}],"variable":[]}},"response":[{"id":"9c0aef2f-0436-49f5-bece-f188e6647ad4","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"api_key_value"}],"url":{"raw":"/v3/api/locations/reviews?page=1","path":["v3","api","locations","reviews"],"query":[{"key":"page","value":"1"}]}},"_postman_previewlanguage":"Text","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"page\": 1,\r\n \"per_page\": 20,\r\n \"total_pages\": 1,\r\n \"locations\": \r\n [\r\n {\r\n \"id\": 1,\r\n \"title\": \"Your location title\",\r\n \"locationId\": \"Your location id\",\r\n \"google\": {\r\n \"avarageRating\": 4.5,\r\n \"amount\": 152\r\n },\r\n \"facebook\": {\r\n \"avarageRating\": 4.8,\r\n \"amount\": 252\r\n }\r\n \r\n }\r\n ]\r\n}"},{"id":"9f0f1f10-64a3-4684-a669-a1062ca721de","name":"400 Error","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"api_key_value","type":"text"}],"url":{"raw":"/v3/api/locations/reviews","path":["v3","api","locations","reviews"],"query":[{"key":"page","value":"1","disabled":true}]}},"_postman_previewlanguage":"Text","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"details\": \"Some data base error\"\r\n}"}],"_postman_id":"8e9a37c1-8b35-4253-b412-1555a890b23a"}],"id":"78a09fba-df27-4111-a92e-efebaf46aecf","description":"

For Clients & Partners: Get all review data including review date, source, rating, text and reviewer name.

\n

For Partners Only: Get the average rating per platform and the number of reviews updated weekly.

\n","_postman_id":"78a09fba-df27-4111-a92e-efebaf46aecf"},{"name":"Location","item":[{"name":"POST location","id":"f9f05a9f-8f92-4562-a7f2-41ea660ccb48","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"api_key_value"}],"body":{"mode":"raw","raw":"{\r\n \"title\": \"Your location title\",\r\n \"locationId\": \"Your location id\",\r\n \"state\": 1,\r\n \"locationAddress\": \"Your location adress\",\r\n \"phoneNumber\": \"Your location phone number\",\r\n \"websiteAddress\": \"Your location web site\",\r\n \"sources\": [\r\n {\r\n \"title\": \"Google\",\r\n \"url\": \"https://www.google.com/....\"\r\n },\r\n {\r\n \"title\": \"Zomato\",\r\n \"url\": \"https://www.zomato.com/....\"\r\n },\r\n {\r\n \"title\": \"Agoda\",\r\n \"url\": \"https://www.agoda.com/....\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"/v3/api/location","description":"

Post new location URL

\n

Fields:

\n
    \n
  • title field is required, type 'string';
    • \n
  • locationId field is required, type 'string';
    • \n
  • state field is required, it's state id value, type 'int';
    • \n
  • sources field is required, type 'array', array of objects with title and url values, acceptable title values are \"Agoda, Airbnb, AliExpress, AlternativeTo, Amazon France, Amazon US, Apartmentratings, Apartments, Apple Appstore, Avvo, BBB, BookATable, Booking, Capterra, CarGurus, Cars.com, Citysearch, Classpass, Consumer Affairs, CreditKarma, CustomerLobby, DealerRater, Deliveroo, Ebay, Edmunds, Etsy, Expedia, Facebook, Feedback, FindLaw, Foursquare, G2Crowd, Gartner, Glassdoor, Google, Google Playstore, Google Shopping, Greatschools, Healthgrades, HomeAdvisor, HomeAway, Homestars, Hotels.com, Houzz, HungerStation, IT Central Station, Indeed, Influenster, Insider Pages, Lawyers.com, Lending Tree, Martindale, Niche, OpenRice, Opentable, ProductHunt, ProductReview.com.au, RateMDs, ReserveOut, Sitejabber, SoftwareAdvice, Talabat, The Knot, Thumbtack, TripAdvisor, Trulia, TrustRadius, TrustedShops, Trustpilot, UberEats, Vitals, Walmart, WeddingWire, Yell, YellowPages, Yelp, Zillow, ZocDoc, Zomato\" ;
    • \n
  • locationAddress field is optional, type 'string';
    • \n
  • phoneNumber field is optional, type 'string';
    • \n
  • websiteAddress field is optional, type 'string';
    • \n
\n

Pay attention there are main sources and additional sources, sources you have access to sets Localyser Admin!!!

\n","urlObject":{"path":["v3","api","location"],"query":[],"variable":[]}},"response":[{"id":"77b2a4a8-2fc7-4a7e-9e38-810ef22b96f9","name":"400 Error","originalRequest":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"api_key_value"}],"body":{"mode":"raw","raw":"{\r\n \"locationId\": \"Your location id\",\r\n \"state\": 1,\r\n \"locationAddress\": \"Your location adress\",\r\n \"phoneNumber\": \"Your location phone number\",\r\n \"websiteAddress\": \"Your location web site\",\r\n \"sources\": [\r\n {\r\n \"title\": \"Google\",\r\n \"url\": \"https://www.google.com/....\"\r\n },\r\n {\r\n \"title\": \"Zomato\",\r\n \"url\": \"https://www.zomato.com/....\"\r\n },\r\n {\r\n \"title\": \"Agoda\",\r\n \"url\": \"https://www.agoda.com/....\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"/v3/api/location"},"_postman_previewlanguage":"Text","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"details\": \"Title or locationId parameter missing\"\r\n}"},{"id":"994af9c9-f873-45c0-b964-00465e871e8b","name":"200 OK","originalRequest":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"api_key_value"}],"body":{"mode":"raw","raw":"{\r\n \"title\": \"Your location title\",\r\n \"locationId\": \"Your location id\",\r\n \"state\": 1,\r\n \"locationAddress\": \"Your location adress\",\r\n \"phoneNumber\": \"Your location phone number\",\r\n \"websiteAddress\": \"Your location web site\",\r\n \"sources\": [\r\n {\r\n \"title\": \"Google\",\r\n \"url\": \"https://www.google.com/....\"\r\n },\r\n {\r\n \"title\": \"Zomato\",\r\n \"url\": \"https://www.zomato.com/....\"\r\n },\r\n {\r\n \"title\": \"Agoda\",\r\n \"url\": \"https://www.agoda.com/....\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"/v3/api/location"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":null,"cookie":[],"responseTime":null,"body":"{ \r\n \"id\": 1,\r\n \"title\": \"Your location title\",\r\n \"locationId\": \"Your location id\",\r\n \"state\": 1,\r\n \"locationAddress\": \"Your location adress\",\r\n \"phoneNumber\": \"Your location phone number\",\r\n \"websiteAddress\": \"Your location web site\",\r\n \"google\": \"https://www.google.com/....\",\r\n \"tripadvisor\": \"https://www.tripadvisor.com/....\",\r\n \"zomato\": \"https://www.zomato.com/....\",\r\n \"reserveOut\": \"https://www.reserveOut.com/....\",\r\n \"facebook\": \"https://www.facebook.com/....\",\r\n \"foursquare\": \"https://www.foursquare.com/....\",\r\n \"talabat\": \"https://www.talabat.com/....\",\r\n \"hungerStation\": \"https://www.hungerStation.com/....\",\r\n \"booking\": \"https://www.booking.com/....\",\r\n \"expedia\": \"https://www.expedia.com/....\",\r\n \"additionalSources\": [\r\n {\r\n \"title\": \"Agoda\",\r\n \"url\": \"https://www.agoda.com/....\"\r\n }\r\n ]\r\n}"}],"_postman_id":"f9f05a9f-8f92-4562-a7f2-41ea660ccb48"},{"name":"PATCH location","id":"34dbc22a-deec-4340-a52d-378731fe52d7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Authorization","type":"text","value":"api_key_value"}],"body":{"mode":"raw","raw":"{ \"id\": 1,\r\n \"title\": \"Your location title\",\r\n \"locationId\": \"Your location id\",\r\n \"state\": 1,\r\n \"locationAddress\": \"Your location adress\",\r\n \"phoneNumber\": \"Your location phone number\",\r\n \"websiteAddress\": \"Your location web site\",\r\n \"sources\": [\r\n {\r\n \"title\": \"Google\",\r\n \"url\": \"https://www.google.com/....\"\r\n },\r\n {\r\n \"title\": \"Zomato\",\r\n \"url\": \"https://www.zomato.com/....\"\r\n },\r\n {\r\n \"title\": \"Agoda\",\r\n \"url\": \"https://www.agoda.com/....\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"/v3/api/location","description":"

Patch location URL

\n

Fields:

\n
    \n
  • id filed is required, type 'int';
    • \n
  • title field is optional, type 'string';
    • \n
  • locationId field is optional, type 'string';
    • \n
  • state field is optional, it's state id value, type 'int';
    • \n
  • locationAddress field is optional, type 'string';
    • \n
  • phoneNumber field is optional, type 'string';
    • \n
  • websiteAddress field is optional, type 'string';
    • \n
  • sources field is optional, type 'array', array of objects with title and url values, acceptable title values are \"Agoda, Airbnb, AliExpress, AlternativeTo, Amazon France, Amazon US, Apartmentratings, Apartments, Apple Appstore, Avvo, BBB, BookATable, Booking, Capterra, CarGurus, Cars.com, Citysearch, Classpass, Consumer Affairs, CreditKarma, CustomerLobby, DealerRater, Deliveroo, Ebay, Edmunds, Etsy, Expedia, Facebook, Feedback, FindLaw, Foursquare, G2Crowd, Gartner, Glassdoor, Google, Google Playstore, Google Shopping, Greatschools, Healthgrades, HomeAdvisor, HomeAway, Homestars, Hotels.com, Houzz, HungerStation, IT Central Station, Indeed, Influenster, Insider Pages, Lawyers.com, Lending Tree, Martindale, Niche, OpenRice, Opentable, ProductHunt, ProductReview.com.au, RateMDs, ReserveOut, Sitejabber, SoftwareAdvice, Talabat, The Knot, Thumbtack, TripAdvisor, Trulia, TrustRadius, TrustedShops, Trustpilot, UberEats, Vitals, Walmart, WeddingWire, Yell, YellowPages, Yelp, Zillow, ZocDoc, Zomato\" ;
    • \n
\n

Pay attention there are main sources and additional sources, sources you have access to sets Localyser Admin!!!

\n","urlObject":{"path":["v3","api","location"],"query":[],"variable":[]}},"response":[{"id":"2578eaab-e991-4b1f-bb1b-ab01e9354bab","name":"200 OK","originalRequest":{"method":"PATCH","header":[{"key":"Authorization","type":"text","value":"api_key_value"}],"body":{"mode":"raw","raw":"{ \"id\": 1,\r\n \"title\": \"Your location title\",\r\n \"locationId\": \"Your location id\",\r\n \"state\": 1,\r\n \"locationAddress\": \"Your location adress\",\r\n \"phoneNumber\": \"Your location phone number\",\r\n \"websiteAddress\": \"Your location web site\"\r\n}","options":{"raw":{"language":"json"}}},"url":"/v3/api/location"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{ \r\n \"id\": 1,\r\n \"title\": \"Your location title\",\r\n \"locationId\": \"Your location id\",\r\n \"state\": 1,\r\n \"locationAddress\": \"Your location adress\",\r\n \"phoneNumber\": \"Your location phone number\",\r\n \"websiteAddress\": \"Your location web site\",\r\n \"google\": \"https://www.google.com/....\",\r\n \"tripadvisor\": \"https://www.tripadvisor.com/....\",\r\n \"zomato\": \"https://www.zomato.com/....\",\r\n \"reserveOut\": \"https://www.reserveOut.com/....\",\r\n \"facebook\": \"https://www.facebook.com/....\",\r\n \"foursquare\": \"https://www.foursquare.com/....\",\r\n \"talabat\": \"https://www.talabat.com/....\",\r\n \"hungerStation\": \"https://www.hungerStation.com/....\",\r\n \"booking\": \"https://www.booking.com/....\",\r\n \"expedia\": \"https://www.expedia.com/....\",\r\n \"additionalSources\": [\r\n {\r\n \"title\": \"Agoda\",\r\n \"url\": \"https://www.agoda.com/....\"\r\n }\r\n ]\r\n}"},{"id":"f9a345a6-324e-4233-92e7-963f54d8a68a","name":"400 Error","originalRequest":{"method":"PATCH","header":[{"key":"Authorization","type":"text","value":"api_key_value"}],"body":{"mode":"raw","raw":"{ \r\n \"title\": \"Your location title\"\r\n}","options":{"raw":{"language":"json"}}},"url":"/v3/api/location"},"_postman_previewlanguage":"Text","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"details\": \"Id parameter missing\"\r\n}"}],"_postman_id":"34dbc22a-deec-4340-a52d-378731fe52d7"},{"name":"DELETE location","id":"107d9293-4767-414a-9c5e-f438ebb11aa2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Authorization","value":"api_key_value","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"id\": 1\r\n}","options":{"raw":{"language":"json"}}},"url":"/v3/api/location","description":"

Delete location URL

\n

Fields:

\n
    \n
  • id field is required, type 'int';
    • \n
\n","urlObject":{"path":["v3","api","location"],"query":[],"variable":[]}},"response":[{"id":"a99296e9-778e-418e-ba67-34974469cd3c","name":"200 OK","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","type":"text","value":"api_key_value"}],"body":{"mode":"raw","raw":"{\r\n \"id\": 1\r\n}","options":{"raw":{"language":"json"}}},"url":"/v3/api/location"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":null,"cookie":[],"responseTime":null,"body":"{ \"id\": 1,\r\n \"title\": \"Your location title\",\r\n \"locationId\": \"Your location id\",\r\n \"state\": 1,\r\n \"locationAddress\": \"Your location adress\",\r\n \"phoneNumber\": \"Your location phone number\",\r\n \"websiteAddress\": \"Your location web site\",\r\n \"google\": \"https://www.google.com/....\",\r\n \"tripadvisor\": \"https://www.tripadvisor.com/....\",\r\n \"zomato\": \"https://www.zomato.com/....\",\r\n \"reserveOut\": \"https://www.reserveOut.com/....\",\r\n \"facebook\": \"https://www.facebook.com/....\",\r\n \"foursquare\": \"https://www.foursquare.com/....\",\r\n \"talabat\": \"https://www.talabat.com/....\",\r\n \"hungerStation\": \"https://www.hungerStation.com/....\",\r\n \"booking\": \"https://www.booking.com/....\",\r\n \"expedia\": \"https://www.expedia.com/....\",\r\n \"additionalSources\": [\r\n {\r\n \"title\": \"Agoda\",\r\n \"url\": \"https://www.agoda.com/....\"\r\n }\r\n ]\r\n}"},{"id":"e9b80068-90b8-47a1-a099-893eaf044a8a","name":"400 Error","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"api_key_value","type":"text"}],"body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}},"url":"/v3/api/location"},"_postman_previewlanguage":"Text","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"details\": \"Id parameter missing\"\r\n}"}],"_postman_id":"107d9293-4767-414a-9c5e-f438ebb11aa2"},{"name":"GET locations","id":"19aad43a-2b28-420e-a1d9-6ed5bfff3354","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"api_key_value","type":"text"}],"url":"/v3/api/location","description":"

GET all locations URL

\n

Params:

\n
    \n
  • page parameter is optional, by default page = 1;
    • \n
  • search parameter is optional;
    • \n
\n

Request return 20 locations per page.

\n

If you set page parameter to value that not exist, system return empty array.

\n","urlObject":{"path":["v3","api","location"],"query":[{"disabled":true,"key":"page","value":"1"},{"disabled":true,"key":"search","value":"Location title ot location id"}],"variable":[]}},"response":[{"id":"22d6ffc5-9a73-44f4-b1f2-033162ea423d","name":"400 Error","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"api_key_value","type":"text"}],"url":{"raw":"/v3/api/company","path":["v3","api","company"],"query":[{"key":"page","value":"1","disabled":true},{"key":"search","value":"Location title ot location id","type":"text","disabled":true}]}},"_postman_previewlanguage":"Text","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"details\": \"Some data base error\"\r\n}"},{"id":"c7f77816-6c93-4aae-9867-384a53371c10","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"api_key_value","type":"text"}],"url":"/v3/api/company"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"page\": 1,\r\n \"per_page\": 20,\r\n \"total_pages\": 1,\r\n \"locations\": [\r\n { \r\n \"id\": 1,\r\n \"title\": \"Your location title\",\r\n \"locationId\": \"Your location id\",\r\n \"state\": 1,\r\n \"locationAddress\": \"Your location adress\",\r\n \"phoneNumber\": \"Your location phone number\",\r\n \"websiteAddress\": \"Your location web site\",\r\n \"google\": \"https://www.google.com/....\",\r\n \"tripadvisor\": \"https://www.tripadvisor.com/....\",\r\n \"zomato\": \"https://www.zomato.com/....\",\r\n \"reserveOut\": \"https://www.reserveOut.com/....\",\r\n \"facebook\": \"https://www.facebook.com/....\",\r\n \"foursquare\": \"https://www.foursquare.com/....\",\r\n \"talabat\": \"https://www.talabat.com/....\",\r\n \"hungerStation\": \"https://www.hungerStation.com/....\",\r\n \"booking\": \"https://www.booking.com/....\",\r\n \"expedia\": \"https://www.expedia.com/....\",\r\n \"additionalSources\": [\r\n {\r\n \"title\": \"Agoda\",\r\n \"url\": \"https://www.agoda.com/....\"\r\n }\r\n ]\r\n }\r\n ]\r\n}"}],"_postman_id":"19aad43a-2b28-420e-a1d9-6ed5bfff3354"}],"id":"9683d358-e567-44ff-9281-bdab54af639b","description":"

For Partners Only: Every company can have one or many locations organized by brand and region. A partner can add, patch, delete, get company locations.

\n","_postman_id":"9683d358-e567-44ff-9281-bdab54af639b"},{"name":"User","item":[{"name":"POST user","id":"2abc890d-9e87-4e58-8ce6-171cace19035","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"api_key_value","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"firstName\": \"Test\",\r\n \"lastName\": \"Test\",\r\n \"email\": \"testuser@gmail.com\",\r\n \"role\": \"Master Admin\"\r\n}","options":{"raw":{"language":"json"}}},"url":"/v3/api/user","description":"

Post new user URL

\n

Fields:

\n
    \n
  • firstName field is required, type 'string';
    • \n
  • lastName field is required, type 'string';
    • \n
  • email field is required, type 'string';
    • \n
  • role field is required, type 'string', acceptable values are \"Analyst\", \"Manager\", \"Responder\", \"Master Admin\"
    • \n
\n","urlObject":{"path":["v3","api","user"],"query":[],"variable":[]}},"response":[{"id":"17e54b86-075b-4015-ba1b-ccd064563bb7","name":"200 OK","originalRequest":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"api_key_value"}],"body":{"mode":"raw","raw":"{\r\n \"firstName\": \"Test\",\r\n \"lastName\": \"Test\",\r\n \"email\": \"testuser@gmail.com\",\r\n \"role\": \"Master Admin\"\r\n}","options":{"raw":{"language":"json"}}},"url":"/v3/api/user"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"id\": 1,\r\n \"firstName\": \"Test\",\r\n \"lastName\": \"Test\",\r\n \"email\": \"testuser@gmail.com\",\r\n \"role\": \"Master Admin\",\r\n \"client\": 1\r\n}\r\n"},{"id":"601f8e34-01b4-40ef-8b2d-ec4b75a3d424","name":"400 Error","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"api_key_value","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"lastName\": \"Test\",\r\n \"email\": \"testuser@gmail.com\",\r\n \"role\": \"Master Admin\"\r\n}","options":{"raw":{"language":"json"}}},"url":"/v3/api/user"},"code":400,"_postman_previewlanguage":"Text","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"details\": \"Parameter missing check firstName and lastName\"\r\n}"}],"_postman_id":"2abc890d-9e87-4e58-8ce6-171cace19035"},{"name":"PATCH user","id":"22a067f1-6c38-4c43-9990-c0df255acef9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Authorization","type":"text","value":"api_key_value"}],"body":{"mode":"raw","raw":"{\r\n \"id\": 1,\r\n \"firstName\": \"Test\",\r\n \"lastName\": \"Test\",\r\n \"email\": \"testuser@gmail.com\",\r\n \"role\": \"Master Admin\"\r\n}","options":{"raw":{"language":"json"}}},"url":"/v3/api/user","description":"

Patch user URL

\n

Fields:

\n
    \n
  • id filed is required, type 'int';
    • \n
  • firstName field is optional, type 'string';
    • \n
  • lastName field is optional, type 'string';
    • \n
  • email field is optional, type 'string';
    • \n
  • role field is optional, type 'string', acceptable values are \"Analyst\", \"Manager\", \"Responder\", \"Master Admin\";
    • \n
\n","urlObject":{"path":["v3","api","user"],"query":[],"variable":[]}},"response":[{"id":"0cf273b3-5fa2-49f0-aed3-84b30d9d919d","name":"400 Error","originalRequest":{"method":"PATCH","header":[{"key":"Authorization","type":"text","value":"api_key_value"}],"body":{"mode":"raw","raw":"{\r\n \"firstName\": \"Test\",\r\n \"lastName\": \"Test\",\r\n \"email\": \"testuser@gmail.com\",\r\n \"role\": \"Master Admin\"\r\n}","options":{"raw":{"language":"json"}}},"url":"/v3/api/user"},"code":400,"_postman_previewlanguage":"Text","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"details\": \"Id parameter missing\"\r\n}"},{"id":"2a4ed2b6-80dc-4a22-b3d0-ae5c2f7026f2","name":"200 OK","originalRequest":{"method":"PATCH","header":[{"key":"Authorization","type":"text","value":"api_key_value"}],"body":{"mode":"raw","raw":"{\r\n \"id\": 1,\r\n \"firstName\": \"Test\",\r\n \"lastName\": \"Test\",\r\n \"email\": \"testuser@gmail.com\",\r\n \"role\": \"Master Admin\"\r\n}","options":{"raw":{"language":"json"}}},"url":"/v3/api/user"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"id\": 1,\r\n \"firstName\": \"Test\",\r\n \"lastName\": \"Test\",\r\n \"email\": \"testuser@gmail.com\",\r\n \"role\": \"Master Admin\"\r\n}"}],"_postman_id":"22a067f1-6c38-4c43-9990-c0df255acef9"},{"name":"DELETE user","id":"049a7f3a-ecab-42a0-841d-3b4170f75d77","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Authorization","type":"text","value":"api_key_value"}],"body":{"mode":"raw","raw":"{\r\n \"id\": 1\r\n}","options":{"raw":{"language":"json"}}},"url":"/v3/api/user","description":"

Delete user URL

\n

Fields:

\n
    \n
  • id field is required, type 'int';
    • \n
\n","urlObject":{"path":["v3","api","user"],"query":[],"variable":[]}},"response":[{"id":"2fd4d6a1-0f80-4d6f-9d7e-4c96096dec20","name":"200 OK","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","type":"text","value":"api_key_value"}],"body":{"mode":"raw","raw":"{\r\n \"id\": 1\r\n}","options":{"raw":{"language":"json"}}},"url":"/v3/api/user"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"id\": 1,\r\n \"firstName\": \"Test\",\r\n \"lastName\": \"Test\",\r\n \"email\": \"testuser@gmail.com\",\r\n \"role\": \"Master Admin\",\r\n \"client\": 1\r\n}"},{"id":"778b4f2b-b426-40d6-a00c-9173030568b6","name":"400 Error","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","type":"text","value":"api_key_value"}],"body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}},"url":"/v3/api/user"},"code":400,"_postman_previewlanguage":"Text","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"details\": \"Id parameter missing\"\r\n}"}],"_postman_id":"049a7f3a-ecab-42a0-841d-3b4170f75d77"},{"name":"GET users","id":"dea0c178-de8a-4a03-a8df-51e065ff01d2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"api_key_value","type":"text"}],"url":"/v3/api/user","description":"

GET all users URL

\n

Params:

\n
    \n
  • search parameter is optional
    • \n
\n","urlObject":{"path":["v3","api","user"],"query":[{"disabled":true,"key":"search","value":"User first or second name"}],"variable":[]}},"response":[{"id":"5860a92f-6f22-4725-b18f-64394e596b0e","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"api_key_value","type":"text"}],"url":""},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":null,"cookie":[],"responseTime":null,"body":"[\r\n {\r\n \"id\": 1,\r\n \"firstName\": \"Test\",\r\n \"lastName\": \"Test\",\r\n \"email\": \"testuser@gmail.com\",\r\n \"role\": \"Master Admin\",\r\n \"client\": 1\r\n }\r\n]"},{"id":"fbd9a67d-58f1-44fc-83af-97a215174f48","name":"400 Error","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"api_key_value","type":"text"}],"url":{"raw":"/v3/api/user","path":["v3","api","user"],"query":[{"key":"search","value":"User first or second name","type":"text","disabled":true}]}},"code":400,"_postman_previewlanguage":"Text","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"details\": \"Some data base error\"\r\n}"}],"_postman_id":"dea0c178-de8a-4a03-a8df-51e065ff01d2"}],"id":"67835412-9e33-4680-9e92-e5c5f6a25022","description":"

For Partners Only: Every company can have unlimited number of users with different permission roles. A partner can add, patch, delete, get users for a Company account.

\n","_postman_id":"67835412-9e33-4680-9e92-e5c5f6a25022"},{"name":"Brand","item":[{"name":"POST brand","id":"36630409-3d43-4dee-a333-187472d1eeba","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"api_key_value","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"title\": \"Brand title\"\r\n}"},"url":"/v3/api/brand","description":"

Post new brand URL

\n

Fields:

\n
    \n
  • title field is required, type 'string';
    • \n
\n","urlObject":{"path":["v3","api","brand"],"query":[],"variable":[]}},"response":[{"id":"2835fd38-8af3-46b7-9440-b46b1eb79815","name":"200 OK","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"api_key_value","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"title\": \"Brand title\"\r\n}"},"url":""},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"id\": 1,\r\n \"title\": \"Brand title\",\r\n \"client\": 1 \r\n}"},{"id":"39a558c9-e04e-4473-ba41-d83986908489","name":"400 Error","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"api_key_value","type":"text"}],"body":{"mode":"raw","raw":"{}"},"url":"/v3/api/brand"},"_postman_previewlanguage":"Text","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"details\": \"Title parameter missing\"\r\n}"}],"_postman_id":"36630409-3d43-4dee-a333-187472d1eeba"},{"name":"PATCH brand","id":"e98d433b-fd29-45ef-b2c2-779209817079","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Authorization","value":"api_key_value","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"id\": 1,\r\n \"title\": \"New Brand title\"\r\n}","options":{"raw":{"language":"json"}}},"url":"/v3/api/brand","description":"

Patch brand URL

\n

Fields:

\n
    \n
  • id filed is required, type 'int';
    • \n
  • title field is required, type 'string';
    • \n
\n","urlObject":{"path":["v3","api","brand"],"query":[],"variable":[]}},"response":[{"id":"1e3a47c2-eeeb-428e-bb1c-e87aef9ccdef","name":"200 OK","originalRequest":{"method":"PATCH","header":[{"key":"Authorization","value":"api_key_value","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"id\": 1,\r\n \"title\": \"New brand title\"\r\n}","options":{"raw":{"language":"json"}}},"url":"/v3/api/brand"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"id\": 1,\r\n \"title\": \"New brand title\",\r\n \"client\": 1 \r\n}"},{"id":"dc612671-69a2-41bf-ae14-cd3d790b5e18","name":"400 Error","originalRequest":{"method":"PATCH","header":[{"key":"Authorization","value":"api_key_value","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"title\": \"New Brand title\"\r\n}","options":{"raw":{"language":"json"}}},"url":"/v3/api/brand"},"_postman_previewlanguage":"Text","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"details\": \"Id parameter missing\"\r\n}"}],"_postman_id":"e98d433b-fd29-45ef-b2c2-779209817079"},{"name":"GET brands","id":"7c883d57-a9d2-4eda-8552-7c839fd0699a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"api_key_value","type":"text"}],"url":"/v3/api/brand","description":"

GET all brands URL

\n","urlObject":{"path":["v3","api","brand"],"query":[],"variable":[]}},"response":[{"id":"a42968fa-f246-4525-8fdd-66694591e0ff","name":"400 Error","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"api_key_value","type":"text"}],"url":"/v3/api/brand"},"_postman_previewlanguage":"Text","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"details\": \"Some data base error\"\r\n}"},{"id":"f852985c-c9a7-464b-954a-823850ab491a","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"api_key_value","type":"text"}],"url":"/v3/api/brand"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":null,"cookie":[],"responseTime":null,"body":"[\r\n {\r\n \"id\": 1,\r\n \"title\": \"New brand title\",\r\n \"client\": 1 \r\n }\r\n]"}],"_postman_id":"7c883d57-a9d2-4eda-8552-7c839fd0699a"}],"id":"75972713-45b2-4511-847a-da8827b3de8d","description":"

A company can have brands.

\n","_postman_id":"75972713-45b2-4511-847a-da8827b3de8d"},{"name":"State","item":[{"name":"POST state","id":"45b81c08-e9d6-4c51-b0b9-ae3cdacc1c64","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"api_key_value","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"title\": \"State title\",\r\n \"brand\": 1\r\n}","options":{"raw":{"language":"json"}}},"url":"/v3/api/state","description":"

Post new state URL

\n

Fields:

\n
    \n
  • title field is required, type 'string';
    • \n
  • brand field is required, type 'int';
    • \n
\n","urlObject":{"path":["v3","api","state"],"query":[],"variable":[]}},"response":[{"id":"4157aceb-7f7a-42cd-93fe-f54e1863c446","name":"400 Error","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"api_key_value","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"brand\": 1\r\n}","options":{"raw":{"language":"json"}}},"url":"/v3/api/state"},"_postman_previewlanguage":"Text","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"details\": \"Title or brand parameter missing\"\r\n}"},{"id":"86dfb0e1-37b5-41e8-a8e6-81d8bccdcf47","name":"200 OK","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"api_key_value","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"title\": \"State title\",\r\n \"brand\": 1\r\n}","options":{"raw":{"language":"json"}}},"url":"/v3/api/state"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"id\": 1,\r\n \"title\": \"State title\",\r\n \"brandTitle\": \"New brand title\",\r\n \"brand\": 1\r\n}"}],"_postman_id":"45b81c08-e9d6-4c51-b0b9-ae3cdacc1c64"},{"name":"PATCH state","id":"076baad1-5513-4164-98e7-e1daaf91a7b5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Authorization","value":"api_key_value","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"id\": 1,\r\n \"title\": \"New state title\",\r\n \"brand\": 2\r\n}","options":{"raw":{"language":"json"}}},"url":"/v3/api/state","description":"

Patch state URL

\n

Fields:

\n
    \n
  • id filed is required, type 'int';
    • \n
  • title field is optional, type 'string';
    • \n
  • brand field is optional, type 'int';
    • \n
\n

One of the optional fields should be passed.

\n","urlObject":{"path":["v3","api","state"],"query":[],"variable":[]}},"response":[{"id":"c6c5cf2a-f4d2-4cb5-9dd0-8e9e7aa03d86","name":"400 Error","originalRequest":{"method":"PATCH","header":[{"key":"Authorization","value":"api_key_value","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"title\": \"New state title\",\r\n \"brand\": 2\r\n}","options":{"raw":{"language":"json"}}},"url":"/v3/api/state"},"_postman_previewlanguage":"Text","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"details\": \"Id parameter missing\"\r\n}"},{"id":"e52c194e-2c15-487e-84a4-be697cc31593","name":"200 OK","originalRequest":{"method":"PATCH","header":[{"key":"Authorization","value":"api_key_value","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"id\": 1,\r\n \"title\": \"New state title\",\r\n \"brand\": 2\r\n}","options":{"raw":{"language":"json"}}},"url":"/v3/api/state"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"id\": 1,\r\n \"title\": \"New state title\",\r\n \"brandTitle\": \"Brand #2\",\r\n \"brand\": 2\r\n}"}],"_postman_id":"076baad1-5513-4164-98e7-e1daaf91a7b5"},{"name":"GET states","id":"f9084e0b-4f0b-4460-b01b-23854315d9fa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"api_key_value","type":"text"}],"url":"/v3/api/state","description":"

GET all states URL

\n","urlObject":{"path":["v3","api","state"],"query":[],"variable":[]}},"response":[{"id":"43846c7b-9e8c-4a89-9062-2d9e10fa6583","name":"400 Error","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"api_key_value","type":"text"}],"url":"/v3/api/state"},"_postman_previewlanguage":"Text","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"details\": \"Some data base error\"\r\n}"},{"id":"c735decb-0e16-4805-bfb1-34ad4779eaa8","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"api_key_value","type":"text"}],"url":"/v3/api/state"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":null,"cookie":[],"responseTime":null,"body":"[\r\n {\r\n \"id\": 1,\r\n \"title\": \"New state title\",\r\n \"brandTitle\": \"Brand #2\",\r\n \"brand\": 2\r\n }\r\n]"}],"_postman_id":"f9084e0b-4f0b-4460-b01b-23854315d9fa"}],"id":"4d34e792-8d5c-4290-9171-e39d1ee10a31","description":"

A company brand can have states.

\n","_postman_id":"4d34e792-8d5c-4290-9171-e39d1ee10a31"},{"name":"IFrame","item":[{"name":"POST IframeToken","id":"89b7b7a0-ce8a-4305-913c-c8d2f4c87d36","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"api-token","value":"api_key_value","type":"text"}],"url":"v3/api/iframe-token?location_id=","description":"

Generate a secure JWT token for iframe integration that allows external applications to embed Localyser reviews with limited, location-specific access.

\n

Token Validity:

\n
    \n

  • Duration: 24 hours (86400 seconds)

    \n
    • \n

  • Refresh: Tokens cannot be refreshed - new token generation required

    \n
    • \n

  • Single Use: Each token is tied to a specific location and optionally a review

    \n
    • \n
\n

Token Payload:

\n
{\n  \"locationId\": \"9650\",\n  \"clientId\": 570,\n  \"iat\": 1757512711,\n  \"exp\": 1757599111\n}\n\n

FIelds:

\n
    \n
  • location_id field is required, type 'string';
    • \n
\n","urlObject":{"path":["api","iframe-token"],"host":["v3"],"query":[{"description":{"content":"

Location identifier - must be a valid location ID that belongs to the authenticated client. This location will be the only one accessible through the generated token.

\n","type":"text/plain"},"key":"location_id","value":""}],"variable":[]}},"response":[{"id":"40f7a7fa-6d43-479d-89f1-ca9c5bee4a6f","name":"200 OK","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"api_key_value","type":"text"}],"url":{"raw":"v3/api/iframe-token?location_id=9650","host":["v3"],"path":["api","iframe-token"],"query":[{"key":"location_id","value":"9650","description":"The ID of the location for which to generate the iframe token"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\r\n \"authToken\": \"{{vault:json-web-token}}\",\r\n \"expiresIn\": 86400,\r\n \"locationId\": \"9650\",\r\n \"clientId\": 570\r\n}"}],"_postman_id":"89b7b7a0-ce8a-4305-913c-c8d2f4c87d36"},{"name":"GET IFrame Reviews","id":"aa8f6caf-2918-4fae-a1bb-60bab1462f94","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":".../reviews?locations=location_id_value&view=[2,3]&auth_token=token_value","description":"

Custom Styling & Theming - Query Parameters

\n

Overview

\n

The iframe integration supports extensive visual customization through URL query parameters, allowing you to seamlessly integrate Localyser reviews with your application's design.

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterTypeDescriptionExample Value
themestringEnables dark mode themedark
fnColorstringFont/text color#ffffff
bgColorstringBackground color#1a1a1a
bgFnColorstringBackground font color#e0e0e0
btnBgColorstringButton background color#007bff
btnFnColorstringButton font color#ffffff
btnBgColorHoverstringButton hover background color#0056b3
companystringYour company name on Localyser lower casewateen
fontFamilystringCustom font familyRoboto
primaryColorstringColor which will be applied on elements hover, focus, select0056b3
\n

fontFamily — Use a URL-encoded value (e.g., font stacks with commas or spaces). To apply a non-default browser font, please contact support.

\n

company — Only required if a custom loader needs to be applied across the application. Before enabling this, please contact support and provide your logo in .gif format.

\n

Usage Examples

\n

Basic Dark Mode:

\n
.../reviews?locations=location_value&view=[2,3]&auth_token=auth_token_value&theme=dark\n\n

Custom Brand Color:

\n
.../reviews?locations=location_value&view=[2,3]&auth_token=auth_token_value&bgColor=f8f9fa&fnColor=212529&btnBgColor=007bff&btnFnColor=ffffff\n\n

Color Format

\n
    \n

  • Format: Hex color codes WITH the # symbol

    \n
    • \n

  • Example: Use #ffffff or ffffff (both supported)

    \n
    • \n

  • URL Encoding: The # symbol should be URL-encoded as # in URLs

    \n
    • \n

  • Auto-handling: The system handles both formats automatically

    \n
    • \n
\n

Dark Mode

\n
    \n

  • Parameter: theme=dark

    \n
    • \n

  • Description: Applies a predefined dark theme with dark backgrounds and light text

    \n
    • \n

  • Combination: Can be combined with custom colors to override specific elements

    \n
    • \n

  • Priority: Custom color parameters take precedence over dark theme defaults

    \n
    • \n
\n

View Modes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
View ModeDescription
view=2Hides filters
view=3With filter controls
\n

Complete Example

\n
.../reviews?auth_token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...&view=3&theme=dark&bgColor=2d3748&fnColor=e2e8f0&btnBgColor=4299e1&btnFnColor=ffffff&btnBgColorHover=3182ce\n\n

This example creates a dark-themed iframe with:

\n
    \n

  • Dark blue-gray background (#2d3748)

    \n
    • \n

  • Light gray text (#e2e8f0)

    \n
    • \n

  • Blue buttons (#4299e1) with white text

    \n
    • \n

  • Darker blue button hover effect (#3182ce)

    \n
    • \n

  • Hidden filters (view=3)

    \n
    • \n
\n

Example:

\n
.../reviews?locations=...&view=3&auth_token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...&btnBgColor=ff6b35&btnFnColor=fff&btnBgColorHover=ff5722&bgColor=2C2C2C&fnColor=f8fafc&bgFnColor=cbd5e1\n\n

**
Important note:** If you are using more than one page within an iframe during a single session, make sure to clear any query parameters that do not belong to the iframe before navigating to another page.

\n","urlObject":{"path":["reviews"],"host":["","","",""],"query":[{"key":"locations","value":"location_id_value"},{"key":"view","value":"[2,3]"},{"key":"auth_token","value":"token_value"}],"variable":[]}},"response":[],"_postman_id":"aa8f6caf-2918-4fae-a1bb-60bab1462f94"},{"name":"Reporting Pages","id":"b9bfda47-665e-4013-9f0e-4ff977e8dece","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"","description":"

Reporting Pages (Overview & Insights):

\n

These pages support additional query parameters for data filtering:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterTypeDescriptionExample
date_fromstringStart date (YYYY-MM-DD)2025-08-13
date_tostringEnd date (YYYY-MM-DD)2025-09-12
categoriesstringComma-separated categoriesFood,Delivery,Service,Price,Atmosphere,Recommend
locationsstringComma-separated location IDs123,456,789
sourcestringReview source filtergoogle,facebook,tripadvisor
\n

Example Insights with Custom Styling + Filtering:

\n
.../reporting/insights?auth_token=YOUR_TOKEN&view=3&date_from=2025-08-13&date_to=2025-09-12&categories=Food,Delivery,Service,Price,Atmosphere,Recommend&locations=123,456&source=google,facebook\n\n

Example Overview with Multiple Filters:

\n
.../reporting/overview?auth_token=YOUR_TOKEN&view=3&date_from=2025-08-13&date_to=2025-09-12&categories=Food,Delivery,Service,Price,Atmosphere,Recommend&locations=123,456&source=google,facebook\n\n

Embedding iframe example:
Report overview

\n
</div><div>width=\"500px\" height=\"500px\" \n<br></div><div>src=\"https://app.localyser.com/reporting/overview?locations=11047&view=2&auth_token=YOUR_TOKEN&theme=dark\" \n<br></div><div>title=\"Overview report\">\n<br></div><div>&lt;/iframe&gt;\n<br></div><div>  src: https://app.localyser.com/reporting/insights\n<br></div><div>  params:\n<br></div><div>    - auth_token=YOUR_TOKEN\n<br></div><div>    - locations=11047\n<br></div><div>    - view=2\n<br></div><div>    - theme=dark\n<br></div><div>  width: 500px\n<br></div><div>  height: 500px\n<br></div></code></pre><p >Report insights</p><pre class=plain><code><div><iframe \n<br></div><div>width=\"500px\" height=\"500px\" \n<br></div><div>src=\"https://app.localyser.com/reporting/insights?locations=11047&view=2&auth_token=YOUR_TOKEN&theme=dark\" \n<br></div><div>title=\"Overview report\">\n<br></div><div>&lt;/iframe&gt;\n<br></div><div>  src: https://app.localyser.com/reporting/insights\n<br></div><div>  params:\n<br></div><div>    - auth_token=YOUR_TOKEN\n<br></div><div>    - locations=11047\n<br></div><div>    - view=2\n<br></div><div>    - theme=dark\n<br></div><div>  width: 500px\n<br></div><div>  height: 500px\n<br></div></code></pre><p ></p></x-turndown>\n
","urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"b9bfda47-665e-4013-9f0e-4ff977e8dece"},{"name":"GET third party login data","id":"6faee82c-7bbb-4804-9783-c5aea5e32cf7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"","description":"

The Third-Party Login page can be embedded into external applications via an iframe.
On that page you may add new Google connection or other accounts

\n

The page is hosted on Localyser and supports:

\n
    \n

  • authentication via token

    \n
    • \n

  • UI customization through query parameters

    \n
    • \n
\n
\n

Iframe URL

\n
https://app.localyser.com/settings/other/thirdPartyLogin\n\n
\n

Required Parameters

\n

🔐 auth_token (required)

\n

Authentication token used to authorize the user inside the iframe.

\n
auth_token=<JWT>\n\n
    \n
  • Must be a valid access token
    • \n
\n

Iframe embedding example

\n
</div><div>width=\"500px\" height=\"500px\" \n<br></div><div>src=\"https://app.localyser.com/settings/other/thirdPartyLogin?locations=11047&view=2&auth_token=YOUR_TOKEN&theme=dark\" \n<br></div><div>title=\"Thrid party login\">\n<br></div><div>&lt;/iframe&gt;\n<br></div><div>  src: https://app.localyser.com/settings/other/thirdPartyLogin\n<br></div><div>  params:\n<br></div><div>    - auth_token=YOUR_TOKEN\n<br></div><div>    - locations=11047\n<br></div><div>    - view=2\n<br></div><div>    - theme=dark\n<br></div><div>  width: 500px\n<br></div><div>  height: 500px\n<br></div></code></pre><p ></p></x-turndown>\n
","urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"6faee82c-7bbb-4804-9783-c5aea5e32cf7"},{"name":"Get Dashboard data","id":"65efd075-c3fd-490d-a741-99a12067a092","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"description":"

The Dashboard page can be embedded into external applications via an iframe.
On that page you may see Reputation Score and Net Promoter Score sections.
Filters and PDF export is available is view Mode - 3 and hidden is viewMode - 2.

\n

The page is hosted on Localyser and supports:

\n
    \n

  • authentication via token

    \n
    • \n

  • UI customization through query parameters

    \n
    • \n
\n
\n

Iframe URL

\n
https://app.localyser.com/dashboard\n\n
\n

Required Parameters

\n

🔐 auth_token (required)

\n

Authentication token used to authorize the user inside the iframe.

\n
auth_token=<JWT>\n\n
    \n
  • Must be a valid access token
    • \n
\n

Iframe embedding example

\n
<iframe \nwidth=\"500px\" height=\"500px\" \nsrc=\"https://app.localyser.com/dashboard?locations=11047&view=2&auth_token=YOUR_TOKEN&theme=dark\" \ntitle=\"Dashboard\">\n</iframe>\n\n\n  src: https://app.localyser.com/dashboard\n  params:\n    - auth_token=YOUR_TOKEN\n    - locations=11047\n    - view=2\n    - theme=dark\n  width: 500px\n  height: 500px\n\n\n
","urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"65efd075-c3fd-490d-a741-99a12067a092"}],"id":"7f386189-a752-475e-ac18-c8d33d38e19d","description":"

Use this endpoint to generate an iframe token for a specific location

\n","_postman_id":"7f386189-a752-475e-ac18-c8d33d38e19d"}]}