The Localyser API is designed for clients and partners to leverage the different functionality of our Online Reputation Management tool.
\nFor Clients, you can pull all of your review data into your own CRM system or BI tool.
\nFor Partners, you can deliver different review management functionality into your own dashboard.
\nAuthentication: 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":"Partner API Documentation","item":[{"name":"company","item":[{"name":"POST company","id":"fca8fda9-cb26-4d13-a6ef-e4046ecfb34d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"companyName\": \"Acme Cafes\",\n \"companyType\": \"Cafes\",\n \"status\": \"Active\",\n \"package\": \"Free trial\",\n \"locationsLimit\": 5,\n \"address1\": \"12 Main St.\",\n \"address2\": \"Suite 4\",\n \"city\": \"Dubai\",\n \"state\": \"Dubai\",\n \"country\": \"United Arab Emirates\",\n \"zip\": \"12345\",\n \"website\": \"https://acmecafes.com\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/v3/api/company","description":"Create a new company under the authenticated partner. Seeds the new client with a fresh access token, default sources for the chosen companyType, default review categories and response templates (based on the country-inferred response languages), and the feature set tied to the chosen package. When package is Free trial, also creates a 30-day trial period record. The whole creation runs in a single DB transaction.
Fields:
\ncompanyName field is required, type 'string';
\ncompanyType field is required, type 'string', acceptable values are \"Automotive\", \"Banks\", \"Cafes\", \"Business Services\", \"Education\", \"Electronics\", \"Fashion\", \"Fitness\", \"Healthcare\", \"Home Services\", \"Hotels\", \"Pharmacies\", \"Restaurants\", \"Spas\", \"Wellness\";
\nstatus field is optional, type 'string', acceptable values are \"Active\" or \"Inactive\", default value is \"Active\";
\npackage field is optional, type 'string', acceptable values are \"Analyzer\", \"Lite\", \"Standard\", \"Premium\",\"Custom\",\"Free trial\", default value is \"Free trial\";
\nlocationsLimit field is optional, type 'integer';
\naddress1 field is optional, type 'string';
\naddress2 field is optional, type 'string';
\ncity field is optional, type 'string';
\nstate field is optional, type 'string';
\ncountry field is optional, type 'string';
\nzip field is optional, type 'int';
\nwebsite field is optional, type 'string', max length 255 characters;
\nUpdate an existing company that belongs to the authenticated partner. Any field except id is optional; omitted fields keep their current values. Validates that companyName is not already taken, that locationsLimit is not lower than the company's in-use locations, and that country is in the supported country list.
Fields:
\nid field is required, type 'int';
\ncompanyName field is optional, type 'string';
\ncompanyType field is optional, type 'string', acceptable values are \"Automotive\", \"Banks\", \"Cafes\", \"Business Services\", \"Education\", \"Electronics\", \"Fashion\", \"Fitness\", \"Healthcare\", \"Home Services\", \"Hotels\", \"Pharmacies\", \"Restaurants\", \"Spas\", \"Wellness\";
\nsources field is optional, type 'array', array of sources names;
\nstatus field is optional, type 'string', acceptable values are \"Active\" or \"Inactive\", default value is \"Active\";
\npackage field is optional, type 'string', acceptable values are \"Analyzer\", \"Lite\", \"Standard\", \"Premium\",\"Custom\",\"Free trial\", default value is \"Free trial\";
\nlocationsLimit field is optional, type 'integer';
\naddress1 field is optional, type 'string';
\naddress2 field is optional, type 'string';
\ncity field is optional, type 'string';
\nstate field is optional, type 'string';
\ncountry field is optional, type 'string';
\nzip field is optional, type 'int';
\nwebsite field is optional, type 'string', max length 255 characters;
\nisArchived field is optional, type 'boolean';
\nArchive an existing company (soft delete) by setting isArchived = true.\nThe company must currently be non-archived and must belong to the\nauthenticated partner. Returns the updated client record(s).
Fields:
\nId parameter can be added either to request body or request url.
\n","urlObject":{"path":["v3","api","company"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"6d74d0a6-0971-4526-be50-8d68a1166896","name":"Company archived successfully. Returns the updated client record(s).","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"id\": 1842\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/v3/api/company"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 1842,\n \"companyName\": \"Acme Cafes\",\n \"companyType\": \"Cafes\",\n \"partner\": 7,\n \"isArchived\": true,\n \"updatedAt\": 1748275200000\n }\n]"},{"id":"f158956a-1d4e-473d-a3d3-3a7f42bb083d","name":"Validation or processing error.","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"id\": 1842\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/v3/api/company"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"details\": \"Id parameter missing\"\n}"},{"id":"950a042f-8b09-4651-a7b2-ba1ccf36950b","name":"Missing or invalid `Authorization` header, or partner is archived / not in `Active` status.","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"id\": 1842\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/v3/api/company"},"status":"Forbidden","code":403,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"df163075-a3e0-4d11-9dd9-61450f500c4a"},{"name":"GET companies","id":"94d06627-09ac-44a4-91cc-41a8763ddc54","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"{{baseUrl}}/v3/api/company","description":"List every non-archived company belonging to the authenticated partner.\nEach entry is enriched with the company's brands and the regions\n(\"states\") under each brand. Throws a 400 with \"No companies found\"\nif the partner has no companies.
Params:
\nCreate a company and its first admin user in one call. The company is provisioned as Cafes, Inactive, with English-only defaults; the admin user is created with Master Admin role and isTotalGrant and receives an invitation email. An internal \"Create company request\" notification email is also sent to the Localyser team.
Fields:
\nThe system validates the company user email, check the value uniqueness.
\n","urlObject":{"path":["v3","api","company","byOwner"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"e166f839-275e-4665-be98-bd80c33c33b2","name":"Company and admin user created successfully.","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"companyName\": \"Acme Cafes\",\n \"package\": \"Standard\",\n \"firstName\": \"Jane\",\n \"lastName\": \"Doe\",\n \"locationsLimit\": 5,\n \"email\": \"jane@acme.com\",\n \"mobile\": \"+971501234567\",\n \"website\": \"https://acmecafes.com\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/v3/api/company/byOwner"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 1842,\n \"companyName\": \"Acme Cafes\",\n \"package\": \"Standard\"\n}"},{"id":"c65d921e-990f-489c-9a11-9102c610ce2e","name":"Validation error or user-email collision.","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"companyName\": \"Acme Cafes\",\n \"package\": \"Standard\",\n \"firstName\": \"Jane\",\n \"lastName\": \"Doe\",\n \"locationsLimit\": 5,\n \"email\": \"jane@acme.com\",\n \"mobile\": \"+971501234567\",\n \"website\": \"https://acmecafes.com\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/v3/api/company/byOwner"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"details\": \"Company name parameter missing\"\n}"},{"id":"b22caa83-f3c2-4611-88de-635e41c155ba","name":"Missing or invalid `Authorization` header, or partner is archived / not in `Active` status.","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"companyName\": \"Acme Cafes\",\n \"package\": \"Standard\",\n \"firstName\": \"Jane\",\n \"lastName\": \"Doe\",\n \"locationsLimit\": 5,\n \"email\": \"jane@acme.com\",\n \"mobile\": \"+971501234567\",\n \"website\": \"https://acmecafes.com\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/v3/api/company/byOwner"},"status":"Forbidden","code":403,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"79d54814-8b3d-44d0-bd43-9a0b0fdfdcd6"},{"name":"GET company by id","id":"97d2079c-fcba-4aca-85af-214565c4d75e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"{{baseUrl}}/v3/api/company/:id","description":"Fetch one company that belongs to the authenticated partner, enriched\nwith the count of in-use locations, the company's users, and the\nper-brand list of regions (\"states\"). Returns 400 if the id is missing\nor does not belong to the partner.
\n","urlObject":{"path":["v3","api","company",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"id":"bfcba13d-ff0a-4936-8a79-83e3f2695f00","type":"any","value":"1842","key":"id"}]}},"response":[{"id":"bf86cb97-7a85-4464-ac1e-989547ff9158","name":"Company found.","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/v3/api/company/:id","host":["{{baseUrl}}"],"path":["v3","api","company",":id"],"variable":[{"key":"id","value":"1842"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 1842,\n \"companyName\": \"Acme Cafes\",\n \"accessToken\": \"a1b2c3d4e5f6g7h8\",\n \"status\": \"Active\",\n \"companyType\": \"Cafes\",\n \"website\": \"https://acmecafes.com\",\n \"address1\": \"12 Main St.\",\n \"address2\": \"Suite 4\",\n \"city\": \"Dubai\",\n \"state\": \"Dubai\",\n \"country\": \"United Arab Emirates\",\n \"timeZone\": \"Asia/Dubai\",\n \"zip\": \"12345\",\n \"sources\": [\n \"Google\",\n \"Facebook\",\n \"TripAdvisor\"\n ],\n \"competitorsSources\": [\n \"Google\",\n \"Facebook\",\n \"TripAdvisor\"\n ],\n \"isArchived\": false,\n \"package\": \"Standard\",\n \"locationsLimit\": 50,\n \"locationsInUse\": 10,\n \"createdAt\": 1748275200000,\n \"updatedAt\": 1748275200000,\n \"users\": [\n {\n \"id\": 5501,\n \"firstName\": \"Jane\",\n \"lastName\": \"Doe\",\n \"email\": \"jane@acme.com\",\n \"mobile\": \"+971501234567\",\n \"role\": \"Master Admin\"\n }\n ],\n \"brands\": [\n {\n \"id\": 901,\n \"title\": \"Acme\",\n \"isDefault\": true,\n \"photoUrl\": \"https://cdn.localyser.com/brands/acme.png\",\n \"locationsCount\": 3,\n \"states\": [\n {\n \"id\": 11,\n \"title\": \"Dubai\",\n \"isDefault\": false\n },\n {\n \"id\": 12,\n \"title\": \"Abu Dhabi\",\n \"isDefault\": false\n }\n ]\n }\n ]\n}"},{"id":"7d7d47c1-a7e7-4d00-80b9-b49c6a359f70","name":"Validation error or company not owned by this partner.","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/v3/api/company/:id","host":["{{baseUrl}}"],"path":["v3","api","company",":id"],"variable":[{"key":"id","value":"1842"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"details\": \"Id parameter missing\"\n}"},{"id":"1830f517-1a00-49ed-aa6d-a985af0cdd01","name":"Missing or invalid `Authorization` header, or partner is archived / not in `Active` status.","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/v3/api/company/:id","host":["{{baseUrl}}"],"path":["v3","api","company",":id"],"variable":[{"key":"id","value":"1842"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"97d2079c-fcba-4aca-85af-214565c4d75e"}],"id":"f47c1513-b022-4c66-88bb-3aa7071ec510","_postman_id":"f47c1513-b022-4c66-88bb-3aa7071ec510","description":""}],"id":"7484a4c4-6591-4bf5-ae2c-a432ef36789f","description":"The Partner API is used exclusively for managing partner companies.
\nUse this API only for partner-level company management operations, including creating, updating, listing, retrieving, and archiving companies associated with a partner.
\nFor all other functionality, such as iframe token generation, reviews, brands, locations, users, states, insights, and other company-level endpoints, use the Company API.
\nSummary:
\nPartner API: company management for partners
\nCompany API: all other operational endpoints
\nUse it to:
\nProvision new clients
\nUpdate company configuration
\nRetrieve company structure (brands, states, users, locations in use)
\nArchive companies that are no longer active
\nAll endpoints are available under the /v3/api prefix and are scoped to a single partner. Every request can only read and modify data belonging to the partner associated with the API key used for authentication.
Every request must include the partner API token in the Authorization header:
Authorization: <partner_api_token>\n\nThe token is issued through the Localyser admin panel and identifies the partner making the request.
\nRequests will return 403 Forbidden if:
\nThe token is missing
\nThe token is malformed
\nThe token is invalid or unrecognized
\nThe partner account is archived
\nThe partner account is not in Active status
\n\n\n<p >Treat API tokens like passwords. If a token is exposed, rotate it immediately.</p>
\n
The /v3/api/company endpoints cover the complete company lifecycle.
POST /v3/api/companyCreate a new company under the authenticated partner.
\nOptional fields include:
\nPackage
\nStatus
\nAddress
\nLocations limit
\nPOST /v3/api/company/byOwnerCreate a company together with its first administrator.
\nFeatures:
\nCreates both the company and admin user in a single request
\nAutomatically sends an invitation email to the new administrator
\nPATCH /v3/api/companyUpdate company-level settings, including:
\nCompany name
\nAddress
\nPackage
\nStatus
\nLocations limit
\nWebsite
\nOther company configuration settings
\nDELETE /v3/api/companySoft-deletes a company by setting:
\n{ \"isArchived\": true}\n\nThe company is preserved in the database but no longer appears in active company listings.
\nGET /v3/api/companyReturns all non-archived companies belonging to the authenticated partner.
\nEach company is enriched with:
\nBrand structure
\nState structure
\nGET /v3/api/company/{id}Returns detailed information for a single company, including:
\nAdmin users
\nLocations currently in use
\nComplete brand hierarchy
\nComplete state hierarchy
\nAll endpoints use:
\nJSON request bodies
\nJSON responses
\nExample 400 response:
{ \"details\": \"Description of the validation failure\"}\n\nServer-side validation includes:
\nString length limits
\nSupported country values
\nUniqueness constraints (e.g. companyName, locationId, etc.)
Refer to the endpoint documentation for complete validation rules.
\nPATCH requests support partial updates.
Any field omitted from the request body retains its existing value.
\nMust be called using the Partner API Key
\nPOST /v3/api/iframe-token\n\nCreates a short-lived JWT that allows an iframe to display company reviews for a specific location.
\nValid for 24 hours โ the generated JWT expires 24 hours after issuance.
\nNo additional authentication required โ once the token is embedded in the iframe URL, the embedded page can access and display the authorized reviews without requiring the end user to log in or provide additional credentials.
\nAdditional Documentation
\nFor complete request and response schemas, validation rules, error catalogs, and implementation examples, refer to the documentation for each endpoint.
\n","_postman_id":"7484a4c4-6591-4bf5-ae2c-a432ef36789f"},{"name":"White Label Solution","item":[{"name":"iframe-token","item":[{"name":"POST IframeToken","id":"7b7d1f72-8f27-4861-ae67-ad64d314cf8c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"api-token","value":"api_key_value"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"locationId\": 12425\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/v3/api/iframe-token?location_id=string","description":"Generate a secure JWT token for iframe integration that allows external applications to embed Localyser reviews with limited, location-specific access.
\nAuthentication: your partner api-key must be provided in the request headers (see the api-token header parameter below).
Token Validity:
\nToken Payload:
\n{\n \"locationId\": \"9650\",\n \"clientId\": 570,\n \"iat\": 1757512711,\n \"exp\": 1757599111\n}\n\nFIelds:
\nLocation 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":"string"}],"variable":[]}},"response":[{"id":"bbf6e2c8-1677-4e9e-a9a1-80eb3ab8f3ab","name":"OK","originalRequest":{"method":"POST","header":[{"key":"api-token","value":"api_key_value"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"locationId\": 12425\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"{{baseUrl}}/v3/api/iframe-token?location_id=string","host":["{{baseUrl}}"],"path":["v3","api","iframe-token"],"query":[{"description":"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.","key":"location_id","value":"string"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"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":"7b7d1f72-8f27-4861-ae67-ad64d314cf8c"},{"name":"GET IFrame Reviews","id":"8d2c39b5-2972-4467-a2ae-93f956a89ded","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{baseUrl}}/reviews?locations=location_id_value&view=[2,3]&auth_token=token_value","description":"The iframe integration supports extensive visual customization through URL query parameters, allowing you to seamlessly integrate Localyser reviews with your application's design.
\nfontFamily โ Use a URL-encoded value (e.g., font stacks with commas or spaces). To apply a non-default browser font, please contact support.
\ncompany โ 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.
Usage Examples
\nBasic Dark Mode:
\n.../reviews?locations=location_value&view=[2,3]&auth_token=auth_token_value&theme=dark\n\nCustom Brand Color:
\n.../reviews?locations=location_value&view=[2,3]&auth_token=auth_token_value&bgColor=f8f9fa&fnColor=212529&btnBgColor=007bff&btnFnColor=ffffff\n\nFormat: Hex color codes WITH the # symbol
\nExample: Use #ffffff or ffffff (both supported)
\nURL Encoding: The # symbol should be URL-encoded as # in URLs
\nAuto-handling: The system handles both formats automatically
\nParameter: theme=dark
\nDescription: Applies a predefined dark theme with dark backgrounds and light text
\nCombination: Can be combined with custom colors to override specific elements
\nPriority: Custom color parameters take precedence over dark theme defaults
\n.../reviews?auth_token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...&view=3&theme=dark&bgColor=2d3748&fnColor=e2e8f0&btnBgColor=4299e1&btnFnColor=ffffff&btnBgColorHover=3182ce\n\nThis example creates a dark-themed iframe with:
\nDark blue-gray background (#2d3748)
\nLight gray text (#e2e8f0)
\nBlue buttons (#4299e1) with white text
\nDarker blue button hover effect (#3182ce)
\nHidden filters (view=3)
\nExample:
\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.
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
The page is hosted on Localyser and supports:
\nauthentication via token
\nUI customization through query parameters
\nhttps://app.localyser.com/settings/other/thirdPartyLogin\n\nauth_token (required)Authentication token used to authorize the user inside the iframe.
\nauth_token=<JWT>\n\nIframe 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></iframe>\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>\nThe 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.
The page is hosted on Localyser and supports:
\nauthentication via token
\nUI customization through query parameters
\nhttps://app.localyser.com/dashboard\n\nauth_token (required)Authentication token used to authorize the user inside the iframe.
\nauth_token=<JWT>\n\nIframe embedding example
\n</div><div>width=\"500px\" height=\"500px\" \n<br></div><div>src=\"https://app.localyser.com/dashboard?locations=11047&view=2&auth_token=YOUR_TOKEN&theme=dark\" \n<br></div><div>title=\"Dashboard\">\n<br></div><div></iframe>\n<br></div><div> src: https://app.localyser.com/dashboard\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>\nThese pages support additional query parameters for data filtering:
\nExample 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\nExample 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\nEmbedding iframe example:
Report overview
</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></iframe>\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></iframe>\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>\nThe Iframe module allows you to securely embed Localyser pages (such as Reviews, Dashboard, or Reporting pages) into your own website or application using an .
\nAuthentication is handled through a short-lived JWT token, so your users can access the embedded Localyser content without logging in separately.
\nEmbedding Localyser content requires only three steps:
\nGet an IFrame token using your Company API Token.
\nInclude the returned token in the iframe URL and use that URL as the src attribute of your iframe.
The authentication token is valid for 24 hours. For security reasons, your backend should request a new token whenever you generate an iframe URL for your users.
\nThe endpoint that generates the iframe authentication token is protected.
\nTo call it, you must include a valid Company API Token in the request.
\nWithout a valid API token, the iframe authentication token cannot be generated and the embedded content will not be accessible.
\nAfter receiving the authentication token, construct the iframe URL by adding it as the auth_token query parameter.
Example:
\nhttps://app.localyser.com/reviews?view=2&auth_token=YOUR_AUTH_TOKEN \n\nThen use that URL as the src of your iframe.
<iframe\n src=\"https://app.localyser.com/reviews?view=2&auth_token=YOUR_AUTH_TOKEN\"\n width=\"100%\"\n height=\"600\"\n frameborder=\"0\"\n allowfullscreen>\n</iframe>\n\nLocalyser offers an iFrame Reviews Widget that allows you to embed review content on your dashboard or app. There are three types of iframe integrations available:
\nView2 - Reviews Only: Displays a list of reviews.
\nView3 - Reviews Filtering: Displays reviews with filtering options.
\nView 2&id - Single Review: Displays a specific review by its ID (see Webhook below).
\nReviews with Filter Pane View3:
\nIndividual Review View2&id:
\nTo use the iframe, you will need to append specific View parameters to the primary /reviews URL: https://app.localyser.com/reviews.
\nThe following parameters are accepted:
\nview=2 (Review without filter)
\nview=3 (Review with filter)
\nview=2&id=reviewId (Single review, replace reviewId with the actual review ID)
\nThe tag is used to embed the content. Here are examples of the iframe code:
\n<iframe src=\"https://app.localyser.com/reviews?id=9508041&view=2\" style=\"width: 100%; height: 100%; overflow: scroll;\" id=\"MyFrame\"></iframe>\n<iframe src=\"https://app.localyser.com/reviews?view=2\" style=\"width: 100%; height: 100%; overflow: scroll;\" id=\"MyFrame\"></iframe>\n<iframe src=\"https://app.localyser.com/reviews?view=3\" style=\"width: 100%; height: 100%; overflow: scroll;\" id=\"MyFrame\"></iframe>\n\nThe Partner Webhook allows you to receive review data directly from Localyser whenever a new review is posted. Hereโs more details.
\nNavigate to the app dashboard: https://app.localyser.com
\nLog in as a valid user.
\nNavigate to Settings - Other.
\nChoose Webhook API.
\nUnder Webhook URL, specify the desired URL that Localyser will send reviews to.
\nOnce saved, you will be provided with a token used for URL verification. Copy this token.
\nMake your endpoint return this token as plain text (content-type: text/plain). Click the Verify button to establish verification.
\nNote: This verification is a one-time operation. You do not need to return the token after verification is complete.
\nAfter successful setup and verification, the system will automatically send reviews to the specified URL whenever new reviews appear in Localyser.
\nSince youโd obtain a per-client API key, you could use it to get the iFrame authentication JWT token per location.
\nBefore accessing the iFrame (or displaying it to your users), youโd have to execute an API call to the Localyser API to get a fresh iFrame Authentication JWT token by sending a POST request to /v3/api/company/iframe-token (payload details will be provided later, the payload will include locationId field to identify the location).
\nThis token will have a TTL of 24 hours, which ensures that it canโt be used in a harmful way. You need to make sure that you execute an API call every time you display the iFrame content.
\nTo enable automatic authentication of the iframe page with Localyser, include the auth_token={authentication_token} parameter in the page URL. For example: reviews?view=2&auth_token={authentication_token}. This allows users to access the Localyser web application without being prompted to log in manually.
\nWe will send you steps on how to add CNAME, MX and TXT on your DNS in order to have all Localyser email notifications sent from notifications@yourdomain.com instead of notifications@localyser.com
\nGET IFrame Reviews
\nThe iframe integration supports extensive visual customization through URL query parameters, allowing you to seamlessly integrate Localyser reviews with your application's design.
\nBasic Dark Mode:
\n.../reviews?locations=location_value&view=[2,3]&auth_token=auth_token_val\n\nCustom Brand Color:
\n.../reviews?locations=location_value&view=[2,3]&auth_token=auth_token_value&bgColor=f8f9fa&fnColor=212529&btnBgColor=007bff&btnFnColor=ffffff\n\nFormat: Hex color codes WITH the # symbol
\nExample: Use #ffffff or ffffff (both supported)
\nURL Encoding: The # symbol should be URL-encoded as # in URLs
\nAuto-handling: The system handles both formats automatically
\nParameter: theme=dark
\nDescription: Applies a predefined dark theme with dark backgrounds and light text
\nCombination: Can be combined with custom colors to override specific elements
\nPriority: Custom color parameters take precedence over dark theme defaults
\n.../reviews?auth_token=your_token&view=3&theme=dark&bgColor=2d3748&fnColor=e2e8f0&btnBgColor=4299e1&btnFnColor=ffffff&btnBgColorHover=3182ce\n\nThis example creates a dark-themed iframe with:
\nDark blue-gray background (#2d3748)
\nLight gray text (#e2e8f0)
\nBlue buttons (#4299e1) with white text
\nDarker blue button hover effect (#3182ce)
\nHidden filters (view=3)
\nExample:
\n.../reviews?locations=...&view=3&btnBgColor=ff6b35&btnFnColor=fff&btnBgColorHover=ff5722&bgColor=2C2C2C&fnColor=f8fafc&bgFnColor=cbd5e1\n\nReporting Pages
\nThese pages support additional query parameters for data filtering:
\nExample Insights with Custom Styling + Filtering:
\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\nExample 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\nOn that page you might access reputation score and net promoter score widgets via iframe access.
\nThis page support additional query parameters for data filtering:
\nExample Insights with Custom Styling + Filtering:
\n.../dashboard?locations=11046&view=3&auth_token=YOUR_TOKEN&theme=dark&date_from=2026-01-12&date_to=2026-02-10\n\nCreate a new location under the authenticated company. Enforces the company's locationsLimit, validates that (title, locationId) is unique system-wide, that the state belongs to the same company, and that every source the company is allowed to use.
Fields:
\nUpdate an existing location belonging to the authenticated company. Any combination of fields can be passed; omitted fields keep their current values. If state is changed the brand title is recomputed.
Fields:
\nHide an existing location belonging to the authenticated company (soft\ndelete โ sets isHidden = true). The location must currently be\nvisible (isHidden = false). Returns the updated location record.
Fields:
\nList the authenticated company's visible (non-hidden) locations, paginated 20 per page. Supports a search query that matches both location title and locationId. Out-of-range page values return an empty locations array (not an error).
Params:
\nRequest return 20 locations per page.
\nIf you set page parameter to value that not exist, system return empty array.
\n","urlObject":{"path":["v3","api","location"],"host":["{{baseUrl}}"],"query":[{"key":"page","value":"1"},{"key":"search","value":"dubai"}],"variable":[]}},"response":[{"id":"8d59c604-eaef-439f-9787-96013a50b6f3","name":"Paginated list of locations.","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/v3/api/location?page=1&search=dubai","host":["{{baseUrl}}"],"path":["v3","api","location"],"query":[{"key":"page","value":"1"},{"key":"search","value":"dubai"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"page\": 1,\n \"perPage\": 20,\n \"totalPages\": 1,\n \"locations\": [\n {\n \"id\": 7741,\n \"title\": \"Acme Cafe โ Dubai Marina\",\n \"locationId\": \"ACME-DXB-MAR-001\",\n \"state\": 11,\n \"brand\": 901,\n \"client\": 1842,\n \"brandTitle\": \"Acme Dubai\",\n \"isHidden\": false,\n \"locationAddress\": \"Marina Walk, Dubai Marina\",\n \"phoneNumber\": \"+97141234567\",\n \"websiteAddress\": \"https://acme.com/dubai-marina\",\n \"google\": \"https://www.google.com/maps/place/acme-dubai-marina\",\n \"zomato\": \"https://www.zomato.com/dubai/acme-dubai-marina\",\n \"facebook\": null,\n \"tripadvisor\": null,\n \"foursquare\": null,\n \"talabat\": null,\n \"hungerStation\": null,\n \"booking\": null,\n \"expedia\": null,\n \"reserveOut\": null,\n \"deliveroo\": \"https://deliveroo.ae/menu/dubai/acme-dubai-marina\",\n \"deliverooOrgId\": \"acme-restaurants\",\n \"deliverooBranchId\": \"acme-marina-1\",\n \"doordashStoreId\": \"doordash-987654\",\n \"profilesCount\": 14,\n \"reviewsCount\": 1287,\n \"countryCode\": \"AE\",\n \"posId\": \"POS-DXB-001\",\n \"ccSupportEmail\": \"support+acme-marina@localyser.com\",\n \"serviceCredentials\": [\n {\n \"id\": 412,\n \"service\": \"google\"\n }\n ],\n \"additionalSources\": [\n {\n \"title\": \"Agoda\",\n \"url\": \"https://www.agoda.com/acme-dubai-marina.html\"\n }\n ]\n }\n ]\n}"},{"id":"fa20ea43-438a-4723-aac7-bf3f9a4b726c","name":"Processing error.","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/v3/api/location?page=1&search=dubai","host":["{{baseUrl}}"],"path":["v3","api","location"],"query":[{"key":"page","value":"1"},{"key":"search","value":"dubai"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"details\": \"Some data base error\"\n}"},{"id":"bbbd9d88-887e-4938-913b-4a06c9560155","name":"Missing or invalid `Authorization` header, or the access token does not match an active, non-archived company.","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/v3/api/location?page=1&search=dubai","host":["{{baseUrl}}"],"path":["v3","api","location"],"query":[{"key":"page","value":"1"},{"key":"search","value":"dubai"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"20f2c363-d9fd-4252-8572-ee4790764930"}],"id":"bc4b6875-4571-42a0-876f-d8265b66bd26","_postman_id":"bc4b6875-4571-42a0-876f-d8265b66bd26","description":""},{"name":"reviews","item":[{"name":"GET reviews","id":"bb444528-a782-4123-af4e-3412a99ad562","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"{{baseUrl}}/v3/api/reviews?page=1&reviewCountPerPage=20&services=google,facebook,tripadvisor&locations=7741,7742&states=11,12&brands=901,902&date_from=2026-01-01&date_to=2026-06-01&rating=4,5&direction=desc&order=date","description":"Returns a paginated list of reviews for the authenticated company.\nSupports filtering by source, brand, state, location, star rating\nand date range, plus sorting by date, sentiment (rating value) or\nreview length, in either direction. Each review entry contains the\nfull underlying review record together with the parent\nbrandTitle and locationId joined in from the state/location\ntables.
Default page size is 20. If page points past the last page, the\nreviews array is empty (it is not an error).
Params:
\npage parameter is optional, by default page = 1;
\nreviewCountPerPage parameter is optional, page size, by\ndefault 20;
\nservices parameter is optional, comma separated source names\n(e.g. google,zomato,facebook,tripadvisor). Validated against the\nlist of supported sources; unknown values throw\nWrong source name <name>;
locations parameter is optional, comma separated location\nids. Each id must belong to the authenticated company; a foreign\nid throws Location id <X> is not your location;
states parameter is optional, comma separated state ids.\nEach id must belong to the authenticated company; a foreign id\nthrows State id <X> is not your state;
brands parameter is optional, comma separated brand ids.\nEach id must belong to the authenticated company; a foreign id\nthrows Brand id <X> is not your brand;
date_from parameter is optional, format yyyy-mm-dd, lower\nbound on the review's date;
date_to parameter is optional, format yyyy-mm-dd, upper\nbound on the review's date;
rating parameter is optional, comma separated star values\nfrom 1 to 5; any other value throws\nWrong rating value <X> use 1,2,3,4,5;
direction parameter is optional, sort direction asc or\ndesc, default desc;
order parameter is optional, sort key โ date (default),\nsentiment (= rating value) or length (= length of\nreviewText).
Returns a paginated list of the authenticated company's visible\n(non-hidden) locations, each annotated with average star rating\nand total review count per source. Per-source stats are nested\nunder dynamic keys matching the source name (e.g. google,\nfacebook, zomato, ...) โ only sources with at least one\nreview for that location are present.
Returns 20 locations per page. If page points past the last\npage, the locations array is empty (it is not an error).
Params:
\nCreate a new user under the authenticated company. The user is created\nwith isEnabled = true and isTotalGrant = true, and immediately receives\nan invitation email so they can set their own password. Accepts\ncompanyId body field that resolves to a company belonging to that\npartner.
\nFields:
\nUpdate an existing user that belongs to the authenticated company. All\nbody fields except id are optional; omitted fields keep their\ncurrent values. If email is changed it must not collide with any\nexisting user.
Fields:
\nPermanently delete a user that belongs to the authenticated company.\nReturns the deleted user record.
\nFields:
\nList every user belonging to the authenticated company. Supports an\noptional search query that matches against the user's name and\nemail.
Params:
\nCreate a new state (region) under an existing brand of the\nauthenticated company. The (title, brand) pair must be unique. The\nbrand must belong to the same company.
Fields:
\nUpdate a state's title and/or move it under a different brand. The\nstate and the target brand must both belong to the authenticated\ncompany. The resulting (title, brand) pair must remain unique.
Fields:
\nOne of the optional fields should be passed.
\n","urlObject":{"path":["v3","api","state"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"ee4e0d0f-0253-444b-af00-bee052af6ceb","name":"State updated successfully.","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"id\": 11,\n \"title\": \"Dubai Marina\",\n \"brand\": 901\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/v3/api/state"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 11,\n \"title\": \"Dubai Marina\",\n \"brandTitle\": \"Acme\",\n \"brand\": 901,\n \"client\": 1842,\n \"createdAt\": 1748275200000,\n \"updatedAt\": 1748361600000,\n \"isDefault\": false\n}"},{"id":"a3c4bc84-9af6-4653-b94c-05ab41875b6f","name":"Validation or processing error.","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"id\": 11,\n \"title\": \"Dubai Marina\",\n \"brand\": 901\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/v3/api/state"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"details\": \"Id parameter missing\"\n}"},{"id":"edd48e38-f355-41a5-9e75-c2d8b2e76bf3","name":"Missing or invalid `Authorization` header, or the access token does not match an active, non-archived company.","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"id\": 11,\n \"title\": \"Dubai Marina\",\n \"brand\": 901\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/v3/api/state"},"status":"Forbidden","code":403,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"70c858e9-7a89-4222-b235-fd1156a6fd02"},{"name":"DELETE state","id":"208d285d-0a8d-46c3-bdee-61be3dc5ad25","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"id\": 11\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/v3/api/state","description":"Delete a state belonging to the authenticated company. The state must\nbelong to the same company. Locations under this state will be\nreassigned to the brand's default state.
\nFields:
\nList every state belonging to the authenticated company. Returns only\nthe core fields: id, title, brandTitle, client, brand.
Returns the tree of sentiment insight categories applicable to the\nauthenticated client's companyType. Each top-level entry is a\nprimary category and may contain child secondary categories under\nchildren. A primary category that has no real children gets a\nsingle synthetic child titled \"<Category> General\" so that the\nclient always renders a leaf row.
Used to populate filter selectors and chart legends. No filtering;\nthe response is fully determined by the client's company type.
\n","urlObject":{"path":["v3","api","insights","categories"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"68ab543b-3572-4690-84a3-fc9c3bffa804","name":"Category tree for the client's company type.","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"{{baseUrl}}/v3/api/insights/categories"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"title\": \"Service\",\n \"id\": 12,\n \"shortName\": \"Serv\",\n \"shortNegativeName\": \"Bad service\",\n \"key\": 12,\n \"color\": \"#FF6B6B\",\n \"translations\": {\n \"en\": \"Service\",\n \"ar\": \"ุงูุฎุฏู ุฉ\"\n },\n \"children\": [\n {\n \"id\": 22,\n \"title\": \"Staff friendliness\",\n \"shortName\": \"Staff\",\n \"shortNegativeName\": \"Rude staff\",\n \"key\": 22,\n \"color\": null,\n \"translations\": {\n \"en\": \"Staff friendliness\",\n \"ar\": \"ู ูุฏุฉ ุงูู ูุธููู\"\n }\n }\n ]\n },\n {\n \"title\": \"Food\",\n \"id\": 13,\n \"shortName\": \"Food\",\n \"shortNegativeName\": \"Bad food\",\n \"key\": 13,\n \"color\": \"#4ECDC4\",\n \"translations\": {\n \"en\": \"Food\",\n \"ar\": \"ุงูุทุนุงู \"\n },\n \"children\": [\n {\n \"id\": 13,\n \"title\": \"Food General\",\n \"shortName\": \"Food\",\n \"shortNegativeName\": \"Bad food\",\n \"key\": 13,\n \"color\": \"#4ECDC4\",\n \"translations\": {\n \"en\": \"Food\",\n \"ar\": \"ุงูุทุนุงู \"\n }\n }\n ]\n }\n]"},{"id":"c322e473-b035-44bd-81c4-b70c78c1dfd4","name":"Validation or processing error.","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"{{baseUrl}}/v3/api/insights/categories"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"details\": \"Can't find type for company 1842\"\n}"},{"id":"1dbc792d-4ed3-4354-b017-57324b7a84a1","name":"Missing or invalid `Authorization` header, or the access token does not match an active, non-archived company.","originalRequest":{"method":"GET","header":[],"url":"{{baseUrl}}/v3/api/insights/categories"},"status":"Forbidden","code":403,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"9d628ff4-4896-48c5-9a5d-192d3a167b3c"},{"name":"GET sentiment words","id":"5386de04-1adc-4464-96ed-58e071692c9a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"{{baseUrl}}/v3/api/insights/words?services=Google,Facebook&locations=4501,4502&states=11,12&date_from=2026-01-01&date_to=2026-06-01&page=1","description":"Extracts the per-review menuItems field across the filtered review\nset, splits each entry into individual words, and buckets them by\nthe review's ratingValue (โฅ 3 โ positive, otherwise โ\nnegative). Words are normalised to lowercase for grouping but the\noriginal casing is preserved in the response.
The response is always a single-element array; each side is an\nobject keyed by the normalised word, with the original word text\nand the number of occurrences.
Params:
\npage parameter is optional, by default page = 1;
\nservices parameter is optional, comma separated service names;
\nlocations parameter is optional, comma separated location ids;
\nstates parameter is optional, comma separated state ids;
\ndate_from parameter is optional, format yyyy-mm-dd;
\ndate_to parameter is optional, format yyyy-mm-dd;
\nReturns the configured menu-item dictionary as a flat list of\nstrings. This is the dictionary used by the back-office word\nextractor to detect food / menu / product terms inside review text\nand tag them on each Review.menuItems field; the same list is\nuseful client-side as a hint dataset (e.g. autocomplete) when\nnavigating the words endpoint.
Returns every dictionary entry. No filtering.
\n","urlObject":{"path":["v3","api","insights","menu"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"d83678c9-20e7-4cff-900c-70ec6d1f2a2f","name":"Menu-item dictionary (flat list of strings).","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"{{baseUrl}}/v3/api/insights/menu"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n \"latte\",\n \"cappuccino\",\n \"americano\",\n \"cold brew\",\n \"croissant\",\n \"tiramisu\"\n]"},{"id":"b921b04e-0ba1-4ff6-96e6-d1a97a1c038d","name":"Processing error.","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"{{baseUrl}}/v3/api/insights/menu"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"details\": \"Some data base error\"\n}"},{"id":"146ee483-dcb7-4f55-a305-ba12b2763aa6","name":"Missing or invalid `Authorization` header, or the access token does not match an active, non-archived company.","originalRequest":{"method":"GET","header":[],"url":"{{baseUrl}}/v3/api/insights/menu"},"status":"Forbidden","code":403,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"5f12ab08-611f-4894-a5a8-b62ced4804c8"},{"name":"GET secondary insights","id":"8a98765a-4efa-4787-8acb-2673ed2e2258","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"{{baseUrl}}/v3/api/insights/secondary?services=Google,Facebook&locations=4501,4502&states=11,12&date_from=2026-01-01&date_to=2026-06-01&page=1","description":"Returns absolute positive and negative review counts per secondary\n(child) category for the filtered review set, plus the parentId\nlinking each secondary back to its primary. The gap field\n(total / 500) is a rendering hint used by the front-end radar\nchart to space points; fullMark is (pos + neg) * 1.2 so the\nchart always has some headroom above the largest value.
Params:
\npage parameter is optional, by default page = 1;
\nservices parameter is optional, comma separated service names;
\nlocations parameter is optional, comma separated location ids;
\nstates parameter is optional, comma separated state ids;
\ndate_from parameter is optional, format yyyy-mm-dd;
\ndate_to parameter is optional, format yyyy-mm-dd;
\nReturns the positive/negative distribution (as percentages of total\ncategory-tagged reviews) for each primary insight category that\napplies to the client's company type, computed over the filtered\nreview set. Reviews tagged against a secondary category are rolled up\nto their primary parent. Designed to feed the primary radar chart.
\nParams:
\npage parameter is optional, by default page = 1;
\nservices parameter is optional, comma separated service names;
\nlocations parameter is optional, comma separated location ids;
\nstates parameter is optional, comma separated state ids;
\ndate_from parameter is optional, format yyyy-mm-dd;
\ndate_to parameter is optional, format yyyy-mm-dd;
\nCreate a new brand under the authenticated company. The title must not\ncollide with any existing brand under the provided company.
\nFields:
\nUpdate a brand's title. The brand must belong to the authenticated\ncompany, and the new title must not already be in use by another brand\nin that company.
\nFields:
\nDelete a brand belonging to the authenticated company. The brand must\nbelong to the same company. Any states and locations associated with\nthe brand will be reassigned or removed according to the cascade\nrules defined in the data model.
\nFields:
\nList every brand belonging to the authenticated company. Returns the\nraw brand records (no nested states or locations).
\n","urlObject":{"path":["v3","api","brand"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"aa0ad507-3c03-4515-9593-400d4d2f2e77","name":"List of brands belonging to the company.","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"{{baseUrl}}/v3/api/brand"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 901,\n \"title\": \"Acme\",\n \"client\": 1842,\n \"isDefault\": false,\n \"photoUrl\": \"https://cdn.localyser.com/brands/acme.png\",\n \"createdAt\": 1748275200000,\n \"updatedAt\": 1748275200000\n },\n {\n \"id\": 903,\n \"title\": \"Other\",\n \"client\": 1842,\n \"isDefault\": true,\n \"photoUrl\": null,\n \"createdAt\": 1748275200000,\n \"updatedAt\": 1748275200000\n }\n]"},{"id":"2c8c938b-ef46-45f4-ae2a-fb70f8018a9a","name":"Processing error.","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"{{baseUrl}}/v3/api/brand"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"details\": \"Some data base error\"\n}"},{"id":"4571016a-8fdd-44f8-97d2-775dbe443b7d","name":"Missing or invalid `Authorization` header, or the access token does not match an active, non-archived company.","originalRequest":{"method":"GET","header":[],"url":"{{baseUrl}}/v3/api/brand"},"status":"Forbidden","code":403,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"c537aeec-5916-4ada-8650-eb08515807c1"}],"id":"5a0a5344-87de-469a-b351-9df3bc70b70d","_postman_id":"5a0a5344-87de-469a-b351-9df3bc70b70d","description":""}],"id":"94190766-da02-4973-b6c5-1e89d2d32856","description":"The Localyser Company API gives a connected business programmatic access to everything needed to manage its review presence:
\nBrand and region structure
\nPhysical locations
\nTeam members and permissions
\nReviews and replies
\nReview analytics and insights
\nAll endpoints are available under the /v3/api prefix and are automatically scoped to the company associated with the access token used for authentication.
Every request must include a company access token in the Authorization header:
Authorization: <your-company-access-token>\n\nThe token is issued when the company is provisioned and uniquely identifies that company.
\nRequests return 403 Forbidden if:
\nThe token is missing
\nThe token is invalid or unknown
\nThe company is archived
\nThe company is not in Active status
\nThe partner associated with the company is not in Active status
\n\n\n<p >Treat access tokens like passwords. Rotate them immediately if they become exposed.</p>
\n
Endpoint: /v3/api/brand
Brands are used to group locations within a company and support multi-brand organizations.
\nPOST /v3/api/brand\n\nCreates a new brand.
\nRequirements:
\nPATCH /v3/api/brand\n\nRenames an existing brand.
\nDELETE /v3/api/brand\n\nDeletes a brand.
\nAssociated states and locations are handled according to the platform's cascade rules.
\nGET /v3/api/brand\n\nReturns all brands belonging to the company.
\nEndpoint: /v3/api/state
States (regions) belong to a brand and group locations within that brand.
\nUniqueness rule:
\n(title, brand)\n\nmust be unique.
\nPOST /v3/api/state\n\nCreates a state under a specified brand.
\nPATCH /v3/api/state\n\nAllows:
\nRenaming a state
\nMoving a state to another brand
\nDELETE /v3/api/state\n\nDeletes a state.
\nAny child locations are reassigned to the brand's default state.
\nGET /v3/api/state\n\nReturns all states belonging to the company.
\nEndpoint: /v3/api/location
Locations represent the physical places whose reviews are tracked.
\nEach location:
\nBelongs to a state
\nInherits its brand through the state
\nCan be connected to multiple review platforms
\nSupported sources include:
\nTripAdvisor
\nZomato
\nBooking
\nTalabat
\nHungerStation
\nExpedia
\nDeliveroo
\nDoorDash
\nOther supported review services
\nPOST /v3/api/location\n\nCreates a location with:
\nSource URLs
\nContact information
\nLocation metadata
\nThe endpoint enforces the company's locationsLimit.
PATCH /v3/api/location\n\nAllows updates to:
\nTitle
\nAddress
\nContact details
\nSource connections
\nState assignment
\nDELETE /v3/api/location\n\nSoft-deletes a location:
\n{ \"isHidden\": true}\n\nGET /v3/api/location\n\nReturns a paginated list of visible locations with full configuration details, including:
\nPrimary review sources
\nAdditional review sources
\nDelivery integration IDs
\nCountry code
\nService credentials
\nCustomer support email
\nPOS ID
\nEndpoint: /v3/api/user
Manage users who have access to company data.
\nPOST /v3/api/user\n\nCreates a new user invitation with a specified role.
\nPATCH /v3/api/user\n\nAllows updates to:
\nName
\nRole
\nAccess scope
\nDELETE /v3/api/user\n\nRemoves a user from the company.
\nGET /v3/api/user\n\nReturns all users belonging to the company.
\nGET /v3/api/reviews\n\nReturns a paginated feed of reviews.
\nServices (review sources)
\nBrands
\nStates
\nLocations
\nStar ratings
\nDate ranges
\nReview date
\nSentiment score
\nReview length
\nSorting can be performed in ascending or descending order.
\nEach review includes:
\nFull review data
\nbrandTitle
locationId
GET /v3/api/locations/reviews\n\nReturns per-location review statistics:
\nAverage rating
\nReview count
\nBreakdown by source
\nUseful for dashboards and overview pages.
\nEndpoint: /v3/api/insights/\\\\*
Insights are analytics generated from the review dataset.
\nAll insight endpoints support the same filtering model:
\nserviceslocationsstatesdate_fromdate_topage\n\nResults are automatically restricted to locations owned by the authenticated company.
\nGET /v3/api/insights/categories\n\nReturns the sentiment-category hierarchy configured for the company's companyType.
GET /v3/api/insights/primary\n\nReturns positive and negative sentiment percentages grouped by primary insight categories.
\nGET /v3/api/insights/secondary\n\nReturns:
\nPositive review counts
\nNegative review counts
\nParent category relationships
\nRadar-chart rendering metadata
\nGET /v3/api/insights/menu\n\nReturns the configured menu-item dictionary used by the word extraction engine.
\nGET /v3/api/insights/words\n\nReturns extracted words grouped by sentiment.
\nEach word includes:
\nSentiment bucket
\nOccurrence count
\nThe data is generated from review menu-item content.
\nJSON request bodies
\nJSON responses
\nExample validation error:
\n{ \"details\": \"Validation error description\"}\n\nDefault page size: 20 items
\nOut-of-range pages return an empty array
\nNo error is generated for empty pages
\nMultiple values are provided as comma-separated strings:
\nservices=google,facebook,tripadvisorrating=4,5\n\nAll endpoints automatically scope data to the authenticated company.
\nRequests that reference resources belonging to another company (brands, states, locations, etc.) are rejected with:
\n400 Bad Request\n\nPATCH endpoints support partial updates.
Any omitted field preserves its current value.
\nFor complete request and response schemas, validation rules, parameter catalogs, error examples, and sample payloads, refer to the individual endpoint reference documentation.
\n","_postman_id":"94190766-da02-4973-b6c5-1e89d2d32856"}]}