{"info":{"_postman_id":"ee74364f-0d5b-4d0c-89bd-c4b85ff3cbd3","name":"Reputation API","description":"

Overview

\n\n

Reputation's API offers a seamless pathway for data integration and management. This robust interface allows for smooth integration with the Reputation platform.

Our REST APIs enable you to aggregate feedback, assess metrics, and streamline operations within your environment. Explore our documentation, complete with detailed code samples, and endpoint insights.

Getting Started

Obtain an API key by contacting your customer success manager.
\n
Discuss additional resources you need so they can guide you through the initial setup and test calls.
\n
Ensure your API key is included in your request headers.
\n
Use our endpoints to access the desired resources and functions.
\n

What You Should Know

The Reputation API delivers responses in JSON format. For GET requests, the Accept HTTP Header may be necessary, while POST and PUT requests often require the Content-Type HTTP Header set to application/json.
\n
The API is language agnostic, allowing you to use any HTTP client—be it Postman, cURL, or others—for requests.
\n

For example: A bash script to list all tenants would follow this structure.

#!/bin/bash \\\nACCESS_TOKEN=\\\"API_KEY\\\" \\\ncurl \\\n    -H \\\"Content-Type: application/json\\\" \\\n    -H \\\"X-API-KEY: $ACCESS_TOKEN\\\" \\\n    -X $ACTION\n    \\\"https://api.reputation.com/v3/tenants\\\"\n\n

TLS Cipher Policy

Our TLS Cipher Policy outlines a list of approved cryptographic algorithms, known as TLS ciphers, which are used in the Transport Layer Security (TLS) protocol. These ciphers ensure the secure transmission of data by encrypting the communication between a client and server. To comply with this policy, you must use one of the ciphers listed below:

- TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA\n- TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256\n- TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA\n- TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384\n- TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256\n- TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA\n- TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256\n- TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA\n- TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384\n- TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256\n- TLS_RSA_WITH_3DES_EDE_CBC_SHA\n- TLS_RSA_WITH_AES_128_CBC_SHA\n- TLS_RSA_WITH_AES_128_GCM_SHA256\n- TLS_RSA_WITH_AES_256_CBC_SHA\n- TLS_RSA_WITH_AES_256_GCM_SHA384\n\n

Agency API Keys

An Agency API key refers to a distinct type of API key issued to agencies on the Reputation platform, allowing them to manage resources across multiple clients or tenants. Each tenant represents a unique entity or client with its own set of data and configurations.

When interacting with the platform using the Agency API key, it's essential to specify the target tenant for each request, by including the TENANT ID in the request header. This ensures actions are appropriately scoped and directed to the correct tenant's resources.

The following example shows a simple bash script to list all locations for a particular tenant.

#!/bin/bash \\\nACCESS_TOKEN=\\\"API_KEY\\\" \\\nTENANT_ID=\\\"TENANT_ID\\\" \\\ncurl \\\n    -H \\\"Content-Type: application/json\\\" \\\n    -H \\\"X-API-KEY: $ACCESS_TOKEN\\\" \\\n    -H \\\"X-TENANT-ID: $TENANT_ID\\\" \\\n    -X $ACTION\n    \\\"https://api.reputation.com/v3/locations\\\"\n\n

Validation

Every incoming request undergoes validation. If the desired resource is absent, a 404 (Not found) HTTP status code is returned. Should the validation not pass, a 403 (Forbidden) status code is issued.

Any validation issues are detailed in the response as a collection of error objects.

Errors

The following is a list of error parameters.

Parameter	Parent	Data Type	Description
`errors`		Object Array	An array of `error` objects.
`error`	`errors`	Object	An object containing error details.
`field`	`error`	String	Name of the field which failed validation.
`code`	`error`	String	Validation failure code.
`message`	`error`	String	Message explaining the `code`.

\n\n

Status Codes

HTTP Status Code	Result
200	Ok
400	Bad Parameters Account is locked Invalid Parameters Missing Parameters
401	Unauthorized: API Key is invalid
403	Forbidden: API Key is not permitted the operation
404	Resource Not Found: Missing Tenant Id Missing Location Id Missing Source Id
405	Action not supported by this method
429	Too many requests. API rate limit exceeded
500	Internal Server Error
504	Timeout

\n\n

Pagination

For endpoints returning multiple results, the user data is paginated, with a default limit set to 20. The response will feature a pagination object containing the subsequent fields:

Parameter	Data Type	Description
`offset`	Integer	This offsets the start of each page by the number specified
`limit`	Integer	This is the maximum number of objects that may be returned. A query may return fewer than the value of limit due to filtering.
`next`	String	API endpoint that will return the next page of data. If not included, this is the last page of data.
`previous`	String	API endpoint that will return the previous page of data. If not included, this is the first page of data.

\n\n

Date Range

When interacting with endpoints that accommodate date ranges, the response will contain a specific range object. This object includes the following fields:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Description
`range`	The specified date range
`from`	The start date of the range
`to`	The end date of the range

Each field provides insight into the range used for the data retrieval or filtering in the response.

Endpoints

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Overview","slug":"overview"}],"owner":"17280339","collectionId":"ee74364f-0d5b-4d0c-89bd-c4b85ff3cbd3","publishedId":"2s83YWk4kZ","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"004F5D"},"publishDate":"2023-09-21T10:09:42.000Z"},"item":[{"name":"/Asset Library","item":[{"name":"Upload Image Files","id":"02773d2d-e349-4ac5-bf13-4c7ca398c9e7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"multipart/form-data"},{"key":"Accept","value":"application/json"},{"key":"x-api-key","value":""}],"body":{"mode":"formdata","formdata":[{"key":"images","description":"

(Required) Choose one or multiple image files from your computer. There's no limit to how many you can upload.

\n","type":"file"},{"key":"tags","value":"[Key:Value]","description":"

Provide a valid JSON string with image file names as keys and their respective tags as values. For example: {\"image1.jpg\": [\"tag1\", \"tag2\"], \"image2.jpg\": [\"tag2\", \"tag3\"]}.

\n","type":"text"}]},"url":"{{baseUrl}}/asset-library/upload/image","description":"

Select any number of files from your computer. Attach tags to each image and send them as formData in the API request. The images will display in your Asset Library (see below).

\n\n

You must request to have the asset library enabled. Please contact your CSM for assistance.

Note: This endpoint only accepts .jpg, .jpeg, or .png files.

Sample Requests

\n\n

Python

import requests\nfile_1 = ('ImageFile_1.png', open('path_to_ImageFile_1.png', 'rb'))\nfile_2 = ('ImageFile_2.png', open('path_to_ImageFile_2.png', 'rb'))\ntags = '{\"ImageFile_1.png\":[\"tag1\", \"tag2\"], \"ImageFile_2.png\" : [\"tag3\"]}'\nurl = \"http://localhost:8082/v3/asset-library/upload/image\"\nheaders = {\n    \"x-api-key\": \"Enter_Api_Key_here\"\n}\nfiles = {\n    'images': file_1,\n    'images': file_2,\n    'tags': (None, tags)\n}\nresponse = requests.post(url, headers=headers, files=files)\nprint(response.text)\n\n

Javascript XHR

\n\n

    var data = new FormData();\n    data.append(\"images\", fileInput.files[0], \"ImageFile_1.png\");\n    data.append(\"images\", fileInput.files[0], \"ImageFile_2.png\");\n    data.append(\"tags\", \"{\\\"ImageFile_1.png\\\":[\\\"tag1\\\", \\\"tag2\\\"], \\\"ImageFile_2.png\\\" : [\\\"tag3\\\",]}\");\nvar xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\nxhr.addEventListener(\"readystatechange\", function() {\nif(this.readyState === 4) {\n    console.log(this.responseText);\n}\n});\nxhr.open(\"POST\", \"http://localhost:8082/v3/asset-library/upload/image\");\nxhr.setRequestHeader(\"x-api-key\", \"Enter_Api_Key_here\");\nxhr.send(data);\n\n

Returned Parameters

Data returned by this endpoint.

\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

Parameter	Parent	Data Type	Description
`addedImages`		Object Array	An array that contains details about successfully added images to the asset library.
`name`	`addedImages`	String	The filename of the image - ex. `Lobby.png`
`url`	`addedImages`	String	URL where the image can be accessed - ex. `assets.reputation.com`
`description`	`addedImages`	String	Assigned description for the image - ex. `Lobby.png`
`tags`	`addedImages`	String Array	An array of tags associated with the image for easy search or categorization - ex. [`entrance, decore]`
`modules`	`addedImages`	String Array	An array of modules in the platform where the image is used or associated ex. [`Listings,Pages,Social`]
`failedImages`		Object Array	An array that holds details about images that failed to be added to the asset library.
`image`	`failedImages`	String	The filename of the failed image - ex. `Lobby_Video.mp4`
`error`	`failedImages`	String	Reason the image failed to upload - ex - `File extension not supported.`

","urlObject":{"path":["asset-library","upload","image"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"9c92aed9-0f89-4364-912a-817e330aa237","name":"Success","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"Your API key"}],"body":{"mode":"formdata","formdata":[{"key":"images","description":"(Required) Select single image file or multiple image files from the computer. There is no limit on number of images that can be uploaded.","type":"file"},{"key":"tags","value":"{\"image1.png\":[\"Entrance\", \"Office\"],\"image2.mp4\":[\"View\",\"Decore\"]}","description":" Valid json string containing key value pairs where image file name is key and list of tag( tag name) is the value. Example {\"image1.jpg\":[\"tag1\", \"tag1\"],\"image2.jpg\":[\"tag2\", \"tag3\"]}","type":"text"}]},"url":"https://api.reputation.com/v3/asset-library/upload/image"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"addedImages\": [\n {\n \"name\": \"1695566027667_Lobby.png\",\n \"url\": \"https://assets.reputation.com/assets/f631eb0f561/1695566027667_Lobby.png\",\n \"description\": \"1695566027667_Lobby.png\",\n \"tags\": [\n \"Entrance\",\n \"View\"\n ],\n \"modules\": [\n \"Listings\",\n \"Pages\",\n \"Social\"\n ]\n }\n ],\n \"failedImages\": [\n {\n \"image\": \"1695566027899_Lobby_Video.mp4\",\n \"error\": \"File extension not supported: mp4\"\n }\n ]\n}"}],"_postman_id":"02773d2d-e349-4ac5-bf13-4c7ca398c9e7"},{"name":"Upload Image Using Public Urls","id":"070efdda-0a0d-43eb-b6b6-56662d3e9b4a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"x-api-key","value":""}],"body":{"mode":"raw","raw":"{\n \"images\": [\n {\n \"url\": \"string\",\n \"tags\": [\n \"string\"\n ]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/asset-library/upload/image/url","description":"

Upload images to your asset library using a public URL rather than a direct file upload. The images will display in your Asset Library (see below).

\n\n

You must request to have the asset library enabled. Please contact your CSM for assistance.

Note: This endpoint only accepts .jpg, .jpeg, or .png files.

Sample Requests

\n\n

Python

import requests\nimport json\ndata = {\n    \"images\": [\n        {\n            \"url\": \"https://www.testImageUrl.com/image_1.jpg\",\n            \"tags\": [\"test_tag_1\", \"test_tag_2\"]\n        },\n        {\n            \"url\": \"https://www.testImageUrl.com/image_2.jpg\",\n            \"tags\": [\"test_tag_3\", \"test_tag_2\"]\n        }\n    ]\n}\nurl = \"https://api.reputation.com/v3/asset-library/upload/image/url\"\nheaders = {\n    \"x-api-key\": \"Enter_Api_Key_here\",\n    \"Content-Type\": \"application/json\"\n}\nresponse = requests.post(url, headers=headers, data=json.dumps(data))\nprint(response.text)\n\n

Javascript XHR

\n\n

    var data = JSON.stringify({\n      \"images\": [\n        {\n          \"url\": \"https://www.testImageUrl.com/image_1.jpg\",\n          \"tags\": [\n            \"test_tag_1\",\n            \"test_tag_2\"\n          ]\n        },\n        {\n          \"url\": \"https://www.testImageUrl.com/image_2.jpg\",\n          \"tags\": [\n            \"test_tag_3\",\n            \"test_tag_2\"\n          ]\n        }\n      ]\n    });\nvar xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\nxhr.addEventListener(\"readystatechange\", function() {\n  if(this.readyState === 4) {\n    console.log(this.responseText);\n  }\n});\nxhr.open(\"POST\", \"https://api.reputation.com/v3/asset-library/upload/image/url\");\nxhr.setRequestHeader(\"x-api-key\", \"Enter_Api_Key_here\");\nxhr.setRequestHeader(\"Content-Type\", \"application/json\");\nxhr.send(data);\n\n

Parameter Descriptions

\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\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Parent	Data Type	Description
`addedImages`		Object Array	An array that contains details about successfully added images to the asset library.
`name`	`addedImages`	String	Image's assigned name. Typically a portion of the image's original URL path - ex. `images/Reputation_Logo_Horizontal_Dark.svg`
`url`	`addedImages`	String	New URL where the image can be accessed - ex. `assets.reputation.com`
`description`	`addedImages`	String	Assigned description for the image - ex. `images/Reputation_Logo_Horizontal_Dark.svg`
`tags`	`addedImages`	Object Array	An array of tag objects associated with the image.
`id`	`tags`	String	Unique tag identifier - ex. `5023110`
`agencyID`	`tags`	String	Agency ID number - ex. `1`
`tenantID`	`tags`	String	Tenant ID number - ex. `1990`
`name`	`tags`	String	Tag name - ex. `Logo`
`modules`	`tags`	String Array	An array of modules in the platform where the tags will be used or associated ex. [`Listings, Pages, Social`]
`modules`	`addedImages`	String Array	An array of modules in the platform where the image is used or associated ex. [`Listings,Pages,Social`]
`failedImages`		Object Array	An array that holds details about images that failed to be added to the asset library.
`image`	`failedImages`	String	The filename of the failed image - ex. `Lobby_Video.mp4`
`error`	`failedImages`	String	Reason the image failed to upload - ex - `File extension not supported.`

","urlObject":{"path":["asset-library","upload","image","url"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"0af7b114-c169-41dd-889c-953ff048fe8c","name":"Success","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"Your API key"}],"body":{"mode":"raw","raw":"{\n \"images\": [\n {\n \"url\": \"https://reputation.com/wp-content/themes/reputation/dist/images/Reputation_Logo_Horizontal_Dark.svg\",\n \"tags\": [\n \"Logo\",\n \"Brand\"\n ]\n \n },\n {\n \"url\": \"https://youtu.be/8-_hnHwrodc\",\n \"tags\": [\n \"Education\",\n \"Learn\"\n ]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.reputation.com/v3/asset-library/upload/image/url"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"902"},{"key":"etag","value":"W/\"386-5mfwsLc6aqDijBvxolpJT6hOFvY\""},{"key":"date","value":"Sun, 24 Sep 2023 19:59:54 GMT"},{"key":"x-envoy-upstream-service-time","value":"2588"},{"key":"server","value":"istio-envoy"},{"key":"Via","value":"1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"addedImages\": [\n {\n \"name\": \"/wp-content/themes/reputation/dist/images/Reputation_Logo_Horizontal_Dark.svg.null\",\n \"url\": \"https://assets.reputation.com/assets/f631eb0f561/wp-content/themes/reputation/dist/images/Reputation_Logo_Horizontal_Dark.svg.null\",\n \"description\": \"/wp-content/themes/reputation/dist/images/Reputation_Logo_Horizontal_Dark.svg.null\",\n \"tags\": [\n {\n \"id\": 5023110,\n \"agencyID\": 1,\n \"tenantID\": 1990,\n \"name\": \"Logo\",\n \"modules\": [\n \"Listings\",\n \"Pages\",\n \"Social\"\n ]\n }\n ],\n \"modules\": [\n \"Listings\",\n \"Pages\",\n \"Social\"\n ]\n },\n {\n \"name\": \"/8-_hnHwrodc.html\",\n \"url\": \"https://assets.reputation.com/assets/f631eb0f561/8-_hnHwrodc.html\",\n \"description\": \"/8-_hnHwrodc.html\",\n \"tags\": [\n {\n \"id\": 5023111,\n \"agencyID\": 1,\n \"tenantID\": 1990,\n \"name\": \"Education\",\n \"modules\": [\n \"Listings\",\n \"Pages\",\n \"Social\"\n ]\n },\n {\n \"id\": 5023112,\n \"agencyID\": 1,\n \"tenantID\": 1990,\n \"name\": \"Learn\",\n \"modules\": [\n \"Listings\",\n \"Pages\",\n \"Social\"\n ]\n }\n ],\n \"modules\": [\n \"Listings\",\n \"Pages\",\n \"Social\"\n ]\n }\n ],\n \"failedImages\": []\n}"}],"_postman_id":"070efdda-0a0d-43eb-b6b6-56662d3e9b4a"}],"id":"0305f87a-1fb4-49da-85e9-09fec6c7a108","description":"

Use the Asset Library collection to upload assets like images to your Reputation platform.

\n","_postman_id":"0305f87a-1fb4-49da-85e9-09fec6c7a108"},{"name":"/Authorize","item":[{"name":"Authorize","id":"02e713f5-aea4-448f-81e0-c26a129391c7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"x-api-key","value":""}],"body":{"mode":"raw","raw":"{\n \"userId\": \"string\",\n \"locationCodes\": \"string array\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"email\": \"string\",\n \"role\": \"string\",\n \"timezone\": \"string\"\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/authorize","description":"

Authorize a user on your platform, either granting them access or updating their permissions based on provided personal and role-specific details.

Sample Requests

Python

import requests\nimport json\nurl = 'https://api.reputation.com/v3/authorize'\nheaders = {\n    'x-api-key': 'Your API key',\n    'Content-Type': 'application/json;charset=UTF-8'\n}\ndata = {\n    \"userId\": \"346345\",\n    \"locationCodes\": \"145, 742, 520\",\n    \"firstName\": \"Jeff\",\n    \"lastName\": \"Goodman\",\n    \"email\": \"john@goodman.com\",\n    \"role\": \"Admin\",\n    \"timezone\": \"America/Los_Angeles\"\n}\nresponse = requests.post(url, headers=headers, data=json.dumps(data))\nif response.status_code >= 200 and response.status_code < 400:\n    print(response.text)\nelse:\n    print(\"Error: \", response.text)\n\n

JavaScript XHR

var xhr = new XMLHttpRequest();\nxhr.open('POST', 'https://api.reputation.com/v3/authorize', true);\nxhr.setRequestHeader('x-api-key', 'Your API key');\nxhr.setRequestHeader('Content-Type', 'application/json;charset=UTF-8');\nxhr.onload = function() {\n    if (xhr.status >= 200 && xhr.status < 400) {\n        console.log(xhr.responseText);\n    } else {\n        console.error(\"Error: \", xhr.responseText);\n    }\n};\nxhr.onerror = function() {\n    console.error(\"Network error\");\n};\nvar data = JSON.stringify({\n    \"userId\": \"346345\",\n    \"locationCodes\": \"145, 742, 520\",\n    \"firstName\": \"Jeff\",\n    \"lastName\": \"Goodman\",\n    \"email\": \"john@goodman.com\",\n    \"role\": \"Admin\",\n    \"timezone\": \"America/Los_Angeles\"\n});\nxhr.send(data);\n\n

Parameter Descriptions

Request Parameters

\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

Parameter	Data Type	Description
userID	String	Unique identifier for the user - ex. \"346345\"
locationCodes	String Array	Comma-separated codes representing the user's associated locations or branches - ex. \"145, 742, 520\"
firstName	String	First name of the user - ex. \"Jeff\"
lastName	String	Last name of the user - ex. \"Goodman\"
email	String	Email address associated with the user's account - ex. \"john@goodman.com\"
role	String	Role assigned to the user - ex. Admin Find your role permissions in the platform.
timezone	String	Timezone Id. Example timezone ids can be found on Momentjs's interactive timezone map https://momentjs.com/timezone - ex. \"America/Los_Angeles\"
path	String	Redirect to product-specific landing page. Valid values. Actions, Dashboard, Insights, Listings, RepScore, Reports, Requests, Reviews, Social, or Surveys. Default value is Dashboard

Response Parameters

\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

Parameter	Data Type	Description
token	String	An authentication or session token generated for the user - ex. b8b9e16131777f141a0ca38dc2e69777
authorize_token	String	A specialized token dedicated to user authorization. It might be used in certain contexts where specific or granular permissions are required - ex. b8b9e16131777f141a0ca38dc2e69778
redirectURL	String	This is a URL to which the user is redirected - ex. https://app.reputation.com/auth-sso?token=b8b9e16131b22f141a0ca38dc2e69777

","urlObject":{"path":["authorize"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"a40f7767-e08c-4e02-b7f5-dc2b3bd5df5c","name":"Success","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"Your API key"}],"body":{"mode":"raw","raw":"{\n \"userId\": \"346345\",\n \"locationCodes\": \"145, 742, 520\",\n \"firstName\": \"Jeff\",\n \"lastName\": \"Goodman\",\n \"email\": \"john@goodman.com\",\n \"role\": \"Admin\",\n \"timezone\": \"America/Los_Angeles\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.reputation.com/v3/authorize"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"188"},{"key":"etag","value":"W/\"bc-Fh+drIMqdRT7GfcPNeh5PeIIq/c\""},{"key":"date","value":"Sun, 24 Sep 2023 21:51:05 GMT"},{"key":"x-envoy-upstream-service-time","value":"212"},{"key":"server","value":"istio-envoy"},{"key":"Via","value":"1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"token\": \"b8b9e16131b22f141a0ca38dc2e69377\",\n \"authorize_token\": \"b8b9e16131b22f141a0ca38dc2e69377\",\n \"redirectUrl\": \"https://app.reputation.com/auth-sso?token=b8b9e16131b22f141a0ca38dc2e69777\"\n}"}],"_postman_id":"02e713f5-aea4-448f-81e0-c26a129391c7"}],"id":"8af3f7c7-4009-407e-9108-abb138f10d21","description":"

Use this collection to authorize users and configure roles.

\n","_postman_id":"8af3f7c7-4009-407e-9108-abb138f10d21"},{"name":"/Categories","item":[{"name":"Get Categories","id":"5e3d326d-d80d-4538-a536-68ad60fd2a7d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"x-api-key","value":""}],"body":{"mode":"raw","raw":""},"url":"{{baseUrl}}/categories?offset=&limit=","description":"

Provides the Business Listings categories for each profile, detailing each category's associated industries and identifiers.

Sample Requests

Python

import requests\nurl = 'https://api.reputation.com/v3/categories?offset=0&limit=3'\nheaders = {\n    'x-api-key': 'Your API Key',\n    'Content-Type': 'application/json;charset=UTF-8'\n}\nresponse = requests.get(url, headers=headers)\nif response.status_code >= 200 and response.status_code < 400:\n    print(response.text)\nelse:\n    print(\"Error: \", response.text)\n\n

JavaScript XHR

var xhr = new XMLHttpRequest();\nxhr.open('GET', 'https://api.reputation.com/v3/categories?offset=0&limit=3', true);\nxhr.setRequestHeader('x-api-key', 'Your API Key');\nxhr.setRequestHeader('Content-Type', 'application/json;charset=UTF-8');\nxhr.onload = function() {\n    if (xhr.status >= 200 && xhr.status < 400) {\n        console.log(xhr.responseText);\n    } else {\n        console.error(\"Error: \", xhr.responseText);\n    }\n};\nxhr.onerror = function() {\n    console.error(\"Network error\");\n};\nxhr.send();\n\n

Response Parameters

\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

Parameter	Parent	Data Type	Description
categories	-	Object Array	An array of category objects, each detailing a specific category available on the Reputation platform.
id	categories	String	A unique identifier for the category, often hinting at its industry or nature ex. \"RESTAURANTS_\"
industryIDs	categories	String Array	An array of specific industries or sectors associated with the category, representing finer classifications or branches within the main category ex. [\"restaurant-bars\", \"restaurant-fast-food\", \"restaurant-fine-dining\"]
name	categories	String	The human-readable name of the category, representing its primary classification or theme - ex. \"Restaurants\"
paging		Object	An object detailing pagination information for the categories list, indicating how the list can be traversed in chunks or pages.
offset	paging	Integer	The starting point or index from where the current list of categories begins, typically used in conjunction with the limitto paginate results - ex. 0
limit	paging	Integer	Determines the number of items returned in the current response. This is distinct from rate limiting and refers to the size of the data set returned, which is controlled by the value you specify. The default limit is 20 categories, with a maximum possible limit of 2,000.
next	paging	String	A URL pointing to the next set of category objects, allowing users or systems to fetch the subsequent page of results - ex. https://api.reputation.com/v3/categories?offset=3&limit=3

","urlObject":{"path":["categories"],"host":["{{baseUrl}}"],"query":[{"description":{"content":"

This offsets the start of each page by the number specified. Max offset is 100k.

\n","type":"text/plain"},"key":"offset","value":""},{"description":{"content":"

Determines the number of items returned in the current response. This is distinct from rate limiting and refers to the size of the data set returned, which is controlled by the value you specify. The default limit is 20 categories, with a maximum possible limit of 2,000.

\n","type":"text/plain"},"key":"limit","value":""}],"variable":[]}},"response":[{"id":"69455657-39e0-468b-ab86-e6d34f7d8421","name":"Success","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"Your API key"}],"body":{"mode":"raw","raw":""},"url":{"raw":"https://api.reputation.com/v3/categories?offset=0&limit=3","protocol":"https","host":["api","reputation","com"],"path":["v3","categories"],"query":[{"key":"offset","value":"0"},{"key":"limit","value":"3"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"904"},{"key":"etag","value":"W/\"388-MjwZE6ks+a9ccxCdwRWj8yCESCc\""},{"key":"date","value":"Sun, 24 Sep 2023 23:12:29 GMT"},{"key":"x-envoy-upstream-service-time","value":"41"},{"key":"server","value":"istio-envoy"},{"key":"Via","value":"1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"categories\": [\n {\n \"id\": \"RESTAURANTS_\",\n \"industryIDs\": [\n \"restaurants-bars\",\n \"restaurants-carry-out\",\n \"restaurants-casual-dining\",\n \"restaurants-fast-food\",\n \"restaurants-fine-dining\",\n \"restaurants-restaurants-other\",\n \"wellness-fitness-center\",\n \"retail-furniture\"\n ],\n \"name\": \"Restaurants\"\n },\n {\n \"id\": \"ARTS_&_ENTERTAINMENT_ARTIST\",\n \"industryIDs\": [\n \"entertainment-amusement-park\",\n \"entertainment-live-performance-&-sports\",\n \"entertainment-movie-theaters\",\n \"entertainment-museums-and-parks\",\n \"entertainment-other\",\n \"wellness-fitness-center\"\n ],\n \"name\": \"Artist\"\n },\n {\n \"id\": \"ARTS_&_ENTERTAINMENT_ARTS_ORGANIZATION\",\n \"industryIDs\": [\n \"entertainment-amusement-park\",\n \"entertainment-live-performance-&-sports\",\n \"entertainment-movie-theaters\",\n \"entertainment-museums-and-parks\",\n \"entertainment-other\",\n \"wellness-fitness-center\"\n ],\n \"name\": \"Arts Organization\"\n }\n ],\n \"paging\": {\n \"offset\": 0,\n \"limit\": 3,\n \"next\": \"https://api.reputation.com/v3/categories?offset=3&limit=3\"\n }\n}"}],"_postman_id":"5e3d326d-d80d-4538-a536-68ad60fd2a7d"}],"id":"ddd88a7c-6725-40b6-b209-d13d57822d40","description":"

Use this collection to see categories configured to your Reputation platform.

\n","_postman_id":"ddd88a7c-6725-40b6-b209-d13d57822d40"},{"name":"/Credentials","item":[{"name":"Get Oauth Status","id":"059f14b8-a191-42f3-85cb-dea50741e344","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"x-api-key","value":""}],"url":"{{baseUrl}}/credentials/oauth","description":"

This endpoint retrieves the OAuth credentials for various locations, detailing the validity and the last refresh date of connections to different online sources like Facebook, Instagram, LinkedIn and more.

Sample Requests

Python

import requests\nurl = 'https://api.reputation.com/v3/credentials/oauth'\nheaders = {\n    'Accept': 'application/json',\n    'x-api-key': 'Your API key'\n}\nresponse = requests.get(url, headers=headers)\nif response.status_code == 200:\n    print(response.json())\nelse:\n    print(f'Request failed with status: {response.status_code} Response: {response.text}')\n\n

JavaScript XHR

var xhr = new XMLHttpRequest();\nxhr.open('GET', 'https://api.reputation.com/v3/credentials/oauth', true);\nxhr.setRequestHeader('Accept', 'application/json');\nxhr.setRequestHeader('x-api-key', 'Your API key');\nxhr.onreadystatechange = function() {\n    if (xhr.readyState === 4) {\n        if (xhr.status === 200) {\n            console.log(JSON.parse(xhr.responseText));\n        } else {\n            console.error('Request failed with status:', xhr.status, 'Response:', xhr.responseText);\n        }\n    }\n};\nxhr.send();\n\n

Response Parameters

Here's the requested information organized into a table:

\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

Parameter	Parent	Data Type	Description
locationID	-	String	A unique identifier representing a specific location, store, branch, or unit of a business or entity.
sources	-	Object Array	An array detailing the online sources associated with the given location.
sourceID	sources	String	Specifies the platform or online source, such as \"FACEBOOK\", \"INSTAGRAM\", \"LINKEDIN\", etc.
valid	sources	Boolean	A boolean value (true or false) that indicates whether the OAuth connection to the specific source is valid/active.
lastRefreshDate	sources	String	A timestamp representing the last time the OAuth connection was refreshed or checked.

","urlObject":{"path":["credentials","oauth"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"07586c2c-50a8-4104-8b1d-3546bdf4de0c","name":"Success","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"Your API key"}],"url":"https://api.reputation.com/v3/credentials/oauth"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"locationID\": \"CH\",\n \"sources\": [\n {\n \"sourceID\": \"FACEBOOK\",\n \"valid\": true,\n \"lastRefreshDate\": \"2023-09-25T22:58:19\"\n },\n {\n \"sourceID\": \"INSTAGRAM\",\n \"valid\": true,\n \"lastRefreshDate\": \"2023-09-25T22:58:20\"\n }\n ]\n },\n {\n \"locationID\": \"SA\",\n \"sources\": [\n {\n \"sourceID\": \"FACEBOOK\",\n \"valid\": true,\n \"lastRefreshDate\": \"2023-09-25T22:58:19\"\n },\n {\n \"sourceID\": \"LINKEDIN\",\n \"valid\": true,\n \"lastRefreshDate\": \"2023-09-25T20:17:40\"\n }\n ]\n },\n {\n \"locationID\": \"TG\",\n \"sources\": [\n {\n \"sourceID\": \"FACEBOOK\",\n \"valid\": true,\n \"lastRefreshDate\": \"2023-09-25T22:58:19\"\n }\n ]\n },\n {\n \"locationID\": \"AAA Waterbury\",\n \"sources\": [\n {\n \"sourceID\": \"FACEBOOK\",\n \"valid\": true,\n \"lastRefreshDate\": \"2023-09-25T22:58:19\"\n }\n ]\n },\n {\n \"locationID\": \"BP\",\n \"sources\": [\n {\n \"sourceID\": \"LINKEDIN\",\n \"valid\": true,\n \"lastRefreshDate\": \"2023-09-25T20:17:40\"\n }\n ]\n },\n {\n \"locationID\": \"DW\",\n \"sources\": [\n {\n \"sourceID\": \"FACEBOOK\",\n \"valid\": true,\n \"lastRefreshDate\": \"2023-09-25T22:58:19\"\n }\n ]\n },\n {\n \"locationID\": \"costco\",\n \"sources\": [\n {\n \"sourceID\": \"TWITTER\",\n \"valid\": true,\n \"lastRefreshDate\": \"2023-09-25T20:03:20\"\n }\n ]\n }\n]"}],"_postman_id":"059f14b8-a191-42f3-85cb-dea50741e344"}],"id":"6387f2b5-dac2-4e36-aaf5-669527bbf9df","description":"

This collection is designed for managing credentials within the Reputation platform and its connected sources. Currently, the Get OAuth Status endpoint is the sole endpoint available in this collection.

\n","_postman_id":"6387f2b5-dac2-4e36-aaf5-669527bbf9df"},{"name":"/Listing-Audits","item":[{"name":"Get Listing Audits","id":"5d6ea324-b733-48b9-a62d-b97cf78e8d08","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"{{baseUrl}}/listing-audits?offset=&limit=&from=&to=&range=&locationIDs=&sourceIDs=","description":"

This endpoint facilitates the retrieval of listing audits, allowing you to examine and assess the integrity of listings over specified time frames or for specific locations and sources with the optional query parameters.

Sample Requests

JavaScript XHR Request

var xhr = new XMLHttpRequest();\nxhr.open('GET', 'https://api.reputation.com/v3/listing-audits?limit=2', true);\nxhr.setRequestHeader('Accept', 'application/json');\nxhr.setRequestHeader('x-api-key', 'Your API key');\nxhr.onreadystatechange = function() {\n    if (xhr.readyState === 4) {\n        if (xhr.status === 200) {\n            console.log(JSON.parse(xhr.responseText));\n        } else {\n            console.error('Request failed with status:', xhr.status, 'Response:', xhr.responseText);\n        }\n    }\n};\nxhr.send();\n\n

Response Parameters

Parameter	Parent	Data Type	Description
`listing-audits`		Object Array	An array of audit records for different listings.
`locationID`	`listing-audits`	String	Unique identifier for the location - ex. `SA`
`sourceID`	`listing-audits`	String	Specifies the platform or online source - ex. `FACEBOOK`
`url`	`listing-audits`	String	The specific URL of the listing on the given source. - ex. `https://www.cars.com/dealers/92401/carscom`
`optedOut`	`listing-audits`	Boolean	A boolean value indicating if the listing opted out from being audited.
`date`	`listing-audits`	String	A timestamp showing when the audit was performed - ex. `2023-05-17T21:46:14`
`state`	`listing-audits`	String	Describes the state of the audit - ex. `AUDIT_ONLY`
`sourceState`	`listing-audits`	Object	Contains states related to the listing's status on the source platform.
`suspended`	`sourceState`	Boolean	Indicates whether the location is suspended.
`duplicate`	`sourceState`	Boolean	Indicates whether the location is a duplicate of another location.
`verified`	`sourceState`	Boolean	Indicates whether the location is verified.
`pendingReview`	`sourceState`	Boolean	Indicates whether the review of the location is pending.
`disabled`	`sourceState`	Boolean	Indicates whether the location is disabled.
`published`	`sourceState`	Boolean	Indicates whether the location is published.
`claimed`	`sourceState`	Boolean	Indicates whether the location is claimed.
`pendingVerification`	`sourceState`	Boolean	Indicates whether the location is pending verification.
`optedOut`	`sourceState`	Boolean	Indicates whether the location is opted out.
`nameAudit`	`listing-audits`	Object	Audit details for the name of the listing.
`name`	`nameAudit`	String	The actual name of the listing as it appears or is recorded on the specified platform or source - ex. `Cars Now`
`match`	`nameAudit`	String	Whether the current name in the system matches the name from the online source - valid values. `MATCH MISMATCH`
`descriptionAudit`	`listing-audits`	Object	Audit details for the listing description.
`description`	`descriptionAudit`	String	Description of the business - ex. `Cars at great prices.`
`match`	`descriptionAudit`	String	Whether the current description in the system matches the description from the online source - valid values. `MATCH` `MISMATCH`
`placeAudit`	`listing-audits`	Object	Audit details for the listing's contact information and hours.
`addressAudit`	`placeAudit`	Object	Audit details for the listing's address.
`address`	`addressAudit`	Object	An object representing the business's address information.
`streetAddress1`	`address`	String	Street Address 1 - ex. `100 Main Street`
`streetAddress2`	`address`	String	Street Address 2 - ex. `Suite 300`
`locality`	`address`	String	Locality/City - ex. `Chicago`
`region`	`address`	String	Region/State. ex. `Illinois`
`country`	`address`	String	Country two letter ISO code - ex. `US`
`postalCode`	`address`	String	Postal Code/Zip Code - ex. `60131`
`latitude`	`address`	String	Address latitude - ex. `41.881832`
`longitude`	`address`	String	Address longitude - ex. `-87.623177`
`match`	`addressAudit`	String	Whether address in system matches address in online source - valid values. `MATCH MISMATCH`
`businessHoursAudit`	`placeAudit`	Object	Audit details for the listing's business hours.
`businessHours`	`businessHoursAudit`	Object Array	An array of business hours objects.
`name`	`businessHours`	String	Name of the business hours object.
`businessHourType`	`businessHours`	String	Type of business hours - valid values. `Main`,`Sails`,`Service`,`Parts`,`Holiday`
`timePeriods`	businessHours	String	List of time period objects.
`openDay`	`timePeriods`	String	The day associated with the `openTime`. - valid values. `Sunday`,`Monday`,`Tuesday`,`Wednesday`,`Thursday`,`Friday`,`Saturday`
`openTime`	`timePeriods`	String	The time associated with the `openDay` in 24hr ISO 8601 extended format (hh:mm). Valid values are 00:00-24:00, where 24:00 represents midnight at the end of the specified `openDay`.
`closeDay`	`timePeriods`	String	The day associated with the `closedTime` - valid values. `Sunday`,`Monday`,`Tuesday`,`Wednesday`,`Thursday`,`Friday`,`Saturday`
`closeTime`	`timePeriods`	String	The time associated with the `closedDay` in 24hr ISO 8601 extended format (hh:mm). Valid values are 00:00-24:00, where 24:00 represents midnight at the end of the `closedDay`.
`open24Hours`	`timePeriods`	Boolean	Whether the business is open 24 hours on the current day.
`closed`	`timePeriods`	Boolean	Whether the business is closed at the current time.
`primary`	`businessHours`	Boolean	Whether the business hours object represents the primary business hours.
`specialHours`	`businessHours`	Object Array	An array of special hours objects used to define hours implemented for one-off or specific circumstances like an event or construction.
`startDate`	`specialHours`	String	The starting calendar date for the special hours in ISO 8601 format (YYYY-MM-DD).
`openTime`	`specialHours`	String	Time the business opens during the special hours time frame in 24hr ISO 8601 extended format (hh:mm). Valid values are 00:00-24:00, where 24:00 represents midnight at the end of the specified day field. Specified if `closed` and `open24Hours` are false.
`closedTime`	`specialHours`	String	Time the business closes during the special hours time frame in 24hr ISO 8601 extended format (hh:mm). Valid values are 00:00-24:00, where 24:00 represents midnight at the end of the specified day field. Specified if `closed` and `open24Hours` are false.
`open24Hours`	`specialHours`	String	Whether open 24 hours during the specified day range. If true, `openTime`, and `closeTime` are ignored, and the date specified in `startDate`is treated as the location being open for the entire day.
`closed`	`specialHours`	String	Whether business is closed. If true, `openTime`, and `closeTime` are ignored, and the date specified in startDate is treated as the location being closed for the entire day.
`match`	`businessHoursAudit`	String	Whether business hours in system matches business hours in online source - valid values. `MATCH MISMATCH`
`phonesAudit`	`placeAudit`	Object	Audit details for the listing's phone information.
`phones`	`phonesAudit`	Object Array	A list of phone objects.
`phoneType`	`phones`	String	Type of phone number - valid values. `Local`,`Mobile`,`Fax`,`TollFree`,`Tracked`,`Sales`,`Service`,`Parts`,`Emergency`,`GoogleOnly`,`FacebookOnly`,`BingOnly`,`FoursquareOnly`,`Other`
`number`	`phones`	String	Phone number.
`extension`	`phones`	String	Extension number.
`country`	`phones`	String	Country of origin - ex. `United States`
`primary`	`phones`	Boolean	Whether phone number is business's primary number.
`match`	`phonesAudit`	String	Whether phone numbers in the system match phone numbers from the online source - valid values. `MATCH` `MISMATCH`
`websitesAudit`	`placeAudit`	Object	Audit details for the listing's website details.
`websites`	`websitesAudit`	Object Array	An array of webste objects.
`websiteType`	`websites`	String	Type of website - valid values. `Homepage`,`Reservation`,`Order`,`GoogleHomepage`,`Covid`,`Telehealth`,`Menu`
`url`	`websites`	String	Website url - ex. `google.com`
`primary`	`websites`	Boolean	Whether website in business's primary website.
`match`	`websitesAudit`	String	Whether websites in the system match websites in the listing - valid values. `MATCH`,`MISMATCH`
`categoryAudit`	`listing-audits`	Object	Audit details for the listing's categories.
`category`	`categoryAudit`	String Array	An array of categories - ex. [`restaurant,hotel`]
`match`	`categoryAudit`	String	Whether system categories match the listing's categories - valid values. `MATCH`,`MISMATCH`
`paging`		Object	Contains details about pagination.
`offset`	`paging`	Integer	Specifies the starting point of the current page of results - ex. `0`
`limit`	`paging`	Integer	Determines the number of items returned in the current response. This is distinct from rate limiting and refers to the size of the data set returned, which is controlled by the value you specify. The default limit is 20 listing audits, with a maximum possible limit of 2,000.
`next`	`paging`	String	The URL to fetch the next page of results - ex. `https://api.reputation.com/v3/listing-audits?offset=2&limit=2`
`previous`	`paging`	String	The URL to fetch the previous page of results.
`dateRange`		Object	Contains details about the audit's date range.
`range`	`dateRange`	String	The selected range for audit retreival - ex. `LifetoDate`
`from`	`dateRange`	String	The start date for the audit retrieval period - ex. A hyphen is used `-` if there is no specified start date.
`to`	`dateRange`	String	The end date for the audit retrieval period - ex. `2023-09-26T23:59:59`

Response Schema

{\n  \"listingAudits\": [\n    {\n      \"locationID\": \"string\",\n      \"sourceID\": \"string\",\n      \"url\": \"string\",\n      \"optedOut\": \"boolean\",\n      \"date\": \"string\",\n      \"state\": \"string\",\n      \"sourceState\": {\n        \"suspended\": \"boolean\",\n        \"duplicate\": \"boolean\",\n        \"verified\": \"boolean\",\n        \"pendingReview\": \"boolean\",\n        \"disabled\": \"boolean\",\n        \"published\": \"boolean\",\n        \"claimed\": \"boolean\",\n        \"pendingVerification\": \"boolean\",\n        \"optedOut\": \"boolean\"\n      },\n      \"nameAudit\": {\n        \"name\": \"string\",\n        \"match\": \"string\"\n      },\n      \"descriptionAudit\": {\n          \"description\": \"string\",\n          \"match\": \"string\"\n      },\n      \"placesAudit\": [\n        {\n          \"addressAudit\": {\n            \"address\": {\n              \"addressType\": \"string\",\n              \"streetAddress2\": \"string\",\n              \"houseNumber\": \"string\",\n              \"route\": \"string\",\n              \"locality\": \"string\",\n              \"region\": \"string\",\n              \"postalCode\": \"string\",\n              \"country\": \"string\",\n              \"latitude\": \"string\",\n              \"longitude\": \"string\",\n              \"timeZone\": \"string\",\n              \"pin\": \"string\",\n              \"streetAddress1\": \"string\"\n            },\n            \"match\": \"string\"\n          },\n          \"phonesAudit\": {\n            \"phones\": [\n              {\n                \"number\": \"string\",\n                \"primary\": \"boolean\",\n                \"country\": \"US\",\n                \"extension\": \"string\",\n                \"phoneType\": \"string\"\n              }\n            ],\n            \"match\": \"string\"\n          },\n          \"websitesAudit\": {\n            \"websites\": [\n              {\n                \"url\": \"string\",\n                \"primary\": \"boolean\",\n                \"websiteType\": \"string\"\n              }\n            ],\n            \"match\": \"string\"\n          },\n          \"businessHoursAudit\": {\n              \"businessHours\": [\n                    {\n                            \"timePeriods\": [\n                                {\n                                    \"openDay\": \"string\",\n                                    \"openTime\": \"string\",\n                                    \"closeDay\": \"string\",\n                                    \"closeTime\": \"string\",\n                                    \"open24Hours\": \"boolean\",\n                                    \"closed\": \"boolean\"\n                                },\n                            ],\n                            \"name\": \"string\",\n                            \"primary\": \"boolean\",\n                            \"specialHours\": [\n                                {\n                                    \"openTime\": \"string\",\n                                    \"closeTime\": \"string\",\n                                    \"open24Hours\": \"boolean\",\n                                    \"closed\": \"boolean\",\n                                    \"startDate\": \"string\"\n                                },\n                            ],\n                            \"businessHourType\": \"string\"\n                        }\n                ],\n              \"match\": \"string\"\n          }\n        }\n      ],\n      \"categoriesAudit\": {\n          \"category\": [\"string\"],\n          \"match\": \"string\"\n      }\n    },\n  ],\n  \"paging\": {\n    \"offset\": \"integer\",\n    \"limit\": \"integer\",\n    \"next\": \"string\"\n  },\n  \"dateRange\": {\n    \"range\": \"string\",\n    \"from\": \"string\",\n    \"to\": \"string\"\n  }\n}\n\n\n

\n","urlObject":{"path":["listing-audits"],"host":["{{baseUrl}}"],"query":[{"description":{"content":"

Specifies the starting point for the retrieved audits. Useful for pagination. Maximum value: 100,000

\n","type":"text/plain"},"key":"offset","value":""},{"description":{"content":"

Determines the number of items returned in the current response. This is distinct from rate limiting and refers to the size of the data set returned, which is controlled by the value you specify. The default limit is 20 listing audits, with a maximum possible limit of 2,000.

\n","type":"text/plain"},"key":"limit","value":""},{"description":{"content":"

The start date for the audit retrieval period, formatted as an ISO Date.

ex. 2023-09-23T14:32:44

\n","type":"text/plain"},"key":"from","value":""},{"description":{"content":"

The end date for the audit retrieval period, also in ISO Date format.

ex. 2023-09-26T12:32:44

\n","type":"text/plain"},"key":"to","value":""},{"description":{"content":"

Pre-defined date ranges for audit retrieval. Valid options include:

Valid Values:

Today,Yesterday,ThisWeek,PreviousWeek,ThisMonth,PreviousMonth,ThisQuarter,PreviousQuarter,ThisYear,PreviousYear,YearToDate,LifeToDate,Last7Days,Last30Days,Last60Days,Last90Days,Last6Months,Last1Year,Last2Years,Last3Years

\n","type":"text/plain"},"key":"range","value":""},{"description":{"content":"

A comma-separated list of specific location IDs. Useful for filtering audits pertaining to certain locations.

ex. CH

\n","type":"text/plain"},"key":"locationIDs","value":""},{"description":{"content":"

A comma-separated list of source IDs to further narrow down the retrieved audits by particular platforms or sites.

ex. FACEBOOK

\n","type":"text/plain"},"key":"sourceIDs","value":""}],"variable":[]}},"response":[{"id":"66c7073c-0aa4-4164-8b7c-57bdcd40f3b1","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"x-api-key","value":"Your API key"}],"url":{"raw":"https://api.reputation.com/v3/listing-audits?limit=2","protocol":"https","host":["api","reputation","com"],"path":["v3","listing-audits"],"query":[{"key":"offset","value":"0","disabled":true},{"key":"limit","value":"2"},{"key":"from","value":"2001-06-17T15:40:12.790Z","disabled":true},{"key":"to","value":"2001-06-17T15:40:12.790Z","disabled":true},{"key":"range","value":"PreviousWeek","disabled":true},{"key":"locationIDs","value":"L005","disabled":true},{"key":"sourceIDs","value":"GOOGLE","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"1757"},{"key":"etag","value":"W/\"6dd-2qFwJry1cOKGoMylX2DimhbOX/c\""},{"key":"date","value":"Wed, 27 Sep 2023 04:05:36 GMT"},{"key":"x-envoy-upstream-service-time","value":"53"},{"key":"server","value":"istio-envoy"},{"key":"Via","value":"1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"listingAudits\": [\n {\n \"locationID\": \"SA\",\n \"sourceID\": \"CARS\",\n \"url\": \"https://www.cars.com/dealers/92401/carscom-betaqa-only/\",\n \"optedOut\": false,\n \"date\": \"2023-05-17T21:46:14\",\n \"state\": \"AUDIT_ONLY\",\n \"sourceState\": {\n \"suspended\": false,\n \"duplicate\": false,\n \"verified\": false,\n \"pendingReview\": false,\n \"disabled\": false,\n \"published\": false,\n \"claimed\": false,\n \"pendingVerification\": false,\n \"optedOut\": false\n },\n \"nameAudit\": {\n \"name\": \"\\\"Cars.com BetaQA Only\\\"\",\n \"match\": \"MISMATCH\"\n },\n \"descriptionAudit\": null,\n \"placesAudit\": [\n {\n \"addressAudit\": {\n \"address\": {\n \"addressType\": null,\n \"streetAddress2\": null,\n \"houseNumber\": null,\n \"route\": null,\n \"locality\": \"Chicago\",\n \"region\": \"IL\",\n \"postalCode\": \"60604\",\n \"country\": \"USA\",\n \"latitude\": 0,\n \"longitude\": 0,\n \"timeZone\": null,\n \"pin\": null,\n \"streetAddress1\": \"pego pego Beta testing dealer\"\n },\n \"match\": \"MISMATCH\"\n },\n \"phonesAudit\": {\n \"phones\": [\n {\n \"number\": \"(777) 888-7777\",\n \"primary\": false,\n \"country\": \"US\",\n \"extension\": null,\n \"phoneType\": \"Local\"\n }\n ],\n \"match\": null\n },\n \"websitesAudit\": {\n \"websites\": [\n {\n \"url\": \"http://www.microsoft.com\",\n \"primary\": false,\n \"websiteType\": \"Homepage\"\n }\n ],\n \"match\": \"MISMATCH\"\n },\n \"businessHoursAudit\": null,\n \"serviceAreaAudit\": null\n }\n ],\n \"categoriesAudit\": null\n },\n {\n \"locationID\": \"SA\",\n \"sourceID\": \"FACEBOOK\",\n \"url\": \"https://www.facebook.com/845842458799728\",\n \"optedOut\": false,\n \"date\": \"2023-05-17T21:46:14\",\n \"state\": \"NOT_PUBLISHABLE\",\n \"sourceState\": {\n \"suspended\": false,\n \"duplicate\": false,\n \"verified\": false,\n \"pendingReview\": false,\n \"disabled\": false,\n \"published\": false,\n \"claimed\": false,\n \"pendingVerification\": false,\n \"optedOut\": false\n },\n \"nameAudit\": {\n \"name\": \"Simple Art\",\n \"match\": \"MATCH\"\n },\n \"descriptionAudit\": null,\n \"placesAudit\": null,\n \"categoriesAudit\": null\n }\n ],\n \"paging\": {\n \"offset\": 0,\n \"limit\": 2,\n \"next\": \"https://api.reputation.com/v3/listing-audits?offset=2&limit=2\"\n },\n \"dateRange\": {\n \"range\": \"LifeToDate\",\n \"from\": \"-\",\n \"to\": \"2023-09-26T23:59:59\"\n }\n}"}],"_postman_id":"5d6ea324-b733-48b9-a62d-b97cf78e8d08"}],"id":"ddb11535-1517-41ca-8088-d584f3977899","description":"

Use this collection to perform audits and gain additional insights on your business listings.

\n","_postman_id":"ddb11535-1517-41ca-8088-d584f3977899"},{"name":"/Locations","item":[{"name":"Get Locations","id":"3bfb15eb-8775-438b-afa0-cf6efd458da2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":""},{"key":"Accept","value":"application/json"}],"url":"{{baseUrl}}/locations?offset=&limit=","description":"

Retrieves detailed location profiles, providing comprehensive data that extends beyond just basic location attributes within the Business Listing Solution. You can use this endpoint to access an array of information about specific profiles.

Note: The Get Locations and Get Location endpoints are designed to retrieve only cleansed profiles. If you attempt to fetch an unmanaged profile using either endpoint, the response will result in a null value.

Sample

JavaScript XHR Request

var xhr = new XMLHttpRequest();\nxhr.open('GET', 'https://api.reputation.com/v3/locations', true);\nxhr.setRequestHeader('x-api-key', 'Your API key');\nxhr.setRequestHeader('Accept', 'application/json');\nxhr.onreadystatechange = function() {\n    if (xhr.readyState == 4 && xhr.status == 200) {\n        var response = JSON.parse(xhr.responseText);\n        console.log(response);\n    }\n};\nxhr.send();\n\n

Response Parameters

\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\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\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\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\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\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\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\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\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\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\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\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\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\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\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

Parameter	Parent	Data Type	Description
`locations`		Object Array	An array of location profiles providing detailed information about specific locations.
`id`	`locations`	String	Identifier for the location - ex. `SA`
`internalID`	`locations`	String	The internal identification number assigned to the location - ex. `737476`
`optedOut`	`locations`	Boolean	Indicates whether the location has opted out of listings publishing.
`linkedProfileID`	`locations`	String	Id used to reference existing linked profiles
`tenantID`	`locations`	String	Tenant's unique id. Attribute becomes read-only after profile is created
`internalName`	`locations`	String	The internal name given to the location - ex. `Simple Art`
`externalName`	`locations`	String	Location's external name - ex. `Majestic Art`
`industryID`	`locations`	String	The industry identification associated with the location - ex. `automotive-dealer`
`parentID`	`locations`	String	The ID of the parent location if there's any, otherwise `null`.
`customVariables`	`locations`	Object Array	An array of custom variables associated with the location, containing the variable name and its value.
`name`	`customVariables`	String	Custom variable name - ex. `CAMPAIGN_ENROLLMENT_AND_SCHEDULE_PREFERENCE`
`value`	`customVariables`	String	Value of the custom variable - ex. `MANUAL`
`customFilters`	`locations`	Object Arrary	An array of custom filters applied to the location, containing the filter name and its value.
`name`	`customFilters`	String	Custom filter name - ex. `Brand`
`value`	`customFilters`	String	Value of the custom filter - ex. `Gallery`
`locationType`	`locations`	String	Specifies the location type whether it's `main`, `branch`, etc.
`groupCode`	`Location`	String	A common identifier used to associate the main location with its corresponding departmental or supplemental locations. This unique code must be the same for both the main location and any related department/supplemental locations - ex. `SA`
`primaryProfile`	`locations`	Boolean	Indicates if the profile is the primary one.
`type`	`locations`	String	Indicates the type of the location - ex. `Rooftop`
`profileDefinition`	`locations`	String	Definition or category of the profile - ex. `Rooftop`
`state`	`locations`	String	Defines the state of the entity, i.e. whether it is covered by the current contract with Reputation. If left empty, state will default to active - ex. `Active`
`places`	`locations`	Object Array	List of \"Place\" objects
`placeID`	`places`	String	Place id
`officeName`	`places`	String	Office or practice name - ex. `Bay Plumbing`
`address`	`places`	Object	Address object
`streetAddress1`	`address`	String	Street address line 1 - ex. `1001 Marshall St`
`streetAddress2`	`address`	String	Street address line 2 - ex. `Suite 300 null` if there is no line 2
`locality`	`address`	String	Locality/city - ex. `Redwood City`
`region`	`address`	String	Region/State or Province - ex. `CA`
`country`	`address`	String	Country's 2 letter ISO Code - ex. `US`
`postalCode`	`address`	String	Postal Code/Zip Code - ex. `94063`
`latitude`	`address`	String	Address latitude - ex. `37.4880518`
`longitude`	`address`	String	Address longitude - ex. `-122.2243949`
`originalAddress`	`places`	Object	Raw non-normalized version of the address inputed by the user
`streetAddress1`	`originalAddress`	String	Street address line 1 - ex. `1001 Marshall St`
`streetAddress2`	`originalAddress`	String	Street address line 2 - ex. `Suite 300 null` if there is no line 2
`locality`	`originalAddress`	String	Locality/city - ex. `Redwood City`
`region`	`orignialAddress`	String	Region/State or Province - ex. `CA`
`country`	`originalAddress`	String	Country's 2 letter ISO Code - ex. `US`
`postalCode`	`originalAdress`	String	Postal Code/Zip Code - ex. `94063-2052`
`latitude`	`originalAddress`	String	Address latitude - ex. `37.48776`
`longitude`	`originalAddress`	String	Address longitude - ex. `-122.2243949`
`businessHours`	`places`	Object Array	List of \"business hours\" objects - If there are no objects, `null` is returned.
`name`	`businessHours`	String	Name of the \"business hour\" object
`businessHourType`	`businessHours`	String	Refers to the type of business hours. - valid values: `Main` `Sales` `Service` `Parts` `Holiday`
`timePeriods`	`businessHours`	Object Array	List of \"Time Period\" objects to represent days and times opened/closed.
`openDay`	`timePeriods`	String	Profile's open days - valid values: `Sunday`, `Monday`, `Tuesday`,`Wednesday`,`Thursday`,`Friday`,`Saturday`
`openTime`	`timePeriods`	String	Profile's open times in 24hr ISO 8601 - valid values: `00:00-24:00`, where 24:00 represents midnight at the end of the specified `openDay`.
`closeDay`	`timePeriods`	String	Profile's closed days - valid values: `Sunday` ,`Monday`, `Tuesday` ,`Wednesday` ,`Thursday` ,`Friday` ,`Saturday`
`closeTime`	`timePeriods`	String	Profile's closed times in 24hr ISO 8601 - valid values: `00:00-24:00`, where 24:00 represents midnight at the end of the specified `closeDay`.
`open24Hours`	`timePeriods`	Boolean	Denotes whether the profile is open 24 hours during the specified day range
`closed`	`timePeriods`	Boolean	Denotes whether the profile is closed at the current time
`primary`	`businessHours`	Boolean	Denotes whether business hours are the profile's primary hours
`specialHours`	`businessHours`	Object Array	List of \"special time period\" objects -similar to `timePeriods` but used for special instances
`startDate`	`specialHours`	String	The calendar date the special hour period starts on - In ISO 8601 format (YYYY-MM-DD) .
`openTime`	`specialHours`	String	Time in 24hr ISO 8601 extended format (hh:mm). Valid values are 00:00-24:00, where 24:00 represents midnight at the end of the specified day field. Specified if `closed`and `open24Hours` is `false`.
`closeTime`	`speicalHours`	String	Time in 24hr ISO 8601 extended format (hh:mm). Valid values are 00:00-24:00, where 24:00 represents midnight at the end of the specified day field. Specified if `closed`and `open24Hours` is `false`.
`open24Hours`	`specialHours`	Boolean	Denotes whether open 24 hours during the specified day range. If true, `openTime`, and `closeTime` are ignored, and the date specified in startDate is treated as the location being open for the entire day.
`closed`	`specialHours`	Boolean	Denotes whether the profile is closed. If `true`, `openTime`, and `closeTime` are ignored, and the date specified in `startDate` is treated as the location being closed for the entire day.
`phones`	`places`	Object Array	List of phone number objects.
`phoneType`	`phones`	String	Phone type - valid values: `Local`, `Mobile`, `Fax`, `TollFree`, `Tracked`, `Sales`, `Service`, `Parts`, `Emergency`, `GoogleOnly`, `FacebookOnly`, `BingOnly`, `FourSquareOnly`, `WhatsApp`, `Text_SMS`, `Other`
`number`	`phones`	String	Phone number - ex. \"`(408) 900-9080`
`extension`	`phones`	String	Extension number
`country`	`phones`	String	Country of origin - ex. `US`
`primary`	`phones`	Boolean	Denotes whether phone is primary
`websites`	`places`	Object Array	List of websites
`websiteType`	`websites`	String	Type of website - valid values: `Homepage` ,`Reservation`, `Order`, `GoogleHomepage`, `Covid`, `Telehealth`, `Menu`
`url`	`websites`	String	Website URL - ex. `http://www.reputation.com`
`primary`	`websites`	Boolean	Whether website is primary
`emails`	`places`	Object Array	List of emails
`email`	`emails`	String	The business's email address - ex. `business@reputation.com`
`primary`	`emails`	Boolean	Whether email is primary email
`officeStatus`	`places`	Object	An office status object containing the `officeState` and `operationalDate`.
`officeState`	`officeStatus`	String	Office state/status type - valid values: `Open`,`Closed`,`Moved`,`Permanently_Closed`,`Opening_Soon`,`Closing_Soon`,`Temporarily_Closed`
`operationalDate`	`officeStatus`	String	Date of office state in ISO 8601 format (YYYY-MM-DD) - ex. `2021-05-01`
`primary`	`places`	Boolean	Whether place is business's primary place
`description`	`locations`	String	Description of the business - ex. `Simple Art Page Description`
`shortDescription`	`locations`	String	Short description to publish on Source site. Limit of 155 characters - ex. `Simple Art Page`
`tags`	`locations`	String	Keywords identifying the location, used in meta-tags - ex. `art`,`exclusive`,`low prices`
`utm`	`locations`	Boolean	Whether a UTM source is appended to a primary URL when it is sent to GoogleMyBusinees. UTM example: ?utm_source=local&utm_medium=organic&utm_camp
`attributes`	`locations`	Object Array	List of Attribute objects. Available attributes depend on selected categories. See Attributes section below for more details.
`attributeId`	`attributes`	String	Attribute Id
`boolValue`	`attributes`	Boolean	Attribute boolean value. This field or `values`is used but not both. Valid values are: `true`or `false`
`values`	`attributes`	Object Array	List of Attribute values. This field or `boolValue`is used but not both
`id`	`values`	String	Attribute value Id
`boolValue`	`values`	Boolean	Boolean of attribute value
`owners`	`locations`	Object Array	List of owners
`name`	`owners`	String	The name of the admin. When making the initial invitation, this is the invitee's email address.
`role`	`owners`	String	Role of the owner
`pendingInvitation`	`owners`	Boolean	Status of the invitation sent to the owner.
`socialMedias`	`locations`	Object Array	List of social media objects
`socialMediaType`	`socialMedias`	String	Type of social media - valid values: `Facebook`,`Twitter`,`Instagram`,`Snapchat`,`YouTube`,`LinkedIn`,`Pintrest`,`Blog`
`url`	`socialMedias`	String	URL for social media
`medias`	`locations`	Object Array	List of media objects
`mediaType`	`medias`	String	Media Type. png or jpeg file for cover photo: 16:9 aspect ratio with minimum size 400px - valid values: `Headshot`,`Cover`,`Profile`,`Logo`,`Video`,`Google_Logo`,`Google_Cover`,`Facebook_Profile`,`Facebook_Cover`,`Additional`
`url`	`medias`	String	URL for Media
`title`	`medias`	String	Title for media object
`primary`	`medias`	Boolean	Whether media is primary
`medical`	`locations`	Object	Medical details provided if listing is for a medical business.
`npi`	`medical`	String	National Provider Identifier (NPI) is a unique 10-digit identification number issued to health care providers in the United States. NPI is used to uniquely identify health care providers in the US.
`stateLicenseNumber`	`medical`	String	State license number
`insurancesAccepted`	`medical`	Object Array	List of insurance objects
`id`	`insurancesAccepted`	String	Id of the object
`label`	`insurancesAccepted`	String	Object label
`acceptingNewPatients`	`medical`	Boolean	Boolean used to determine whether a health care provider or facility is currently accepting new patients
`employerAffiliation`	`medical`	String	Used to characterize the employer affiliation, as doctors can be either employed or affiliated with a health care group ex. `Employed`, `Independent`
`specialties`	`medical`	Object Array	List of specialties associated with the entity.
`specialty`	`specialties`	String	Specialty type.
`primary`	`specialties`	Boolean	Whether specialty is primary.
`webMdCampaignId`	`medical`	String	This is an ID provided by WebMD to shared clients between Reputation and WebMD that are running paid Carefinder campaigns on WebMD. This field will allow shared clients to manage their WebMD campaigns directly from the Reputation platform.
`insuranceNetworks`	`medical`	Object Array	List of insurance networks that are accepted by the health care provider or facility. This field will replace the deprecated InsurancesAccepted.
`insuranceNetork`	`medical`	Object Array	An insurance network is a list of the doctors, other health care providers, and hospitals that a plan has contracted with to provide medical care to its members
`id`	`insuranceNetork`	String	Id of the object
`label`	`insuranceNetork`	String	Label of the object
`professional`	`locations`	Object	If the listing is for service professional, then it will provide the details for the professional.
`title`	`professional`	String	Person's Title
`appellation`	`professional`	String	Person's Appellation
`degrees`	`professional`	Object Array	List of Degrees
`degree`	`degrees`	String	Name of degree
`primary`	`degrees`	Boolean	Whether degree is primary
`firstName`	`professional`	String	Person's first name
`lastName`	`professional`	String	Person's last name
`middleName`	`professional`	String	Person's middle name
`gender`	`professional`	String	Person's gender
`birthday`	`professional`	String	Person's Birthday in ISO 8601 format (YYYY-MM-DD)
`biography`	`professional`	String	Person's biography
`certifications`	`professional`	Object Array	List of certifications
`number`	`certifications`	String	Certification/License number
`country`	`certifications`	String	Country issuing certification. 2 letter ISO code.
`endDate`	`certifications`	String	Expiration date of the Certification/License (YYYY-MM-DD).
`name`	`certifications`	String	Certification name
`issuer`	`certifications`	String	Certification issuer
`primary`	`certifications`	Boolean	Whether certification is primary certification
`affiliations`	`professional`	Object Array	List of affiliations. For non-healthcare professionals, list of professional associations. For Healthcare Professionals, list of admitting hospitals.
`affiliation`	`affiliations`	String	Affiliation name
`primary`	`affiliations`	Boolean	Whether affiliation is primary affiliation. If none of the affiliations are defined as prmary=`true`, then the first affiliation will be defaulted to primary=`true`
`educations`	`professional`	Object Array	List of educational experience
`type`	`educations`	String	Type of edcuation - valid values: `Undergraduate`,`Graduate`,`Medical`,`Law`,`Internship`,`Fellowship`,`Residency`,`AdditionalTraining`,`BachelorOfScience`,`DentalSchool`,`MasterOfArts`,`Masters`,`MastersOfScience`,`NursingSchool`,`PHD`,`ProfessionalEducation`,`PsyD`,`Society`,`Certification`,`Education`,`ProfessionalAffiliations`,`ProfessionalMembership`,`SpecializationsAndProcedures`,`Awards`,`Other`
`institution`	`educations`	String	Name of institution
`graduationYear`	`educations`	String	Graduation year
`degree`	`educations`	String	Graduation Degree
`primary`	`educations`	String	Whether education is the professional's primary/main education
`languages`	`professionals`	String	List of languages
`serviceArea`	`locations`	Object	Service are details object (for service area businesses).
`places`	`serviceArea`	String Array	Zip Code or City Name, State, Country (if applicable)
`businessType`	`serviceArea`	String	Business type - valid values: `BUSINESS_TYPE_UNSPECIFIED`,`CUSTOMER_AND_BUSINESS_LOCATION`,`CUSTOMER_LOCATION_ONLY`
`categories`	`locations`	Object Array	List of category objects
`category`	`categories`	Object	Caregory object
`id`	`category`	String	Object id
`label`	`category`	String	Object label
`primary`	`categories`	Boolean	Whether `category` object is the primary object.
`paymentTypes`	`locations`	String Array	Comma separated list of accepted payment types
`richKnowledge`	`locations`	Object	Object containing metadata
`titleTag`	`richKnowledge`	String	The HTML element that specifies the title of the web page
`metaDescription`	`richKnowledge`	String	The HTML element that describes the subject of the webpage
`metaKeywords`	`richKnowledge`	String Array	The HTML element that lists keywords related to the webpage
`htmlDescription`	`richKnowledge`	String	HTML enabled business description of the profile
`zipCodesServed`	`richKnowledge`	String Array	The list of zipCodes served by the entity
`areasServed`	`richKnowledge`	String Array	The list of areas served by the entity
`professionalStatement`	`richKnowledge`	String	Brief statement of the professional represented by the entity
`covidMessage`	`locations`	String	This field allows communication centered around COVID-19. It can be used to communicate cleaning protocols, store capacity, security measures, mask requirements, and other measures. The field is limited to 200 characters and must only be used to provide messages related to COVID-19.
`createdDate`	`locations`	String	Profile's created date - Datetime ISO 8601
`updatedDate`	`locations`	String	Profile's updated date - Datetime ISO 8601
`distance`	`locations`	Number (Double)	Shows the distance of the Location from the provided Latitude and Longitude or Postal Code
`slug`	`locations`	String	Url slug
`paging`		Object	Object containing request pagination details
`offset`	`paging`	Integer (int64)	This offsets the start of each page by the number specified
`limit`	`paging`	Integer (int64)	Determines the number of items returned in the current response. This is distinct from rate limiting and refers to the size of the data set returned, which is controlled by the value you specify. The default limit is 20 locations, with a maximum possible limit of 2,000.
`count`	`paging`	Integer (int64)	This is the maximum number of objects that may be returned for the search.
`previous`	`paging`	Integer (int64)	API endpoint that will return the next page of data. If not included, this is the last page of data.

Attributes

Attributes are features/flags on a business listings page that allow users to know what a business offers at a glance. For example, the attributes below are located under the service options.

\n\n

Response Schema

{\n    \"locations\": [\n        {\n            \"id\": \"string\",\n            \"internalID\": \"string\",\n            \"optedOut\": \"boolean\",\n            \"linkedProfileID\": \"string\",\n            \"tenantID\": \"string\",\n            \"internalName\": \"string\",\n            \"externalName\": \"string\",\n            \"industryID\": \"string\",\n            \"parentID\": \"string\",\n            \"customVariables\": [\n                {\n                    \"name\": \"string\",\n                    \"value\": \"string\"\n                }\n            ],\n            \"customFilters\": [\n                {\n                    \"name\": \"string\",\n                    \"value\": \"string\"\n                }\n            ],\n            \"locationType\": \"string\",\n            \"groupCode\": \"string\",\n            \"state\": \"string\",\n            \"utm\": \"boolean\",\n            \"description\": \"string\",\n            \"tags\": [\n                \"string\",\n            ],\n            \"paymentTypes\": [\n                \"string\"\n            ],\n            \"covidMessage\": \"string\",\n            \"medias\": [\n                {\n                    \"url\": \"string\",\n                    \"title\": \"string\",\n                    \"mediaType\": \"string\",\n                    \"primary\": \"boolean\"\n                }\n            ],\n            \"attributes\": [\n                {\n                    \"attributeId\": \"string\",\n                    \"boolValue\": \"boolean\"\n                },\n                {\n                    \"attributeId\": \"string\",\n                    \"values\": [\n                        {\n                            \"id\": \"string\",\n                            \"boolValue\": \"boolean\"\n                        },\n                    ]\n                }\n            ],\n            \"owners\": [\n                {\n                    \"name\": \"string\",\n                    \"role\": \"string\",\n                    \"pendingInvitation\": \"boolean\"\n                }\n            ]\n            \"socialMedias\": [\n                {\n                    \"url\": \"string\",\n                    \"socialMediaType\": \"string\"\n                },\n            ],\n            \"shortDescription\": \"string\",\n            \"medical\": {\n                \"npi\": \"string\",\n                \"stateLicenseNumber\": \"string\",\n                \"insurancesAccepted\": [\n                    {\n                        \"id\": \"string\",\n                        \"label\": \"string\"\n                    },\n                ],\n                \"acceptingNewPatients\": \"boolean\",\n                \"employerAffiliation\": \"string\",\n                \"specialties\": [\n                    {\n                        \"specialty\": \"string\",\n                        \"primary\": \"boolean\"\n                    }\n                ],\n                \"webMdCampaignId\": \"string\",\n                \"insuranceNetworks\": [\n                    {\n                        \"insuranceNetwork\": {\n                            \"id\": \"string\",\n                            \"label\": \"string\"\n                        }\n                    },\n                ]\n            },\n            \"categories\": [\n                {\n                    \"category\": {\n                        \"id\": \"string\",\n                        \"label\": \"string\"\n                    },\n                    \"primary\": \"boolean\"\n                }\n            ],\n            \"places\": [\n                {\n                    \"placeID\": \"string\",\n                    \"officeName\": \"string\",\n                    \"address\": {\n                        \"streetAddress2\": \"string\",\n                        \"locality\": \"string\",\n                        \"region\": \"string\",\n                        \"postalCode\": \"string\",\n                        \"country\": \"string\",\n                        \"latitude\": \"string\",\n                        \"longitude\": \"string\",\n                        \"streetAddress1\": \"string\"\n                    },\n                    \"businessHours\": [\n                        {\n                            \"timePeriods\": [\n                                {\n                                    \"openDay\": \"string\",\n                                    \"openTime\": \"string\",\n                                    \"closeDay\": \"string\",\n                                    \"closeTime\": \"string\",\n                                    \"open24Hours\": \"boolean\",\n                                    \"closed\": \"boolean\"\n                                },\n                            ],\n                            \"name\": \"string\",\n                            \"primary\": \"boolean\",\n                            \"specialHours\": [\n                                {\n                                    \"openTime\": \"string\",\n                                    \"closeTime\": \"string\",\n                                    \"open24Hours\": \"boolean\",\n                                    \"closed\": \"boolean\",\n                                    \"startDate\": \"string\"\n                                },\n                            ],\n                            \"businessHourType\": \"string\"\n                        }\n                    ],\n                    \"phones\": [\n                        {\n                            \"number\": \"string\",\n                            \"extension\": \"string\",\n                            \"primary\": \"boolean\",\n                            \"country\": \"string\",\n                            \"phoneType\": \"string\"\n                        }\n                    ],\n                    \"websites\": [\n                        {\n                            \"url\": \"string\",\n                            \"primary\": \"boolean\",\n                            \"websiteType\": \"string\"\n                        }\n                    ],\n                    \"emails\": [\n                        {\n                            \"email\": \"string\",\n                            \"primary\": \"boolean\"\n                        },\n                    ],\n                    \"primary\": \"boolean\",\n                    \"officeStatus\": {\n                        \"officeState\": \"string\",\n                        \"operationalDate\": \"string\"\n                    },\n                    \"originalAddress\": {\n                        \"streetAddress2\": \"string\",\n                        \"locality\": \"string\",\n                        \"region\": \"string\",\n                        \"postalCode\": \"string\",\n                        \"country\": \"string\",\n                        \"latitude\": \"string\",\n                        \"longitude\": \"string\",\n                        \"streetAddress1\": \"string\"\n                    },\n                    \"linkedLuid\": \"integer\",\n                    \"relatedLocations\": [\n                        {\n                            \"type\": \"integer\",\n                            \"placeId\": \"string\"\n                        }\n                    ]\n                }\n            ],\n            \"professional\": {\n                \"title\": \"string\",\n                \"appellation\": \"string\",\n                \"degrees\": [\n                    {\n                        \"degree\": \"string\",\n                        \"primary\": \"boolean\"\n                    }\n                ]\n                \"firstName\": \"string\"\n                \"lastName\": \"string\",\n                \"middleName\": \"string\",\n                \"gender\": \"string\",\n                \"birthday\": \"string\",\n                \"biography\": \"string\",\n                \"certifications\": [\n                    {\n                        \"number\": \"string\",\n                        \"country\": \"string\",\n                        \"endDate\": \"string\",\n                        \"name\": \"string\",\n                        \"issuer\": \"string\",\n                        \"primary\": \"boolean\"\n                    }\n                ],\n                \"affiliations\": [\n                    {\n                        \"affiliation\": \"string\",\n                        \"primary\": \"boolean\"\n                    }\n                ],\n                \"educations\": [\n                    {\n                        \"type\": \"string\",\n                        \"institution\": \"string\",\n                        \"graduationYear\": \"string\",\n                        \"degree\": \"string\",\n                        \"primary\": \"boolean\"\n                    }\n                ],\n                \"languages\": [\n                    \"string\",\n                ],\n            },\n            \"serviceArea\": {\n                \"places\": [\"string\"],\n                \"businessType\": \"string\"\n            },\n            \"richKnowledge\": {\n                \"titleTag\": \"string\",\n                \"metaDescription\": \"string\",\n                \"metaKeywords\": [\"string\"],\n                \"htmlDescription\": \"string\",\n                \"zipCodesServed\": [\"string\"],\n                \"areasServed\": [\"string\"],\n                \"professionalStatement\": \"string\"\n            }\n            \"type\": \"string\",\n            \"primaryProfile\": \"boolean\",\n            \"profileDefinition\": \"string\",\n            \"createdDate\": \"string\",\n            \"updatedDate\": \"string\",\n            \"distance\": \"Double\",\n            \"slug\": \"string\"\n        },\n    ],\n    \"paging\": {\n        \"offset\": \"integer\",\n        \"limit\": \"integer\",\n        \"previous\": \"integer\",\n        \"next\": \"string\",\n        \"count\": \"integer\"\n    }\n}\n\n

\n","urlObject":{"path":["locations"],"host":["{{baseUrl}}"],"query":[{"description":{"content":"

Determines the starting point in the dataset from which data retrieval begins. It is useful for pagination, allowing users to skip a specified number of records before starting to fetch. Max offset is 35k.

\n","type":"text/plain"},"key":"offset","value":""},{"description":{"content":"

\n","type":"text/plain"},"key":"limit","value":""}],"variable":[]}},"response":[{"id":"3e227a9a-d7de-4875-93ff-35bb7b9537b8","name":"Success","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"Your API key"},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://api.reputation.com/v3/locations?offset=0&limit=2","protocol":"https","host":["api","reputation","com"],"path":["v3","locations"],"query":[{"key":"offset","value":"0","description":"This offsets the start of each page by the number specified. Max offset is 35k."},{"key":"limit","value":"2","description":"This is the maximum number of objects that may be returned. A query may return fewer than the value of limit due to filtering. Default limit is 20. Max limit is 2000."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"3247"},{"key":"etag","value":"W/\"caf-ys3g/zOdkmEIwxKxZ62+toUpkdc\""},{"key":"date","value":"Thu, 03 Aug 2023 09:01:34 GMT"},{"key":"x-envoy-upstream-service-time","value":"181"},{"key":"server","value":"istio-envoy"},{"key":"Via","value":"1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"locations\": [\n {\n \"id\": \"SA\",\n \"internalID\": \"737476\",\n \"optedOut\": false,\n \"internalName\": \"Simple Art\",\n \"industryID\": \"automotive-dealer\",\n \"parentID\": null,\n \"customVariables\": [\n {\n \"name\": \"test-inventory\",\n \"value\": \"www.apple.com\"\n },\n {\n \"name\": \"CAMPAIGN_ENROLLMENT_AND_SCHEDULE_PREFERENCE\",\n \"value\": \"MANUAL\"\n }\n ],\n \"customFilters\": [\n {\n \"name\": \"Brand\",\n \"value\": \"Gallery\"\n }\n ],\n \"state\": \"Active\",\n \"externalName\": \"Simple Art\",\n \"description\": \"Simple Art Page Descripton\",\n \"shortDescription\": \"Simple Art Page\",\n \"categories\": [\n {\n \"category\": {\n \"id\": \"TENANT_1990:OPEN_HEART_SURGERY\",\n \"label\": \"Open Heart Surgery\"\n },\n \"primary\": true\n }\n ],\n \"places\": [\n {\n \"officeName\": \"Simple Art\",\n \"address\": {\n \"streetAddress2\": null,\n \"locality\": \"Redwood City\",\n \"region\": \"CA\",\n \"postalCode\": \"94063\",\n \"country\": \"US\",\n \"latitude\": \"37.48805\",\n \"longitude\": \"-122.22439\",\n \"streetAddress1\": \"1001 Marshall St\"\n },\n \"businessHours\": null,\n \"phones\": [\n {\n \"number\": \"(408) 900-9080\",\n \"primary\": true,\n \"country\": \"US\",\n \"phoneType\": \"Local\"\n },\n {\n \"number\": \"(408) 990-9090\",\n \"primary\": false,\n \"country\": \"US\",\n \"phoneType\": \"Mobile\"\n }\n ],\n \"websites\": [\n {\n \"url\": \"http://www.yahoo.com\",\n \"primary\": true,\n \"websiteType\": \"Homepage\"\n }\n ],\n \"emails\": [\n {\n \"email\": \"repdef40+1990@gmail.com\",\n \"primary\": true\n }\n ],\n \"primary\": true,\n \"officeStatus\": {\n \"officeState\": \"Opening_Soon\",\n \"operationalDate\": \"2021-05-01\"\n },\n \"originalAddress\": {\n \"streetAddress2\": null,\n \"locality\": \"Redwood City\",\n \"region\": \"CA\",\n \"postalCode\": \"94063\",\n \"country\": \"US\",\n \"latitude\": \"37.48805\",\n \"longitude\": \"-122.22439\",\n \"streetAddress1\": \"1001 Marshall St\"\n },\n \"linkedLuid\": null,\n \"relatedLocations\": null\n }\n ],\n \"type\": \"RoofTop\",\n \"locationType\": \"main\",\n \"groupCode\": \"SA\",\n \"primaryProfile\": true,\n \"profileDefinition\": \"RoofTop\",\n \"createdDate\": \"2018-03-14T05:08:53\",\n \"updatedDate\": \"2023-04-07T07:45:01\",\n \"distance\": null,\n \"slug\": \"simple-art-simple-art-redwood-city-ca\"\n },\n {\n \"id\": \"BP\",\n \"internalID\": \"737493\",\n \"optedOut\": false,\n \"internalName\": \"Bay Plumbing & test (BP)\",\n \"industryID\": \"automotive-parts\",\n \"parentID\": null,\n \"customVariables\": [\n {\n \"name\": \"CAMPAIGN_ENROLLMENT_AND_SCHEDULE_PREFERENCE\",\n \"value\": \"MANUAL\"\n }\n ],\n \"customFilters\": [\n {\n \"name\": \"Brand\",\n \"value\": \"N/A\"\n }\n ],\n \"state\": \"Active\",\n \"externalName\": \"Bay Plumbing\",\n \"categories\": [\n {\n \"category\": {\n \"id\": \"MISSING_CATEGORY\",\n \"label\": \"Missing Category\"\n },\n \"primary\": true\n }\n ],\n \"places\": [\n {\n \"officeName\": \"Bay Plumbing\",\n \"address\": {\n \"streetAddress2\": null,\n \"locality\": \"Redwood City\",\n \"region\": \"CA\",\n \"postalCode\": \"94063\",\n \"country\": \"US\",\n \"latitude\": \"37.4880518\",\n \"longitude\": \"-122.2243949\",\n \"streetAddress1\": \"1001 Marshall St\"\n },\n \"businessHours\": null,\n \"phones\": [\n {\n \"number\": \"(650) 367-9493\",\n \"primary\": true,\n \"country\": \"US\",\n \"phoneType\": \"Local\"\n }\n ],\n \"websites\": [\n {\n \"url\": \"http://bayplumbing.net\",\n \"primary\": true,\n \"websiteType\": \"Homepage\"\n }\n ],\n \"emails\": [\n {\n \"email\": \"\",\n \"primary\": true\n }\n ],\n \"primary\": true,\n \"officeStatus\": null,\n \"originalAddress\": {\n \"streetAddress2\": null,\n \"locality\": \"Redwood City\",\n \"region\": \"CA\",\n \"postalCode\": \"94063-2052\",\n \"country\": \"US\",\n \"latitude\": \"37.48776\",\n \"longitude\": \"-122.22447\",\n \"streetAddress1\": \"1001 Marshall St\"\n },\n \"linkedLuid\": null,\n \"relatedLocations\": null\n }\n ],\n \"type\": \"RoofTop\",\n \"locationType\": \"main\",\n \"groupCode\": \"BP\",\n \"primaryProfile\": true,\n \"profileDefinition\": \"RoofTop\",\n \"createdDate\": \"2018-03-14T05:08:53\",\n \"updatedDate\": \"2023-04-07T07:45:01\",\n \"distance\": null,\n \"slug\": \"bay-plumbing-bay-plumbing-redwood-city-ca\"\n }\n ],\n \"paging\": {\n \"offset\": 0,\n \"limit\": 2,\n \"next\": \"https://api.reputation.com/v3/locations?offset=2&limit=2\"\n }\n}"}],"_postman_id":"3bfb15eb-8775-438b-afa0-cf6efd458da2"},{"name":"Save Location","id":"e6e8bb54-bd15-45a3-bc9a-79b0ee8a852e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-api-key","value":""}],"body":{"mode":"raw","raw":"{\n \"location\": {\n \"optedOut\": \"boolean\",\n \"internalName\": \"string\",\n \"industryID\": \"string\",\n \"externalName\": \"string\",\n \"places\": [\n {\n \"officeName\": \"string\",\n \"address\": {\n \"streetAddress1\": \"string\",\n \"locality\": \"string\",\n \"region\": \"string\",\n \"postalCode\": \"string\",\n \"country\": \"string\"\n },\n \"phones\": [\n {\n \"number\": \"string\",\n \"primary\": \"boolean\",\n \"country\": \"string\",\n \"phoneType\": \"string\"\n }\n ],\n \"primary\": \"boolean\"\n }\n ],\n \"description\": \"string\",\n \"categories\": [\n {\n \"category\": {\n \"label\": \"string\"\n },\n \"primary\": \"boolean\"\n }\n ],\n \"utm\": \"boolean\",\n \"attributes\": [\n {\n \"attributeId\": \"string\",\n \"boolValue\": \"boolean\"\n },\n {\n \"attributeId\": \"string\",\n \"values\": [\n {\n \"boolValue\": \"boolean\"\n },\n {\n \"boolValue\": \"boolean\"\n }\n ]\n }\n ],\n \"type\": \"string\",\n \"createdDate\": \"string\",\n \"updatedDate\": \"string\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/locations","description":"

Let's you submit a detailed location profile, providing comprehensive data that extends beyond just basic location attributes within the Business Listing Solution. You can also use this endpoint to add our update information about specific profile.

Please note: Incremental changes are not supported. All profile data must be included in each request to prevent existing data from being overwritten or removed.

Sample

JavaScript XHR Request

var xhr = new XMLHttpRequest();\nxhr.open('POST', 'https://api.reputation.com/v3/locations', true);\nxhr.setRequestHeader('x-api-key', 'Your API key');\nxhr.setRequestHeader('Content-Type', 'application/json;charset=UTF-8');\nxhr.onreadystatechange = function () {\n    if (xhr.readyState === 4 && xhr.status === 200) {\n        var response = JSON.parse(xhr.responseText);\n        console.log(response);\n    }\n};\nvar data = {\n    \"location\": [\n        {\n            \"id\": \"SA\",\n            \"internalID\": \"737476\",\n            \"optedOut\": false,\n            \"internalName\": \"Simple Art\",\n            \"industryID\": \"automotive-dealer\",\n            \"parentID\": null,\n            \"customVariables\": [\n                {\n                    \"name\": \"test-inventory\",\n                    \"value\": \"www.apple.com\"\n                },\n                {\n                    \"name\": \"CAMPAIGN_ENROLLMENT_AND_SCHEDULE_PREFERENCE\",\n                    \"value\": \"MANUAL\"\n                }\n            ],\n            \"customFilters\": [\n                {\n                    \"name\": \"Brand\",\n                    \"value\": \"Gallery\"\n                }\n            ],\n            \"state\": \"Active\",\n            \"externalName\": \"Simple Art\",\n            \"description\": \"Simple Art Page Descripton\",\n            \"shortDescription\": \"Simple Art Page\",\n            \"categories\": [\n                {\n                    \"category\": {\n                        \"id\": \"TENANT_1990:OPEN_HEART_SURGERY\",\n                        \"label\": \"Open Heart Surgery\"\n                    },\n                    \"primary\": true\n                }\n            ],\n            \"places\": [\n                {\n                    \"officeName\": \"Simple Art\",\n                    \"address\": {\n                        \"streetAddress2\": null,\n                        \"locality\": \"Redwood City\",\n                        \"region\": \"CA\",\n                        \"postalCode\": \"94063\",\n                        \"country\": \"US\",\n                        \"latitude\": \"37.48805\",\n                        \"longitude\": \"-122.22439\",\n                        \"streetAddress1\": \"1001 Marshall St\"\n                    },\n                    \"businessHours\": null,\n                    \"phones\": [\n                        {\n                            \"number\": \"(408) 900-9080\",\n                            \"primary\": true,\n                            \"country\": \"US\",\n                            \"phoneType\": \"Local\"\n                        },\n                        {\n                            \"number\": \"(408) 990-9090\",\n                            \"primary\": false,\n                            \"country\": \"US\",\n                            \"phoneType\": \"Mobile\"\n                        },\n                        {\n                            \"number\": \"(408) 990-9090\",\n                            \"primary\": false,\n                            \"country\": \"US\",\n                            \"phoneType\": \"WhatsApp\"\n                        },\n                        {\n                            \"number\": \"(408) 990-9090\",\n                            \"primary\": false,\n                            \"country\": \"US\",\n                            \"phoneType\": \"Text_SMS\"\n                        }\n                    ],\n                    \"websites\": [\n                        {\n                            \"url\": \"http://www.yahoo.com\",\n                            \"primary\": true,\n                            \"websiteType\": \"Homepage\"\n                        }\n                    ],\n                    \"emails\": [\n                        {\n                            \"email\": \"repdef40+1990@gmail.com\",\n                            \"primary\": true\n                        }\n                    ],\n                    \"primary\": true,\n                    \"officeStatus\": {\n                        \"officeState\": \"Opening_Soon\",\n                        \"operationalDate\": \"2021-05-01\"\n                    },\n                    \"originalAddress\": {\n                        \"streetAddress2\": null,\n                        \"locality\": \"Redwood City\",\n                        \"region\": \"CA\",\n                        \"postalCode\": \"94063\",\n                        \"country\": \"US\",\n                        \"latitude\": \"37.48805\",\n                        \"longitude\": \"-122.22439\",\n                        \"streetAddress1\": \"1001 Marshall St\"\n                    },\n                    \"linkedLuid\": null,\n                    \"relatedLocations\": null\n                }\n            ],\n            \"type\": \"RoofTop\",\n            \"locationType\": \"main\",\n            \"groupCode\": \"SA\",\n            \"primaryProfile\": true,\n            \"profileDefinition\": \"RoofTop\",\n            \"createdDate\": \"2018-03-14T05:08:53\",\n            \"updatedDate\": \"2023-04-07T07:45:01\",\n            \"distance\": null,\n            \"slug\": \"simple-art-simple-art-redwood-city-ca\"\n        }\n    ]\n};\nxhr.send(JSON.stringify(data));\n\n

Request Parameters

The following table is a list of parameters you can add to the body of your request to create or update your profile. It notes which parameters are required. The term required by parent is used for nested parameters that are required when an optional parent paremeter is included in the request.

Parameter	Parent	Data Type	Description
`location` (Required)		Object	Profile object
`id` (Required)	`location`	String	Location's unique id - ex. `SA`
`internalID`	`location`	String	Location's unique internal id. This is a read-only attribute. - ex. `737476`
`optedOut`	`location`	Boolean	Refers to enrolling the location profile in listings publishing - ex. `false` This is a read-only attribute.
`linkedProfileID`	`location`	String	Id used to reference existing linked profiles
`tenantID`	`location`	String	Tenant's unique id. Attribute becomes read-only after profile is created
`internalName`	`location`	String	Profile's internal name - ex. `Simple Art`
`externalName` (Required)	`location`	String	Profile's external name - ex. `Simple Art`
`industryID`	`location`	String	Profile's industry id - ex. `automotive-parts`
`parentID`	`location`	String	Parent-child relationship between multiple locations. Used for businesses or locations that exist within another location
`customVariables`	`location`	Object Array	List of custom variables. Custom variables can be used to pass metadata you want stored for reporting or integration mapping.
`name`	`customVariables`	String	Custom variable name - ex. `CAMPAIGN_ENROLLMENT_AND_SCHEDULE_PREFERENCE`
`value`	`customVariables`	String	Value of the custom variable - ex. `MANUAL`
`customFilters`	`location`	Object Arrary	List of custom filters. Custom filters can be used to pass metadata you want stored for reporting or integration mapping.
`name`	`customFilters`	String	Custom filter name - ex. `Brand`
`value`	`customFilters`	String	Value of the custom filter - ex. `Gallery`
`locationType`	`location`	String	Used to indicate the type of location. Example: main, parts, sales, service, etc. Required if the location is a departmental listing location - ex. `main`
`groupCode`	`location`	String	A common identifier used to associate the main location with its corresponding departmental or supplemental locations. This unique code must be the same for both the main location and any related department/supplemental locations - ex. `SA`
`primaryProfile`	`location`	Boolean	Denotes whether the profile is the primary linked profile - ex. `true`
`type` (Required)	`location`	String	Location type - ex. `Rooftop` `Person`
`profileDefinition`	`location`	String	Profile definition - ex. `RoofTop`
`state`	`location`	String	Defines the state of the entity, i.e. whether it is covered by the current contract with Reputation. If left empty, state will default to active - ex. `Active`
`places` (Required)	`location`	Object Array	List of \"Place\" objects
`placeID`	`places`	String	Place id
`officeName`	`places`	String	Office or practice name - ex. `Bay Plumbing`
`address` (Required)	`places`	Object	Address object
`streetAddress1` (Required)	`address`	String	Street address line 1 - ex. `1001 Marshall St`
`streetAddress2`	`address`	String	Street address line 2 - ex. `Suite 300 null` if there is no line 2
`locality` (Required)	`address`	String	Locality/city - ex. `Redwood City`
`region`	`address`	String	Region/State or Province - ex. `CA`
`country` (Required)	`address`	String	Country's 2 letter ISO Code - ex. `US`
`postalCode` (Required)	`address`	String	Postal Code/Zip Code - ex. `94063`
`latitude`	`address`	String	Address latitude - ex. `37.4880518`
`longitude`	`address`	String	Address longitude - ex. `-122.2243949`
`businessHours`	`places`	Object Array	List of \"business hours\" objects - If there are no objects, `null` is returned.
`name` (Required by parent)	`businessHours`	String	Name of the \"business hour\" object
`businessHourType` (Required by parent)	`businessHours`	String	Refers to the type of business hours. - valid values: `Main` `Sales` `Service` `Parts` `Holiday`
`timePeriods` (Required by parent)	`businessHours`	Object Array	List of \"Time Period\" objects to represent days and times opened/closed.
`openDay` (Required by parent)	`timePeriods`	String	Profile's open days - valid values: `Sunday`, `Monday`, `Tuesday`,`Wednesday`,`Thursday`,`Friday`,`Saturday`
`openTime`	`timePeriods`	String	Profile's open times in 24hr ISO 8601 - valid values: `00:00-24:00`, where 24:00 represents midnight at the end of the specified `openDay`.
`closeDay`(Required by parent)	`timePeriods`	String	Profile's closed days - valid values: `Sunday` ,`Monday`, `Tuesday` ,`Wednesday` ,`Thursday` ,`Friday` ,`Saturday`
`closeTime`	`timePeriods`	String	Profile's closed times in 24hr ISO 8601 - valid values: `00:00-24:00`, where 24:00 represents midnight at the end of the specified `closeDay`.
`open24Hours` (Required by parent)	`timePeriods`	Boolean	Denotes whether the profile is open 24 hours during the specified day range
`closed` (Required by parent)	`timePeriods`	Boolean	Denotes whether the profile is closed at the current time
`primary` (Required by parent)	`businessHours`	Boolean	Denotes whether business hours are the profile's primary hours
`specialHours`	`businessHours`	Object Array	List of \"special time period\" objects -similar to `timePeriods` but used for special instances
`startDate` (Required by parent)	`specialHours`	String	The calendar date the special hour period starts on - In ISO 8601 format (YYYY-MM-DD) .
`openTime`	`specialHours`	String	Time in 24hr ISO 8601 extended format (hh:mm). Valid values are 00:00-24:00, where 24:00 represents midnight at the end of the specified day field. Specified if `closed`and `open24Hours` is `false`.
`closeTime`	`speicalHours`	String	Time in 24hr ISO 8601 extended format (hh:mm). Valid values are 00:00-24:00, where 24:00 represents midnight at the end of the specified day field. Specified if `closed`and `open24Hours` is `false`.
`open24Hours`	`specialHours`	Boolean	Denotes whether open 24 hours during the specified day range. If true, `openTime`, and `closeTime` are ignored, and the date specified in startDate is treated as the location being open for the entire day.
`closed`	`specialHours`	Boolean	Denotes whether the profile is closed. If `true`, `openTime`, and `closeTime` are ignored, and the date specified in `startDate` is treated as the location being closed for the entire day.
`phones`	`places`	Object Array	List of phone number objects.
`phoneType` (Reqiured by Parent)	`phones`	String	Phone type - valid values: `Local`, `Mobile`, `Fax`, `TollFree`, `Tracked`, `Sales`, `Service`, `Parts`, `Emergency`, `GoogleOnly`, `FacebookOnly`, `BingOnly`, `FourSquareOnly`, `WhatsApp`, `Text_SMS`, `Other`
`number` (Required by parent)	`phones`	String	Phone number - ex. \"`(408) 900-9080`
`extension`	`phones`	String	Extension number
`country`	`phones`	String	Country of origin - ex. `US`
`primary` (Required by parent)	`phones`	Boolean	Denotes whether phone is primary
`websites`	`places`	Object Array	List of websites
`websiteType` (Required by parent)	`websites`	String	Type of website - valid values: `Homepage` ,`Reservation`, `Order`, `GoogleHomepage`, `Covid`, `Telehealth`, `Menu`, `BingHomepage`
`url` (Required by parent)	`websites`	String	Website URL - ex. `http://www.reputation.com`
`primary` (Required by parent)	`websites`	Boolean	Whether website is primary
`emails`	`places`	Object Array	List of emails
`email`(Required by parent)	`emails`	String	The business's email address - ex. `business@reputation.com`
`primary`(Required by parent)	`emails`	Boolean	Whether email is primary email
`officeStatus`	`places`	Object	An office status object containing the `officeState` and `operationalDate`.
`officeState`(Required by parent)	`officeStatus`	String	Office state/status type - valid values: `Open`,`Closed`,`Moved`,`Permanently_Closed`,`Opening_Soon`,`Closing_Soon`,`Temporarily_Closed`
`operationalDate`	`officeStatus`	String	Date of office state in ISO 8601 format (YYYY-MM-DD) - ex. `2021-05-01`
`primary` (Required)	`places`	Boolean	Whether place is business's primary place
`description`	`locations`	String	Description of the business - ex. `Simple Art Page Description`
`shortDescription`	`locations`	String	Short description to publish on Source site. Limit of 155 characters - ex. `Simple Art Page`
`tags`	`locations`	String	Keywords identifying the location, used in meta-tags - ex. `art`,`exclusive`,`low prices`
`utm`	`locations`	Boolean	Whether a UTM source is appended to a primary URL when it is sent to GoogleMyBusinees. UTM example: ?utm_source=local&utm_medium=organic&utm_camp
`attributes`	`locations`	Object Array	List of Attribute objects. Available attributes depend on selected categories. See Attributes section below for more details.
`attributeId` (Required by parent)	`attributes`	String	Attribute Id
`boolValue`	`attributes`	Boolean	Attribute boolean value. This field or `values`is used but not both. Valid values are: `true`or `false`
`values`	`attributes`	Object Array	List of Attribute values. This field or `boolValue`is used but not both
`id`	`values`	String	Attribute value Id
`boolValue`	`values`	Boolean	Boolean of attribute value
`owners`	`locations`	Object Array	List of owners
`name`	`owners`	String	The name of the admin. When making the initial invitation, this is the invitee's email address.
`role`	`owners`	String	Role of the owner
`pendingInvitation`	`owners`	Boolean	Status of the invitation sent to the owner.
`socialMedias`	`locations`	Object Array	List of social media objects
`socialMediaType` (Required by parent)	`socialMedias`	String	Type of social media - valid values: `Facebook`,`Twitter`,`Instagram`,`Snapchat`,`YouTube`,`LinkedIn`,`Pintrest`,`Blog`
`url` (Required by parent)	`socialMedias`	String	URL for social media
`medias`	`locations`	Object Array	List of media objects
`mediaType` (Required by parent)	`medias`	String	Media Type. png or jpeg file for cover photo: 16:9 aspect ratio with minimum size 400px - valid values: `Headshot`,`Cover`,`Profile`,`Logo`,`Video`,`Google_Logo`,`Google_Cover`,`Facebook_Profile`,`Facebook_Cover`,`Additional`
`url` (Required by parent)	`medias`	String	URL for Media
`title`	`medias`	String	Title for media object
`primary`	`medias`	Boolean	Whether media is primary
`medical`	`locations`	Object	Medical details provided if listing is for a medical business.
`npi` (Required by parent)	`medical`	String	National Provider Identifier (NPI) is a unique 10-digit identification number issued to health care providers in the United States. NPI is used to uniquely identify health care providers in the US.
`stateLicenseNumber`	`medical`	String	State license number
`insurancesAccepted`	`medical`	Object Array	List of insurance objects
`id`	`insurancesAccepted`	String	Id of the object
`label`	`insurancesAccepted`	String	Object label
`acceptingNewPatients`	`medical`	Boolean	Boolean used to determine whether a health care provider or facility is currently accepting new patients
`employerAffiliation`	`medical`	String	Used to characterize the employer affiliation, as doctors can be either employed or affiliated with a health care group. Example: Employed, Independent
`specialties`	`medical`	Object Array	List of specialties associated with the entity
`specialty`	`specialties`	String	Specialty
`primary`	`specialties`	Boolean	Whether specialty is primary
`webMdCampaignId`	`medical`	String	This is an ID provided by WebMD to shared clients between Reputation and WebMD that are running paid Carefinder campaigns on WebMD. This field will allow shared clients to manage their WebMD campaigns directly from the Reputation platform.
`insuranceNetworks`	`medical`	Object Array	List of insurance networks that are accepted by the health care provider or facility. This field will replace the deprecated InsurancesAccepted.
`insuranceNetork`	`medical`	Object Array	An insurance network is a list of the doctors, other health care providers, and hospitals that a plan has contracted with to provide medical care to its members
`id`	`insuranceNetork`	String	Id of the object
`label`	`insuranceNetork`	String	Label of the object
`professional`	`locations`	Object	If the listing is for service professional, then it will provide the details for the professional.
`title`	`professional`	String	Person's Title
`appellation`	`professional`	String	Person's Appellation
`degrees`	`professional`	Object Array	List of Degree objects
`degree`	`degrees`	Object	The degree object
`id` (Required by parent)	`degree`	String	Id of the degree object
`label`	`degree`	String	Descriptive text for the degree object
`primary`	`degrees`	Boolean	Whether degree is primary
`firstName`	`professional`	String	Person's first name
`lastName`	`professional`	String	Person's last name
`middleName`	`professional`	String	Person's middle name
`gender`	`professional`	String	Person's gender
`birthday`	`professional`	String	Person's Birthday in ISO 8601 format (YYYY-MM-DD)
`biography`	`professional`	String	Person's biography
`certifications`	`professional`	Object Array	List of certifications
`number`	`certifications`	String	Certification/License number
`country`	`certifications`	String	Country issuing certification. 2 letter ISO code.
`endDate`	`certifications`	String	Expiration date of the Certification/License (YYYY-MM-DD).
`name`	`certifications`	String	Certification name
`issuer`	`certifications`	String	Certification issuer
`primary`	`certifications`	Boolean	Whether certification is primary certification
`affiliations`	`professional`	Object Array	List of affiliations. For non-healthcare professionals, list of professional associations. For Healthcare Professionals, list of admitting hospitals.
`affiliation`	`affiliations`	String	Affiliation name
`primary`	`affiliations`	Boolean	Whether affiliation is primary affiliation. If none of the affiliations are defined as prmary=`true`, then the first affiliation will be defaulted to primary=`true`
`educations`	`professional`	Object Array	List of educational experience
`type`	`educations`	String	Type of edcuation - valid values: `Undergraduate`,`Graduate`,`Medical`,`Law`,`Internship`,`Fellowship`,`Residency`,`AdditionalTraining`,`BachelorOfScience`,`DentalSchool`,`MasterOfArts`,`Masters`,`MastersOfScience`,`NursingSchool`,`PHD`,`ProfessionalEducation`,`PsyD`,`Society`,`Certification`,`Education`,`ProfessionalAffiliations`,`ProfessionalMembership`,`SpecializationsAndProcedures`,`Awards`,`Other`
`institution`	`educations`	String	Name of institution
`graduationYear`	`educations`	String	Graduation year
`degree`	`educations`	String	Graduation Degree
`primary`	`educations`	String	Whether education is the professional's primary/main education
`languages`	`professionals`	String	List of languages
`serviceArea`	`locations`	Object	Service are details object (for service area businesses).
`places`	`serviceArea`	String Array	Zip Code or City Name, State, Country (if applicable)
`businessType`	`serviceArea`	String	Business type - valid values: `BUSINESS_TYPE_UNSPECIFIED`,`CUSTOMER_AND_BUSINESS_LOCATION`,`CUSTOMER_LOCATION_ONLY`
`categories`	`locations`	Object Array	List of category objects
`category` (Required)	`categories`	Object	Caregory object
`id`	`category`	String	Object id
`label`	`category`	String	Object label
`primary`	`categories`	Boolean	Whether `category` object is the primary object.
`paymentTypes`	`locations`	String Array	Comma separated list of accepted payment types
`richKnowledge`	`locations`	Object	Object containing metadata
`titleTag`	`richKnowledge`	String	The HTML element that specifies the title of the web page
`metaDescription`	`richKnowledge`	String	The HTML element that describes the subject of the webpage
`metaKeywords`	`richKnowledge`	String Array	The HTML element that lists keywords related to the webpage
`htmlDescription`	`richKnowledge`	String	HTML enabled business description of the profile
`zipCodesServed`	`richKnowledge`	String Array	The list of zipCodes served by the entity
`areasServed`	`richKnowledge`	String Array	The list of areas served by the entity
`professionalStatement`	`richKnowledge`	String	Brief statement of the professional represented by the entity
`covidMessage`	`locations`	String	This field allows communication centered around COVID-19. It can be used to communicate cleaning protocols, store capacity, security measures, mask requirements, and other measures. The field is limited to 200 characters and must only be used to provide messages related to COVID-19.
`createdDate`	`locations`	String	Profile's created date - Datetime ISO 8601
`updatedDate`	`locations`	String	Profile's updated date - Datetime ISO 8601
`distance`	`locations`	Number (Double)	Shows the distance of the Location from the provided Latitude and Longitude or Postal Code
`slug`	`locations`	String	Url slug
`paging`		Object	Object containing request pagination details
`offset`	`paging`	Integer (int64)	This offsets the start of each page by the number specified
`limit`	`paging`	Integer (int64)	This is the maximum number of objects that may be returned. A query may return fewer than the value of limit due to filtering.
`count`	`paging`	Integer (int64)	This is the maximum number of objects that may be returned for the search.
`previous`	`paging`	Integer (int64)	API endpoint that will return the next page of data. If not included, this is the last page of data.

Attributes

Attributes are features/flags on a business listings page that allow users to know what a business offers at a glance. For example, the attributes below are located under the service options

","urlObject":{"path":["locations"],"host":["{{baseUrl}}"],"query":[{"disabled":true,"description":{"content":"

Validates the request without actually creating a profile when set to true.

\n","type":"text/plain"},"key":"validateOnly","value":""},{"disabled":true,"description":{"content":"

Checks the request to ensure listings can be successfully created when set to true.

\n","type":"text/plain"},"key":"validateListings","value":""},{"disabled":true,"description":{"content":"

A list of source Ids, separated by commas. If \"validateListings\" is true and \"validateSources\" is not specified, all sources will undergo validation.

\n","type":"text/plain"},"key":"validateSources","value":""},{"disabled":true,"description":{"content":"

Bypasses the address normalization process when set to true.

\n","type":"text/plain"},"key":"skipAddressNormalization","value":""},{"disabled":true,"description":{"content":"

When set to true, irrelevant attributes for the primary category will be removed, retaining only the applicable ones.

\n","type":"text/plain"},"key":"optimizeAttributes","value":""},{"disabled":true,"description":{"content":"

If set to true and a media logo is provided, this logo will replace the current location's logo.

\n","type":"text/plain"},"key":"useLogoForLocation","value":""}],"variable":[]}},"response":[{"id":"e34c7188-8105-4413-a757-1d85984cbaec","name":"Success","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"Your API key"}],"body":{"mode":"raw","raw":"{\n \"location\": [\n {\n \"id\": \"SA\",\n \"internalID\": \"737476\",\n \"optedOut\": false,\n \"internalName\": \"Simple Art\",\n \"industryID\": \"automotive-dealer\",\n \"parentID\": null,\n \"customVariables\": [\n {\n \"name\": \"test-inventory\",\n \"value\": \"www.apple.com\"\n },\n {\n \"name\": \"CAMPAIGN_ENROLLMENT_AND_SCHEDULE_PREFERENCE\",\n \"value\": \"MANUAL\"\n }\n ],\n \"customFilters\": [\n {\n \"name\": \"Brand\",\n \"value\": \"Gallery\"\n }\n ],\n \"state\": \"Active\",\n \"externalName\": \"Simple Art\",\n \"description\": \"Simple Art Page Descripton\",\n \"shortDescription\": \"Simple Art Page\",\n \"categories\": [\n {\n \"category\": {\n \"id\": \"TENANT_1990:OPEN_HEART_SURGERY\",\n \"label\": \"Open Heart Surgery\"\n },\n \"primary\": true\n }\n ],\n \"places\": [\n {\n \"officeName\": \"Simple Art\",\n \"address\": {\n \"streetAddress2\": null,\n \"locality\": \"Redwood City\",\n \"region\": \"CA\",\n \"postalCode\": \"94063\",\n \"country\": \"US\",\n \"latitude\": \"37.48805\",\n \"longitude\": \"-122.22439\",\n \"streetAddress1\": \"1001 Marshall St\"\n },\n \"businessHours\": null,\n \"phones\": [\n {\n \"number\": \"(408) 900-9080\",\n \"primary\": true,\n \"country\": \"US\",\n \"phoneType\": \"Local\"\n },\n {\n \"number\": \"(408) 990-9090\",\n \"primary\": false,\n \"country\": \"US\",\n \"phoneType\": \"Mobile\"\n }\n ],\n \"websites\": [\n {\n \"url\": \"http://www.yahoo.com\",\n \"primary\": true,\n \"websiteType\": \"Homepage\"\n }\n ],\n \"emails\": [\n {\n \"email\": \"repdef40+1990@gmail.com\",\n \"primary\": true\n }\n ],\n \"primary\": true,\n \"officeStatus\": {\n \"officeState\": \"Opening_Soon\",\n \"operationalDate\": \"2021-05-01\"\n },\n \"originalAddress\": {\n \"streetAddress2\": null,\n \"locality\": \"Redwood City\",\n \"region\": \"CA\",\n \"postalCode\": \"94063\",\n \"country\": \"US\",\n \"latitude\": \"37.48805\",\n \"longitude\": \"-122.22439\",\n \"streetAddress1\": \"1001 Marshall St\"\n },\n \"linkedLuid\": null,\n \"relatedLocations\": null\n }\n ],\n \"type\": \"RoofTop\",\n \"locationType\": \"main\",\n \"groupCode\": \"SA\",\n \"primaryProfile\": true,\n \"profileDefinition\": \"RoofTop\",\n \"createdDate\": \"2018-03-14T05:08:53\",\n \"updatedDate\": \"2023-04-07T07:45:01\",\n \"distance\": null,\n \"slug\": \"simple-art-simple-art-redwood-city-ca\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.reputation.com/v3/locations","protocol":"https","host":["api","reputation","com"],"path":["v3","locations"],"query":[{"key":"validateOnly","value":"true","disabled":true},{"key":"validateListings","value":"true","disabled":true},{"key":"validateSources","value":"dolor ut","disabled":true},{"key":"skipAddressNormalization","value":"true","disabled":true},{"key":"optimizeAttributes","value":"true","disabled":true}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"346345\",\n \"optedOut\": false,\n \"internalName\": \"Store 100\",\n \"industryID\": \"home-services\",\n \"externalName\": \"Johns Plumbing Company\",\n \"places\": [\n {\n \"officeName\": \"Johns Plumbing Company\",\n \"address\": {\n \"streetAddress1\": \"123 Main Blvd\",\n \"streetAddress2\": null,\n \"locality\": \"Redwood City\",\n \"region\": \"CA\",\n \"postalCode\": \"95063\",\n \"country\": \"US\"\n },\n \"businessHours\": null,\n \"phones\": [\n {\n \"number\": \"(650) 555-2700\",\n \"primary\": true,\n \"country\": \"US\",\n \"phoneType\": \"Local\"\n }\n ],\n \"primary\": true\n }\n ],\n \"description\": \"Johns Plumbing Company\",\n \"categories\": [\n {\n \"category\": {\n \"id\": \"GENERAL_CONTRACTOR\",\n \"label\": \"General Contractor\"\n },\n \"primary\": true\n }\n ],\n \"paymentTypes\": null,\n \"tags\": null,\n \"utm\": false,\n \"attributes\": [\n {\n \"attributeId\": \"pay_debit_card\",\n \"boolValue\": false\n },\n {\n \"attributeId\": \"pay_credit_card_types_accepted\",\n \"values\": [\n {\n \"id\": \"american_express\",\n \"boolValue\": false\n },\n {\n \"id\": \"visa\",\n \"boolValue\": true\n }\n ]\n }\n ],\n \"type\": \"RoofTop\",\n \"createdDate\": \"2014-01-23T14:32:44\",\n \"updatedDate\": \"2014-01-23T14:32:44\"\n}"}],"_postman_id":"e6e8bb54-bd15-45a3-bc9a-79b0ee8a852e"},{"name":"Search Locations","id":"e60c20a2-2016-4e2d-93f2-26be1f349cd2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":""}],"url":"{{baseUrl}}/locations-search","description":"

Facilitates the searching of profiles based on various parameters like name, location, type, and more. It's designed to offer a comprehensive search capability for you to filter and retrieve specific profiles from the vast Business Listing Solution database.

Sample

JavaScript XHR Request

var xhr = new XMLHttpRequest();\nxhr.open('GET', 'https://api.reputation.com/v3/locations-search?type=Person&primaryProfile=true&sort=ASC&offset=0&limit=20', true);\nxhr.setRequestHeader('x-api-key', 'Your API key');\nxhr.onreadystatechange = function() {\n    if (xhr.readyState === 4 && xhr.status === 200) {\n        var response = JSON.parse(xhr.responseText);\n        console.log(response);\n    }\n};\nxhr.send();\n\n

Response Parameters

Parameter	Parent	Data Type	Description
`locations`		Object Array	An array of location profiles providing detailed information about specific locations.
`id`	`locations`	String	Identifier for the location - ex. `SA`
`internalID`	`locations`	String	The internal identification number assigned to the location - ex. `737476`
`optedOut`	`locations`	Boolean	Indicates whether the location has opted out of listings publishing.
`linkedProfileID`	`locations`	String	Id used to reference existing linked profiles
`tenantID`	`locations`	String	Tenant's unique id. Attribute becomes read-only after profile is created
`internalName`	`locations`	String	The internal name given to the location - ex. `Simple Art`
`externalName`	`locations`	String	Location's external name - ex. `Majestic Art`
`industryID`	`locations`	String	The industry identification associated with the location - ex. `automotive-dealer`
`parentID`	`locations`	String	The ID of the parent location if there's any, otherwise `null`.
`customVariables`	`locations`	Object Array	An array of custom variables associated with the location, containing the variable name and its value.
`name`	`customVariables`	String	Custom variable name - ex. `CAMPAIGN_ENROLLMENT_AND_SCHEDULE_PREFERENCE`
`value`	`customVariables`	String	Value of the custom variable - ex. `MANUAL`
`customFilters`	`locations`	Object Arrary	An array of custom filters applied to the location, containing the filter name and its value.
`name`	`customFilters`	String	Custom filter name - ex. `Brand`
`value`	`customFilters`	String	Value of the custom filter - ex. `Gallery`
`locationType`	`locations`	String	Specifies the location type whether it's `main`, `branch`, etc.
`groupCode`	`Location`	String	A common identifier used to associate the main location with its corresponding departmental or supplemental locations. This unique code must be the same for both the main location and any related department/supplemental locations - ex. `SA`
`primaryProfile`	`locations`	Boolean	Indicates if the profile is the primary one.
`type`	`locations`	String	Indicates the type of the location - ex. `Rooftop`
`profileDefinition`	`locations`	String	Definition or category of the profile - ex. `Rooftop`
`state`	`locations`	String	Defines the state of the entity, i.e. whether it is covered by the current contract with Reputation. If left empty, state will default to active - ex. `Active`
`places`	`locations`	Object Array	List of \"Place\" objects
`placeID`	`places`	String	Place id
`officeName`	`places`	String	Office or practice name - ex. `Bay Plumbing`
`address`	`places`	Object	Address object
`streetAddress1`	`address`	String	Street address line 1 - ex. `1001 Marshall St`
`streetAddress2`	`address`	String	Street address line 2 - ex. `Suite 300 null` if there is no line 2
`locality`	`address`	String	Locality/city - ex. `Redwood City`
`region`	`address`	String	Region/State or Province - ex. `CA`
`country`	`address`	String	Country's 2 letter ISO Code - ex. `US`
`postalCode`	`address`	String	Postal Code/Zip Code - ex. `94063`
`latitude`	`address`	String	Address latitude - ex. `37.4880518`
`longitude`	`address`	String	Address longitude - ex. `-122.2243949`
`originalAddress`	`places`	Object	Raw non-normalized version of the address inputed by the user
`streetAddress1`	`originalAddress`	String	Street address line 1 - ex. `1001 Marshall St`
`streetAddress2`	`originalAddress`	String	Street address line 2 - ex. `Suite 300 null` if there is no line 2
`locality`	`originalAddress`	String	Locality/city - ex. `Redwood City`
`region`	`orignialAddress`	String	Region/State or Province - ex. `CA`
`country`	`originalAddress`	String	Country's 2 letter ISO Code - ex. `US`
`postalCode`	`originalAdress`	String	Postal Code/Zip Code - ex. `94063-2052`
`latitude`	`originalAddress`	String	Address latitude - ex. `37.48776`
`longitude`	`originalAddress`	String	Address longitude - ex. `-122.2243949`
`businessHours`	`places`	Object Array	List of \"business hours\" objects - If there are no objects, `null` is returned.
`name`	`businessHours`	String	Name of the \"business hour\" object
`businessHourType`	`businessHours`	String	Refers to the type of business hours. - valid values: `Main` `Sales` `Service` `Parts` `Holiday`
`timePeriods`	`businessHours`	Object Array	List of \"Time Period\" objects to represent days and times opened/closed.
`openDay`	`timePeriods`	String	Profile's open days - valid values: `Sunday`, `Monday`, `Tuesday`,`Wednesday`,`Thursday`,`Friday`,`Saturday`
`openTime`	`timePeriods`	String	Profile's open times in 24hr ISO 8601 - valid values: `00:00-24:00`, where 24:00 represents midnight at the end of the specified `openDay`.
`closeDay`	`timePeriods`	String	Profile's closed days - valid values: `Sunday` ,`Monday`, `Tuesday` ,`Wednesday` ,`Thursday` ,`Friday` ,`Saturday`
`closeTime`	`timePeriods`	String	Profile's closed times in 24hr ISO 8601 - valid values: `00:00-24:00`, where 24:00 represents midnight at the end of the specified `closeDay`.
`open24Hours`	`timePeriods`	Boolean	Denotes whether the profile is open 24 hours during the specified day range
`closed`	`timePeriods`	Boolean	Denotes whether the profile is closed at the current time
`primary`	`businessHours`	Boolean	Denotes whether business hours are the profile's primary hours
`specialHours`	`businessHours`	Object Array	List of \"special time period\" objects -similar to `timePeriods` but used for special instances
`startDate`	`specialHours`	String	The calendar date the special hour period starts on - In ISO 8601 format (YYYY-MM-DD) .
`openTime`	`specialHours`	String	Time in 24hr ISO 8601 extended format (hh:mm). Valid values are 00:00-24:00, where 24:00 represents midnight at the end of the specified day field. Specified if `closed`and `open24Hours` is `false`.
`closeTime`	`speicalHours`	String	Time in 24hr ISO 8601 extended format (hh:mm). Valid values are 00:00-24:00, where 24:00 represents midnight at the end of the specified day field. Specified if `closed`and `open24Hours` is `false`.
`open24Hours`	`specialHours`	Boolean	Denotes whether open 24 hours during the specified day range. If true, `openTime`, and `closeTime` are ignored, and the date specified in startDate is treated as the location being open for the entire day.
`closed`	`specialHours`	Boolean	Denotes whether the profile is closed. If `true`, `openTime`, and `closeTime` are ignored, and the date specified in `startDate` is treated as the location being closed for the entire day.
`phones`	`places`	Object Array	List of phone number objects.
`phoneType`	`phones`	String	Phone type - valid values: `Local`, `Mobile`, `Fax`, `TollFree`, `Tracked`, `Sales`, `Service`, `Parts`, `Emergency`, `GoogleOnly`, `FacebookOnly`, `BingOnly`, `FourSquareOnly`, `WhatsApp`, `Text_SMS`, `Other`
`number`	`phones`	String	Phone number - ex. \"`(408) 900-9080`
`extension`	`phones`	String	Extension number
`country`	`phones`	String	Country of origin - ex. `US`
`primary`	`phones`	Boolean	Denotes whether phone is primary
`websites`	`places`	Object Array	List of websites
`websiteType`	`websites`	String	Type of website - valid values: `Homepage` ,`Reservation`, `Order`, `GoogleHomepage`, `Covid`, `Telehealth`, `Menu`
`url`	`websites`	String	Website URL - ex. `http://www.reputation.com`
`primary`	`websites`	Boolean	Whether website is primary
`emails`	`places`	Object Array	List of emails
`email`	`emails`	String	The business's email address - ex. `business@reputation.com`
`primary`	`emails`	Boolean	Whether email is primary email
`officeStatus`	`places`	Object	An office status object containing the `officeState` and `operationalDate`.
`officeState`	`officeStatus`	String	Office state/status type - valid values: `Open`,`Closed`,`Moved`,`Permanently_Closed`,`Opening_Soon`,`Closing_Soon`,`Temporarily_Closed`
`operationalDate`	`officeStatus`	String	Date of office state in ISO 8601 format (YYYY-MM-DD) - ex. `2021-05-01`
`primary`	`places`	Boolean	Whether place is business's primary place
`description`	`locations`	String	Description of the business - ex. `Simple Art Page Description`
`shortDescription`	`locations`	String	Short description to publish on Source site. Limit of 155 characters - ex. `Simple Art Page`
`tags`	`locations`	String	Keywords identifying the location, used in meta-tags - ex. `art`,`exclusive`,`low prices`
`utm`	`locations`	Boolean	Whether a UTM source is appended to a primary URL when it is sent to GoogleMyBusinees. UTM example: ?utm_source=local&utm_medium=organic&utm_camp
`attributes`	`locations`	Object Array	List of Attribute objects. Available attributes depend on selected categories. See Attributes section below for more details.
`attributeId`	`attributes`	String	Attribute Id
`boolValue`	`attributes`	Boolean	Attribute boolean value. This field or `values`is used but not both. Valid values are: `true`or `false`
`values`	`attributes`	Object Array	List of Attribute values. This field or `boolValue`is used but not both
`id`	`values`	String	Attribute value Id
`boolValue`	`values`	Boolean	Boolean of attribute value
`owners`	`locations`	Object Array	List of owners
`name`	`owners`	String	The name of the admin. When making the initial invitation, this is the invitee's email address.
`role`	`owners`	String	Role of the owner
`pendingInvitation`	`owners`	Boolean	Status of the invitation sent to the owner.
`socialMedias`	`locations`	Object Array	List of social media objects
`socialMediaType`	`socialMedias`	String	Type of social media - valid values: `Facebook`,`Twitter`,`Instagram`,`Snapchat`,`YouTube`,`LinkedIn`,`Pintrest`,`Blog`
`url`	`socialMedias`	String	URL for social media
`medias`	`locations`	Object Array	List of media objects
`mediaType`	`medias`	String	Media Type. png or jpeg file for cover photo: 16:9 aspect ratio with minimum size 400px - valid values: `Headshot`,`Cover`,`Profile`,`Logo`,`Video`,`Google_Logo`,`Google_Cover`,`Facebook_Profile`,`Facebook_Cover`,`Additional`
`url`	`medias`	String	URL for Media
`title`	`medias`	String	Title for media object
`primary`	`medias`	Boolean	Whether media is primary
`medical`	`locations`	Object	Medical details provided if listing is for a medical business.
`npi`	`medical`	String	National Provider Identifier (NPI) is a unique 10-digit identification number issued to health care providers in the United States. NPI is used to uniquely identify health care providers in the US.
`stateLicenseNumber`	`medical`	String	State license number
`insurancesAccepted`	`medical`	Object Array	List of insurance objects
`id`	`insurancesAccepted`	String	Id of the object
`label`	`insurancesAccepted`	String	Object label
`acceptingNewPatients`	`medical`	Boolean	Boolean used to determine whether a health care provider or facility is currently accepting new patients
`employerAffiliation`	`medical`	String	Used to characterize the employer affiliation, as doctors can be either employed or affiliated with a health care group ex. `Employed`, `Independent`
`specialties`	`medical`	Object Array	List of specialties associated with the entity.
`specialty`	`specialties`	String	Specialty type.
`primary`	`specialties`	Boolean	Whether specialty is primary.
`webMdCampaignId`	`medical`	String	This is an ID provided by WebMD to shared clients between Reputation and WebMD that are running paid Carefinder campaigns on WebMD. This field will allow shared clients to manage their WebMD campaigns directly from the Reputation platform.
`insuranceNetworks`	`medical`	Object Array	List of insurance networks that are accepted by the health care provider or facility. This field will replace the deprecated InsurancesAccepted.
`insuranceNetork`	`medical`	Object Array	An insurance network is a list of the doctors, other health care providers, and hospitals that a plan has contracted with to provide medical care to its members
`id`	`insuranceNetork`	String	Id of the object
`label`	`insuranceNetork`	String	Label of the object
`professional`	`locations`	Object	If the listing is for service professional, then it will provide the details for the professional.
`title`	`professional`	String	Person's Title
`appellation`	`professional`	String	Person's Appellation
`degrees`	`professional`	Object Array	List of Degrees
`degree`	`degrees`	String	Name of degree
`primary`	`degrees`	Boolean	Whether degree is primary
`firstName`	`professional`	String	Person's first name
`lastName`	`professional`	String	Person's last name
`middleName`	`professional`	String	Person's middle name
`gender`	`professional`	String	Person's gender
`birthday`	`professional`	String	Person's Birthday in ISO 8601 format (YYYY-MM-DD)
`biography`	`professional`	String	Person's biography
`certifications`	`professional`	Object Array	List of certifications
`number`	`certifications`	String	Certification/License number
`country`	`certifications`	String	Country issuing certification. 2 letter ISO code.
`endDate`	`certifications`	String	Expiration date of the Certification/License (YYYY-MM-DD).
`name`	`certifications`	String	Certification name
`issuer`	`certifications`	String	Certification issuer
`primary`	`certifications`	Boolean	Whether certification is primary certification
`affiliations`	`professional`	Object Array	List of affiliations. For non-healthcare professionals, list of professional associations. For Healthcare Professionals, list of admitting hospitals.
`affiliation`	`affiliations`	String	Affiliation name
`primary`	`affiliations`	Boolean	Whether affiliation is primary affiliation. If none of the affiliations are defined as prmary=`true`, then the first affiliation will be defaulted to primary=`true`
`educations`	`professional`	Object Array	List of educational experience
`type`	`educations`	String	Type of edcuation - valid values: `Undergraduate`,`Graduate`,`Medical`,`Law`,`Internship`,`Fellowship`,`Residency`,`AdditionalTraining`,`BachelorOfScience`,`DentalSchool`,`MasterOfArts`,`Masters`,`MastersOfScience`,`NursingSchool`,`PHD`,`ProfessionalEducation`,`PsyD`,`Society`,`Certification`,`Education`,`ProfessionalAffiliations`,`ProfessionalMembership`,`SpecializationsAndProcedures`,`Awards`,`Other`
`institution`	`educations`	String	Name of institution
`graduationYear`	`educations`	String	Graduation year
`degree`	`educations`	String	Graduation Degree
`primary`	`educations`	String	Whether education is the professional's primary/main education
`languages`	`professionals`	String	List of languages
`serviceArea`	`locations`	Object	Service are details object (for service area businesses).
`places`	`serviceArea`	String Array	Zip Code or City Name, State, Country (if applicable)
`businessType`	`serviceArea`	String	Business type - valid values: `BUSINESS_TYPE_UNSPECIFIED`,`CUSTOMER_AND_BUSINESS_LOCATION`,`CUSTOMER_LOCATION_ONLY`
`categories`	`locations`	Object Array	List of category objects
`category`	`categories`	Object	Caregory object
`id`	`category`	String	Object id
`label`	`category`	String	Object label
`primary`	`categories`	Boolean	Whether `category` object is the primary object.
`paymentTypes`	`locations`	String Array	Comma separated list of accepted payment types
`richKnowledge`	`locations`	Object	Object containing metadata
`titleTag`	`richKnowledge`	String	The HTML element that specifies the title of the web page
`metaDescription`	`richKnowledge`	String	The HTML element that describes the subject of the webpage
`metaKeywords`	`richKnowledge`	String Array	The HTML element that lists keywords related to the webpage
`htmlDescription`	`richKnowledge`	String	HTML enabled business description of the profile
`zipCodesServed`	`richKnowledge`	String Array	The list of zipCodes served by the entity
`areasServed`	`richKnowledge`	String Array	The list of areas served by the entity
`professionalStatement`	`richKnowledge`	String	Brief statement of the professional represented by the entity
`covidMessage`	`locations`	String	This field allows communication centered around COVID-19. It can be used to communicate cleaning protocols, store capacity, security measures, mask requirements, and other measures. The field is limited to 200 characters and must only be used to provide messages related to COVID-19.
`createdDate`	`locations`	String	Profile's created date - Datetime ISO 8601
`updatedDate`	`locations`	String	Profile's updated date - Datetime ISO 8601
`distance`	`locations`	Number (Double)	Shows the distance of the Location from the provided Latitude and Longitude or Postal Code
`slug`	`locations`	String	Url slug
`paging`		Object	Object containing request pagination details
`offset`	`paging`	Integer (int64)	This offsets the start of each page by the number specified
`limit`	`paging`	Integer (int64)	Determines the number of items returned in the current response. This is distinct from rate limiting and refers to the size of the data set returned, which is controlled by the value you specify. The default limit is 20 locations, with a maximum possible limit of 2,000.
`count`	`paging`	Integer (int64)	This is the maximum number of objects that may be returned for the search.
`previous`	`paging`	Integer (int64)	API endpoint that will return the next page of data. If not included, this is the last page of data.

Response Schema

{\n    \"locations\": [\n        {\n            \"id\": \"string\",\n            \"internalID\": \"string\",\n            \"optedOut\": \"boolean\",\n            \"linkedProfileID\": \"string\",\n            \"tenantID\": \"string\",\n            \"internalName\": \"string\",\n            \"externalName\": \"string\",\n            \"industryID\": \"string\",\n            \"parentID\": \"string\",\n            \"customVariables\": [\n                {\n                    \"name\": \"string\",\n                    \"value\": \"string\"\n                }\n            ],\n            \"customFilters\": [\n                {\n                    \"name\": \"string\",\n                    \"value\": \"string\"\n                }\n            ],\n            \"locationType\": \"string\",\n            \"groupCode\": \"string\",\n            \"state\": \"string\",\n            \"utm\": \"boolean\",\n            \"description\": \"string\",\n            \"tags\": [\n                \"string\",\n            ],\n            \"paymentTypes\": [\n                \"string\"\n            ],\n            \"covidMessage\": \"string\",\n            \"medias\": [\n                {\n                    \"url\": \"string\",\n                    \"title\": \"string\",\n                    \"mediaType\": \"string\",\n                    \"primary\": \"boolean\"\n                }\n            ],\n            \"attributes\": [\n                {\n                    \"attributeId\": \"string\",\n                    \"boolValue\": \"boolean\"\n                },\n                {\n                    \"attributeId\": \"string\",\n                    \"values\": [\n                        {\n                            \"id\": \"string\",\n                            \"boolValue\": \"boolean\"\n                        },\n                    ]\n                }\n            ],\n            \"owners\": [\n                {\n                    \"name\": \"string\",\n                    \"role\": \"string\",\n                    \"pendingInvitation\": \"boolean\"\n                }\n            ]\n            \"socialMedias\": [\n                {\n                    \"url\": \"string\",\n                    \"socialMediaType\": \"string\"\n                },\n            ],\n            \"shortDescription\": \"string\",\n            \"medical\": {\n                \"npi\": \"string\",\n                \"stateLicenseNumber\": \"string\",\n                \"insurancesAccepted\": [\n                    {\n                        \"id\": \"string\",\n                        \"label\": \"string\"\n                    },\n                ],\n                \"acceptingNewPatients\": \"boolean\",\n                \"employerAffiliation\": \"string\",\n                \"specialties\": [\n                    {\n                        \"specialty\": \"string\",\n                        \"primary\": \"boolean\"\n                    }\n                ],\n                \"webMdCampaignId\": \"string\",\n                \"insuranceNetworks\": [\n                    {\n                        \"insuranceNetwork\": {\n                            \"id\": \"string\",\n                            \"label\": \"string\"\n                        }\n                    },\n                ]\n            },\n            \"categories\": [\n                {\n                    \"category\": {\n                        \"id\": \"string\",\n                        \"label\": \"string\"\n                    },\n                    \"primary\": \"boolean\"\n                }\n            ],\n            \"places\": [\n                {\n                    \"placeID\": \"string\",\n                    \"officeName\": \"string\",\n                    \"address\": {\n                        \"streetAddress2\": \"string\",\n                        \"locality\": \"string\",\n                        \"region\": \"string\",\n                        \"postalCode\": \"string\",\n                        \"country\": \"string\",\n                        \"latitude\": \"string\",\n                        \"longitude\": \"string\",\n                        \"streetAddress1\": \"string\"\n                    },\n                    \"businessHours\": [\n                        {\n                            \"timePeriods\": [\n                                {\n                                    \"openDay\": \"string\",\n                                    \"openTime\": \"string\",\n                                    \"closeDay\": \"string\",\n                                    \"closeTime\": \"string\",\n                                    \"open24Hours\": \"boolean\",\n                                    \"closed\": \"boolean\"\n                                },\n                            ],\n                            \"name\": \"string\",\n                            \"primary\": \"boolean\",\n                            \"specialHours\": [\n                                {\n                                    \"openTime\": \"string\",\n                                    \"closeTime\": \"string\",\n                                    \"open24Hours\": \"boolean\",\n                                    \"closed\": \"boolean\",\n                                    \"startDate\": \"string\"\n                                },\n                            ],\n                            \"businessHourType\": \"string\"\n                        }\n                    ],\n                    \"phones\": [\n                        {\n                            \"number\": \"string\",\n                            \"extension\": \"string\",\n                            \"primary\": \"boolean\",\n                            \"country\": \"string\",\n                            \"phoneType\": \"string\"\n                        }\n                    ],\n                    \"websites\": [\n                        {\n                            \"url\": \"string\",\n                            \"primary\": \"boolean\",\n                            \"websiteType\": \"string\"\n                        }\n                    ],\n                    \"emails\": [\n                        {\n                            \"email\": \"string\",\n                            \"primary\": \"boolean\"\n                        },\n                    ],\n                    \"primary\": \"boolean\",\n                    \"officeStatus\": {\n                        \"officeState\": \"string\",\n                        \"operationalDate\": \"string\"\n                    },\n                    \"originalAddress\": {\n                        \"streetAddress2\": \"string\",\n                        \"locality\": \"string\",\n                        \"region\": \"string\",\n                        \"postalCode\": \"string\",\n                        \"country\": \"string\",\n                        \"latitude\": \"string\",\n                        \"longitude\": \"string\",\n                        \"streetAddress1\": \"string\"\n                    },\n                    \"linkedLuid\": \"integer\",\n                    \"relatedLocations\": [\n                        {\n                            \"type\": \"integer\",\n                            \"placeId\": \"string\"\n                        }\n                    ]\n                }\n            ],\n            \"professional\": {\n                \"title\": \"string\",\n                \"appellation\": \"string\",\n                \"degrees\": [\n                    {\n                        \"degree\": \"string\",\n                        \"primary\": \"boolean\"\n                    }\n                ]\n                \"firstName\": \"string\"\n                \"lastName\": \"string\",\n                \"middleName\": \"string\",\n                \"gender\": \"string\",\n                \"birthday\": \"string\",\n                \"biography\": \"string\",\n                \"certifications\": [\n                    {\n                        \"number\": \"string\",\n                        \"country\": \"string\",\n                        \"endDate\": \"string\",\n                        \"name\": \"string\",\n                        \"issuer\": \"string\",\n                        \"primary\": \"boolean\"\n                    }\n                ],\n                \"affiliations\": [\n                    {\n                        \"affiliation\": \"string\",\n                        \"primary\": \"boolean\"\n                    }\n                ],\n                \"educations\": [\n                    {\n                        \"type\": \"string\",\n                        \"institution\": \"string\",\n                        \"graduationYear\": \"string\",\n                        \"degree\": \"string\",\n                        \"primary\": \"boolean\"\n                    }\n                ],\n                \"languages\": [\n                    \"string\",\n                ],\n            },\n            \"serviceArea\": {\n                \"places\": [\"string\"],\n                \"businessType\": \"string\"\n            },\n            \"richKnowledge\": {\n                \"titleTag\": \"string\",\n                \"metaDescription\": \"string\",\n                \"metaKeywords\": [\"string\"],\n                \"htmlDescription\": \"string\",\n                \"zipCodesServed\": [\"string\"],\n                \"areasServed\": [\"string\"],\n                \"professionalStatement\": \"string\"\n            }\n            \"type\": \"string\",\n            \"primaryProfile\": \"boolean\",\n            \"profileDefinition\": \"string\",\n            \"createdDate\": \"string\",\n            \"updatedDate\": \"string\",\n            \"distance\": \"Double\",\n            \"slug\": \"string\"\n        },\n    ],\n    \"paging\": {\n        \"offset\": \"integer\",\n        \"limit\": \"integer\",\n        \"previous\": \"integer\",\n        \"next\": \"string\",\n        \"count\": \"integer\"\n    }\n}\n\n

\n","urlObject":{"path":["locations-search"],"host":["{{baseUrl}}"],"query":[{"disabled":true,"description":{"content":"

First name of the service provider.

\n","type":"text/plain"},"key":"firstName","value":""},{"disabled":true,"description":{"content":"

Last name of the service provider.

\n","type":"text/plain"},"key":"lastName","value":""},{"disabled":true,"description":{"content":"

Unique identifier for a specific place.

\n","type":"text/plain"},"key":"placeID","value":""},{"disabled":true,"description":{"content":"

Identifier representing a parent location. Useful for businesses or entities located within a larger establishment.

\n","type":"text/plain"},"key":"parentID","value":""},{"disabled":true,"description":{"content":"

Identifier of the linked profile.

\n","type":"text/plain"},"key":"linkedProfileID","value":""},{"disabled":true,"description":{"content":"

Name of the specific office or establishment.

\n","type":"text/plain"},"key":"officeName","value":""},{"disabled":true,"description":{"content":"

City or locality where the provider is based.

\n","type":"text/plain"},"key":"locality","value":""},{"disabled":true,"description":{"content":"

State or region where the provider operates.

\n","type":"text/plain"},"key":"region","value":""},{"disabled":true,"description":{"content":"

ZIP or postal code of the provider's location.

\n","type":"text/plain"},"key":"postalCode","value":""},{"disabled":true,"description":{"content":"

Gender of the provider. Accepts values: Male, Female, Unknown.

\n","type":"text/plain"},"key":"gender","value":""},{"disabled":true,"description":{"content":"

Type of phone. Valid values are: Local, Mobile, Fax, TollFree, Tracked, Sales, Service, Parts, Emergency, GoogleOnly, FacebookOnly, BingOnly, FoursquareOnly, Other

\n","type":"text/plain"},"key":"phoneType","value":""},{"disabled":true,"description":{"content":"

Specifies the type of the associated website. Options include: Homepage, Reservation, Order, GoogleHomepage, Covid, Telehealth, Menu

\n","type":"text/plain"},"key":"websiteType","value":""},{"disabled":true,"description":{"content":"

Defines the profile type. Possible values are: Person, RoofTop.

\n","type":"text/plain"},"key":"type","value":""},{"disabled":true,"description":{"content":"

Classification or definition of the profile.

\n","type":"text/plain"},"key":"profileDefinition","value":""},{"disabled":true,"description":{"content":"

A list of category identifiers.

\n","type":"text/plain"},"key":"categoryID","value":""},{"disabled":true,"description":{"content":"

Names of categories. For names containing commas, encapsulate within double quotes.

\n","type":"text/plain"},"key":"categoryName","value":""},{"disabled":true,"description":{"content":"

Tags associated with the profile, accepted in JSON or as comma-separated values.

\n","type":"text/plain"},"key":"tag","value":""},{"disabled":true,"description":{"content":"

A list of associated insurance identifiers.

\n","type":"text/plain"},"key":"insuranceID","value":""},{"disabled":true,"description":{"content":"

Names of insurance providers.

\n","type":"text/plain"},"key":"insuranceName","value":""},{"disabled":true,"description":{"content":"

Languages spoken or offered by the provider.

\n","type":"text/plain"},"key":"language","value":""},{"disabled":true,"description":{"content":"

Whether accepting new patients. Valid values are: true or false

\n","type":"text/plain"},"key":"acceptingNewPatients","value":""},{"disabled":true,"description":{"content":"

List of Specialty Ids

\n","type":"text/plain"},"key":"specialtyID","value":""},{"disabled":true,"description":{"content":"

Indicates if the provider is accepting new patients. Accepts values: true, false.

\n","type":"text/plain"},"key":"primaryProfile","value":""},{"disabled":true,"description":{"content":"

Latitude for a radius-based search. Requires both longitude and radius when specified.

\n","type":"text/plain"},"key":"lat","value":""},{"disabled":true,"description":{"content":"

Longitude for a radius-based search. Requires both latitude and radius when specified.

\n","type":"text/plain"},"key":"lng","value":""},{"disabled":true,"description":{"content":"

Search radius. Mandatory with latitude and longitude. Can also be paired with postalCode for centralized postal code searches.

\n","type":"text/plain"},"key":"radius","value":""},{"disabled":true,"description":{"content":"

Fields for sorting results. The direction (ASC or DESC) can be specified.

Examples:

lastName:DESC,firstName:ASC,distance:DESC,officeName:ASC

\n","type":"text/plain"},"key":"sort","value":""},{"disabled":true,"description":{"content":"

Skips the starting results by the specified number. Maximum offset is 35,000.

\n","type":"text/plain"},"key":"offset","value":""},{"disabled":true,"description":{"content":"

\n","type":"text/plain"},"key":"limit","value":""},{"disabled":true,"description":{"content":"

A partial search string to match results.

\n","type":"text/plain"},"key":"query","value":""},{"disabled":true,"description":{"content":"

Fetches results updated after the specified date. Date should be in ISO 8601 format.

\n","type":"text/plain"},"key":"updatedSince","value":""}],"variable":[]}},"response":[{"id":"6571f70c-e14f-4bb8-9443-9fa8e822c965","name":"Success","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"Your API key"}],"url":{"raw":"https://api.reputation.com/v3/locations-search?type=Person&primaryProfile=true&sort=ASC&offset=0&limit=20","protocol":"https","host":["api","reputation","com"],"path":["v3","locations-search"],"query":[{"key":"firstName","value":"","description":"First name of the provider\n\n","disabled":true},{"key":"lastName","value":"","description":"Last name of the provider","disabled":true},{"key":"placeID","value":"BP","description":"Place Id","disabled":true},{"key":"parentID","value":"","description":"Parent id. Parent-child relationship between multiple locations. Used for businesses or locations that exist within another location.","disabled":true},{"key":"linkedProfileID","value":"","description":"Linked Profile Id\n\n","disabled":true},{"key":"officeName","value":"Johns Plumbing Company","description":"Name of the office","disabled":true},{"key":"locality","value":"Redwood Cit","description":"City / Locality of the provider\n\n","disabled":true},{"key":"region","value":"CA","description":"Region / State of the provider\n\n","disabled":true},{"key":"postalCode","value":"95063","description":"Postal code / Zip code of the provider\n\n","disabled":true},{"key":"gender","value":"Male","description":"Gender of the provider. Valid values are: Male, Female, Unknown\n\n","disabled":true},{"key":"phoneType","value":"Local","description":"Type of phone. Valid values are: Local, Mobile, Fax, TollFree, Tracked, Sales, Service, Parts, Emergency, GoogleOnly, FacebookOnly, BingOnly, FoursquareOnly, Other","disabled":true},{"key":"websiteType","value":"","description":"Type of website. Valid values are: Homepage, Reservation, Order, GoogleHomepage, Covid, Telehealth, Menu","disabled":true},{"key":"type","value":"Person","description":"Type of the profile. Valid values are: Person, RoofTop\n\n"},{"key":"profileDefinition","value":"","description":"Profile definition\n\n","disabled":true},{"key":"categoryID","value":"GENERAL_CONTRACTOR","description":"List of category Ids","disabled":true},{"key":"categoryName","value":"General Contractor","description":"List of category names. Use double quotes if category name contains commas\n\n","disabled":true},{"key":"tag","value":"","description":"List of tags. Either JSON or Comma separated values.\n\n","disabled":true},{"key":"insuranceID","value":"","description":"List of Insurance Ids\n\n","disabled":true},{"key":"insuranceName","value":"","description":"List of Insurance Names","disabled":true},{"key":"language","value":"","description":"List of Languages\n\n","disabled":true},{"key":"acceptingNewPatients","value":"true","description":"Whether accepting new patients. Valid values are: true or false","disabled":true},{"key":"specialtyID","value":"","description":"List of Specialty Ids\n\n","disabled":true},{"key":"primaryProfile","value":"true","description":"Whether primary linked profile. Valid values are: true or false\n\n"},{"key":"lat","value":"94565360.0320892","description":"Latitude to search for profiles within the radius. If latitude is passed, than both longitude and radius are required\n\n","disabled":true},{"key":"lng","value":"94565360.0320892","description":"Longitude to search for profiles within the radius. If longitude is passed, than both latitude and radius are required","disabled":true},{"key":"radius","value":"94565360.0320892","description":"Radius to search. Required if either latitude and longitude are passed. radius can also be used with postalCode. When used with postal code, profiles will be searched from the center of the postalCode\n\n","disabled":true},{"key":"sort","value":"ASC","description":"List of sort fields separated by comma. Sort order for the field is passed along with the field name separated by :. Default sort order is ASC if the order is not specified with the field name. Example: lastName:DESC,firstName:ASC,distance:DESC,officeName:ASC"},{"key":"offset","value":"0","description":"This offsets the start of each page by the number specified. Max offset is 35k."},{"key":"limit","value":"20","description":"This is the maximum number of objects that may be returned. A query may return fewer than the value of limit due to filtering. Default limit is 20. Max limit is 500."},{"key":"query","value":"","description":"Returns matching results using partial search.\n\n","disabled":true},{"key":"updatedSince","value":"","description":"Returns matching results last updated since date (Datetime ISO 8601).\n\n","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"2840"},{"key":"etag","value":"W/\"b18-JtHELOLGM33b00B7U1rdi4JKNYM\""},{"key":"date","value":"Tue, 03 Oct 2023 06:25:23 GMT"},{"key":"x-envoy-upstream-service-time","value":"176"},{"key":"server","value":"istio-envoy"},{"key":"Via","value":"1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"locations\": [\n {\n \"id\": \"LVO\",\n \"internalID\": \"737497\",\n \"optedOut\": false,\n \"internalName\": \"Leone & Vaughn Orthodontics\",\n \"industryID\": \"health-care-dentists\",\n \"parentID\": null,\n \"customVariables\": [\n {\n \"name\": \"CAMPAIGN_ENROLLMENT_AND_SCHEDULE_PREFERENCE\",\n \"value\": \"AUTOMATED\"\n }\n ],\n \"customFilters\": [\n {\n \"name\": \"Brand\",\n \"value\": \"N/A\"\n },\n {\n \"name\": \"Pants\",\n \"value\": \"N/A\"\n }\n ],\n \"state\": \"Active\",\n \"externalName\": \"Leone & Vaughn Orthodontics\",\n \"professional\": {\n \"lastName\": \"Vaughn Orthodontics\",\n \"firstName\": \"Leone\"\n },\n \"medical\": {\n \"npi\": \"1598213076\"\n },\n \"categories\": [\n {\n \"category\": {\n \"id\": \"TENANT_1990:MANGALAM\",\n \"label\": \"mangalam\"\n },\n \"primary\": true\n }\n ],\n \"places\": [\n {\n \"officeName\": \"Leone & Vaughn Orthodontics\",\n \"address\": {\n \"streetAddress2\": \"#100\",\n \"locality\": \"Seattle\",\n \"region\": \"WA\",\n \"postalCode\": \"98119\",\n \"country\": \"US\",\n \"latitude\": \"47.62729\",\n \"longitude\": \"-122.36967\",\n \"streetAddress1\": \"945 Elliott Avenue West\"\n },\n \"businessHours\": null,\n \"phones\": [\n {\n \"number\": \"(206) 792-5473\",\n \"primary\": true,\n \"country\": \"US\",\n \"phoneType\": \"Local\"\n }\n ],\n \"websites\": null,\n \"emails\": [\n {\n \"email\": \"ss@gmail.com\",\n \"primary\": true\n }\n ],\n \"primary\": true,\n \"officeStatus\": null,\n \"originalAddress\": {\n \"streetAddress2\": \"#100\",\n \"locality\": \"Seattle\",\n \"region\": \"WA\",\n \"postalCode\": \"98119\",\n \"country\": \"US\",\n \"latitude\": \"47.62729\",\n \"longitude\": \"-122.36967\",\n \"streetAddress1\": \"945 Elliott Avenue West\"\n },\n \"linkedLuid\": null,\n \"relatedLocations\": null\n }\n ],\n \"type\": \"Person\",\n \"locationType\": \"main\",\n \"groupCode\": \"LVO\",\n \"primaryProfile\": true,\n \"profileDefinition\": \"Physician\",\n \"createdDate\": \"2018-03-14T05:09:02\",\n \"updatedDate\": \"2023-04-07T07:44:59\",\n \"distance\": null,\n \"slug\": \"leone-vaughn-orthodontics-seattle-wa\"\n },\n {\n \"id\": \"T\",\n \"internalID\": \"3490502\",\n \"optedOut\": false,\n \"internalName\": \"T\",\n \"industryID\": \"automotive-parts\",\n \"parentID\": null,\n \"customVariables\": null,\n \"customFilters\": [\n {\n \"name\": \"Brand\",\n \"value\": \"N/A\"\n },\n {\n \"name\": \"Pants\",\n \"value\": \"N/A\"\n }\n ],\n \"state\": \"Active\",\n \"externalName\": \"jl\",\n \"professional\": {\n \"lastName\": \"L\",\n \"firstName\": \"j\"\n },\n \"medical\": {\n \"npi\": \"1619943354\"\n },\n \"categories\": [\n {\n \"category\": {\n \"id\": \"TENANT_1990:OPEN_HEART_SURGERY\",\n \"label\": \"Open Heart Surgery\"\n },\n \"primary\": true\n }\n ],\n \"places\": [\n {\n \"officeName\": \"jl office\",\n \"address\": {\n \"streetAddress2\": null,\n \"locality\": \"Littleton\",\n \"region\": \"CO\",\n \"postalCode\": \"80123\",\n \"country\": \"US\",\n \"latitude\": \"39.6092313\",\n \"longitude\": \"-105.0355823\",\n \"streetAddress1\": \"5911 Middlefield Rd\"\n },\n \"businessHours\": null,\n \"phones\": null,\n \"websites\": null,\n \"emails\": null,\n \"primary\": true,\n \"officeStatus\": {\n \"officeState\": \"Open\"\n },\n \"originalAddress\": {\n \"streetAddress2\": null,\n \"locality\": \"Littleton\",\n \"region\": \"CO\",\n \"postalCode\": \"80123\",\n \"country\": \"US\",\n \"latitude\": 0,\n \"longitude\": 0,\n \"streetAddress1\": \"5911 Middlefield Rd\"\n },\n \"linkedLuid\": null,\n \"relatedLocations\": null\n }\n ],\n \"type\": \"Person\",\n \"locationType\": \"main\",\n \"groupCode\": \"T\",\n \"primaryProfile\": true,\n \"profileDefinition\": \"Physician\",\n \"createdDate\": \"2021-04-01T15:28:10\",\n \"updatedDate\": \"2023-04-07T03:02:51\",\n \"distance\": null,\n \"slug\": \"j-l-littleton-co\"\n }\n ],\n \"paging\": {\n \"offset\": 0,\n \"limit\": 20,\n \"count\": 2\n }\n}"}],"_postman_id":"e60c20a2-2016-4e2d-93f2-26be1f349cd2"},{"name":"Search Locations","id":"6606b81e-4c60-45ed-abd7-462a9518169f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"placeID\": \"string\",\n \"parentID\": \"string\",\n \"linkedProfileID\": \"string\",\n \"officeName\": \"string\",\n \"locality\": \"string\",\n \"region\": \"string\",\n \"postalCode\": \"string\",\n \"gender\": \"string\",\n \"phoneType\": \"string\",\n \"websiteType\": \"string\",\n \"type\": \"string\",\n \"profileDefinition\": \"string\",\n \"categoryID\": [\n \"string\"\n ],\n \"categoryName\": [\n \"string\"\n ],\n \"tag\": [\n \"string\"\n ],\n \"utm\": \"boolean\",\n \"insuranceID\": [\n \"string\"\n ],\n \"insuranceName\": [\n \"string\"\n ],\n \"language\": [\n \"string\"\n ],\n \"acceptingNewPatients\": \"string\",\n \"specialtyID\": [\n \"string\"\n ],\n \"primaryProfile\": \"string\",\n \"lat\": 0,\n \"lng\": 0,\n \"radius\": 0,\n \"sorts\": [\n {\n \"fieldName\": \"string\",\n \"sortOrder\": \"string\"\n }\n ],\n \"offset\": \"integer\",\n \"limit\": \"integer\",\n \"query\": \"string\",\n \"updatedSince\": \"string\"\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/locations-search","description":"

Facilitates detailed searches for location profiles based on a range of specific parameters provided in the request body. It serves as an alternative to the GET version of the endpoint, providing a means to submit search parameters in the body of the request.

Sample

JavaScript XHR Request

var xhr = new XMLHttpRequest();\nvar url = \"https://api.reputation.com/v3/locations-search\";\nxhr.open(\"POST\", url, true);\nxhr.setRequestHeader(\"Content-Type\", \"application/json\");\nxhr.setRequestHeader(\"x-api-key\", \"Your API key\");\nxhr.onreadystatechange = function() {\n    if (xhr.readyState == 4 && xhr.status == 200) {\n        var response = JSON.parse(xhr.responseText);\n        console.log(response);\n    }\n};\nvar data = JSON.stringify({\n    \"type\": \"Person\",\n    \"primaryProfile\": \"true\",\n    \"sorts\": [\n        {\n            \"fieldName\": \"type\",\n            \"sortOrder\": \"ASC\"\n        }\n    ],\n    \"offset\": 0,\n    \"limit\": 20\n});\nxhr.send(data);\n\n

Request Parameters

Parameter	Data Type	Description
`firstName`	String	First name of the provider - ex. `John`
`lastName`	String	Last name of the provider - ex. `Doe`
`placeID`	String	Identifier for a specific place - ex. `SA2`
`parentID`	String	Denotes the parent-child relationship - ex. `SA`
`linkedProfileID`	String	Identifier for a linked profile - ex. `abcd1234`
`officeName`	String	Name of the office
`locality`	String	The city or locality where the provider is located.
`region`	String	The state or region where the provider operates.
`postalCode`	String	The postal code or zip code associated with the provider's location.
`gender`	String	Gender of the provider. Valid values include `Male`, `Female`, and `Unknown`
`phoneType`	String	Specifies the type of phone. Valid options encompass `Local`, `Mobile`, `Fax`, `Tollfree`,`Tracked`,`Sales`,`Parts`,`Emergency`,`GoogleOnly`,`FacebookOnly`,`BingOnly`,`FoursquareOnly`,`Other`.
`websiteType`	String	Defines the kind of website. Options include `Homepage`, `Reservation`,`Order`,`GoogleHomepage`,`Telehealth`,`Menu`.
`type`	String	Type of profile. Valid values are `Person` and `Rooftop`.
`profileDefinition`	String	Definition of the profile
`categoryID`	String Array	List of category names. If a category name contains commas, it should be enclosed in double quotes
`tag`	String Array	List of tags, either JSON or comma seperated values.
`utm`	Boolean	Indicator for UTM tracking.
`insuranceID`	String Array	List of Insurance IDs.
`insuranceName`	String Array	List of Insurance Names.
`language`	String Array	List of languages associated with the provider.
acceptingNewPatients	String	Indicates if the provider is accepting new patients. Valid values are `true` or `false`
`specialtyID`	String Array	List of Specialty IDs.
`primaryProfile`	String	Denotes whether the profile is the primary linked profile. Valid values are `true` or `false`
`lat`	Number	Latitude for searching profiles within a specified radius. Required if `lng` is used.
`lng`	Number	Longitude for searching profiles within a specific radius. Required if `lat` is used.
`radius`	Number	The search defined by `lat`and `lng` in which profiles are sought.
`sorts`	Object Array	Specifies the fields and their respective order for sorting results. Each object contains a `fieldName`and a `sortOrder`
`fieldName` parent: `sorts`	String	Name of the field to sort - ex. `firstName`
`sortOrder` parent: `sorts`	String	Order to sort - valid values. `ASC`,`DESC`
`offset`	Number	Offsets the start of each results page by the specified number.
`limit`	Integer	Determines the number of items returned in the current response. This is distinct from rate limiting and refers to the size of the data set returned, which is controlled by the value you specify. The default limit is 20 locations, with a maximum possible limit of 2,000.
`query`	String	Returns matching results based on a partial search.
`updatedSince`	String	Returns results updated since the specified date (Datetime in ISO 8601 format).

Response Parameters

Parameter	Parent	Data Type	Description
`locations`		Object Array	An array of location profiles providing detailed information about specific locations.
`id`	`locations`	String	Identifier for the location - ex. `SA`
`internalID`	`locations`	String	The internal identification number assigned to the location - ex. `737476`
`optedOut`	`locations`	Boolean	Indicates whether the location has opted out of listings publishing.
`linkedProfileID`	`locations`	String	Id used to reference existing linked profiles
`tenantID`	`locations`	String	Tenant's unique id. Attribute becomes read-only after profile is created
`internalName`	`locations`	String	The internal name given to the location - ex. `Simple Art`
`externalName`	`locations`	String	Location's external name - ex. `Majestic Art`
`industryID`	`locations`	String	The industry identification associated with the location - ex. `automotive-dealer`
`parentID`	`locations`	String	The ID of the parent location if there's any, otherwise `null`.
`customVariables`	`locations`	Object Array	An array of custom variables associated with the location, containing the variable name and its value.
`name`	`customVariables`	String	Custom variable name - ex. `CAMPAIGN_ENROLLMENT_AND_SCHEDULE_PREFERENCE`
`value`	`customVariables`	String	Value of the custom variable - ex. `MANUAL`
`customFilters`	`locations`	Object Arrary	An array of custom filters applied to the location, containing the filter name and its value.
`name`	`customFilters`	String	Custom filter name - ex. `Brand`
`value`	`customFilters`	String	Value of the custom filter - ex. `Gallery`
`locationType`	`locations`	String	Specifies the location type whether it's `main`, `branch`, etc.
`groupCode`	`Location`	String	A common identifier used to associate the main location with its corresponding departmental or supplemental locations. This unique code must be the same for both the main location and any related department/supplemental locations - ex. `SA`
`primaryProfile`	`locations`	Boolean	Indicates if the profile is the primary one.
`type`	`locations`	String	Indicates the type of the location - ex. `Rooftop`
`profileDefinition`	`locations`	String	Definition or category of the profile - ex. `Rooftop`
`state`	`locations`	String	Defines the state of the entity, i.e. whether it is covered by the current contract with Reputation. If left empty, state will default to active - ex. `Active`
`places`	`locations`	Object Array	List of \"Place\" objects
`placeID`	`places`	String	Place id
`officeName`	`places`	String	Office or practice name - ex. `Bay Plumbing`
`address`	`places`	Object	Address object
`streetAddress1`	`address`	String	Street address line 1 - ex. `1001 Marshall St`
`streetAddress2`	`address`	String	Street address line 2 - ex. `Suite 300 null` if there is no line 2
`locality`	`address`	String	Locality/city - ex. `Redwood City`
`region`	`address`	String	Region/State or Province - ex. `CA`
`country`	`address`	String	Country's 2 letter ISO Code - ex. `US`
`postalCode`	`address`	String	Postal Code/Zip Code - ex. `94063`
`latitude`	`address`	String	Address latitude - ex. `37.4880518`
`longitude`	`address`	String	Address longitude - ex. `-122.2243949`
`originalAddress`	`places`	Object	Raw non-normalized version of the address inputed by the user
`streetAddress1`	`originalAddress`	String	Street address line 1 - ex. `1001 Marshall St`
`streetAddress2`	`originalAddress`	String	Street address line 2 - ex. `Suite 300 null` if there is no line 2
`locality`	`originalAddress`	String	Locality/city - ex. `Redwood City`
`region`	`orignialAddress`	String	Region/State or Province - ex. `CA`
`country`	`originalAddress`	String	Country's 2 letter ISO Code - ex. `US`
`postalCode`	`originalAdress`	String	Postal Code/Zip Code - ex. `94063-2052`
`latitude`	`originalAddress`	String	Address latitude - ex. `37.48776`
`longitude`	`originalAddress`	String	Address longitude - ex. `-122.2243949`
`businessHours`	`places`	Object Array	List of \"business hours\" objects - If there are no objects, `null` is returned.
`name`	`businessHours`	String	Name of the \"business hour\" object
`businessHourType`	`businessHours`	String	Refers to the type of business hours. - valid values: `Main` `Sales` `Service` `Parts` `Holiday`
`timePeriods`	`businessHours`	Object Array	List of \"Time Period\" objects to represent days and times opened/closed.
`openDay`	`timePeriods`	String	Profile's open days - valid values: `Sunday`, `Monday`, `Tuesday`,`Wednesday`,`Thursday`,`Friday`,`Saturday`
`openTime`	`timePeriods`	String	Profile's open times in 24hr ISO 8601 - valid values: `00:00-24:00`, where 24:00 represents midnight at the end of the specified `openDay`.
`closeDay`	`timePeriods`	String	Profile's closed days - valid values: `Sunday` ,`Monday`, `Tuesday` ,`Wednesday` ,`Thursday` ,`Friday` ,`Saturday`
`closeTime`	`timePeriods`	String	Profile's closed times in 24hr ISO 8601 - valid values: `00:00-24:00`, where 24:00 represents midnight at the end of the specified `closeDay`.
`open24Hours`	`timePeriods`	Boolean	Denotes whether the profile is open 24 hours during the specified day range
`closed`	`timePeriods`	Boolean	Denotes whether the profile is closed at the current time
`primary`	`businessHours`	Boolean	Denotes whether business hours are the profile's primary hours
`specialHours`	`businessHours`	Object Array	List of \"special time period\" objects -similar to `timePeriods` but used for special instances
`startDate`	`specialHours`	String	The calendar date the special hour period starts on - In ISO 8601 format (YYYY-MM-DD) .
`openTime`	`specialHours`	String	Time in 24hr ISO 8601 extended format (hh:mm). Valid values are 00:00-24:00, where 24:00 represents midnight at the end of the specified day field. Specified if `closed`and `open24Hours` is `false`.
`closeTime`	`speicalHours`	String	Time in 24hr ISO 8601 extended format (hh:mm). Valid values are 00:00-24:00, where 24:00 represents midnight at the end of the specified day field. Specified if `closed`and `open24Hours` is `false`.
`open24Hours`	`specialHours`	Boolean	Denotes whether open 24 hours during the specified day range. If true, `openTime`, and `closeTime` are ignored, and the date specified in startDate is treated as the location being open for the entire day.
`closed`	`specialHours`	Boolean	Denotes whether the profile is closed. If `true`, `openTime`, and `closeTime` are ignored, and the date specified in `startDate` is treated as the location being closed for the entire day.
`phones`	`places`	Object Array	List of phone number objects.
`phoneType`	`phones`	String	Phone type - valid values: `Local`, `Mobile`, `Fax`, `TollFree`, `Tracked`, `Sales`, `Service`, `Parts`, `Emergency`, `GoogleOnly`, `FacebookOnly`, `BingOnly`, `FourSquareOnly`, `WhatsApp`, `Text_SMS`, `Other`
`number`	`phones`	String	Phone number - ex. \"`(408) 900-9080`
`extension`	`phones`	String	Extension number
`country`	`phones`	String	Country of origin - ex. `US`
`primary`	`phones`	Boolean	Denotes whether phone is primary
`websites`	`places`	Object Array	List of websites
`websiteType`	`websites`	String	Type of website - valid values: `Homepage` ,`Reservation`, `Order`, `GoogleHomepage`, `Covid`, `Telehealth`, `Menu`
`url`	`websites`	String	Website URL - ex. `http://www.reputation.com`
`primary`	`websites`	Boolean	Whether website is primary
`emails`	`places`	Object Array	List of emails
`email`	`emails`	String	The business's email address - ex. `business@reputation.com`
`primary`	`emails`	Boolean	Whether email is primary email
`officeStatus`	`places`	Object	An office status object containing the `officeState` and `operationalDate`.
`officeState`	`officeStatus`	String	Office state/status type - valid values: `Open`,`Closed`,`Moved`,`Permanently_Closed`,`Opening_Soon`,`Closing_Soon`,`Temporarily_Closed`
`operationalDate`	`officeStatus`	String	Date of office state in ISO 8601 format (YYYY-MM-DD) - ex. `2021-05-01`
`primary`	`places`	Boolean	Whether place is business's primary place
`description`	`locations`	String	Description of the business - ex. `Simple Art Page Description`
`shortDescription`	`locations`	String	Short description to publish on Source site. Limit of 155 characters - ex. `Simple Art Page`
`tags`	`locations`	String	Keywords identifying the location, used in meta-tags - ex. `art`,`exclusive`,`low prices`
`utm`	`locations`	Boolean	Whether a UTM source is appended to a primary URL when it is sent to GoogleMyBusinees. UTM example: ?utm_source=local&utm_medium=organic&utm_camp
`attributes`	`locations`	Object Array	List of Attribute objects. Available attributes depend on selected categories. See Attributes section below for more details.
`attributeId`	`attributes`	String	Attribute Id
`boolValue`	`attributes`	Boolean	Attribute boolean value. This field or `values`is used but not both. Valid values are: `true`or `false`
`values`	`attributes`	Object Array	List of Attribute values. This field or `boolValue`is used but not both
`id`	`values`	String	Attribute value Id
`boolValue`	`values`	Boolean	Boolean of attribute value
`owners`	`locations`	Object Array	List of owners
`name`	`owners`	String	The name of the admin. When making the initial invitation, this is the invitee's email address.
`role`	`owners`	String	Role of the owner
`pendingInvitation`	`owners`	Boolean	Status of the invitation sent to the owner.
`socialMedias`	`locations`	Object Array	List of social media objects
`socialMediaType`	`socialMedias`	String	Type of social media - valid values: `Facebook`,`Twitter`,`Instagram`,`Snapchat`,`YouTube`,`LinkedIn`,`Pintrest`,`Blog`
`url`	`socialMedias`	String	URL for social media
`medias`	`locations`	Object Array	List of media objects
`mediaType`	`medias`	String	Media Type. png or jpeg file for cover photo: 16:9 aspect ratio with minimum size 400px - valid values: `Headshot`,`Cover`,`Profile`,`Logo`,`Video`,`Google_Logo`,`Google_Cover`,`Facebook_Profile`,`Facebook_Cover`,`Additional`
`url`	`medias`	String	URL for Media
`title`	`medias`	String	Title for media object
`primary`	`medias`	Boolean	Whether media is primary
`medical`	`locations`	Object	Medical details provided if listing is for a medical business.
`npi`	`medical`	String	National Provider Identifier (NPI) is a unique 10-digit identification number issued to health care providers in the United States. NPI is used to uniquely identify health care providers in the US.
`stateLicenseNumber`	`medical`	String	State license number
`insurancesAccepted`	`medical`	Object Array	List of insurance objects
`id`	`insurancesAccepted`	String	Id of the object
`label`	`insurancesAccepted`	String	Object label
`acceptingNewPatients`	`medical`	Boolean	Boolean used to determine whether a health care provider or facility is currently accepting new patients
`employerAffiliation`	`medical`	String	Used to characterize the employer affiliation, as doctors can be either employed or affiliated with a health care group ex. `Employed`, `Independent`
`specialties`	`medical`	Object Array	List of specialties associated with the entity.
`specialty`	`specialties`	String	Specialty type.
`primary`	`specialties`	Boolean	Whether specialty is primary.
`webMdCampaignId`	`medical`	String	This is an ID provided by WebMD to shared clients between Reputation and WebMD that are running paid Carefinder campaigns on WebMD. This field will allow shared clients to manage their WebMD campaigns directly from the Reputation platform.
`insuranceNetworks`	`medical`	Object Array	List of insurance networks that are accepted by the health care provider or facility. This field will replace the deprecated InsurancesAccepted.
`insuranceNetork`	`medical`	Object Array	An insurance network is a list of the doctors, other health care providers, and hospitals that a plan has contracted with to provide medical care to its members
`id`	`insuranceNetork`	String	Id of the object
`label`	`insuranceNetork`	String	Label of the object
`professional`	`locations`	Object	If the listing is for service professional, then it will provide the details for the professional.
`title`	`professional`	String	Person's Title
`appellation`	`professional`	String	Person's Appellation
`degrees`	`professional`	Object Array	List of Degrees
`degree`	`degrees`	String	Name of degree
`primary`	`degrees`	Boolean	Whether degree is primary
`firstName`	`professional`	String	Person's first name
`lastName`	`professional`	String	Person's last name
`middleName`	`professional`	String	Person's middle name
`gender`	`professional`	String	Person's gender
`birthday`	`professional`	String	Person's Birthday in ISO 8601 format (YYYY-MM-DD)
`biography`	`professional`	String	Person's biography
`certifications`	`professional`	Object Array	List of certifications
`number`	`certifications`	String	Certification/License number
`country`	`certifications`	String	Country issuing certification. 2 letter ISO code.
`endDate`	`certifications`	String	Expiration date of the Certification/License (YYYY-MM-DD).
`name`	`certifications`	String	Certification name
`issuer`	`certifications`	String	Certification issuer
`primary`	`certifications`	Boolean	Whether certification is primary certification
`affiliations`	`professional`	Object Array	List of affiliations. For non-healthcare professionals, list of professional associations. For Healthcare Professionals, list of admitting hospitals.
`affiliation`	`affiliations`	String	Affiliation name
`primary`	`affiliations`	Boolean	Whether affiliation is primary affiliation. If none of the affiliations are defined as prmary=`true`, then the first affiliation will be defaulted to primary=`true`
`educations`	`professional`	Object Array	List of educational experience
`type`	`educations`	String	Type of edcuation - valid values: `Undergraduate`,`Graduate`,`Medical`,`Law`,`Internship`,`Fellowship`,`Residency`,`AdditionalTraining`,`BachelorOfScience`,`DentalSchool`,`MasterOfArts`,`Masters`,`MastersOfScience`,`NursingSchool`,`PHD`,`ProfessionalEducation`,`PsyD`,`Society`,`Certification`,`Education`,`ProfessionalAffiliations`,`ProfessionalMembership`,`SpecializationsAndProcedures`,`Awards`,`Other`
`institution`	`educations`	String	Name of institution
`graduationYear`	`educations`	String	Graduation year
`degree`	`educations`	String	Graduation Degree
`primary`	`educations`	String	Whether education is the professional's primary/main education
`languages`	`professionals`	String	List of languages
`serviceArea`	`locations`	Object	Service are details object (for service area businesses).
`places`	`serviceArea`	String Array	Zip Code or City Name, State, Country (if applicable)
`businessType`	`serviceArea`	String	Business type - valid values: `BUSINESS_TYPE_UNSPECIFIED`,`CUSTOMER_AND_BUSINESS_LOCATION`,`CUSTOMER_LOCATION_ONLY`
`categories`	`locations`	Object Array	List of category objects
`category`	`categories`	Object	Caregory object
`id`	`category`	String	Object id
`label`	`category`	String	Object label
`primary`	`categories`	Boolean	Whether `category` object is the primary object.
`paymentTypes`	`locations`	String Array	Comma separated list of accepted payment types
`richKnowledge`	`locations`	Object	Object containing metadata
`titleTag`	`richKnowledge`	String	The HTML element that specifies the title of the web page
`metaDescription`	`richKnowledge`	String	The HTML element that describes the subject of the webpage
`metaKeywords`	`richKnowledge`	String Array	The HTML element that lists keywords related to the webpage
`htmlDescription`	`richKnowledge`	String	HTML enabled business description of the profile
`zipCodesServed`	`richKnowledge`	String Array	The list of zipCodes served by the entity
`areasServed`	`richKnowledge`	String Array	The list of areas served by the entity
`professionalStatement`	`richKnowledge`	String	Brief statement of the professional represented by the entity
`covidMessage`	`locations`	String	This field allows communication centered around COVID-19. It can be used to communicate cleaning protocols, store capacity, security measures, mask requirements, and other measures. The field is limited to 200 characters and must only be used to provide messages related to COVID-19.
`createdDate`	`locations`	String	Profile's created date - Datetime ISO 8601
`updatedDate`	`locations`	String	Profile's updated date - Datetime ISO 8601
`distance`	`locations`	Number (Double)	Shows the distance of the Location from the provided Latitude and Longitude or Postal Code
`slug`	`locations`	String	Url slug
`paging`		Object	Object containing request pagination details
`offset`	`paging`	Integer (int64)	This offsets the start of each page by the number specified
`limit`	`paging`	Integer (int64)	Determines the number of items returned in the current response. This is distinct from rate limiting and refers to the size of the data set returned, which is controlled by the value you specify. The default limit is 20 locations, with a maximum possible limit of 2,000.
`count`	`paging`	Integer (int64)	This is the maximum number of objects that may be returned for the search.
`previous`	`paging`	Integer (int64)	API endpoint that will return the next page of data. If not included, this is the last page of data.

","urlObject":{"path":["locations-search"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"c5fc7126-3c92-4e69-a3af-1580a92156ed","name":"Success","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"Your API key"}],"body":{"mode":"raw","raw":"{\n \"type\": \"Person\",\n \"primaryProfile\": \"true\",\n \"sorts\": [\n {\n \"fieldName\": \"type\",\n \"sortOrder\": \"ASC\"\n }\n ],\n \"offset\": 0,\n \"limit\": 20\n}","options":{"raw":{"language":"json"}}},"url":"https://api.reputation.com/v3/locations-search"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"2840"},{"key":"etag","value":"W/\"b18-JtHELOLGM33b00B7U1rdi4JKNYM\""},{"key":"date","value":"Tue, 03 Oct 2023 08:53:39 GMT"},{"key":"x-envoy-upstream-service-time","value":"249"},{"key":"server","value":"istio-envoy"},{"key":"Via","value":"1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"locations\": [\n {\n \"id\": \"LVO\",\n \"internalID\": \"737497\",\n \"optedOut\": false,\n \"internalName\": \"Leone & Vaughn Orthodontics\",\n \"industryID\": \"health-care-dentists\",\n \"parentID\": null,\n \"customVariables\": [\n {\n \"name\": \"CAMPAIGN_ENROLLMENT_AND_SCHEDULE_PREFERENCE\",\n \"value\": \"AUTOMATED\"\n }\n ],\n \"customFilters\": [\n {\n \"name\": \"Brand\",\n \"value\": \"N/A\"\n },\n {\n \"name\": \"Pants\",\n \"value\": \"N/A\"\n }\n ],\n \"state\": \"Active\",\n \"externalName\": \"Leone & Vaughn Orthodontics\",\n \"professional\": {\n \"lastName\": \"Vaughn Orthodontics\",\n \"firstName\": \"Leone\"\n },\n \"medical\": {\n \"npi\": \"1598213076\"\n },\n \"categories\": [\n {\n \"category\": {\n \"id\": \"TENANT_1990:MANGALAM\",\n \"label\": \"mangalam\"\n },\n \"primary\": true\n }\n ],\n \"places\": [\n {\n \"officeName\": \"Leone & Vaughn Orthodontics\",\n \"address\": {\n \"streetAddress2\": \"#100\",\n \"locality\": \"Seattle\",\n \"region\": \"WA\",\n \"postalCode\": \"98119\",\n \"country\": \"US\",\n \"latitude\": \"47.62729\",\n \"longitude\": \"-122.36967\",\n \"streetAddress1\": \"945 Elliott Avenue West\"\n },\n \"businessHours\": null,\n \"phones\": [\n {\n \"number\": \"(206) 792-5473\",\n \"primary\": true,\n \"country\": \"US\",\n \"phoneType\": \"Local\"\n }\n ],\n \"websites\": null,\n \"emails\": [\n {\n \"email\": \"ss@gmail.com\",\n \"primary\": true\n }\n ],\n \"primary\": true,\n \"officeStatus\": null,\n \"originalAddress\": {\n \"streetAddress2\": \"#100\",\n \"locality\": \"Seattle\",\n \"region\": \"WA\",\n \"postalCode\": \"98119\",\n \"country\": \"US\",\n \"latitude\": \"47.62729\",\n \"longitude\": \"-122.36967\",\n \"streetAddress1\": \"945 Elliott Avenue West\"\n },\n \"linkedLuid\": null,\n \"relatedLocations\": null\n }\n ],\n \"type\": \"Person\",\n \"locationType\": \"main\",\n \"groupCode\": \"LVO\",\n \"primaryProfile\": true,\n \"profileDefinition\": \"Physician\",\n \"createdDate\": \"2018-03-14T05:09:02\",\n \"updatedDate\": \"2023-04-07T07:44:59\",\n \"distance\": null,\n \"slug\": \"leone-vaughn-orthodontics-seattle-wa\"\n },\n {\n \"id\": \"T\",\n \"internalID\": \"3490502\",\n \"optedOut\": false,\n \"internalName\": \"T\",\n \"industryID\": \"automotive-parts\",\n \"parentID\": null,\n \"customVariables\": null,\n \"customFilters\": [\n {\n \"name\": \"Brand\",\n \"value\": \"N/A\"\n },\n {\n \"name\": \"Pants\",\n \"value\": \"N/A\"\n }\n ],\n \"state\": \"Active\",\n \"externalName\": \"jl\",\n \"professional\": {\n \"lastName\": \"L\",\n \"firstName\": \"j\"\n },\n \"medical\": {\n \"npi\": \"1619943354\"\n },\n \"categories\": [\n {\n \"category\": {\n \"id\": \"TENANT_1990:OPEN_HEART_SURGERY\",\n \"label\": \"Open Heart Surgery\"\n },\n \"primary\": true\n }\n ],\n \"places\": [\n {\n \"officeName\": \"jl office\",\n \"address\": {\n \"streetAddress2\": null,\n \"locality\": \"Littleton\",\n \"region\": \"CO\",\n \"postalCode\": \"80123\",\n \"country\": \"US\",\n \"latitude\": \"39.6092313\",\n \"longitude\": \"-105.0355823\",\n \"streetAddress1\": \"5911 Middlefield Rd\"\n },\n \"businessHours\": null,\n \"phones\": null,\n \"websites\": null,\n \"emails\": null,\n \"primary\": true,\n \"officeStatus\": {\n \"officeState\": \"Open\"\n },\n \"originalAddress\": {\n \"streetAddress2\": null,\n \"locality\": \"Littleton\",\n \"region\": \"CO\",\n \"postalCode\": \"80123\",\n \"country\": \"US\",\n \"latitude\": 0,\n \"longitude\": 0,\n \"streetAddress1\": \"5911 Middlefield Rd\"\n },\n \"linkedLuid\": null,\n \"relatedLocations\": null\n }\n ],\n \"type\": \"Person\",\n \"locationType\": \"main\",\n \"groupCode\": \"T\",\n \"primaryProfile\": true,\n \"profileDefinition\": \"Physician\",\n \"createdDate\": \"2021-04-01T15:28:10\",\n \"updatedDate\": \"2023-04-07T03:02:51\",\n \"distance\": null,\n \"slug\": \"j-l-littleton-co\"\n }\n ],\n \"paging\": {\n \"offset\": 0,\n \"limit\": 20,\n \"count\": 2\n }\n}"}],"_postman_id":"6606b81e-4c60-45ed-abd7-462a9518169f"},{"name":"Search Faceted Locations","id":"bd275ce4-4f8b-42b1-ac01-e0099d35f9c7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"x-api-key","value":""}],"url":"{{baseUrl}}/locations-faceted-search?groupBy=","description":"

This endpoint facilitates a faceted profile search of the platform, providing aggregated counts of profiles based on specified criteria. Rather than returning individual profile data, this endpoint groups profiles based on a selected attribute (such as phoneType, gender, etc.) and returns a count of profiles for each distinct value within that attribute. It's an efficient way to understand the distribution of profiles based on varying characteristics without retrieving the details of each profile.

For instance, if you'd like to know how many providers have a Local phone type versus a Mobile phone type, this service can quickly provide those aggregated counts, as exemplified in the given response.

Sample

JavaScript XHR Request

var xhr = new XMLHttpRequest();\nxhr.open('GET', 'https://api.reputation.com/v3/locations-faceted-search?groupBy=phoneType', true);\nxhr.setRequestHeader('x-api-key', 'Your API key');\n\nxhr.onreadystatechange = function() {\n    if (xhr.readyState == 4 && xhr.status == 200) {\n        var jsonResponse = JSON.parse(xhr.responseText);\n        console.log(jsonResponse);\n    }\n};\n\nxhr.send();\n\n

Response Parameters

\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

Parameter	Parent	Data Type	Description
`locations`		Object Array	A collection of aggregated results based on the specified grouping criteria.
`count`	`locations`	Integer	Represents the number of occurrences of the specified value within its associated group - ex. `16`
`value`	`locations`	String	The specific value or category that the count pertains to within its associated group - ex. `Local`
`group`	`locations`	String	The criteria or category by which the results are grouped. - ex. `phoneType`

Response Schema

{\n    \"locations\": [\n        {\n            \"count\": \"integer\",\n            \"value\": \"string\",\n            \"group\": \"string\"\n        },\n    ]\n}\n\n\n

\n","urlObject":{"path":["locations-faceted-search"],"host":["{{baseUrl}}"],"query":[{"description":{"content":"

(Required) Attributes by which the results should be grouped. Valid Values: gender, language, officeName, employerAffiliation, websiteType, phoneType, categoryID, categoryName, tag

\n","type":"text/plain"},"key":"groupBy","value":""},{"disabled":true,"description":{"content":"

First name of the provider

\n","type":"text/plain"},"key":"firstName","value":""},{"disabled":true,"description":{"content":"

Last name of the provider

\n","type":"text/plain"},"key":"lastName","value":""},{"disabled":true,"description":{"content":"

Name of the office or establishment.

\n","type":"text/plain"},"key":"officeName","value":""},{"disabled":true,"description":{"content":"

City or locality where the provider is located.

\n","type":"text/plain"},"key":"locality","value":""},{"disabled":true,"description":{"content":"

Region or state where the provider operates.

\n","type":"text/plain"},"key":"region","value":""},{"disabled":true,"description":{"content":"

Postal or zip code of the provider's location.

\n","type":"text/plain"},"key":"postalCode","value":""},{"disabled":true,"description":{"content":"

Gender of the provider. Valid Values: Male, Female, Unknown

\n","type":"text/plain"},"key":"gender","value":""},{"disabled":true,"description":{"content":"

The classification of phone numbers associated with the provider. Valid Values: Local, Mobile, Fax, TollFree, Tracked, Sales, Service, Parts, Emergency, GoogleOnly, FacebookOnly, BingOnly, FoursquareOnly, Other

\n","type":"text/plain"},"key":"phoneType","value":""},{"disabled":true,"description":{"content":"

Type or purpose of the website linked with the provider. Valid Values: Homepage, Reservation, Order, GoogleHomepage, Covid, Telehealth, Menu

\n","type":"text/plain"},"key":"websiteType","value":""},{"disabled":true,"description":{"content":"

Classification of the profile. Valid Values: Person, RoofTop

\n","type":"text/plain"},"key":"type","value":""},{"disabled":true,"description":{"content":"

Identifier(s) corresponding to the service categories of the provider.

\n","type":"text/plain"},"key":"categoryID","value":""},{"disabled":true,"description":{"content":"

Names of service categories. Enclose in double quotes if the name contains commas. Example: \"General Medicine\", \"Pediatrics\"

\n","type":"text/plain"},"key":"categoryName","value":""},{"disabled":true,"description":{"content":"

Tags associated with the profile. Can be provided as JSON or comma-separated values.

\n","type":"text/plain"},"key":"tags","value":""},{"disabled":true,"description":{"content":"

Identifier(s) of insurance plans accepted by the provider.

\n","type":"text/plain"},"key":"insuranceID","value":""},{"disabled":true,"description":{"content":"

Names of insurance plans accepted.

\n","type":"text/plain"},"key":"insuranceName","value":""},{"disabled":true,"description":{"content":"

Language(s) spoken by the provider.

\n","type":"text/plain"},"key":"languages","value":""},{"disabled":true,"description":{"content":"

Indicator if the provider is currently accepting new patients. Valid Values: true, false

\n","type":"text/plain"},"key":"acceptingNewPatients","value":""},{"disabled":true,"description":{"content":"

Latitude coordinate for location-based search. Must be used in conjunction with lng and radius. Example: 37.7749

\n","type":"text/plain"},"key":"lat","value":""},{"disabled":true,"description":{"content":"

Longitude coordinate for location-based search. Must be used in conjunction with lat and radius. Example: -122.4194

\n","type":"text/plain"},"key":"lng","value":""},{"disabled":true,"description":{"content":"

Search radius in kilometers/miles (as applicable). Required if lat and lng are provided. Can also be combined with postalCode to initiate search from the center of the postal code. Example: 10

\n","type":"text/plain"},"key":"radius","value":""}],"variable":[]}},"response":[{"id":"1db28dbe-165c-4a49-a610-e416ef5a3c63","name":"Success","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"Your API key"}],"url":{"raw":"https://api.reputation.com/v3/locations-faceted-search?groupBy=phoneType","protocol":"https","host":["api","reputation","com"],"path":["v3","locations-faceted-search"],"query":[{"key":"firstName","value":"","disabled":true},{"key":"lastName","value":"","disabled":true},{"key":"placeID","value":"","disabled":true},{"key":"parentID","value":"","disabled":true},{"key":"linkedProfileID","value":"","disabled":true},{"key":"officeName","value":"Johns Plumbing Company","disabled":true},{"key":"locality","value":"Redwood Cit","disabled":true},{"key":"region","value":"CA","disabled":true},{"key":"postalCode","value":"95063","disabled":true},{"key":"gender","value":"Male","disabled":true},{"key":"phoneType","value":"Local","disabled":true},{"key":"websiteType","value":"","disabled":true},{"key":"type","value":"Person","disabled":true},{"key":"profileDefinition","value":"","disabled":true},{"key":"categoryID","value":"GENERAL_CONTRACTOR","disabled":true},{"key":"categoryName","value":"General Contractor","disabled":true},{"key":"tag","value":"","disabled":true},{"key":"insuranceID","value":"","disabled":true},{"key":"insuranceName","value":"","disabled":true},{"key":"language","value":"","disabled":true},{"key":"acceptingNewPatients","value":"true","disabled":true},{"key":"specialtyID","value":"","disabled":true},{"key":"primaryProfile","value":"true","disabled":true},{"key":"lat","value":"94565360.0320892","disabled":true},{"key":"lng","value":"94565360.0320892","disabled":true},{"key":"radius","value":"94565360.0320892","disabled":true},{"key":"sort","value":"ASC","disabled":true},{"key":"offset","value":"0","disabled":true},{"key":"limit","value":"20","disabled":true},{"key":"query","value":"","disabled":true},{"key":"updatedSince","value":"","disabled":true},{"key":"groupBy","value":"phoneType"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"113"},{"key":"etag","value":"W/\"71-dcV+7LHPbfxAImUWaR7srMwEUr0\""},{"key":"date","value":"Tue, 03 Oct 2023 11:36:43 GMT"},{"key":"x-envoy-upstream-service-time","value":"86"},{"key":"server","value":"istio-envoy"},{"key":"Via","value":"1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"locations\": [\n {\n \"count\": 16,\n \"value\": \"Local\",\n \"group\": \"phoneType\"\n },\n {\n \"count\": 2,\n \"value\": \"Mobile\",\n \"group\": \"phoneType\"\n }\n ]\n}"}],"_postman_id":"bd275ce4-4f8b-42b1-ac01-e0099d35f9c7"},{"name":"Get Location","id":"5dfe287f-1395-40b9-8f43-2eb2aac05798","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"x-api-key","value":"Your API key"}],"url":"{{baseUrl}}/locations/:locationID","description":"

This endpoint retrieves detailed information about a specific location profile on the platform based on the provided locationID.

The response returns detailed attributes of the location profile, including its internal and external names, industry type, state, associated places like office addresses, contact information, and more.

Sample

JavaScript XHR Request

var xhr = new XMLHttpRequest();\nxhr.open('GET', 'https://api.reputation.com/v3/locations/SA', true);\nxhr.setRequestHeader('x-api-key', 'Your API key');\nxhr.onreadystatechange = function() {\n    if (xhr.readyState === 4 && xhr.status === 200) {\n        var response = JSON.parse(xhr.responseText);\n        console.log(response);\n    }\n};\nxhr.send();\n\n

Response Parameters

Parameter	Parent	Data Type	Description
`id`		String	Identifier for the location - ex. `SA`
`internalID`		String	The internal identification number assigned to the location - ex. `737476`
`optedOut`		Boolean	Indicates whether the location has opted out of listings publishing.
`linkedProfileID`		String	Id used to reference existing linked profiles
`tenantID`		String	Tenant's unique id. Attribute becomes read-only after profile is created
`internalName`		String	The internal name given to the location - ex. `Simple Art`
`externalName`		String	Location's external name - ex. `Majestic Art`
`industryID`		String	The industry identification associated with the location - ex. `automotive-dealer`
`parentID`		String	The ID of the parent location if there's any, otherwise `null`.
`customVariables`		Object Array	An array of custom variables associated with the location, containing the variable name and its value.
`name`	`customVariables`	String	Custom variable name - ex. `CAMPAIGN_ENROLLMENT_AND_SCHEDULE_PREFERENCE`
`value`	`customVariables`	String	Value of the custom variable - ex. `MANUAL`
`customFilters`		Object Arrary	An array of custom filters applied to the location, containing the filter name and its value.
`name`	`customFilters`	String	Custom filter name - ex. `Brand`
`value`	`customFilters`	String	Value of the custom filter - ex. `Gallery`
`locationType`		String	Specifies the location type whether it's `main`, `branch`, etc.
`groupCode`		String	A common identifier used to associate the main location with its corresponding departmental or supplemental locations. This unique code must be the same for both the main location and any related department/supplemental locations - ex. `SA`
`primaryProfile`		Boolean	Indicates if the profile is the primary one.
`type`		String	Indicates the type of the location - ex. `Rooftop`
`profileDefinition`		String	Definition or category of the profile - ex. `Rooftop`
`state`		String	Defines the state of the entity, i.e. whether it is covered by the current contract with Reputation. If left empty, state will default to active - ex. `Active`
`places`		Object Array	List of \"Place\" objects
`placeID`	`places`	String	Place id
`officeName`	`places`	String	Office or practice name - ex. `Bay Plumbing`
`address`	`places`	Object	Address object
`streetAddress1`	`address`	String	Street address line 1 - ex. `1001 Marshall St`
`streetAddress2`	`address`	String	Street address line 2 - ex. `Suite 300 null` if there is no line 2
`locality`	`address`	String	Locality/city - ex. `Redwood City`
`region`	`address`	String	Region/State or Province - ex. `CA`
`country`	`address`	String	Country's 2 letter ISO Code - ex. `US`
`postalCode`	`address`	String	Postal Code/Zip Code - ex. `94063`
`latitude`	`address`	String	Address latitude - ex. `37.4880518`
`longitude`	`address`	String	Address longitude - ex. `-122.2243949`
`originalAddress`	`places`	Object	Raw non-normalized version of the address inputed by the user
`streetAddress1`	`originalAddress`	String	Street address line 1 - ex. `1001 Marshall St`
`streetAddress2`	`originalAddress`	String	Street address line 2 - ex. `Suite 300 null` if there is no line 2
`locality`	`originalAddress`	String	Locality/city - ex. `Redwood City`
`region`	`orignialAddress`	String	Region/State or Province - ex. `CA`
`country`	`originalAddress`	String	Country's 2 letter ISO Code - ex. `US`
`postalCode`	`originalAdress`	String	Postal Code/Zip Code - ex. `94063-2052`
`latitude`	`originalAddress`	String	Address latitude - ex. `37.48776`
`longitude`	`originalAddress`	String	Address longitude - ex. `-122.2243949`
`businessHours`	`places`	Object Array	List of \"business hours\" objects - If there are no objects, `null` is returned.
`name`	`businessHours`	String	Name of the \"business hour\" object
`businessHourType`	`businessHours`	String	Refers to the type of business hours. - valid values: `Main` `Sales` `Service` `Parts` `Holiday`
`timePeriods`	`businessHours`	Object Array	List of \"Time Period\" objects to represent days and times opened/closed.
`openDay`	`timePeriods`	String	Profile's open days - valid values: `Sunday`, `Monday`, `Tuesday`,`Wednesday`,`Thursday`,`Friday`,`Saturday`
`openTime`	`timePeriods`	String	Profile's open times in 24hr ISO 8601 - valid values: `00:00-24:00`, where 24:00 represents midnight at the end of the specified `openDay`.
`closeDay`	`timePeriods`	String	Profile's closed days - valid values: `Sunday` ,`Monday`, `Tuesday` ,`Wednesday` ,`Thursday` ,`Friday` ,`Saturday`
`closeTime`	`timePeriods`	String	Profile's closed times in 24hr ISO 8601 - valid values: `00:00-24:00`, where 24:00 represents midnight at the end of the specified `closeDay`.
`open24Hours`	`timePeriods`	Boolean	Denotes whether the profile is open 24 hours during the specified day range
`closed`	`timePeriods`	Boolean	Denotes whether the profile is closed at the current time
`primary`	`businessHours`	Boolean	Denotes whether business hours are the profile's primary hours
`specialHours`	`businessHours`	Object Array	List of \"special time period\" objects -similar to `timePeriods` but used for special instances
`startDate`	`specialHours`	String	The calendar date the special hour period starts on - In ISO 8601 format (YYYY-MM-DD) .
`openTime`	`specialHours`	String	Time in 24hr ISO 8601 extended format (hh:mm). Valid values are 00:00-24:00, where 24:00 represents midnight at the end of the specified day field. Specified if `closed`and `open24Hours` is `false`.
`closeTime`	`speicalHours`	String	Time in 24hr ISO 8601 extended format (hh:mm). Valid values are 00:00-24:00, where 24:00 represents midnight at the end of the specified day field. Specified if `closed`and `open24Hours` is `false`.
`open24Hours`	`specialHours`	Boolean	Denotes whether open 24 hours during the specified day range. If true, `openTime`, and `closeTime` are ignored, and the date specified in startDate is treated as the location being open for the entire day.
`closed`	`specialHours`	Boolean	Denotes whether the profile is closed. If `true`, `openTime`, and `closeTime` are ignored, and the date specified in `startDate` is treated as the location being closed for the entire day.
`phones`	`places`	Object Array	List of phone number objects.
`phoneType`	`phones`	String	Phone type - valid values: `Local`, `Mobile`, `Fax`, `TollFree`, `Tracked`, `Sales`, `Service`, `Parts`, `Emergency`, `GoogleOnly`, `FacebookOnly`, `BingOnly`, `FourSquareOnly`, `WhatsApp`, `Text_SMS`, `Other`
`number`	`phones`	String	Phone number - ex. \"`(408) 900-9080`
`extension`	`phones`	String	Extension number
`country`	`phones`	String	Country of origin - ex. `US`
`primary`	`phones`	Boolean	Denotes whether phone is primary
`websites`	`places`	Object Array	List of websites
`websiteType`	`websites`	String	Type of website - valid values: `Homepage` ,`Reservation`, `Order`, `GoogleHomepage`, `Covid`, `Telehealth`, `Menu`
`url`	`websites`	String	Website URL - ex. `http://www.reputation.com`
`primary`	`websites`	Boolean	Whether website is primary
`emails`	`places`	Object Array	List of emails
`email`	`emails`	String	The business's email address - ex. `business@reputation.com`
`primary`	`emails`	Boolean	Whether email is primary email
`officeStatus`	`places`	Object	An office status object containing the `officeState` and `operationalDate`.
`officeState`	`officeStatus`	String	Office state/status type - valid values: `Open`,`Closed`,`Moved`,`Permanently_Closed`,`Opening_Soon`,`Closing_Soon`,`Temporarily_Closed`
`operationalDate`	`officeStatus`	String	Date of office state in ISO 8601 format (YYYY-MM-DD) - ex. `2021-05-01`
`primary`	`places`	Boolean	Whether place is business's primary place
`description`		String	Description of the business - ex. `Simple Art Page Description`
`shortDescription`		String	Short description to publish on Source site. Limit of 155 characters - ex. `Simple Art Page`
`tags`		String	Keywords identifying the location, used in meta-tags - ex. `art`,`exclusive`,`low prices`
`utm`		Boolean	Whether a UTM source is appended to a primary URL when it is sent to GoogleMyBusinees. UTM example: ?utm_source=local&utm_medium=organic&utm_camp
`attributes`		Object Array	List of Attribute objects. Available attributes depend on selected categories. See Attributes section below for more details.
`attributeId`	`attributes`	String	Attribute Id
`boolValue`	`attributes`	Boolean	Attribute boolean value. This field or `values`is used but not both. Valid values are: `true`or `false`
`values`	`attributes`	Object Array	List of Attribute values. This field or `boolValue`is used but not both
`id`	`values`	String	Attribute value Id
`boolValue`	`values`	Boolean	Boolean of attribute value
`owners`		Object Array	List of owners
`name`	`owners`	String	The name of the admin. When making the initial invitation, this is the invitee's email address.
`role`	`owners`	String	Role of the owner
`pendingInvitation`	`owners`	Boolean	Status of the invitation sent to the owner.
`socialMedias`		Object Array	List of social media objects
`socialMediaType`	`socialMedias`	String	Type of social media - valid values: `Facebook`,`Twitter`,`Instagram`,`Snapchat`,`YouTube`,`LinkedIn`,`Pintrest`,`Blog`
`url`	`socialMedias`	String	URL for social media
`medias`		Object Array	List of media objects
`mediaType`	`medias`	String	Media Type. png or jpeg file for cover photo: 16:9 aspect ratio with minimum size 400px - valid values: `Headshot`,`Cover`,`Profile`,`Logo`,`Video`,`Google_Logo`,`Google_Cover`,`Facebook_Profile`,`Facebook_Cover`,`Additional`
`url`	`medias`	String	URL for Media
`title`	`medias`	String	Title for media object
`primary`	`medias`	Boolean	Whether media is primary
`medical`		Object	Medical details provided if listing is for a medical business.
`npi`	`medical`	String	National Provider Identifier (NPI) is a unique 10-digit identification number issued to health care providers in the United States. NPI is used to uniquely identify health care providers in the US.
`stateLicenseNumber`	`medical`	String	State license number
`insurancesAccepted`	`medical`	Object Array	List of insurance objects
`id`	`insurancesAccepted`	String	Id of the object
`label`	`insurancesAccepted`	String	Object label
`acceptingNewPatients`	`medical`	Boolean	Boolean used to determine whether a health care provider or facility is currently accepting new patients
`employerAffiliation`	`medical`	String	Used to characterize the employer affiliation, as doctors can be either employed or affiliated with a health care group ex. `Employed`, `Independent`
`specialties`	`medical`	Object Array	List of specialties associated with the entity.
`specialty`	`specialties`	String	Specialty type.
`primary`	`specialties`	Boolean	Whether specialty is primary.
`webMdCampaignId`	`medical`	String	This is an ID provided by WebMD to shared clients between Reputation and WebMD that are running paid Carefinder campaigns on WebMD. This field will allow shared clients to manage their WebMD campaigns directly from the Reputation platform.
`insuranceNetworks`	`medical`	Object Array	List of insurance networks that are accepted by the health care provider or facility. This field will replace the deprecated InsurancesAccepted.
`insuranceNetork`	`medical`	Object Array	An insurance network is a list of the doctors, other health care providers, and hospitals that a plan has contracted with to provide medical care to its members
`id`	`insuranceNetork`	String	Id of the object
`label`	`insuranceNetork`	String	Label of the object
`professional`		Object	If the listing is for service professional, then it will provide the details for the professional.
`title`	`professional`	String	Person's Title
`appellation`	`professional`	String	Person's Appellation
`degrees`	`professional`	Object Array	List of Degrees
`degree`	`degrees`	String	Name of degree
`primary`	`degrees`	Boolean	Whether degree is primary
`firstName`	`professional`	String	Person's first name
`lastName`	`professional`	String	Person's last name
`middleName`	`professional`	String	Person's middle name
`gender`	`professional`	String	Person's gender
`birthday`	`professional`	String	Person's Birthday in ISO 8601 format (YYYY-MM-DD)
`biography`	`professional`	String	Person's biography
`certifications`	`professional`	Object Array	List of certifications
`number`	`certifications`	String	Certification/License number
`country`	`certifications`	String	Country issuing certification. 2 letter ISO code.
`endDate`	`certifications`	String	Expiration date of the Certification/License (YYYY-MM-DD).
`name`	`certifications`	String	Certification name
`issuer`	`certifications`	String	Certification issuer
`primary`	`certifications`	Boolean	Whether certification is primary certification
`affiliations`	`professional`	Object Array	List of affiliations. For non-healthcare professionals, list of professional associations. For Healthcare Professionals, list of admitting hospitals.
`affiliation`	`affiliations`	String	Affiliation name
`primary`	`affiliations`	Boolean	Whether affiliation is primary affiliation. If none of the affiliations are defined as prmary=`true`, then the first affiliation will be defaulted to primary=`true`
`educations`	`professional`	Object Array	List of educational experience
`type`	`educations`	String	Type of edcuation - valid values: `Undergraduate`,`Graduate`,`Medical`,`Law`,`Internship`,`Fellowship`,`Residency`,`AdditionalTraining`,`BachelorOfScience`,`DentalSchool`,`MasterOfArts`,`Masters`,`MastersOfScience`,`NursingSchool`,`PHD`,`ProfessionalEducation`,`PsyD`,`Society`,`Certification`,`Education`,`ProfessionalAffiliations`,`ProfessionalMembership`,`SpecializationsAndProcedures`,`Awards`,`Other`
`institution`	`educations`	String	Name of institution
`graduationYear`	`educations`	String	Graduation year
`degree`	`educations`	String	Graduation Degree
`primary`	`educations`	String	Whether education is the professional's primary/main education
`languages`	`professionals`	String	List of languages
`serviceArea`		Object	Service are details object (for service area businesses).
`places`	`serviceArea`	String Array	Zip Code or City Name, State, Country (if applicable)
`businessType`	`serviceArea`	String	Business type - valid values: `BUSINESS_TYPE_UNSPECIFIED`,`CUSTOMER_AND_BUSINESS_LOCATION`,`CUSTOMER_LOCATION_ONLY`
`categories`		Object Array	List of category objects
`category`	`categories`	Object	Caregory object
`id`	`category`	String	Object id
`label`	`category`	String	Object label
`primary`	`categories`	Boolean	Whether `category` object is the primary object.
`paymentTypes`		String Array	Comma separated list of accepted payment types
`richKnowledge`		Object	Object containing metadata
`titleTag`	`richKnowledge`	String	The HTML element that specifies the title of the web page
`metaDescription`	`richKnowledge`	String	The HTML element that describes the subject of the webpage
`metaKeywords`	`richKnowledge`	String Array	The HTML element that lists keywords related to the webpage
`htmlDescription`	`richKnowledge`	String	HTML enabled business description of the profile
`zipCodesServed`	`richKnowledge`	String Array	The list of zipCodes served by the entity
`areasServed`	`richKnowledge`	String Array	The list of areas served by the entity
`professionalStatement`	`richKnowledge`	String	Brief statement of the professional represented by the entity
`covidMessage`		String	This field allows communication centered around COVID-19. It can be used to communicate cleaning protocols, store capacity, security measures, mask requirements, and other measures. The field is limited to 200 characters and must only be used to provide messages related to COVID-19.
`createdDate`		String	Profile's created date - Datetime ISO 8601
`updatedDate`		String	Profile's updated date - Datetime ISO 8601
`distance`		Number (Double)	Shows the distance of the Location from the provided Latitude and Longitude or Postal Code
`slug`		String	Url slug

Response Schema

{\n    \"id\": \"string\",\n    \"internalID\": \"string\",\n    \"optedOut\": \"boolean\",\n    \"linkedProfileID\": \"string\",\n    \"tenantID\": \"string\",\n    \"internalName\": \"string\",\n    \"externalName\": \"string\",\n    \"industryID\": \"string\",\n    \"parentID\": \"string\",\n    \"customVariables\": [\n        {\n            \"name\": \"string\",\n            \"value\": \"string\"\n        }\n    ],\n    \"customFilters\": [\n        {\n            \"name\": \"string\",\n            \"value\": \"string\"\n        }\n    ],\n    \"locationType\": \"string\",\n    \"groupCode\": \"string\",\n    \"state\": \"string\",\n    \"utm\": \"boolean\",\n    \"description\": \"string\",\n    \"tags\": [\n        \"string\",\n    ],\n    \"paymentTypes\": [\n        \"string\"\n    ],\n    \"covidMessage\": \"string\",\n    \"medias\": [\n        {\n            \"url\": \"string\",\n            \"title\": \"string\",\n            \"mediaType\": \"string\",\n            \"primary\": \"boolean\"\n        }\n    ],\n    \"attributes\": [\n        {\n            \"attributeId\": \"string\",\n            \"boolValue\": \"boolean\"\n        },\n        {\n            \"attributeId\": \"string\",\n            \"values\": [\n                {\n                    \"id\": \"string\",\n                    \"boolValue\": \"boolean\"\n                },\n            ]\n        }\n    ],\n    \"owners\": [\n        {\n            \"name\": \"string\",\n            \"role\": \"string\",\n            \"pendingInvitation\": \"boolean\"\n        }\n    ]\n    \"socialMedias\": [\n        {\n            \"url\": \"string\",\n            \"socialMediaType\": \"string\"\n        },\n    ],\n    \"shortDescription\": \"string\",\n    \"medical\": {\n        \"npi\": \"string\",\n        \"stateLicenseNumber\": \"string\",\n        \"insurancesAccepted\": [\n            {\n                \"id\": \"string\",\n                \"label\": \"string\"\n            },\n        ],\n        \"acceptingNewPatients\": \"boolean\",\n        \"employerAffiliation\": \"string\",\n        \"specialties\": [\n            {\n                \"specialty\": \"string\",\n                \"primary\": \"boolean\"\n            }\n        ],\n        \"webMdCampaignId\": \"string\",\n        \"insuranceNetworks\": [\n            {\n                \"insuranceNetwork\": {\n                    \"id\": \"string\",\n                    \"label\": \"string\"\n                }\n            },\n        ]\n    },\n    \"categories\": [\n        {\n            \"category\": {\n                \"id\": \"string\",\n                \"label\": \"string\"\n            },\n            \"primary\": \"boolean\"\n        }\n    ],\n    \"places\": [\n        {\n            \"placeID\": \"string\",\n            \"officeName\": \"string\",\n            \"address\": {\n                \"streetAddress2\": \"string\",\n                \"locality\": \"string\",\n                \"region\": \"string\",\n                \"postalCode\": \"string\",\n                \"country\": \"string\",\n                \"latitude\": \"string\",\n                \"longitude\": \"string\",\n                \"streetAddress1\": \"string\"\n            },\n            \"businessHours\": [\n                {\n                    \"timePeriods\": [\n                        {\n                            \"openDay\": \"string\",\n                            \"openTime\": \"string\",\n                            \"closeDay\": \"string\",\n                            \"closeTime\": \"string\",\n                            \"open24Hours\": \"boolean\",\n                            \"closed\": \"boolean\"\n                        },\n                    ],\n                    \"name\": \"string\",\n                    \"primary\": \"boolean\",\n                    \"specialHours\": [\n                        {\n                            \"openTime\": \"string\",\n                            \"closeTime\": \"string\",\n                            \"open24Hours\": \"boolean\",\n                            \"closed\": \"boolean\",\n                            \"startDate\": \"string\"\n                        },\n                    ],\n                    \"businessHourType\": \"string\"\n                }\n            ],\n            \"phones\": [\n                {\n                    \"number\": \"string\",\n                    \"extension\": \"string\",\n                    \"primary\": \"boolean\",\n                    \"country\": \"string\",\n                    \"phoneType\": \"string\"\n                }\n            ],\n            \"websites\": [\n                {\n                    \"url\": \"string\",\n                    \"primary\": \"boolean\",\n                    \"websiteType\": \"string\"\n                }\n            ],\n            \"emails\": [\n                {\n                    \"email\": \"string\",\n                    \"primary\": \"boolean\"\n                },\n            ],\n            \"primary\": \"boolean\",\n            \"officeStatus\": {\n                \"officeState\": \"string\",\n                \"operationalDate\": \"string\"\n            },\n            \"originalAddress\": {\n                \"streetAddress2\": \"string\",\n                \"locality\": \"string\",\n                \"region\": \"string\",\n                \"postalCode\": \"string\",\n                \"country\": \"string\",\n                \"latitude\": \"string\",\n                \"longitude\": \"string\",\n                \"streetAddress1\": \"string\"\n            },\n            \"linkedLuid\": \"integer\",\n            \"relatedLocations\": [\n                {\n                    \"type\": \"integer\",\n                    \"placeId\": \"string\"\n                }\n            ]\n        }\n    ],\n    \"professional\": {\n        \"title\": \"string\",\n        \"appellation\": \"string\",\n        \"degrees\": [\n            {\n                \"degree\": \"string\",\n                \"primary\": \"boolean\"\n            }\n        ]\n        \"firstName\": \"string\"\n        \"lastName\": \"string\",\n        \"middleName\": \"string\",\n        \"gender\": \"string\",\n        \"birthday\": \"string\",\n        \"biography\": \"string\",\n        \"certifications\": [\n            {\n                \"number\": \"string\",\n                \"country\": \"string\",\n                \"endDate\": \"string\",\n                \"name\": \"string\",\n                \"issuer\": \"string\",\n                \"primary\": \"boolean\"\n            }\n        ],\n        \"affiliations\": [\n            {\n                \"affiliation\": \"string\",\n                \"primary\": \"boolean\"\n            }\n        ],\n        \"educations\": [\n            {\n                \"type\": \"string\",\n                \"institution\": \"string\",\n                \"graduationYear\": \"string\",\n                \"degree\": \"string\",\n                \"primary\": \"boolean\"\n            }\n        ],\n        \"languages\": [\n            \"string\",\n        ],\n    },\n    \"serviceArea\": {\n        \"places\": [\"string\"],\n        \"businessType\": \"string\"\n    },\n    \"richKnowledge\": {\n        \"titleTag\": \"string\",\n        \"metaDescription\": \"string\",\n        \"metaKeywords\": [\"string\"],\n        \"htmlDescription\": \"string\",\n        \"zipCodesServed\": [\"string\"],\n        \"areasServed\": [\"string\"],\n        \"professionalStatement\": \"string\"\n    }\n    \"type\": \"string\",\n    \"primaryProfile\": \"boolean\",\n    \"profileDefinition\": \"string\",\n    \"createdDate\": \"string\",\n    \"updatedDate\": \"string\",\n    \"distance\": \"Double\",\n    \"slug\": \"string\"\n}\n\n

\n","urlObject":{"path":["locations",":locationID"],"host":["{{baseUrl}}"],"query":[],"variable":[{"description":{"content":"

(Required) The specific location identifier tied to the profile.

\n","type":"text/plain"},"type":"any","value":"","key":"locationID"}]}},"response":[{"id":"86408a7f-2d02-4cc5-a63b-469313c08d9e","name":"Success","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"Your API key"}],"url":{"raw":"https://api.reputation.com/v3/locations/:locationID","protocol":"https","host":["api","reputation","com"],"path":["v3","locations",":locationID"],"variable":[{"key":"locationID","value":"SA","description":"(Required) Location id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"1705"},{"key":"etag","value":"W/\"6a9-6bxjKXSpBiutQV6EZq0GBDGL4Ws\""},{"key":"date","value":"Tue, 03 Oct 2023 17:27:59 GMT"},{"key":"x-envoy-upstream-service-time","value":"207"},{"key":"server","value":"istio-envoy"},{"key":"Via","value":"1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"SA\",\n \"internalID\": \"737476\",\n \"optedOut\": false,\n \"internalName\": \"Simple Art\",\n \"industryID\": \"automotive-dealer\",\n \"parentID\": null,\n \"customVariables\": [\n {\n \"name\": \"test-inventory\",\n \"value\": \"www.apple.com\"\n },\n {\n \"name\": \"CAMPAIGN_ENROLLMENT_AND_SCHEDULE_PREFERENCE\",\n \"value\": \"MANUAL\"\n }\n ],\n \"customFilters\": [\n {\n \"name\": \"Brand\",\n \"value\": \"Gallery\"\n }\n ],\n \"state\": \"Active\",\n \"externalName\": \"Simple Art\",\n \"description\": \"Simple Art Page Descripton\",\n \"shortDescription\": \"Simple Art Page\",\n \"categories\": [\n {\n \"category\": {\n \"id\": \"TENANT_1990:OPEN_HEART_SURGERY\",\n \"label\": \"Open Heart Surgery\"\n },\n \"primary\": true\n }\n ],\n \"places\": [\n {\n \"officeName\": \"Simple Art\",\n \"address\": {\n \"streetAddress2\": null,\n \"locality\": \"Redwood City\",\n \"region\": \"CA\",\n \"postalCode\": \"94063\",\n \"country\": \"US\",\n \"latitude\": \"37.48805\",\n \"longitude\": \"-122.22439\",\n \"streetAddress1\": \"1001 Marshall St\"\n },\n \"businessHours\": null,\n \"phones\": [\n {\n \"number\": \"(408) 900-9080\",\n \"primary\": true,\n \"country\": \"US\",\n \"phoneType\": \"Local\"\n },\n {\n \"number\": \"(408) 990-9090\",\n \"primary\": false,\n \"country\": \"US\",\n \"phoneType\": \"Mobile\"\n }\n ],\n \"websites\": [\n {\n \"url\": \"http://www.yahoo.com\",\n \"primary\": true,\n \"websiteType\": \"Homepage\"\n }\n ],\n \"emails\": [\n {\n \"email\": \"repdef40+1990@gmail.com\",\n \"primary\": true\n }\n ],\n \"primary\": true,\n \"officeStatus\": {\n \"officeState\": \"Opening_Soon\",\n \"operationalDate\": \"2021-05-01\"\n },\n \"originalAddress\": {\n \"streetAddress2\": null,\n \"locality\": \"Redwood City\",\n \"region\": \"CA\",\n \"postalCode\": \"94063\",\n \"country\": \"US\",\n \"latitude\": \"37.48805\",\n \"longitude\": \"-122.22439\",\n \"streetAddress1\": \"1001 Marshall St\"\n },\n \"linkedLuid\": null,\n \"relatedLocations\": null\n }\n ],\n \"type\": \"RoofTop\",\n \"locationType\": \"main\",\n \"groupCode\": \"SA\",\n \"primaryProfile\": true,\n \"profileDefinition\": \"RoofTop\",\n \"createdDate\": \"2018-03-14T05:08:53\",\n \"updatedDate\": \"2023-04-07T07:45:01\",\n \"distance\": null,\n \"slug\": \"simple-art-simple-art-redwood-city-ca\"\n}"}],"_postman_id":"5dfe287f-1395-40b9-8f43-2eb2aac05798"},{"name":"Delete Location","id":"8a321c1d-d9fe-4db2-be5e-f7a55ecf4e71","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"},{"key":"x-api-key","value":""}],"url":"{{baseUrl}}/locations/:locationID","description":"

This endpoint lets you delete a specific location profile from the system, identified by its locationID. If you wish to only mark the location as inactive rather than fully deleting it, you can utilize the optional preserveLocation query parameter.

Sample

JavaScript XHR Request

var xhr = new XMLHttpRequest();\nxhr.open('DELETE', 'https://api.reputation.com/v3/locations/BP?preserveLocation=true', true);\nxhr.setRequestHeader('x-api-key', 'Your API key');\nxhr.onreadystatechange = function() {\n    if (xhr.readyState == 4 && xhr.status == 200) {\n        var response = JSON.parse(xhr.responseText);\n        console.log(response);\n    }\n};\nxhr.send();\n\n

Response Parameters

Parameter	Parent	Data Type	Description
`id`		String	Identifier for the location - ex. `SA`
`internalID`		String	The internal identification number assigned to the location - ex. `737476`
`optedOut`		Boolean	Indicates whether the location has opted out of listings publishing.
`linkedProfileID`		String	Id used to reference existing linked profiles
`tenantID`		String	Tenant's unique id. Attribute becomes read-only after profile is created
`internalName`		String	The internal name given to the location - ex. `Simple Art`
`externalName`		String	Location's external name - ex. `Majestic Art`
`industryID`		String	The industry identification associated with the location - ex. `automotive-dealer`
`parentID`		String	The ID of the parent location if there's any, otherwise `null`.
`customVariables`		Object Array	An array of custom variables associated with the location, containing the variable name and its value.
`name`	`customVariables`	String	Custom variable name - ex. `CAMPAIGN_ENROLLMENT_AND_SCHEDULE_PREFERENCE`
`value`	`customVariables`	String	Value of the custom variable - ex. `MANUAL`
`customFilters`		Object Arrary	An array of custom filters applied to the location, containing the filter name and its value.
`name`	`customFilters`	String	Custom filter name - ex. `Brand`
`value`	`customFilters`	String	Value of the custom filter - ex. `Gallery`
`locationType`		String	Specifies the location type whether it's `main`, `branch`, etc.
`groupCode`		String	A common identifier used to associate the main location with its corresponding departmental or supplemental locations. This unique code must be the same for both the main location and any related department/supplemental locations - ex. `SA`
`primaryProfile`		Boolean	Indicates if the profile is the primary one.
`type`		String	Indicates the type of the location - ex. `Rooftop`
`profileDefinition`		String	Definition or category of the profile - ex. `Rooftop`
`state`		String	Defines the state of the entity, i.e. whether it is covered by the current contract with Reputation. If left empty, state will default to active - ex. `Active`
`places`		Object Array	List of \"Place\" objects
`placeID`	`places`	String	Place id
`officeName`	`places`	String	Office or practice name - ex. `Bay Plumbing`
`address`	`places`	Object	Address object
`streetAddress1`	`address`	String	Street address line 1 - ex. `1001 Marshall St`
`streetAddress2`	`address`	String	Street address line 2 - ex. `Suite 300 null` if there is no line 2
`locality`	`address`	String	Locality/city - ex. `Redwood City`
`region`	`address`	String	Region/State or Province - ex. `CA`
`country`	`address`	String	Country's 2 letter ISO Code - ex. `US`
`postalCode`	`address`	String	Postal Code/Zip Code - ex. `94063`
`latitude`	`address`	String	Address latitude - ex. `37.4880518`
`longitude`	`address`	String	Address longitude - ex. `-122.2243949`
`originalAddress`	`places`	Object	Raw non-normalized version of the address inputed by the user
`streetAddress1`	`originalAddress`	String	Street address line 1 - ex. `1001 Marshall St`
`streetAddress2`	`originalAddress`	String	Street address line 2 - ex. `Suite 300 null` if there is no line 2
`locality`	`originalAddress`	String	Locality/city - ex. `Redwood City`
`region`	`orignialAddress`	String	Region/State or Province - ex. `CA`
`country`	`originalAddress`	String	Country's 2 letter ISO Code - ex. `US`
`postalCode`	`originalAdress`	String	Postal Code/Zip Code - ex. `94063-2052`
`latitude`	`originalAddress`	String	Address latitude - ex. `37.48776`
`longitude`	`originalAddress`	String	Address longitude - ex. `-122.2243949`
`businessHours`	`places`	Object Array	List of \"business hours\" objects - If there are no objects, `null` is returned.
`name`	`businessHours`	String	Name of the \"business hour\" object
`businessHourType`	`businessHours`	String	Refers to the type of business hours. - valid values: `Main` `Sales` `Service` `Parts` `Holiday`
`timePeriods`	`businessHours`	Object Array	List of \"Time Period\" objects to represent days and times opened/closed.
`openDay`	`timePeriods`	String	Profile's open days - valid values: `Sunday`, `Monday`, `Tuesday`,`Wednesday`,`Thursday`,`Friday`,`Saturday`
`openTime`	`timePeriods`	String	Profile's open times in 24hr ISO 8601 - valid values: `00:00-24:00`, where 24:00 represents midnight at the end of the specified `openDay`.
`closeDay`	`timePeriods`	String	Profile's closed days - valid values: `Sunday` ,`Monday`, `Tuesday` ,`Wednesday` ,`Thursday` ,`Friday` ,`Saturday`
`closeTime`	`timePeriods`	String	Profile's closed times in 24hr ISO 8601 - valid values: `00:00-24:00`, where 24:00 represents midnight at the end of the specified `closeDay`.
`open24Hours`	`timePeriods`	Boolean	Denotes whether the profile is open 24 hours during the specified day range
`closed`	`timePeriods`	Boolean	Denotes whether the profile is closed at the current time
`primary`	`businessHours`	Boolean	Denotes whether business hours are the profile's primary hours
`specialHours`	`businessHours`	Object Array	List of \"special time period\" objects -similar to `timePeriods` but used for special instances
`startDate`	`specialHours`	String	The calendar date the special hour period starts on - In ISO 8601 format (YYYY-MM-DD) .
`openTime`	`specialHours`	String	Time in 24hr ISO 8601 extended format (hh:mm). Valid values are 00:00-24:00, where 24:00 represents midnight at the end of the specified day field. Specified if `closed`and `open24Hours` is `false`.
`closeTime`	`speicalHours`	String	Time in 24hr ISO 8601 extended format (hh:mm). Valid values are 00:00-24:00, where 24:00 represents midnight at the end of the specified day field. Specified if `closed`and `open24Hours` is `false`.
`open24Hours`	`specialHours`	Boolean	Denotes whether open 24 hours during the specified day range. If true, `openTime`, and `closeTime` are ignored, and the date specified in startDate is treated as the location being open for the entire day.
`closed`	`specialHours`	Boolean	Denotes whether the profile is closed. If `true`, `openTime`, and `closeTime` are ignored, and the date specified in `startDate` is treated as the location being closed for the entire day.
`phones`	`places`	Object Array	List of phone number objects.
`phoneType`	`phones`	String	Phone type - valid values: `Local`, `Mobile`, `Fax`, `TollFree`, `Tracked`, `Sales`, `Service`, `Parts`, `Emergency`, `GoogleOnly`, `FacebookOnly`, `BingOnly`, `FourSquareOnly`, `WhatsApp`, `Text_SMS`, `Other`
`number`	`phones`	String	Phone number - ex. \"`(408) 900-9080`
`extension`	`phones`	String	Extension number
`country`	`phones`	String	Country of origin - ex. `US`
`primary`	`phones`	Boolean	Denotes whether phone is primary
`websites`	`places`	Object Array	List of websites
`websiteType`	`websites`	String	Type of website - valid values: `Homepage` ,`Reservation`, `Order`, `GoogleHomepage`, `Covid`, `Telehealth`, `Menu`
`url`	`websites`	String	Website URL - ex. `http://www.reputation.com`
`primary`	`websites`	Boolean	Whether website is primary
`emails`	`places`	Object Array	List of emails
`email`	`emails`	String	The business's email address - ex. `business@reputation.com`
`primary`	`emails`	Boolean	Whether email is primary email
`officeStatus`	`places`	Object	An office status object containing the `officeState` and `operationalDate`.
`officeState`	`officeStatus`	String	Office state/status type - valid values: `Open`,`Closed`,`Moved`,`Permanently_Closed`,`Opening_Soon`,`Closing_Soon`,`Temporarily_Closed`
`operationalDate`	`officeStatus`	String	Date of office state in ISO 8601 format (YYYY-MM-DD) - ex. `2021-05-01`
`primary`	`places`	Boolean	Whether place is business's primary place
`description`		String	Description of the business - ex. `Simple Art Page Description`
`shortDescription`		String	Short description to publish on Source site. Limit of 155 characters - ex. `Simple Art Page`
`tags`		String	Keywords identifying the location, used in meta-tags - ex. `art`,`exclusive`,`low prices`
`utm`		Boolean	Whether a UTM source is appended to a primary URL when it is sent to GoogleMyBusinees. UTM example: ?utm_source=local&utm_medium=organic&utm_camp
`attributes`		Object Array	List of Attribute objects. Available attributes depend on selected categories. See Attributes section below for more details.
`attributeId`	`attributes`	String	Attribute Id
`boolValue`	`attributes`	Boolean	Attribute boolean value. This field or `values`is used but not both. Valid values are: `true`or `false`
`values`	`attributes`	Object Array	List of Attribute values. This field or `boolValue`is used but not both
`id`	`values`	String	Attribute value Id
`boolValue`	`values`	Boolean	Boolean of attribute value
`owners`		Object Array	List of owners
`name`	`owners`	String	The name of the admin. When making the initial invitation, this is the invitee's email address.
`role`	`owners`	String	Role of the owner
`pendingInvitation`	`owners`	Boolean	Status of the invitation sent to the owner.
`socialMedias`		Object Array	List of social media objects
`socialMediaType`	`socialMedias`	String	Type of social media - valid values: `Facebook`,`Twitter`,`Instagram`,`Snapchat`,`YouTube`,`LinkedIn`,`Pintrest`,`Blog`
`url`	`socialMedias`	String	URL for social media
`medias`		Object Array	List of media objects
`mediaType`	`medias`	String	Media Type. png or jpeg file for cover photo: 16:9 aspect ratio with minimum size 400px - valid values: `Headshot`,`Cover`,`Profile`,`Logo`,`Video`,`Google_Logo`,`Google_Cover`,`Facebook_Profile`,`Facebook_Cover`,`Additional`
`url`	`medias`	String	URL for Media
`title`	`medias`	String	Title for media object
`primary`	`medias`	Boolean	Whether media is primary
`medical`		Object	Medical details provided if listing is for a medical business.
`npi`	`medical`	String	National Provider Identifier (NPI) is a unique 10-digit identification number issued to health care providers in the United States. NPI is used to uniquely identify health care providers in the US.
`stateLicenseNumber`	`medical`	String	State license number
`insurancesAccepted`	`medical`	Object Array	List of insurance objects
`id`	`insurancesAccepted`	String	Id of the object
`label`	`insurancesAccepted`	String	Object label
`acceptingNewPatients`	`medical`	Boolean	Boolean used to determine whether a health care provider or facility is currently accepting new patients
`employerAffiliation`	`medical`	String	Used to characterize the employer affiliation, as doctors can be either employed or affiliated with a health care group ex. `Employed`, `Independent`
`specialties`	`medical`	Object Array	List of specialties associated with the entity.
`specialty`	`specialties`	String	Specialty type.
`primary`	`specialties`	Boolean	Whether specialty is primary.
`webMdCampaignId`	`medical`	String	This is an ID provided by WebMD to shared clients between Reputation and WebMD that are running paid Carefinder campaigns on WebMD. This field will allow shared clients to manage their WebMD campaigns directly from the Reputation platform.
`insuranceNetworks`	`medical`	Object Array	List of insurance networks that are accepted by the health care provider or facility. This field will replace the deprecated InsurancesAccepted.
`insuranceNetork`	`medical`	Object Array	An insurance network is a list of the doctors, other health care providers, and hospitals that a plan has contracted with to provide medical care to its members
`id`	`insuranceNetork`	String	Id of the object
`label`	`insuranceNetork`	String	Label of the object
`professional`		Object	If the listing is for service professional, then it will provide the details for the professional.
`title`	`professional`	String	Person's Title
`appellation`	`professional`	String	Person's Appellation
`degrees`	`professional`	Object Array	List of Degrees
`degree`	`degrees`	String	Name of degree
`primary`	`degrees`	Boolean	Whether degree is primary
`firstName`	`professional`	String	Person's first name
`lastName`	`professional`	String	Person's last name
`middleName`	`professional`	String	Person's middle name
`gender`	`professional`	String	Person's gender
`birthday`	`professional`	String	Person's Birthday in ISO 8601 format (YYYY-MM-DD)
`biography`	`professional`	String	Person's biography
`certifications`	`professional`	Object Array	List of certifications
`number`	`certifications`	String	Certification/License number
`country`	`certifications`	String	Country issuing certification. 2 letter ISO code.
`endDate`	`certifications`	String	Expiration date of the Certification/License (YYYY-MM-DD).
`name`	`certifications`	String	Certification name
`issuer`	`certifications`	String	Certification issuer
`primary`	`certifications`	Boolean	Whether certification is primary certification
`affiliations`	`professional`	Object Array	List of affiliations. For non-healthcare professionals, list of professional associations. For Healthcare Professionals, list of admitting hospitals.
`affiliation`	`affiliations`	String	Affiliation name
`primary`	`affiliations`	Boolean	Whether affiliation is primary affiliation. If none of the affiliations are defined as prmary=`true`, then the first affiliation will be defaulted to primary=`true`
`educations`	`professional`	Object Array	List of educational experience
`type`	`educations`	String	Type of edcuation - valid values: `Undergraduate`,`Graduate`,`Medical`,`Law`,`Internship`,`Fellowship`,`Residency`,`AdditionalTraining`,`BachelorOfScience`,`DentalSchool`,`MasterOfArts`,`Masters`,`MastersOfScience`,`NursingSchool`,`PHD`,`ProfessionalEducation`,`PsyD`,`Society`,`Certification`,`Education`,`ProfessionalAffiliations`,`ProfessionalMembership`,`SpecializationsAndProcedures`,`Awards`,`Other`
`institution`	`educations`	String	Name of institution
`graduationYear`	`educations`	String	Graduation year
`degree`	`educations`	String	Graduation Degree
`primary`	`educations`	String	Whether education is the professional's primary/main education
`languages`	`professionals`	String	List of languages
`serviceArea`		Object	Service are details object (for service area businesses).
`places`	`serviceArea`	String Array	Zip Code or City Name, State, Country (if applicable)
`businessType`	`serviceArea`	String	Business type - valid values: `BUSINESS_TYPE_UNSPECIFIED`,`CUSTOMER_AND_BUSINESS_LOCATION`,`CUSTOMER_LOCATION_ONLY`
`categories`		Object Array	List of category objects
`category`	`categories`	Object	Caregory object
`id`	`category`	String	Object id
`label`	`category`	String	Object label
`primary`	`categories`	Boolean	Whether `category` object is the primary object.
`paymentTypes`		String Array	Comma separated list of accepted payment types
`richKnowledge`		Object	Object containing metadata
`titleTag`	`richKnowledge`	String	The HTML element that specifies the title of the web page
`metaDescription`	`richKnowledge`	String	The HTML element that describes the subject of the webpage
`metaKeywords`	`richKnowledge`	String Array	The HTML element that lists keywords related to the webpage
`htmlDescription`	`richKnowledge`	String	HTML enabled business description of the profile
`zipCodesServed`	`richKnowledge`	String Array	The list of zipCodes served by the entity
`areasServed`	`richKnowledge`	String Array	The list of areas served by the entity
`professionalStatement`	`richKnowledge`	String	Brief statement of the professional represented by the entity
`covidMessage`		String	This field allows communication centered around COVID-19. It can be used to communicate cleaning protocols, store capacity, security measures, mask requirements, and other measures. The field is limited to 200 characters and must only be used to provide messages related to COVID-19.
`createdDate`		String	Profile's created date - Datetime ISO 8601
`updatedDate`		String	Profile's updated date - Datetime ISO 8601
`distance`		Number (Double)	Shows the distance of the Location from the provided Latitude and Longitude or Postal Code
`slug`		String	Url slug

Response Schema

{\n    \"id\": \"string\",\n    \"internalID\": \"string\",\n    \"optedOut\": \"boolean\",\n    \"linkedProfileID\": \"string\",\n    \"tenantID\": \"string\",\n    \"internalName\": \"string\",\n    \"externalName\": \"string\",\n    \"industryID\": \"string\",\n    \"parentID\": \"string\",\n    \"customVariables\": [\n        {\n            \"name\": \"string\",\n            \"value\": \"string\"\n        }\n    ],\n    \"customFilters\": [\n        {\n            \"name\": \"string\",\n            \"value\": \"string\"\n        }\n    ],\n    \"locationType\": \"string\",\n    \"groupCode\": \"string\",\n    \"state\": \"string\",\n    \"utm\": \"boolean\",\n    \"description\": \"string\",\n    \"tags\": [\n        \"string\",\n    ],\n    \"paymentTypes\": [\n        \"string\"\n    ],\n    \"covidMessage\": \"string\",\n    \"medias\": [\n        {\n            \"url\": \"string\",\n            \"title\": \"string\",\n            \"mediaType\": \"string\",\n            \"primary\": \"boolean\"\n        }\n    ],\n    \"attributes\": [\n        {\n            \"attributeId\": \"string\",\n            \"boolValue\": \"boolean\"\n        },\n        {\n            \"attributeId\": \"string\",\n            \"values\": [\n                {\n                    \"id\": \"string\",\n                    \"boolValue\": \"boolean\"\n                },\n            ]\n        }\n    ],\n    \"owners\": [\n        {\n            \"name\": \"string\",\n            \"role\": \"string\",\n            \"pendingInvitation\": \"boolean\"\n        }\n    ]\n    \"socialMedias\": [\n        {\n            \"url\": \"string\",\n            \"socialMediaType\": \"string\"\n        },\n    ],\n    \"shortDescription\": \"string\",\n    \"medical\": {\n        \"npi\": \"string\",\n        \"stateLicenseNumber\": \"string\",\n        \"insurancesAccepted\": [\n            {\n                \"id\": \"string\",\n                \"label\": \"string\"\n            },\n        ],\n        \"acceptingNewPatients\": \"boolean\",\n        \"employerAffiliation\": \"string\",\n        \"specialties\": [\n            {\n                \"specialty\": \"string\",\n                \"primary\": \"boolean\"\n            }\n        ],\n        \"webMdCampaignId\": \"string\",\n        \"insuranceNetworks\": [\n            {\n                \"insuranceNetwork\": {\n                    \"id\": \"string\",\n                    \"label\": \"string\"\n                }\n            },\n        ]\n    },\n    \"categories\": [\n        {\n            \"category\": {\n                \"id\": \"string\",\n                \"label\": \"string\"\n            },\n            \"primary\": \"boolean\"\n        }\n    ],\n    \"places\": [\n        {\n            \"placeID\": \"string\",\n            \"officeName\": \"string\",\n            \"address\": {\n                \"streetAddress2\": \"string\",\n                \"locality\": \"string\",\n                \"region\": \"string\",\n                \"postalCode\": \"string\",\n                \"country\": \"string\",\n                \"latitude\": \"string\",\n                \"longitude\": \"string\",\n                \"streetAddress1\": \"string\"\n            },\n            \"businessHours\": [\n                {\n                    \"timePeriods\": [\n                        {\n                            \"openDay\": \"string\",\n                            \"openTime\": \"string\",\n                            \"closeDay\": \"string\",\n                            \"closeTime\": \"string\",\n                            \"open24Hours\": \"boolean\",\n                            \"closed\": \"boolean\"\n                        },\n                    ],\n                    \"name\": \"string\",\n                    \"primary\": \"boolean\",\n                    \"specialHours\": [\n                        {\n                            \"openTime\": \"string\",\n                            \"closeTime\": \"string\",\n                            \"open24Hours\": \"boolean\",\n                            \"closed\": \"boolean\",\n                            \"startDate\": \"string\"\n                        },\n                    ],\n                    \"businessHourType\": \"string\"\n                }\n            ],\n            \"phones\": [\n                {\n                    \"number\": \"string\",\n                    \"extension\": \"string\",\n                    \"primary\": \"boolean\",\n                    \"country\": \"string\",\n                    \"phoneType\": \"string\"\n                }\n            ],\n            \"websites\": [\n                {\n                    \"url\": \"string\",\n                    \"primary\": \"boolean\",\n                    \"websiteType\": \"string\"\n                }\n            ],\n            \"emails\": [\n                {\n                    \"email\": \"string\",\n                    \"primary\": \"boolean\"\n                },\n            ],\n            \"primary\": \"boolean\",\n            \"officeStatus\": {\n                \"officeState\": \"string\",\n                \"operationalDate\": \"string\"\n            },\n            \"originalAddress\": {\n                \"streetAddress2\": \"string\",\n                \"locality\": \"string\",\n                \"region\": \"string\",\n                \"postalCode\": \"string\",\n                \"country\": \"string\",\n                \"latitude\": \"string\",\n                \"longitude\": \"string\",\n                \"streetAddress1\": \"string\"\n            },\n            \"linkedLuid\": \"integer\",\n            \"relatedLocations\": [\n                {\n                    \"type\": \"integer\",\n                    \"placeId\": \"string\"\n                }\n            ]\n        }\n    ],\n    \"professional\": {\n        \"title\": \"string\",\n        \"appellation\": \"string\",\n        \"degrees\": [\n            {\n                \"degree\": \"string\",\n                \"primary\": \"boolean\"\n            }\n        ]\n        \"firstName\": \"string\"\n        \"lastName\": \"string\",\n        \"middleName\": \"string\",\n        \"gender\": \"string\",\n        \"birthday\": \"string\",\n        \"biography\": \"string\",\n        \"certifications\": [\n            {\n                \"number\": \"string\",\n                \"country\": \"string\",\n                \"endDate\": \"string\",\n                \"name\": \"string\",\n                \"issuer\": \"string\",\n                \"primary\": \"boolean\"\n            }\n        ],\n        \"affiliations\": [\n            {\n                \"affiliation\": \"string\",\n                \"primary\": \"boolean\"\n            }\n        ],\n        \"educations\": [\n            {\n                \"type\": \"string\",\n                \"institution\": \"string\",\n                \"graduationYear\": \"string\",\n                \"degree\": \"string\",\n                \"primary\": \"boolean\"\n            }\n        ],\n        \"languages\": [\n            \"string\",\n        ],\n    },\n    \"serviceArea\": {\n        \"places\": [\"string\"],\n        \"businessType\": \"string\"\n    },\n    \"richKnowledge\": {\n        \"titleTag\": \"string\",\n        \"metaDescription\": \"string\",\n        \"metaKeywords\": [\"string\"],\n        \"htmlDescription\": \"string\",\n        \"zipCodesServed\": [\"string\"],\n        \"areasServed\": [\"string\"],\n        \"professionalStatement\": \"string\"\n    }\n    \"type\": \"string\",\n    \"primaryProfile\": \"boolean\",\n    \"profileDefinition\": \"string\",\n    \"createdDate\": \"string\",\n    \"updatedDate\": \"string\",\n    \"distance\": \"Double\",\n    \"slug\": \"string\"\n}\n\n

\n","urlObject":{"path":["locations",":locationID"],"host":["{{baseUrl}}"],"query":[{"disabled":true,"description":{"content":"

If set to true, the location will be marked as inactive but won't be fully deleted from the system. By default, this value is set to false, meaning the location will be fully removed unless specified otherwise.

\n","type":"text/plain"},"key":"preserveLocation","value":""}],"variable":[{"description":{"content":"

(Required) The unique identifier of the location profile to be deleted.

\n","type":"text/plain"},"type":"any","value":"","key":"locationID"}]}},"response":[{"id":"a54cb9a1-371a-4202-bc1a-a7ee602c285c","name":"Success","originalRequest":{"method":"DELETE","header":[{"key":"x-api-key","value":"Your API key"}],"url":{"raw":"https://api.reputation.com/v3/locations/:locationID?preserveLocation=true","protocol":"https","host":["api","reputation","com"],"path":["v3","locations",":locationID"],"query":[{"key":"preserveLocation","value":"true"}],"variable":[{"key":"locationID","value":"BP"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"1427"},{"key":"etag","value":"W/\"593-0YrdKhyJL/j4J76P64aNU6toQ4A\""},{"key":"date","value":"Tue, 03 Oct 2023 23:33:05 GMT"},{"key":"x-envoy-upstream-service-time","value":"364"},{"key":"server","value":"istio-envoy"},{"key":"Via","value":"1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"BP\",\n \"internalID\": \"737493\",\n \"optedOut\": false,\n \"internalName\": \"Bay Plumbing & test (BP)\",\n \"industryID\": \"automotive-parts\",\n \"parentID\": null,\n \"customVariables\": [\n {\n \"name\": \"CAMPAIGN_ENROLLMENT_AND_SCHEDULE_PREFERENCE\",\n \"value\": \"MANUAL\"\n }\n ],\n \"customFilters\": [\n {\n \"name\": \"Brand\",\n \"value\": \"N/A\"\n }\n ],\n \"state\": \"Active\",\n \"externalName\": \"Bay Plumbing\",\n \"categories\": [\n {\n \"category\": {\n \"id\": \"MISSING_CATEGORY\",\n \"label\": \"Missing Category\"\n },\n \"primary\": true\n }\n ],\n \"places\": [\n {\n \"officeName\": \"Bay Plumbing\",\n \"address\": {\n \"streetAddress2\": null,\n \"locality\": \"Redwood City\",\n \"region\": \"CA\",\n \"postalCode\": \"94063\",\n \"country\": \"US\",\n \"latitude\": \"37.4880518\",\n \"longitude\": \"-122.2243949\",\n \"streetAddress1\": \"1001 Marshall St\"\n },\n \"businessHours\": null,\n \"phones\": [\n {\n \"number\": \"(650) 367-9493\",\n \"primary\": true,\n \"country\": \"US\",\n \"phoneType\": \"Local\"\n }\n ],\n \"websites\": [\n {\n \"url\": \"http://bayplumbing.net\",\n \"primary\": true,\n \"websiteType\": \"Homepage\"\n }\n ],\n \"emails\": [\n {\n \"email\": \"\",\n \"primary\": true\n }\n ],\n \"primary\": true,\n \"officeStatus\": null,\n \"originalAddress\": {\n \"streetAddress2\": null,\n \"locality\": \"Redwood City\",\n \"region\": \"CA\",\n \"postalCode\": \"94063-2052\",\n \"country\": \"US\",\n \"latitude\": \"37.48776\",\n \"longitude\": \"-122.22447\",\n \"streetAddress1\": \"1001 Marshall St\"\n },\n \"linkedLuid\": null,\n \"relatedLocations\": null\n }\n ],\n \"type\": \"RoofTop\",\n \"locationType\": \"main\",\n \"groupCode\": \"BP\",\n \"primaryProfile\": true,\n \"profileDefinition\": \"RoofTop\",\n \"createdDate\": \"2018-03-14T05:08:53\",\n \"updatedDate\": \"2023-04-07T07:45:01\",\n \"distance\": null,\n \"slug\": \"bay-plumbing-bay-plumbing-redwood-city-ca\"\n}"}],"_postman_id":"8a321c1d-d9fe-4db2-be5e-f7a55ecf4e71"},{"name":"Opt Out Of Audit","id":"8ff1d205-2056-409e-810d-683eff0f2dcf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"x-api-key","value":""}],"url":"{{baseUrl}}/locations/:locationID/opt-out","description":"

Opt-out specific sources from location profiles. If no specific sourceIDs are provided, the profile will be opted out from all eligible sources.

Sample

JavaScript XHR Request

var xhr = new XMLHttpRequest();\nxhr.open(\"PUT\", \"https://api.reputation.com/v3/locations/SA/opt-out?sourceIDs=FACEBOOK\", true);\nxhr.setRequestHeader(\"x-api-key\", \"Your API key\");\nxhr.onreadystatechange = function() {\n  if (xhr.readyState == 4 && xhr.status == 200) {\n    var response = JSON.parse(xhr.responseText);\n    console.log(response);\n  }\n};\nxhr.send();\n\n

Response Parameters

Parameter	Parent	Data Type	Description
`id`		String	Identifier for the location - ex. `SA`
`internalID`		String	The internal identification number assigned to the location - ex. `737476`
`optedOut`		Boolean	Indicates whether the location has opted out of listings publishing.
`linkedProfileID`		String	Id used to reference existing linked profiles
`tenantID`		String	Tenant's unique id. Attribute becomes read-only after profile is created
`internalName`		String	The internal name given to the location - ex. `Simple Art`
`externalName`		String	Location's external name - ex. `Majestic Art`
`industryID`		String	The industry identification associated with the location - ex. `automotive-dealer`
`parentID`		String	The ID of the parent location if there's any, otherwise `null`.
`customVariables`		Object Array	An array of custom variables associated with the location, containing the variable name and its value.
`name`	`customVariables`	String	Custom variable name - ex. `CAMPAIGN_ENROLLMENT_AND_SCHEDULE_PREFERENCE`
`value`	`customVariables`	String	Value of the custom variable - ex. `MANUAL`
`customFilters`		Object Arrary	An array of custom filters applied to the location, containing the filter name and its value.
`name`	`customFilters`	String	Custom filter name - ex. `Brand`
`value`	`customFilters`	String	Value of the custom filter - ex. `Gallery`
`locationType`		String	Specifies the location type whether it's `main`, `branch`, etc.
`groupCode`		String	A common identifier used to associate the main location with its corresponding departmental or supplemental locations. This unique code must be the same for both the main location and any related department/supplemental locations - ex. `SA`
`primaryProfile`		Boolean	Indicates if the profile is the primary one.
`type`		String	Indicates the type of the location - ex. `Rooftop`
`profileDefinition`		String	Definition or category of the profile - ex. `Rooftop`
`state`		String	Defines the state of the entity, i.e. whether it is covered by the current contract with Reputation. If left empty, state will default to active - ex. `Active`
`places`		Object Array	List of \"Place\" objects
`placeID`	`places`	String	Place id
`officeName`	`places`	String	Office or practice name - ex. `Bay Plumbing`
`address`	`places`	Object	Address object
`streetAddress1`	`address`	String	Street address line 1 - ex. `1001 Marshall St`
`streetAddress2`	`address`	String	Street address line 2 - ex. `Suite 300 null` if there is no line 2
`locality`	`address`	String	Locality/city - ex. `Redwood City`
`region`	`address`	String	Region/State or Province - ex. `CA`
`country`	`address`	String	Country's 2 letter ISO Code - ex. `US`
`postalCode`	`address`	String	Postal Code/Zip Code - ex. `94063`
`latitude`	`address`	String	Address latitude - ex. `37.4880518`
`longitude`	`address`	String	Address longitude - ex. `-122.2243949`
`originalAddress`	`places`	Object	Raw non-normalized version of the address inputed by the user
`streetAddress1`	`originalAddress`	String	Street address line 1 - ex. `1001 Marshall St`
`streetAddress2`	`originalAddress`	String	Street address line 2 - ex. `Suite 300 null` if there is no line 2
`locality`	`originalAddress`	String	Locality/city - ex. `Redwood City`
`region`	`orignialAddress`	String	Region/State or Province - ex. `CA`
`country`	`originalAddress`	String	Country's 2 letter ISO Code - ex. `US`
`postalCode`	`originalAdress`	String	Postal Code/Zip Code - ex. `94063-2052`
`latitude`	`originalAddress`	String	Address latitude - ex. `37.48776`
`longitude`	`originalAddress`	String	Address longitude - ex. `-122.2243949`
`businessHours`	`places`	Object Array	List of \"business hours\" objects - If there are no objects, `null` is returned.
`name`	`businessHours`	String	Name of the \"business hour\" object
`businessHourType`	`businessHours`	String	Refers to the type of business hours. - valid values: `Main` `Sales` `Service` `Parts` `Holiday`
`timePeriods`	`businessHours`	Object Array	List of \"Time Period\" objects to represent days and times opened/closed.
`openDay`	`timePeriods`	String	Profile's open days - valid values: `Sunday`, `Monday`, `Tuesday`,`Wednesday`,`Thursday`,`Friday`,`Saturday`
`openTime`	`timePeriods`	String	Profile's open times in 24hr ISO 8601 - valid values: `00:00-24:00`, where 24:00 represents midnight at the end of the specified `openDay`.
`closeDay`	`timePeriods`	String	Profile's closed days - valid values: `Sunday` ,`Monday`, `Tuesday` ,`Wednesday` ,`Thursday` ,`Friday` ,`Saturday`
`closeTime`	`timePeriods`	String	Profile's closed times in 24hr ISO 8601 - valid values: `00:00-24:00`, where 24:00 represents midnight at the end of the specified `closeDay`.
`open24Hours`	`timePeriods`	Boolean	Denotes whether the profile is open 24 hours during the specified day range
`closed`	`timePeriods`	Boolean	Denotes whether the profile is closed at the current time
`primary`	`businessHours`	Boolean	Denotes whether business hours are the profile's primary hours
`specialHours`	`businessHours`	Object Array	List of \"special time period\" objects -similar to `timePeriods` but used for special instances
`startDate`	`specialHours`	String	The calendar date the special hour period starts on - In ISO 8601 format (YYYY-MM-DD) .
`openTime`	`specialHours`	String	Time in 24hr ISO 8601 extended format (hh:mm). Valid values are 00:00-24:00, where 24:00 represents midnight at the end of the specified day field. Specified if `closed`and `open24Hours` is `false`.
`closeTime`	`speicalHours`	String	Time in 24hr ISO 8601 extended format (hh:mm). Valid values are 00:00-24:00, where 24:00 represents midnight at the end of the specified day field. Specified if `closed`and `open24Hours` is `false`.
`open24Hours`	`specialHours`	Boolean	Denotes whether open 24 hours during the specified day range. If true, `openTime`, and `closeTime` are ignored, and the date specified in startDate is treated as the location being open for the entire day.
`closed`	`specialHours`	Boolean	Denotes whether the profile is closed. If `true`, `openTime`, and `closeTime` are ignored, and the date specified in `startDate` is treated as the location being closed for the entire day.
`phones`	`places`	Object Array	List of phone number objects.
`phoneType`	`phones`	String	Phone type - valid values: `Local`, `Mobile`, `Fax`, `TollFree`, `Tracked`, `Sales`, `Service`, `Parts`, `Emergency`, `GoogleOnly`, `FacebookOnly`, `BingOnly`, `FourSquareOnly`, `WhatsApp`, `Text_SMS`, `Other`
`number`	`phones`	String	Phone number - ex. \"`(408) 900-9080`
`extension`	`phones`	String	Extension number
`country`	`phones`	String	Country of origin - ex. `US`
`primary`	`phones`	Boolean	Denotes whether phone is primary
`websites`	`places`	Object Array	List of websites
`websiteType`	`websites`	String	Type of website - valid values: `Homepage` ,`Reservation`, `Order`, `GoogleHomepage`, `Covid`, `Telehealth`, `Menu`
`url`	`websites`	String	Website URL - ex. `http://www.reputation.com`
`primary`	`websites`	Boolean	Whether website is primary
`emails`	`places`	Object Array	List of emails
`email`	`emails`	String	The business's email address - ex. `business@reputation.com`
`primary`	`emails`	Boolean	Whether email is primary email
`officeStatus`	`places`	Object	An office status object containing the `officeState` and `operationalDate`.
`officeState`	`officeStatus`	String	Office state/status type - valid values: `Open`,`Closed`,`Moved`,`Permanently_Closed`,`Opening_Soon`,`Closing_Soon`,`Temporarily_Closed`
`operationalDate`	`officeStatus`	String	Date of office state in ISO 8601 format (YYYY-MM-DD) - ex. `2021-05-01`
`primary`	`places`	Boolean	Whether place is business's primary place
`description`		String	Description of the business - ex. `Simple Art Page Description`
`shortDescription`		String	Short description to publish on Source site. Limit of 155 characters - ex. `Simple Art Page`
`tags`		String	Keywords identifying the location, used in meta-tags - ex. `art`,`exclusive`,`low prices`
`utm`		Boolean	Whether a UTM source is appended to a primary URL when it is sent to GoogleMyBusinees. UTM example: ?utm_source=local&utm_medium=organic&utm_camp
`attributes`		Object Array	List of Attribute objects. Available attributes depend on selected categories. See Attributes section below for more details.
`attributeId`	`attributes`	String	Attribute Id
`boolValue`	`attributes`	Boolean	Attribute boolean value. This field or `values`is used but not both. Valid values are: `true`or `false`
`values`	`attributes`	Object Array	List of Attribute values. This field or `boolValue`is used but not both
`id`	`values`	String	Attribute value Id
`boolValue`	`values`	Boolean	Boolean of attribute value
`owners`		Object Array	List of owners
`name`	`owners`	String	The name of the admin. When making the initial invitation, this is the invitee's email address.
`role`	`owners`	String	Role of the owner
`pendingInvitation`	`owners`	Boolean	Status of the invitation sent to the owner.
`socialMedias`		Object Array	List of social media objects
`socialMediaType`	`socialMedias`	String	Type of social media - valid values: `Facebook`,`Twitter`,`Instagram`,`Snapchat`,`YouTube`,`LinkedIn`,`Pintrest`,`Blog`
`url`	`socialMedias`	String	URL for social media
`medias`		Object Array	List of media objects
`mediaType`	`medias`	String	Media Type. png or jpeg file for cover photo: 16:9 aspect ratio with minimum size 400px - valid values: `Headshot`,`Cover`,`Profile`,`Logo`,`Video`,`Google_Logo`,`Google_Cover`,`Facebook_Profile`,`Facebook_Cover`,`Additional`
`url`	`medias`	String	URL for Media
`title`	`medias`	String	Title for media object
`primary`	`medias`	Boolean	Whether media is primary
`medical`		Object	Medical details provided if listing is for a medical business.
`npi`	`medical`	String	National Provider Identifier (NPI) is a unique 10-digit identification number issued to health care providers in the United States. NPI is used to uniquely identify health care providers in the US.
`stateLicenseNumber`	`medical`	String	State license number
`insurancesAccepted`	`medical`	Object Array	List of insurance objects
`id`	`insurancesAccepted`	String	Id of the object
`label`	`insurancesAccepted`	String	Object label
`acceptingNewPatients`	`medical`	Boolean	Boolean used to determine whether a health care provider or facility is currently accepting new patients
`employerAffiliation`	`medical`	String	Used to characterize the employer affiliation, as doctors can be either employed or affiliated with a health care group ex. `Employed`, `Independent`
`specialties`	`medical`	Object Array	List of specialties associated with the entity.
`specialty`	`specialties`	String	Specialty type.
`primary`	`specialties`	Boolean	Whether specialty is primary.
`webMdCampaignId`	`medical`	String	This is an ID provided by WebMD to shared clients between Reputation and WebMD that are running paid Carefinder campaigns on WebMD. This field will allow shared clients to manage their WebMD campaigns directly from the Reputation platform.
`insuranceNetworks`	`medical`	Object Array	List of insurance networks that are accepted by the health care provider or facility. This field will replace the deprecated InsurancesAccepted.
`insuranceNetork`	`medical`	Object Array	An insurance network is a list of the doctors, other health care providers, and hospitals that a plan has contracted with to provide medical care to its members
`id`	`insuranceNetork`	String	Id of the object
`label`	`insuranceNetork`	String	Label of the object
`professional`		Object	If the listing is for service professional, then it will provide the details for the professional.
`title`	`professional`	String	Person's Title
`appellation`	`professional`	String	Person's Appellation
`degrees`	`professional`	Object Array	List of Degrees
`degree`	`degrees`	String	Name of degree
`primary`	`degrees`	Boolean	Whether degree is primary
`firstName`	`professional`	String	Person's first name
`lastName`	`professional`	String	Person's last name
`middleName`	`professional`	String	Person's middle name
`gender`	`professional`	String	Person's gender
`birthday`	`professional`	String	Person's Birthday in ISO 8601 format (YYYY-MM-DD)
`biography`	`professional`	String	Person's biography
`certifications`	`professional`	Object Array	List of certifications
`number`	`certifications`	String	Certification/License number
`country`	`certifications`	String	Country issuing certification. 2 letter ISO code.
`endDate`	`certifications`	String	Expiration date of the Certification/License (YYYY-MM-DD).
`name`	`certifications`	String	Certification name
`issuer`	`certifications`	String	Certification issuer
`primary`	`certifications`	Boolean	Whether certification is primary certification
`affiliations`	`professional`	Object Array	List of affiliations. For non-healthcare professionals, list of professional associations. For Healthcare Professionals, list of admitting hospitals.
`affiliation`	`affiliations`	String	Affiliation name
`primary`	`affiliations`	Boolean	Whether affiliation is primary affiliation. If none of the affiliations are defined as prmary=`true`, then the first affiliation will be defaulted to primary=`true`
`educations`	`professional`	Object Array	List of educational experience
`type`	`educations`	String	Type of edcuation - valid values: `Undergraduate`,`Graduate`,`Medical`,`Law`,`Internship`,`Fellowship`,`Residency`,`AdditionalTraining`,`BachelorOfScience`,`DentalSchool`,`MasterOfArts`,`Masters`,`MastersOfScience`,`NursingSchool`,`PHD`,`ProfessionalEducation`,`PsyD`,`Society`,`Certification`,`Education`,`ProfessionalAffiliations`,`ProfessionalMembership`,`SpecializationsAndProcedures`,`Awards`,`Other`
`institution`	`educations`	String	Name of institution
`graduationYear`	`educations`	String	Graduation year
`degree`	`educations`	String	Graduation Degree
`primary`	`educations`	String	Whether education is the professional's primary/main education
`languages`	`professionals`	String	List of languages
`serviceArea`		Object	Service are details object (for service area businesses).
`places`	`serviceArea`	String Array	Zip Code or City Name, State, Country (if applicable)
`businessType`	`serviceArea`	String	Business type - valid values: `BUSINESS_TYPE_UNSPECIFIED`,`CUSTOMER_AND_BUSINESS_LOCATION`,`CUSTOMER_LOCATION_ONLY`
`categories`		Object Array	List of category objects
`category`	`categories`	Object	Caregory object
`id`	`category`	String	Object id
`label`	`category`	String	Object label
`primary`	`categories`	Boolean	Whether `category` object is the primary object.
`paymentTypes`		String Array	Comma separated list of accepted payment types
`richKnowledge`		Object	Object containing metadata
`titleTag`	`richKnowledge`	String	The HTML element that specifies the title of the web page
`metaDescription`	`richKnowledge`	String	The HTML element that describes the subject of the webpage
`metaKeywords`	`richKnowledge`	String Array	The HTML element that lists keywords related to the webpage
`htmlDescription`	`richKnowledge`	String	HTML enabled business description of the profile
`zipCodesServed`	`richKnowledge`	String Array	The list of zipCodes served by the entity
`areasServed`	`richKnowledge`	String Array	The list of areas served by the entity
`professionalStatement`	`richKnowledge`	String	Brief statement of the professional represented by the entity
`covidMessage`		String	This field allows communication centered around COVID-19. It can be used to communicate cleaning protocols, store capacity, security measures, mask requirements, and other measures. The field is limited to 200 characters and must only be used to provide messages related to COVID-19.
`createdDate`		String	Profile's created date - Datetime ISO 8601
`updatedDate`		String	Profile's updated date - Datetime ISO 8601
`distance`		Number (Double)	Shows the distance of the Location from the provided Latitude and Longitude or Postal Code
`slug`		String	Url slug

Response Schema

{\n    \"id\": \"string\",\n    \"internalID\": \"string\",\n    \"optedOut\": \"boolean\",\n    \"linkedProfileID\": \"string\",\n    \"tenantID\": \"string\",\n    \"internalName\": \"string\",\n    \"externalName\": \"string\",\n    \"industryID\": \"string\",\n    \"parentID\": \"string\",\n    \"customVariables\": [\n        {\n            \"name\": \"string\",\n            \"value\": \"string\"\n        }\n    ],\n    \"customFilters\": [\n        {\n            \"name\": \"string\",\n            \"value\": \"string\"\n        }\n    ],\n    \"locationType\": \"string\",\n    \"groupCode\": \"string\",\n    \"state\": \"string\",\n    \"utm\": \"boolean\",\n    \"description\": \"string\",\n    \"tags\": [\n        \"string\",\n    ],\n    \"paymentTypes\": [\n        \"string\"\n    ],\n    \"covidMessage\": \"string\",\n    \"medias\": [\n        {\n            \"url\": \"string\",\n            \"title\": \"string\",\n            \"mediaType\": \"string\",\n            \"primary\": \"boolean\"\n        }\n    ],\n    \"attributes\": [\n        {\n            \"attributeId\": \"string\",\n            \"boolValue\": \"boolean\"\n        },\n        {\n            \"attributeId\": \"string\",\n            \"values\": [\n                {\n                    \"id\": \"string\",\n                    \"boolValue\": \"boolean\"\n                },\n            ]\n        }\n    ],\n    \"owners\": [\n        {\n            \"name\": \"string\",\n            \"role\": \"string\",\n            \"pendingInvitation\": \"boolean\"\n        }\n    ]\n    \"socialMedias\": [\n        {\n            \"url\": \"string\",\n            \"socialMediaType\": \"string\"\n        },\n    ],\n    \"shortDescription\": \"string\",\n    \"medical\": {\n        \"npi\": \"string\",\n        \"stateLicenseNumber\": \"string\",\n        \"insurancesAccepted\": [\n            {\n                \"id\": \"string\",\n                \"label\": \"string\"\n            },\n        ],\n        \"acceptingNewPatients\": \"boolean\",\n        \"employerAffiliation\": \"string\",\n        \"specialties\": [\n            {\n                \"specialty\": \"string\",\n                \"primary\": \"boolean\"\n            }\n        ],\n        \"webMdCampaignId\": \"string\",\n        \"insuranceNetworks\": [\n            {\n                \"insuranceNetwork\": {\n                    \"id\": \"string\",\n                    \"label\": \"string\"\n                }\n            },\n        ]\n    },\n    \"categories\": [\n        {\n            \"category\": {\n                \"id\": \"string\",\n                \"label\": \"string\"\n            },\n            \"primary\": \"boolean\"\n        }\n    ],\n    \"places\": [\n        {\n            \"placeID\": \"string\",\n            \"officeName\": \"string\",\n            \"address\": {\n                \"streetAddress2\": \"string\",\n                \"locality\": \"string\",\n                \"region\": \"string\",\n                \"postalCode\": \"string\",\n                \"country\": \"string\",\n                \"latitude\": \"string\",\n                \"longitude\": \"string\",\n                \"streetAddress1\": \"string\"\n            },\n            \"businessHours\": [\n                {\n                    \"timePeriods\": [\n                        {\n                            \"openDay\": \"string\",\n                            \"openTime\": \"string\",\n                            \"closeDay\": \"string\",\n                            \"closeTime\": \"string\",\n                            \"open24Hours\": \"boolean\",\n                            \"closed\": \"boolean\"\n                        },\n                    ],\n                    \"name\": \"string\",\n                    \"primary\": \"boolean\",\n                    \"specialHours\": [\n                        {\n                            \"openTime\": \"string\",\n                            \"closeTime\": \"string\",\n                            \"open24Hours\": \"boolean\",\n                            \"closed\": \"boolean\",\n                            \"startDate\": \"string\"\n                        },\n                    ],\n                    \"businessHourType\": \"string\"\n                }\n            ],\n            \"phones\": [\n                {\n                    \"number\": \"string\",\n                    \"extension\": \"string\",\n                    \"primary\": \"boolean\",\n                    \"country\": \"string\",\n                    \"phoneType\": \"string\"\n                }\n            ],\n            \"websites\": [\n                {\n                    \"url\": \"string\",\n                    \"primary\": \"boolean\",\n                    \"websiteType\": \"string\"\n                }\n            ],\n            \"emails\": [\n                {\n                    \"email\": \"string\",\n                    \"primary\": \"boolean\"\n                },\n            ],\n            \"primary\": \"boolean\",\n            \"officeStatus\": {\n                \"officeState\": \"string\",\n                \"operationalDate\": \"string\"\n            },\n            \"originalAddress\": {\n                \"streetAddress2\": \"string\",\n                \"locality\": \"string\",\n                \"region\": \"string\",\n                \"postalCode\": \"string\",\n                \"country\": \"string\",\n                \"latitude\": \"string\",\n                \"longitude\": \"string\",\n                \"streetAddress1\": \"string\"\n            },\n            \"linkedLuid\": \"integer\",\n            \"relatedLocations\": [\n                {\n                    \"type\": \"integer\",\n                    \"placeId\": \"string\"\n                }\n            ]\n        }\n    ],\n    \"professional\": {\n        \"title\": \"string\",\n        \"appellation\": \"string\",\n        \"degrees\": [\n            {\n                \"degree\": \"string\",\n                \"primary\": \"boolean\"\n            }\n        ]\n        \"firstName\": \"string\"\n        \"lastName\": \"string\",\n        \"middleName\": \"string\",\n        \"gender\": \"string\",\n        \"birthday\": \"string\",\n        \"biography\": \"string\",\n        \"certifications\": [\n            {\n                \"number\": \"string\",\n                \"country\": \"string\",\n                \"endDate\": \"string\",\n                \"name\": \"string\",\n                \"issuer\": \"string\",\n                \"primary\": \"boolean\"\n            }\n        ],\n        \"affiliations\": [\n            {\n                \"affiliation\": \"string\",\n                \"primary\": \"boolean\"\n            }\n        ],\n        \"educations\": [\n            {\n                \"type\": \"string\",\n                \"institution\": \"string\",\n                \"graduationYear\": \"string\",\n                \"degree\": \"string\",\n                \"primary\": \"boolean\"\n            }\n        ],\n        \"languages\": [\n            \"string\",\n        ],\n    },\n    \"serviceArea\": {\n        \"places\": [\"string\"],\n        \"businessType\": \"string\"\n    },\n    \"richKnowledge\": {\n        \"titleTag\": \"string\",\n        \"metaDescription\": \"string\",\n        \"metaKeywords\": [\"string\"],\n        \"htmlDescription\": \"string\",\n        \"zipCodesServed\": [\"string\"],\n        \"areasServed\": [\"string\"],\n        \"professionalStatement\": \"string\"\n    }\n    \"type\": \"string\",\n    \"primaryProfile\": \"boolean\",\n    \"profileDefinition\": \"string\",\n    \"createdDate\": \"string\",\n    \"updatedDate\": \"string\",\n    \"distance\": \"Double\",\n    \"slug\": \"string\"\n}\n\n

\n","urlObject":{"path":["locations",":locationID","opt-out"],"host":["{{baseUrl}}"],"query":[{"disabled":true,"description":{"content":"

A comma-separated list of source IDs to specify which sources to opt-out from. If omitted, all eligible sources are opted out.\nExample: source1,source2,source3

\n","type":"text/plain"},"key":"sourceIDs","value":""}],"variable":[{"description":{"content":"

The unique identifier for the profile.

\n","type":"text/plain"},"type":"any","value":"","key":"locationID"}]}},"response":[{"id":"cf32fdcf-cc19-4441-ab9d-5960f231440b","name":"Success","originalRequest":{"method":"PUT","header":[{"key":"x-api-key","value":"Your API key"}],"url":{"raw":"https://api.reputation.com/v3/locations/:locationID/opt-out?sourceIDs=FACEBOOK","protocol":"https","host":["api","reputation","com"],"path":["v3","locations",":locationID","opt-out"],"query":[{"key":"sourceIDs","value":"FACEBOOK"}],"variable":[{"key":"locationID","value":"SA"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"1703"},{"key":"etag","value":"W/\"6a7-+Jh79ZSy7pF4QxnEiXrIwzprLOE\""},{"key":"date","value":"Wed, 04 Oct 2023 00:04:53 GMT"},{"key":"x-envoy-upstream-service-time","value":"414"},{"key":"server","value":"istio-envoy"},{"key":"Via","value":"1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"SA\",\n \"internalID\": \"737476\",\n \"optedOut\": false,\n \"internalName\": \"Simple Art\",\n \"industryID\": \"automotive-dealer\",\n \"parentID\": null,\n \"customVariables\": [\n {\n \"name\": \"test-inventory\",\n \"value\": \"www.apple.com\"\n },\n {\n \"name\": \"CAMPAIGN_ENROLLMENT_AND_SCHEDULE_PREFERENCE\",\n \"value\": \"MANUAL\"\n }\n ],\n \"customFilters\": [\n {\n \"name\": \"Brand\",\n \"value\": \"Gallery\"\n }\n ],\n \"state\": \"Active\",\n \"externalName\": \"Simple Art\",\n \"description\": \"Simple Art Page Descripton\",\n \"shortDescription\": \"Simple Art Page\",\n \"categories\": [\n {\n \"category\": {\n \"id\": \"TENANT_1990:OPEN_HEART_SURGERY\",\n \"label\": \"Open Heart Surgery\"\n },\n \"primary\": true\n }\n ],\n \"places\": [\n {\n \"officeName\": \"Simple Art\",\n \"address\": {\n \"streetAddress2\": null,\n \"locality\": \"Redwood City\",\n \"region\": \"CA\",\n \"postalCode\": \"94063\",\n \"country\": \"US\",\n \"latitude\": \"37.48805\",\n \"longitude\": \"-122.22439\",\n \"streetAddress1\": \"1001 Marshall St\"\n },\n \"businessHours\": null,\n \"phones\": [\n {\n \"number\": \"(408) 900-9080\",\n \"primary\": true,\n \"country\": \"US\",\n \"phoneType\": \"Local\"\n },\n {\n \"number\": \"(408) 990-9090\",\n \"primary\": false,\n \"country\": \"US\",\n \"phoneType\": \"Mobile\"\n }\n ],\n \"websites\": [\n {\n \"url\": \"http://www.yahoo.com\",\n \"primary\": true,\n \"websiteType\": \"Homepage\"\n }\n ],\n \"emails\": [\n {\n \"email\": \"repdef40+1990@gmail.com\",\n \"primary\": true\n }\n ],\n \"primary\": true,\n \"officeStatus\": {\n \"officeState\": \"Opening_Soon\",\n \"operationalDate\": \"2021-05-01\"\n },\n \"originalAddress\": {\n \"streetAddress2\": null,\n \"locality\": \"Redwood City\",\n \"region\": \"CA\",\n \"postalCode\": \"94063\",\n \"country\": \"US\",\n \"latitude\": \"37.48805\",\n \"longitude\": \"-122.22439\",\n \"streetAddress1\": \"1001 Marshall St\"\n },\n \"linkedLuid\": null,\n \"relatedLocations\": null\n }\n ],\n \"type\": \"RoofTop\",\n \"locationType\": null,\n \"groupCode\": null,\n \"primaryProfile\": true,\n \"profileDefinition\": \"RoofTop\",\n \"createdDate\": \"2018-03-14T05:08:53\",\n \"updatedDate\": \"2023-10-03T17:04:52\",\n \"distance\": null,\n \"slug\": \"simple-art-simple-art-redwood-city-ca\"\n}"}],"_postman_id":"8ff1d205-2056-409e-810d-683eff0f2dcf"},{"name":"Opt In To Audit","id":"385b2b69-d70f-4cb1-9d8b-c27212d059f1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"x-api-key","value":""}],"url":"{{baseUrl}}/locations/:locationID/opt-in","description":"

Opt-in specific sources from location profiles. If no specific sourceIDs are provided, the profile will be opted in to all eligible sources.

Sample

JavaScript XHR Request

var xhr = new XMLHttpRequest();\nxhr.open(\"PUT\", \"https://api.reputation.com/v3/locations/SA/opt-in?sourceIDs=FACEBOOK\", true);\nxhr.setRequestHeader(\"x-api-key\", \"Your API key\");\nxhr.onreadystatechange = function() {\n  if (xhr.readyState == 4 && xhr.status == 200) {\n    var response = JSON.parse(xhr.responseText);\n    console.log(response);\n  }\n};\nxhr.send();\n\n

Response Parameters

Parameter	Parent	Data Type	Description
`id`		String	Identifier for the location - ex. `SA`
`internalID`		String	The internal identification number assigned to the location - ex. `737476`
`optedOut`		Boolean	Indicates whether the location has opted out of listings publishing.
`linkedProfileID`		String	Id used to reference existing linked profiles
`tenantID`		String	Tenant's unique id. Attribute becomes read-only after profile is created
`internalName`		String	The internal name given to the location - ex. `Simple Art`
`externalName`		String	Location's external name - ex. `Majestic Art`
`industryID`		String	The industry identification associated with the location - ex. `automotive-dealer`
`parentID`		String	The ID of the parent location if there's any, otherwise `null`.
`customVariables`		Object Array	An array of custom variables associated with the location, containing the variable name and its value.
`name`	`customVariables`	String	Custom variable name - ex. `CAMPAIGN_ENROLLMENT_AND_SCHEDULE_PREFERENCE`
`value`	`customVariables`	String	Value of the custom variable - ex. `MANUAL`
`customFilters`		Object Arrary	An array of custom filters applied to the location, containing the filter name and its value.
`name`	`customFilters`	String	Custom filter name - ex. `Brand`
`value`	`customFilters`	String	Value of the custom filter - ex. `Gallery`
`locationType`		String	Specifies the location type whether it's `main`, `branch`, etc.
`groupCode`		String	A common identifier used to associate the main location with its corresponding departmental or supplemental locations. This unique code must be the same for both the main location and any related department/supplemental locations - ex. `SA`
`primaryProfile`		Boolean	Indicates if the profile is the primary one.
`type`		String	Indicates the type of the location - ex. `Rooftop`
`profileDefinition`		String	Definition or category of the profile - ex. `Rooftop`
`state`		String	Defines the state of the entity, i.e. whether it is covered by the current contract with Reputation. If left empty, state will default to active - ex. `Active`
`places`		Object Array	List of \"Place\" objects
`placeID`	`places`	String	Place id
`officeName`	`places`	String	Office or practice name - ex. `Bay Plumbing`
`address`	`places`	Object	Address object
`streetAddress1`	`address`	String	Street address line 1 - ex. `1001 Marshall St`
`streetAddress2`	`address`	String	Street address line 2 - ex. `Suite 300 null` if there is no line 2
`locality`	`address`	String	Locality/city - ex. `Redwood City`
`region`	`address`	String	Region/State or Province - ex. `CA`
`country`	`address`	String	Country's 2 letter ISO Code - ex. `US`
`postalCode`	`address`	String	Postal Code/Zip Code - ex. `94063`
`latitude`	`address`	String	Address latitude - ex. `37.4880518`
`longitude`	`address`	String	Address longitude - ex. `-122.2243949`
`originalAddress`	`places`	Object	Raw non-normalized version of the address inputed by the user
`streetAddress1`	`originalAddress`	String	Street address line 1 - ex. `1001 Marshall St`
`streetAddress2`	`originalAddress`	String	Street address line 2 - ex. `Suite 300 null` if there is no line 2
`locality`	`originalAddress`	String	Locality/city - ex. `Redwood City`
`region`	`orignialAddress`	String	Region/State or Province - ex. `CA`
`country`	`originalAddress`	String	Country's 2 letter ISO Code - ex. `US`
`postalCode`	`originalAdress`	String	Postal Code/Zip Code - ex. `94063-2052`
`latitude`	`originalAddress`	String	Address latitude - ex. `37.48776`
`longitude`	`originalAddress`	String	Address longitude - ex. `-122.2243949`
`businessHours`	`places`	Object Array	List of \"business hours\" objects - If there are no objects, `null` is returned.
`name`	`businessHours`	String	Name of the \"business hour\" object
`businessHourType`	`businessHours`	String	Refers to the type of business hours. - valid values: `Main` `Sales` `Service` `Parts` `Holiday`
`timePeriods`	`businessHours`	Object Array	List of \"Time Period\" objects to represent days and times opened/closed.
`openDay`	`timePeriods`	String	Profile's open days - valid values: `Sunday`, `Monday`, `Tuesday`,`Wednesday`,`Thursday`,`Friday`,`Saturday`
`openTime`	`timePeriods`	String	Profile's open times in 24hr ISO 8601 - valid values: `00:00-24:00`, where 24:00 represents midnight at the end of the specified `openDay`.
`closeDay`	`timePeriods`	String	Profile's closed days - valid values: `Sunday` ,`Monday`, `Tuesday` ,`Wednesday` ,`Thursday` ,`Friday` ,`Saturday`
`closeTime`	`timePeriods`	String	Profile's closed times in 24hr ISO 8601 - valid values: `00:00-24:00`, where 24:00 represents midnight at the end of the specified `closeDay`.
`open24Hours`	`timePeriods`	Boolean	Denotes whether the profile is open 24 hours during the specified day range
`closed`	`timePeriods`	Boolean	Denotes whether the profile is closed at the current time
`primary`	`businessHours`	Boolean	Denotes whether business hours are the profile's primary hours
`specialHours`	`businessHours`	Object Array	List of \"special time period\" objects -similar to `timePeriods` but used for special instances
`startDate`	`specialHours`	String	The calendar date the special hour period starts on - In ISO 8601 format (YYYY-MM-DD) .
`openTime`	`specialHours`	String	Time in 24hr ISO 8601 extended format (hh:mm). Valid values are 00:00-24:00, where 24:00 represents midnight at the end of the specified day field. Specified if `closed`and `open24Hours` is `false`.
`closeTime`	`speicalHours`	String	Time in 24hr ISO 8601 extended format (hh:mm). Valid values are 00:00-24:00, where 24:00 represents midnight at the end of the specified day field. Specified if `closed`and `open24Hours` is `false`.
`open24Hours`	`specialHours`	Boolean	Denotes whether open 24 hours during the specified day range. If true, `openTime`, and `closeTime` are ignored, and the date specified in startDate is treated as the location being open for the entire day.
`closed`	`specialHours`	Boolean	Denotes whether the profile is closed. If `true`, `openTime`, and `closeTime` are ignored, and the date specified in `startDate` is treated as the location being closed for the entire day.
`phones`	`places`	Object Array	List of phone number objects.
`phoneType`	`phones`	String	Phone type - valid values: `Local`, `Mobile`, `Fax`, `TollFree`, `Tracked`, `Sales`, `Service`, `Parts`, `Emergency`, `GoogleOnly`, `FacebookOnly`, `BingOnly`, `FourSquareOnly`, `WhatsApp`, `Text_SMS`, `Other`
`number`	`phones`	String	Phone number - ex. \"`(408) 900-9080`
`extension`	`phones`	String	Extension number
`country`	`phones`	String	Country of origin - ex. `US`
`primary`	`phones`	Boolean	Denotes whether phone is primary
`websites`	`places`	Object Array	List of websites
`websiteType`	`websites`	String	Type of website - valid values: `Homepage` ,`Reservation`, `Order`, `GoogleHomepage`, `Covid`, `Telehealth`, `Menu`
`url`	`websites`	String	Website URL - ex. `http://www.reputation.com`
`primary`	`websites`	Boolean	Whether website is primary
`emails`	`places`	Object Array	List of emails
`email`	`emails`	String	The business's email address - ex. `business@reputation.com`
`primary`	`emails`	Boolean	Whether email is primary email
`officeStatus`	`places`	Object	An office status object containing the `officeState` and `operationalDate`.
`officeState`	`officeStatus`	String	Office state/status type - valid values: `Open`,`Closed`,`Moved`,`Permanently_Closed`,`Opening_Soon`,`Closing_Soon`,`Temporarily_Closed`
`operationalDate`	`officeStatus`	String	Date of office state in ISO 8601 format (YYYY-MM-DD) - ex. `2021-05-01`
`primary`	`places`	Boolean	Whether place is business's primary place
`description`		String	Description of the business - ex. `Simple Art Page Description`
`shortDescription`		String	Short description to publish on Source site. Limit of 155 characters - ex. `Simple Art Page`
`tags`		String	Keywords identifying the location, used in meta-tags - ex. `art`,`exclusive`,`low prices`
`utm`		Boolean	Whether a UTM source is appended to a primary URL when it is sent to GoogleMyBusinees. UTM example: ?utm_source=local&utm_medium=organic&utm_camp
`attributes`		Object Array	List of Attribute objects. Available attributes depend on selected categories. See Attributes section below for more details.
`attributeId`	`attributes`	String	Attribute Id
`boolValue`	`attributes`	Boolean	Attribute boolean value. This field or `values`is used but not both. Valid values are: `true`or `false`
`values`	`attributes`	Object Array	List of Attribute values. This field or `boolValue`is used but not both
`id`	`values`	String	Attribute value Id
`boolValue`	`values`	Boolean	Boolean of attribute value
`owners`		Object Array	List of owners
`name`	`owners`	String	The name of the admin. When making the initial invitation, this is the invitee's email address.
`role`	`owners`	String	Role of the owner
`pendingInvitation`	`owners`	Boolean	Status of the invitation sent to the owner.
`socialMedias`		Object Array	List of social media objects
`socialMediaType`	`socialMedias`	String	Type of social media - valid values: `Facebook`,`Twitter`,`Instagram`,`Snapchat`,`YouTube`,`LinkedIn`,`Pintrest`,`Blog`
`url`	`socialMedias`	String	URL for social media
`medias`		Object Array	List of media objects
`mediaType`	`medias`	String	Media Type. png or jpeg file for cover photo: 16:9 aspect ratio with minimum size 400px - valid values: `Headshot`,`Cover`,`Profile`,`Logo`,`Video`,`Google_Logo`,`Google_Cover`,`Facebook_Profile`,`Facebook_Cover`,`Additional`
`url`	`medias`	String	URL for Media
`title`	`medias`	String	Title for media object
`primary`	`medias`	Boolean	Whether media is primary
`medical`		Object	Medical details provided if listing is for a medical business.
`npi`	`medical`	String	National Provider Identifier (NPI) is a unique 10-digit identification number issued to health care providers in the United States. NPI is used to uniquely identify health care providers in the US.
`stateLicenseNumber`	`medical`	String	State license number
`insurancesAccepted`	`medical`	Object Array	List of insurance objects
`id`	`insurancesAccepted`	String	Id of the object
`label`	`insurancesAccepted`	String	Object label
`acceptingNewPatients`	`medical`	Boolean	Boolean used to determine whether a health care provider or facility is currently accepting new patients
`employerAffiliation`	`medical`	String	Used to characterize the employer affiliation, as doctors can be either employed or affiliated with a health care group ex. `Employed`, `Independent`
`specialties`	`medical`	Object Array	List of specialties associated with the entity.
`specialty`	`specialties`	String	Specialty type.
`primary`	`specialties`	Boolean	Whether specialty is primary.
`webMdCampaignId`	`medical`	String	This is an ID provided by WebMD to shared clients between Reputation and WebMD that are running paid Carefinder campaigns on WebMD. This field will allow shared clients to manage their WebMD campaigns directly from the Reputation platform.
`insuranceNetworks`	`medical`	Object Array	List of insurance networks that are accepted by the health care provider or facility. This field will replace the deprecated InsurancesAccepted.
`insuranceNetork`	`medical`	Object Array	An insurance network is a list of the doctors, other health care providers, and hospitals that a plan has contracted with to provide medical care to its members
`id`	`insuranceNetork`	String	Id of the object
`label`	`insuranceNetork`	String	Label of the object
`professional`		Object	If the listing is for service professional, then it will provide the details for the professional.
`title`	`professional`	String	Person's Title
`appellation`	`professional`	String	Person's Appellation
`degrees`	`professional`	Object Array	List of Degrees
`degree`	`degrees`	String	Name of degree
`primary`	`degrees`	Boolean	Whether degree is primary
`firstName`	`professional`	String	Person's first name
`lastName`	`professional`	String	Person's last name
`middleName`	`professional`	String	Person's middle name
`gender`	`professional`	String	Person's gender
`birthday`	`professional`	String	Person's Birthday in ISO 8601 format (YYYY-MM-DD)
`biography`	`professional`	String	Person's biography
`certifications`	`professional`	Object Array	List of certifications
`number`	`certifications`	String	Certification/License number
`country`	`certifications`	String	Country issuing certification. 2 letter ISO code.
`endDate`	`certifications`	String	Expiration date of the Certification/License (YYYY-MM-DD).
`name`	`certifications`	String	Certification name
`issuer`	`certifications`	String	Certification issuer
`primary`	`certifications`	Boolean	Whether certification is primary certification
`affiliations`	`professional`	Object Array	List of affiliations. For non-healthcare professionals, list of professional associations. For Healthcare Professionals, list of admitting hospitals.
`affiliation`	`affiliations`	String	Affiliation name
`primary`	`affiliations`	Boolean	Whether affiliation is primary affiliation. If none of the affiliations are defined as prmary=`true`, then the first affiliation will be defaulted to primary=`true`
`educations`	`professional`	Object Array	List of educational experience
`type`	`educations`	String	Type of edcuation - valid values: `Undergraduate`,`Graduate`,`Medical`,`Law`,`Internship`,`Fellowship`,`Residency`,`AdditionalTraining`,`BachelorOfScience`,`DentalSchool`,`MasterOfArts`,`Masters`,`MastersOfScience`,`NursingSchool`,`PHD`,`ProfessionalEducation`,`PsyD`,`Society`,`Certification`,`Education`,`ProfessionalAffiliations`,`ProfessionalMembership`,`SpecializationsAndProcedures`,`Awards`,`Other`
`institution`	`educations`	String	Name of institution
`graduationYear`	`educations`	String	Graduation year
`degree`	`educations`	String	Graduation Degree
`primary`	`educations`	String	Whether education is the professional's primary/main education
`languages`	`professionals`	String	List of languages
`serviceArea`		Object	Service are details object (for service area businesses).
`places`	`serviceArea`	String Array	Zip Code or City Name, State, Country (if applicable)
`businessType`	`serviceArea`	String	Business type - valid values: `BUSINESS_TYPE_UNSPECIFIED`,`CUSTOMER_AND_BUSINESS_LOCATION`,`CUSTOMER_LOCATION_ONLY`
`categories`		Object Array	List of category objects
`category`	`categories`	Object	Caregory object
`id`	`category`	String	Object id
`label`	`category`	String	Object label
`primary`	`categories`	Boolean	Whether `category` object is the primary object.
`paymentTypes`		String Array	Comma separated list of accepted payment types
`richKnowledge`		Object	Object containing metadata
`titleTag`	`richKnowledge`	String	The HTML element that specifies the title of the web page
`metaDescription`	`richKnowledge`	String	The HTML element that describes the subject of the webpage
`metaKeywords`	`richKnowledge`	String Array	The HTML element that lists keywords related to the webpage
`htmlDescription`	`richKnowledge`	String	HTML enabled business description of the profile
`zipCodesServed`	`richKnowledge`	String Array	The list of zipCodes served by the entity
`areasServed`	`richKnowledge`	String Array	The list of areas served by the entity
`professionalStatement`	`richKnowledge`	String	Brief statement of the professional represented by the entity
`covidMessage`		String	This field allows communication centered around COVID-19. It can be used to communicate cleaning protocols, store capacity, security measures, mask requirements, and other measures. The field is limited to 200 characters and must only be used to provide messages related to COVID-19.
`createdDate`		String	Profile's created date - Datetime ISO 8601
`updatedDate`		String	Profile's updated date - Datetime ISO 8601
`distance`		Number (Double)	Shows the distance of the Location from the provided Latitude and Longitude or Postal Code
`slug`		String	Url slug

Response Schema

{\n    \"id\": \"string\",\n    \"internalID\": \"string\",\n    \"optedOut\": \"boolean\",\n    \"linkedProfileID\": \"string\",\n    \"tenantID\": \"string\",\n    \"internalName\": \"string\",\n    \"externalName\": \"string\",\n    \"industryID\": \"string\",\n    \"parentID\": \"string\",\n    \"customVariables\": [\n        {\n            \"name\": \"string\",\n            \"value\": \"string\"\n        }\n    ],\n    \"customFilters\": [\n        {\n            \"name\": \"string\",\n            \"value\": \"string\"\n        }\n    ],\n    \"locationType\": \"string\",\n    \"groupCode\": \"string\",\n    \"state\": \"string\",\n    \"utm\": \"boolean\",\n    \"description\": \"string\",\n    \"tags\": [\n        \"string\",\n    ],\n    \"paymentTypes\": [\n        \"string\"\n    ],\n    \"covidMessage\": \"string\",\n    \"medias\": [\n        {\n            \"url\": \"string\",\n            \"title\": \"string\",\n            \"mediaType\": \"string\",\n            \"primary\": \"boolean\"\n        }\n    ],\n    \"attributes\": [\n        {\n            \"attributeId\": \"string\",\n            \"boolValue\": \"boolean\"\n        },\n        {\n            \"attributeId\": \"string\",\n            \"values\": [\n                {\n                    \"id\": \"string\",\n                    \"boolValue\": \"boolean\"\n                },\n            ]\n        }\n    ],\n    \"owners\": [\n        {\n            \"name\": \"string\",\n            \"role\": \"string\",\n            \"pendingInvitation\": \"boolean\"\n        }\n    ]\n    \"socialMedias\": [\n        {\n            \"url\": \"string\",\n            \"socialMediaType\": \"string\"\n        },\n    ],\n    \"shortDescription\": \"string\",\n    \"medical\": {\n        \"npi\": \"string\",\n        \"stateLicenseNumber\": \"string\",\n        \"insurancesAccepted\": [\n            {\n                \"id\": \"string\",\n                \"label\": \"string\"\n            },\n        ],\n        \"acceptingNewPatients\": \"boolean\",\n        \"employerAffiliation\": \"string\",\n        \"specialties\": [\n            {\n                \"specialty\": \"string\",\n                \"primary\": \"boolean\"\n            }\n        ],\n        \"webMdCampaignId\": \"string\",\n        \"insuranceNetworks\": [\n            {\n                \"insuranceNetwork\": {\n                    \"id\": \"string\",\n                    \"label\": \"string\"\n                }\n            },\n        ]\n    },\n    \"categories\": [\n        {\n            \"category\": {\n                \"id\": \"string\",\n                \"label\": \"string\"\n            },\n            \"primary\": \"boolean\"\n        }\n    ],\n    \"places\": [\n        {\n            \"placeID\": \"string\",\n            \"officeName\": \"string\",\n            \"address\": {\n                \"streetAddress2\": \"string\",\n                \"locality\": \"string\",\n                \"region\": \"string\",\n                \"postalCode\": \"string\",\n                \"country\": \"string\",\n                \"latitude\": \"string\",\n                \"longitude\": \"string\",\n                \"streetAddress1\": \"string\"\n            },\n            \"businessHours\": [\n                {\n                    \"timePeriods\": [\n                        {\n                            \"openDay\": \"string\",\n                            \"openTime\": \"string\",\n                            \"closeDay\": \"string\",\n                            \"closeTime\": \"string\",\n                            \"open24Hours\": \"boolean\",\n                            \"closed\": \"boolean\"\n                        },\n                    ],\n                    \"name\": \"string\",\n                    \"primary\": \"boolean\",\n                    \"specialHours\": [\n                        {\n                            \"openTime\": \"string\",\n                            \"closeTime\": \"string\",\n                            \"open24Hours\": \"boolean\",\n                            \"closed\": \"boolean\",\n                            \"startDate\": \"string\"\n                        },\n                    ],\n                    \"businessHourType\": \"string\"\n                }\n            ],\n            \"phones\": [\n                {\n                    \"number\": \"string\",\n                    \"extension\": \"string\",\n                    \"primary\": \"boolean\",\n                    \"country\": \"string\",\n                    \"phoneType\": \"string\"\n                }\n            ],\n            \"websites\": [\n                {\n                    \"url\": \"string\",\n                    \"primary\": \"boolean\",\n                    \"websiteType\": \"string\"\n                }\n            ],\n            \"emails\": [\n                {\n                    \"email\": \"string\",\n                    \"primary\": \"boolean\"\n                },\n            ],\n            \"primary\": \"boolean\",\n            \"officeStatus\": {\n                \"officeState\": \"string\",\n                \"operationalDate\": \"string\"\n            },\n            \"originalAddress\": {\n                \"streetAddress2\": \"string\",\n                \"locality\": \"string\",\n                \"region\": \"string\",\n                \"postalCode\": \"string\",\n                \"country\": \"string\",\n                \"latitude\": \"string\",\n                \"longitude\": \"string\",\n                \"streetAddress1\": \"string\"\n            },\n            \"linkedLuid\": \"integer\",\n            \"relatedLocations\": [\n                {\n                    \"type\": \"integer\",\n                    \"placeId\": \"string\"\n                }\n            ]\n        }\n    ],\n    \"professional\": {\n        \"title\": \"string\",\n        \"appellation\": \"string\",\n        \"degrees\": [\n            {\n                \"degree\": \"string\",\n                \"primary\": \"boolean\"\n            }\n        ]\n        \"firstName\": \"string\"\n        \"lastName\": \"string\",\n        \"middleName\": \"string\",\n        \"gender\": \"string\",\n        \"birthday\": \"string\",\n        \"biography\": \"string\",\n        \"certifications\": [\n            {\n                \"number\": \"string\",\n                \"country\": \"string\",\n                \"endDate\": \"string\",\n                \"name\": \"string\",\n                \"issuer\": \"string\",\n                \"primary\": \"boolean\"\n            }\n        ],\n        \"affiliations\": [\n            {\n                \"affiliation\": \"string\",\n                \"primary\": \"boolean\"\n            }\n        ],\n        \"educations\": [\n            {\n                \"type\": \"string\",\n                \"institution\": \"string\",\n                \"graduationYear\": \"string\",\n                \"degree\": \"string\",\n                \"primary\": \"boolean\"\n            }\n        ],\n        \"languages\": [\n            \"string\",\n        ],\n    },\n    \"serviceArea\": {\n        \"places\": [\"string\"],\n        \"businessType\": \"string\"\n    },\n    \"richKnowledge\": {\n        \"titleTag\": \"string\",\n        \"metaDescription\": \"string\",\n        \"metaKeywords\": [\"string\"],\n        \"htmlDescription\": \"string\",\n        \"zipCodesServed\": [\"string\"],\n        \"areasServed\": [\"string\"],\n        \"professionalStatement\": \"string\"\n    }\n    \"type\": \"string\",\n    \"primaryProfile\": \"boolean\",\n    \"profileDefinition\": \"string\",\n    \"createdDate\": \"string\",\n    \"updatedDate\": \"string\",\n    \"distance\": \"Double\",\n    \"slug\": \"string\"\n}\n\n

\n","urlObject":{"path":["locations",":locationID","opt-in"],"host":["{{baseUrl}}"],"query":[{"disabled":true,"description":{"content":"

A comma-separated list of source IDs to specify which sources to opt-in to. If omitted, all eligible sources are opted in.

\n","type":"text/plain"},"key":"sourceIDs","value":""}],"variable":[{"description":{"content":"

(Required) The unique identifier for the profile.

\n","type":"text/plain"},"type":"any","value":"","key":"locationID"}]}},"response":[{"id":"c70c4374-52d2-4ffb-aaf7-bd6105ce3738","name":"Success","originalRequest":{"method":"PUT","header":[{"key":"x-api-key","value":"Your API key"}],"url":{"raw":"https://api.reputation.com/v3/locations/:locationID/opt-in?sourceIDs=FACEBOOK","protocol":"https","host":["api","reputation","com"],"path":["v3","locations",":locationID","opt-in"],"query":[{"key":"sourceIDs","value":"FACEBOOK"}],"variable":[{"key":"locationID","value":"SA"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"1703"},{"key":"etag","value":"W/\"6a7-Lkve0iQDlml4K3kRMsFLyPcjNY4\""},{"key":"date","value":"Wed, 04 Oct 2023 00:20:54 GMT"},{"key":"x-envoy-upstream-service-time","value":"124"},{"key":"server","value":"istio-envoy"},{"key":"Via","value":"1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"SA\",\n \"internalID\": \"737476\",\n \"optedOut\": false,\n \"internalName\": \"Simple Art\",\n \"industryID\": \"automotive-dealer\",\n \"parentID\": null,\n \"customVariables\": [\n {\n \"name\": \"test-inventory\",\n \"value\": \"www.apple.com\"\n },\n {\n \"name\": \"CAMPAIGN_ENROLLMENT_AND_SCHEDULE_PREFERENCE\",\n \"value\": \"MANUAL\"\n }\n ],\n \"customFilters\": [\n {\n \"name\": \"Brand\",\n \"value\": \"Gallery\"\n }\n ],\n \"state\": \"Active\",\n \"externalName\": \"Simple Art\",\n \"description\": \"Simple Art Page Descripton\",\n \"shortDescription\": \"Simple Art Page\",\n \"categories\": [\n {\n \"category\": {\n \"id\": \"TENANT_1990:OPEN_HEART_SURGERY\",\n \"label\": \"Open Heart Surgery\"\n },\n \"primary\": true\n }\n ],\n \"places\": [\n {\n \"officeName\": \"Simple Art\",\n \"address\": {\n \"streetAddress2\": null,\n \"locality\": \"Redwood City\",\n \"region\": \"CA\",\n \"postalCode\": \"94063\",\n \"country\": \"US\",\n \"latitude\": \"37.48805\",\n \"longitude\": \"-122.22439\",\n \"streetAddress1\": \"1001 Marshall St\"\n },\n \"businessHours\": null,\n \"phones\": [\n {\n \"number\": \"(408) 900-9080\",\n \"primary\": true,\n \"country\": \"US\",\n \"phoneType\": \"Local\"\n },\n {\n \"number\": \"(408) 990-9090\",\n \"primary\": false,\n \"country\": \"US\",\n \"phoneType\": \"Mobile\"\n }\n ],\n \"websites\": [\n {\n \"url\": \"http://www.yahoo.com\",\n \"primary\": true,\n \"websiteType\": \"Homepage\"\n }\n ],\n \"emails\": [\n {\n \"email\": \"repdef40+1990@gmail.com\",\n \"primary\": true\n }\n ],\n \"primary\": true,\n \"officeStatus\": {\n \"officeState\": \"Opening_Soon\",\n \"operationalDate\": \"2021-05-01\"\n },\n \"originalAddress\": {\n \"streetAddress2\": null,\n \"locality\": \"Redwood City\",\n \"region\": \"CA\",\n \"postalCode\": \"94063\",\n \"country\": \"US\",\n \"latitude\": \"37.48805\",\n \"longitude\": \"-122.22439\",\n \"streetAddress1\": \"1001 Marshall St\"\n },\n \"linkedLuid\": null,\n \"relatedLocations\": null\n }\n ],\n \"type\": \"RoofTop\",\n \"locationType\": null,\n \"groupCode\": null,\n \"primaryProfile\": true,\n \"profileDefinition\": \"RoofTop\",\n \"createdDate\": \"2018-03-14T05:08:53\",\n \"updatedDate\": \"2023-10-03T17:20:54\",\n \"distance\": null,\n \"slug\": \"simple-art-simple-art-redwood-city-ca\"\n}"}],"_postman_id":"385b2b69-d70f-4cb1-9d8b-c27212d059f1"},{"name":"Add Page","id":"1c14d39a-0f0b-47bc-a8f7-645dca46b09c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"x-api-key","value":""}],"body":{"mode":"raw","raw":"{\n \"source\": \"string\",\n \"url\": \"string\",\n \"pageID\": \"string\"\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/locations/:locationID/addPage","description":"

Use this endpoint to associate a new external page (such as a social media profile or a source page) with a specific location profile in the Reputation platform. It's important to ensure that the provided URL and page ID are unclaimed.

For assistance in determining available source URLs, you can utilize the Autofind Results feature in the platform to identify potential matches for your location.

Sample

JavaScript XHR Request

var xhr = new XMLHttpRequest();\nxhr.open(\"POST\", \"https://api.reputation.com/v3/locations/101/addPage\", true);\nxhr.setRequestHeader(\"x-api-key\", \"Your API key\");\nxhr.setRequestHeader(\"Content-Type\", \"application/json\");\nxhr.onreadystatechange = function () {\n  if (xhr.readyState == 4) {\n    console.log(xhr.responseText);\n  }\n};\nvar data = JSON.stringify({\n  \"source\": \"YAHOO_LOCAL\",\n  \"url\": \"https://local.yahoo.com/info-16208499\",\n  \"pageID\": \"16208499\"\n});\nxhr.send(data);\n\n

Parameters

\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

Parameter	Type	Description
`source`(Required)	String	The platform or origin from where the page originates (e.g., `FACEBOOK`, `YELLOW_PAGES`, etc.)
`url` (Required)	String	The complete web address (URL) where the page can be accessed - ex. `https://local.yahoo.com/info-16208499`
`pageID` (Required)	String	A unique identifier for the page assigned by the platform or source hosting the page - ex. `16208499`

","urlObject":{"path":["locations",":locationID","addPage"],"host":["{{baseUrl}}"],"query":[],"variable":[{"description":{"content":"

(Required) The unique identifier for the profile to which the page is to be added.

\n","type":"text/plain"},"type":"any","value":"","key":"locationID"}]}},"response":[{"id":"3dae9ac8-d830-45d1-b41d-ab5256ff3d30","name":"Success","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"Your API key"}],"body":{"mode":"raw","raw":"{\n \"source\": \"YAHOO_LOCAL\",\n \"url\": \"https://local.yahoo.com/info-16208499\",\n \"pageID\": \"16208499\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.reputation.com/v3/locations/:locationID/addPage","protocol":"https","host":["api","reputation","com"],"path":["v3","locations",":locationID","addPage"],"variable":[{"key":"locationID","value":"101","description":"(Required) Location id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"109"},{"key":"etag","value":"W/\"6d-9DFEJuqT8MddR+/XYQAeFEC69LE\""},{"key":"date","value":"Wed, 04 Oct 2023 03:12:12 GMT"},{"key":"x-envoy-upstream-service-time","value":"218"},{"key":"server","value":"istio-envoy"},{"key":"Via","value":"1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"locationID\": \"101\",\n \"source\": \"YAHOO_LOCAL\",\n \"url\": \"https://local.yahoo.com/info-16208499\",\n \"pageID\": \"16208499\"\n}"}],"_postman_id":"1c14d39a-0f0b-47bc-a8f7-645dca46b09c"},{"name":"Get Attribute Definitions","id":"d888f2f7-4521-47ba-846d-301ecf9a5260","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"x-api-key","value":""}],"url":"{{baseUrl}}/location-attribute-definitions?categoryIds=","description":"

An array of category IDs for which the attribute definitions are fetched. The provided IDs help in narrowing down the list of attribute definitions specific to the given profile categories.

Sample

JavaScript XHR Request

var xhr = new XMLHttpRequest();\nxhr.open('GET', 'https://api.reputation.com/v3/location-attribute-definitions?categoryIds=RESTAURANTS_,ARTS_&_ENTERTAINMENT_ARTIST', true);\nxhr.setRequestHeader('x-api-key', 'Your API Key');\nxhr.onreadystatechange = function() {\n    if (xhr.readyState == 4 && xhr.status == 200) {\n        var response = JSON.parse(xhr.responseText);\n        console.log(response);\n    }\n};\nxhr.send();\n\n

Response Parameters

\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

Parameter	Data Type	Description
`id`	String	A unique identifier representing a specific attribute within the system. For example, the ID `has_order_and_pay_ahead` signifies an attribute related to the ability of a location to accept orders and payments ahead of time.
`sourceID`	String	The identifier for the external source platform or system from which the attribute originates or is relevant. It indicates where this particular attribute is primarily used or where it's fetched from -ex. `GOOGLE_PLACES`
`name`	String	A human-readable name or label for the attribute, which offers a brief description or representation of what the attribute stands for or indicates - ex. `Pay ahead`
`type`	String	Specifies the datatype or nature of the attribute's value. This helps in understanding how the attribute's value should be interpreted or used -ex. `BOOL`indicates that the attribute's value is boolean

Response Schema

{\n    \"id\": \"string\",\n    \"sourceID\": \"string\",\n    \"name\": \"string\",\n    \"type\": \"string\"\n}\n\n\n

\n","urlObject":{"path":["location-attribute-definitions"],"host":["{{baseUrl}}"],"query":[{"description":{"content":"

(Required) An array of comma seperated category IDs for which the attribute definitions are to be fetched. The provided IDs help in narrowing down the list of attribute definitions specific to the given location categories.

\n","type":"text/plain"},"key":"categoryIds","value":""}],"variable":[]}},"response":[{"id":"c351b2b0-6dc1-46d8-aff2-3ff46855990f","name":"Success","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"Your API Key"}],"url":{"raw":"https://api.reputation.com/v3/location-attribute-definitions?categoryIds=RESTAURANTS_,ARTS_%26_ENTERTAINMENT_ARTIST","protocol":"https","host":["api","reputation","com"],"path":["v3","location-attribute-definitions"],"query":[{"key":"categoryIds","value":"RESTAURANTS_,ARTS_&_ENTERTAINMENT_ARTIST"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"18564"},{"key":"etag","value":"W/\"4884-rVfP0BMAhAdkSn7EUSb2n7TBOrs\""},{"key":"date","value":"Wed, 04 Oct 2023 03:55:16 GMT"},{"key":"x-envoy-upstream-service-time","value":"2918"},{"key":"server","value":"istio-envoy"},{"key":"Via","value":"1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": \"has_order_and_pay_ahead\",\n \"sourceID\": \"GOOGLE_PLACES\",\n \"name\": \"Pay ahead\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"crossbusiness-breakfastoption-freebreakfast\",\n \"sourceID\": \"APPLE\",\n \"name\": \"Free Breakfast\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"crossbusiness-safety_features-sanitationstation\",\n \"sourceID\": \"APPLE\",\n \"name\": \"Sanitation Station\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"crossbusiness-parking-streetparking\",\n \"sourceID\": \"APPLE\",\n \"name\": \"Street Parking\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"crossbusiness-services-curbside_pickup\",\n \"sourceID\": \"APPLE\",\n \"name\": \"Curbside Pickup\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"crossbusiness-transportation-shuttle\",\n \"sourceID\": \"APPLE\",\n \"name\": \"Shuttle\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"has_no_contact_delivery\",\n \"sourceID\": \"GOOGLE_PLACES\",\n \"name\": \"No-contact delivery\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"crossbusiness-family_kids-kidsamenities\",\n \"sourceID\": \"APPLE\",\n \"name\": \"Kids Amenities\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"has_covid_19_testing_patient_restrictions\",\n \"sourceID\": \"GOOGLE_PLACES\",\n \"name\": \"Tests limited to certain patients\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"crossbusiness-barservice-beer_wine\",\n \"sourceID\": \"APPLE\",\n \"name\": \"Beer Wine\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"crossbusiness-pets-serviceanimals\",\n \"sourceID\": \"APPLE\",\n \"name\": \"Service Animals\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"crossbusiness-transportation-free_airportshuttle\",\n \"sourceID\": \"APPLE\",\n \"name\": \"Free Airport Shuttle\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"crossbusiness-spoken_languages-spanish\",\n \"sourceID\": \"APPLE\",\n \"name\": \"Spanish\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"crossbusiness-accessibility_features-digital_accessibility\",\n \"sourceID\": \"APPLE\",\n \"name\": \"Digital Accessibility\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"welcomes_children\",\n \"sourceID\": \"GOOGLE_PLACES\",\n \"name\": \"Good for kids\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"welcomes_lgbtq\",\n \"sourceID\": \"GOOGLE_PLACES\",\n \"name\": \"LGBTQ+ friendly\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"has_drive_through_covid_19_testing\",\n \"sourceID\": \"GOOGLE_PLACES\",\n \"name\": \"Drive-through\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"serves_halal_food\",\n \"sourceID\": \"GOOGLE_PLACES\",\n \"name\": \"Halal food\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"crossbusiness-payments-cash\",\n \"sourceID\": \"APPLE\",\n \"name\": \"Cash\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"crossbusiness-reservations-accepts_reservations\",\n \"sourceID\": \"APPLE\",\n \"name\": \"Accepts Reservations\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"crossbusiness-parking-valetparking\",\n \"sourceID\": \"APPLE\",\n \"name\": \"Valet Parking\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"serves_dinner\",\n \"sourceID\": \"GOOGLE_PLACES\",\n \"name\": \"Dinner\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"crossbusiness-ev_chargingstations-tesla_supercharger\",\n \"sourceID\": \"APPLE\",\n \"name\": \"Tesla Supercharger\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"suitable_for_watching_sports\",\n \"sourceID\": \"GOOGLE_PLACES\",\n \"name\": \"Sports\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"crossbusiness-goodfor-couples\",\n \"sourceID\": \"APPLE\",\n \"name\": \"Couples\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"crossbusiness-ambiance-traditional\",\n \"sourceID\": \"APPLE\",\n \"name\": \"Traditional\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"is_owned_by_veterans\",\n \"sourceID\": \"GOOGLE_PLACES\",\n \"name\": \"Identifies as veteran-owned\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"has_hearing_loop\",\n \"sourceID\": \"GOOGLE_PLACES\",\n \"name\": \"Assistive hearing loop\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"has_high_chairs\",\n \"sourceID\": \"GOOGLE_PLACES\",\n \"name\": \"High chairs\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"crossbusiness-barservice-fullbar\",\n \"sourceID\": \"APPLE\",\n \"name\": \"Full Bar\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"serves_beer\",\n \"sourceID\": \"GOOGLE_PLACES\",\n \"name\": \"Beer\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"crossbusiness-ambiance-romantic\",\n \"sourceID\": \"APPLE\",\n \"name\": \"Romantic\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"crossbusiness-techfeatures-airconditioning\",\n \"sourceID\": \"APPLE\",\n \"name\": \"Air Conditioning\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"crossbusiness-family_kids-game_gamingroom\",\n \"sourceID\": \"APPLE\",\n \"name\": \"Game Gaming Room\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"has_braille_menu\",\n \"sourceID\": \"GOOGLE_PLACES\",\n \"name\": \"Braille menu\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"crossbusiness-goodfor-groups\",\n \"sourceID\": \"APPLE\",\n \"name\": \"Groups\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"has_counter_service\",\n \"sourceID\": \"GOOGLE_PLACES\",\n \"name\": \"Counter service\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"crossbusiness-ambiance-casual\",\n \"sourceID\": \"APPLE\",\n \"name\": \"Casual\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"crossbusiness-age_restrictions-over_21\",\n \"sourceID\": \"APPLE\",\n \"name\": \"Over 21\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"crossbusiness-ambiance-trendy\",\n \"sourceID\": \"APPLE\",\n \"name\": \"Trendy\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"crossbusiness-specialhours-open_24h\",\n \"sourceID\": \"APPLE\",\n \"name\": \"Open 24h\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"has_takeout\",\n \"sourceID\": \"GOOGLE_PLACES\",\n \"name\": \"Takeout\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"has_wheelchair_accessible_parking\",\n \"sourceID\": \"GOOGLE_PLACES\",\n \"name\": \"Wheelchair accessible parking lot\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"serves_wine\",\n \"sourceID\": \"GOOGLE_PLACES\",\n \"name\": \"Wine\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"serves_happy_hour_food\",\n \"sourceID\": \"GOOGLE_PLACES\",\n \"name\": \"Happy hour food\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"crossbusiness-techfeatures-internet\",\n \"sourceID\": \"APPLE\",\n \"name\": \"Internet\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"crossbusiness-ambiance-upscale\",\n \"sourceID\": \"APPLE\",\n \"name\": \"Upscale\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"crossbusiness-parking-free_selfpark\",\n \"sourceID\": \"APPLE\",\n \"name\": \"Free Self Park\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"requires_temperature_check_customers\",\n \"sourceID\": \"GOOGLE_PLACES\",\n \"name\": \"Temperature check required\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"requires_reservations\",\n \"sourceID\": \"GOOGLE_PLACES\",\n \"name\": \"Reservations required\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"crossbusiness-specialhours-senior_hours\",\n \"sourceID\": \"APPLE\",\n \"name\": \"Senior Hours\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"crossbusiness-reservations-walk_ins\",\n \"sourceID\": \"APPLE\",\n \"name\": \"Walk Ins\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"crossbusiness-parking-bike_parking\",\n \"sourceID\": \"APPLE\",\n \"name\": \"Bike Parking\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"serves_late_night_food\",\n \"sourceID\": \"GOOGLE_PLACES\",\n \"name\": \"Late-night food\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"has_restroom\",\n \"sourceID\": \"GOOGLE_PLACES\",\n \"name\": \"Restroom\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"crossbusiness-age_restrictions-adults_only\",\n \"sourceID\": \"APPLE\",\n \"name\": \"Adults Only\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"crossbusiness-attire-bizcasual\",\n \"sourceID\": \"APPLE\",\n \"name\": \"Bizcasual\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"crossbusiness-payments-applepay\",\n \"sourceID\": \"APPLE\",\n \"name\": \"Apple Pay\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"crossbusiness-age_restrictions-all_ages\",\n \"sourceID\": \"APPLE\",\n \"name\": \"All Ages\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"crossbusiness-restrooms-family_restroom\",\n \"sourceID\": \"APPLE\",\n \"name\": \"Family Restroom\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"crossbusiness-services-dropoff\",\n \"sourceID\": \"APPLE\",\n \"name\": \"Drop Off\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"has_wheelchair_accessible_entrance\",\n \"sourceID\": \"GOOGLE_PLACES\",\n \"name\": \"Wheelchair accessible entrance\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"crossbusiness-ev_chargingstations-dc_fast_chargers\",\n \"sourceID\": \"APPLE\",\n \"name\": \"Dc Fast Chargers\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"has_drive_through\",\n \"sourceID\": \"GOOGLE_PLACES\",\n \"name\": \"Drive-through\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"has_restroom_unisex\",\n \"sourceID\": \"GOOGLE_PLACES\",\n \"name\": \"Gender-neutral restroom\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"has_childrens_menu\",\n \"sourceID\": \"GOOGLE_PLACES\",\n \"name\": \"Kids' menu\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"crossbusiness-parking-accessibleparking\",\n \"sourceID\": \"APPLE\",\n \"name\": \"Accessible Parking\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"serves_organic\",\n \"sourceID\": \"GOOGLE_PLACES\",\n \"name\": \"Organic dishes\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"welcomes_families\",\n \"sourceID\": \"GOOGLE_PLACES\",\n \"name\": \"Family-friendly\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"wi_fi\",\n \"sourceID\": \"GOOGLE_PLACES\",\n \"name\": \"Wi-Fi\",\n \"values\": [\n {\n \"id\": \"free_wi_fi\",\n \"label\": \"Free\"\n },\n {\n \"id\": \"paid_wi_fi\",\n \"label\": \"Paid\"\n }\n ],\n \"type\": \"ENUM\"\n },\n {\n \"id\": \"crossbusiness-payments-debitcard\",\n \"sourceID\": \"APPLE\",\n \"name\": \"Debit Card\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"crossbusiness-parking-outdoor_parking\",\n \"sourceID\": \"APPLE\",\n \"name\": \"Outdoor Parking\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"serves_coffee\",\n \"sourceID\": \"GOOGLE_PLACES\",\n \"name\": \"Coffee\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"crossbusiness-pets-petamenities\",\n \"sourceID\": \"APPLE\",\n \"name\": \"Pet Amenities\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"crossbusiness-pets-pets_welcome\",\n \"sourceID\": \"APPLE\",\n \"name\": \"Pets Welcome\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"serves_lunch\",\n \"sourceID\": \"GOOGLE_PLACES\",\n \"name\": \"Lunch\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"has_catering\",\n \"sourceID\": \"GOOGLE_PLACES\",\n \"name\": \"Catering\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"requires_masks_staff\",\n \"sourceID\": \"GOOGLE_PLACES\",\n \"name\": \"Staff wear masks\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"serves_breakfast\",\n \"sourceID\": \"GOOGLE_PLACES\",\n \"name\": \"Breakfast\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"crossbusiness-services-drive_through\",\n \"sourceID\": \"APPLE\",\n \"name\": \"Drive Through\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"crossbusiness-smoking-smoking_areas\",\n \"sourceID\": \"APPLE\",\n \"name\": \"Smoking Areas\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"crossbusiness-spoken_languages-english\",\n \"sourceID\": \"APPLE\",\n \"name\": \"English\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"crossbusiness-attire-elegant\",\n \"sourceID\": \"APPLE\",\n \"name\": \"Elegant\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"has_fireplace\",\n \"sourceID\": \"GOOGLE_PLACES\",\n \"name\": \"Fireplace\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"is_owned_by_asian\",\n \"sourceID\": \"GOOGLE_PLACES\",\n \"name\": \"Identifies as Asian-owned\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"is_sanitizing_between_customers\",\n \"sourceID\": \"GOOGLE_PLACES\",\n \"name\": \"Staff required to disinfect surfaces between visits\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"serves_cocktails\",\n \"sourceID\": \"GOOGLE_PLACES\",\n \"name\": \"Cocktails\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"crossbusiness-attire-casual_attire\",\n \"sourceID\": \"APPLE\",\n \"name\": \"Casual Attire\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"crossbusiness-safety_features-free_masks\",\n \"sourceID\": \"APPLE\",\n \"name\": \"Free Masks\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"crossbusiness-specialhours-drivethrough_open_24h\",\n \"sourceID\": \"APPLE\",\n \"name\": \"Drive Through Open 24h\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"pay_debit_card\",\n \"sourceID\": \"GOOGLE_PLACES\",\n \"name\": \"Debit cards\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"crossbusiness-breakfastoption-englishbreakfast\",\n \"sourceID\": \"APPLE\",\n \"name\": \"English Breakfast\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"crossbusiness-barservice-happyhour\",\n \"sourceID\": \"APPLE\",\n \"name\": \"Happy Hour\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"is_transgender_safespace\",\n \"sourceID\": \"GOOGLE_PLACES\",\n \"name\": \"Transgender safespace\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"local_specialty\",\n \"sourceID\": \"GOOGLE_PLACES\",\n \"name\": \"Serves local specialty\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"has_seating\",\n \"sourceID\": \"GOOGLE_PLACES\",\n \"name\": \"Seating\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"serves_vegetarian\",\n \"sourceID\": \"GOOGLE_PLACES\",\n \"name\": \"Vegetarian options\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"crossbusiness-restrooms-female_restroom\",\n \"sourceID\": \"APPLE\",\n \"name\": \"Female Restroom\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"crossbusiness-barservice-bar_lounge\",\n \"sourceID\": \"APPLE\",\n \"name\": \"Bar Lounge\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"serves_dessert\",\n \"sourceID\": \"GOOGLE_PLACES\",\n \"name\": \"Dessert\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"serves_brunch\",\n \"sourceID\": \"GOOGLE_PLACES\",\n \"name\": \"Brunch\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"offers_fifa_world_cup_broadcast\",\n \"sourceID\": \"GOOGLE_PLACES\",\n \"name\": \"Showing the World Cup\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"crossbusiness-breakfastoption-continentalbreakfast\",\n \"sourceID\": \"APPLE\",\n \"name\": \"Continental Breakfast\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"accepts_reservations\",\n \"sourceID\": \"GOOGLE_PLACES\",\n \"name\": \"Accepts reservations\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"crossbusiness-family_kids-kids_playarea\",\n \"sourceID\": \"APPLE\",\n \"name\": \"Kids Play Area\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"crossbusiness-goodfor-families\",\n \"sourceID\": \"APPLE\",\n \"name\": \"Families\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"crossbusiness-goodfor-singles\",\n \"sourceID\": \"APPLE\",\n \"name\": \"Singles\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"crossbusiness-specialhours-holiday_hours\",\n \"sourceID\": \"APPLE\",\n \"name\": \"Holiday Hours\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"crossbusiness-parking-parking_garage\",\n \"sourceID\": \"APPLE\",\n \"name\": \"Parking Garage\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"has_private_dining_room\",\n \"sourceID\": \"GOOGLE_PLACES\",\n \"name\": \"Private dining room\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"serves_alcohol\",\n \"sourceID\": \"GOOGLE_PLACES\",\n \"name\": \"Alcohol\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"crossbusiness-pets-petsfree\",\n \"sourceID\": \"APPLE\",\n \"name\": \"Pets Free\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"crossbusiness-reservations-reservations_only\",\n \"sourceID\": \"APPLE\",\n \"name\": \"Reservations Only\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"serves_liquor\",\n \"sourceID\": \"GOOGLE_PLACES\",\n \"name\": \"Hard liquor\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"crossbusiness-payments-creditcard\",\n \"sourceID\": \"APPLE\",\n \"name\": \"Credit Card\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"is_appointment_required_covid_19_testing\",\n \"sourceID\": \"GOOGLE_PLACES\",\n \"name\": \"Appointment required for Covid Test\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"has_live_music\",\n \"sourceID\": \"GOOGLE_PLACES\",\n \"name\": \"Live music\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"serves_happy_hour_drinks\",\n \"sourceID\": \"GOOGLE_PLACES\",\n \"name\": \"Happy hour drinks\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"crossbusiness-transportation-elevator\",\n \"sourceID\": \"APPLE\",\n \"name\": \"Elevator\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"crossbusiness-safety_features-sanitized_rooms\",\n \"sourceID\": \"APPLE\",\n \"name\": \"Sanitized Rooms\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"has_changing_tables\",\n \"sourceID\": \"GOOGLE_PLACES\",\n \"name\": \"Has changing table(s)\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"has_wheelchair_accessible_restroom\",\n \"sourceID\": \"GOOGLE_PLACES\",\n \"name\": \"Wheelchair accessible restroom\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"has_salad_bar\",\n \"sourceID\": \"GOOGLE_PLACES\",\n \"name\": \"Salad bar\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"pay_mobile_nfc\",\n \"sourceID\": \"GOOGLE_PLACES\",\n \"name\": \"NFC mobile payments\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"crossbusiness-age_restrictions-over_16\",\n \"sourceID\": \"APPLE\",\n \"name\": \"Over 16\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"pay_check\",\n \"sourceID\": \"GOOGLE_PLACES\",\n \"name\": \"Checks\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"crossbusiness-techfeatures-wifi\",\n \"sourceID\": \"APPLE\",\n \"name\": \"Wifi\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"crossbusiness-bizmodels-nonprofit\",\n \"sourceID\": \"APPLE\",\n \"name\": \"Non Profit\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"crossbusiness-pets-petsitting_service\",\n \"sourceID\": \"APPLE\",\n \"name\": \"Pet Sitting Service\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"crossbusiness-restrooms-gender_neutral_restroom\",\n \"sourceID\": \"APPLE\",\n \"name\": \"Gender Neutral Restroom\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"allows_dogs_inside\",\n \"sourceID\": \"GOOGLE_PLACES\",\n \"name\": \"Dogs allowed inside\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"crossbusiness-safety_features-free_sanitizers\",\n \"sourceID\": \"APPLE\",\n \"name\": \"Free Sanitizers\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"allows_dogs_outside\",\n \"sourceID\": \"GOOGLE_PLACES\",\n \"name\": \"Dogs allowed outside\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"has_seating_outdoors\",\n \"sourceID\": \"GOOGLE_PLACES\",\n \"name\": \"Outdoor seating\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"is_covid_19_bool_1\",\n \"sourceID\": \"GOOGLE_PLACES\",\n \"name\": \"COVID-19 testing center\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"crossbusiness-pets-dogpark_nearby\",\n \"sourceID\": \"APPLE\",\n \"name\": \"Dog Park Nearby\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"crossbusiness-attire-formal\",\n \"sourceID\": \"APPLE\",\n \"name\": \"Formal\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"has_curbside_pickup\",\n \"sourceID\": \"GOOGLE_PLACES\",\n \"name\": \"Curbside pickup\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"is_owned_by_lgbtq\",\n \"sourceID\": \"GOOGLE_PLACES\",\n \"name\": \"Identifies as LGBTQ+ owned\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"crossbusiness-breakfastoption-fullbreakfast\",\n \"sourceID\": \"APPLE\",\n \"name\": \"Full Breakfast\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"has_wheelchair_accessible_elevator\",\n \"sourceID\": \"GOOGLE_PLACES\",\n \"name\": \"Wheelchair accessible elevator\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"is_prescription_required_covid_19_testing\",\n \"sourceID\": \"GOOGLE_PLACES\",\n \"name\": \"Referral required\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"crossbusiness-ev_chargingstations-e_bike_chargers\",\n \"sourceID\": \"APPLE\",\n \"name\": \"E Bike Chargers\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"crossbusiness-services-self_checkout\",\n \"sourceID\": \"APPLE\",\n \"name\": \"Self Checkout\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"crossbusiness-family_kids-childcare\",\n \"sourceID\": \"APPLE\",\n \"name\": \"Childcare\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"is_owned_by_women\",\n \"sourceID\": \"GOOGLE_PLACES\",\n \"name\": \"Identifies as women-owned\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"has_seating_rooftop\",\n \"sourceID\": \"GOOGLE_PLACES\",\n \"name\": \"Rooftop seating\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"crossbusiness-parking-motorcycle_parking\",\n \"sourceID\": \"APPLE\",\n \"name\": \"Motorcycle Parking\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"crossbusiness-services-delivery\",\n \"sourceID\": \"APPLE\",\n \"name\": \"Delivery\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"is_owned_by_latinx\",\n \"sourceID\": \"GOOGLE_PLACES\",\n \"name\": \"Identifies as Latino-owned\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"serves_small_plates\",\n \"sourceID\": \"GOOGLE_PLACES\",\n \"name\": \"Small plates\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"crossbusiness-accessibility_features-wheelchair_accessible\",\n \"sourceID\": \"APPLE\",\n \"name\": \"Wheelchair Accessible\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"requires_masks_customers\",\n \"sourceID\": \"GOOGLE_PLACES\",\n \"name\": \"Mask required\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"crossbusiness-restrooms-male_restroom\",\n \"sourceID\": \"APPLE\",\n \"name\": \"Male Restroom\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"crossbusiness-smoking-smoking_free\",\n \"sourceID\": \"APPLE\",\n \"name\": \"Smoking Free\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"crossbusiness-bizmodels-co_op\",\n \"sourceID\": \"APPLE\",\n \"name\": \"Co Op\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"crossbusiness-transportation-car_rental_desk\",\n \"sourceID\": \"APPLE\",\n \"name\": \"Car Rental Desk\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"crossbusiness-parking-rec_vehicleparking\",\n \"sourceID\": \"APPLE\",\n \"name\": \"Rec Vehicle Parking\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"pay_credit_card_types_accepted\",\n \"sourceID\": \"GOOGLE_PLACES\",\n \"name\": \"Credit cards\",\n \"values\": [\n {\n \"id\": \"american_express\",\n \"label\": \"American Express\"\n },\n {\n \"id\": \"china_union_pay\",\n \"label\": \"China Union Pay\"\n },\n {\n \"id\": \"diners_club\",\n \"label\": \"Diners Club\"\n },\n {\n \"id\": \"discover\",\n \"label\": \"Discover\"\n },\n {\n \"id\": \"jcb\",\n \"label\": \"JCB\"\n },\n {\n \"id\": \"mastercard\",\n \"label\": \"MasterCard\"\n },\n {\n \"id\": \"visa\",\n \"label\": \"VISA\"\n }\n ],\n \"type\": \"ENUM\"\n },\n {\n \"id\": \"crossbusiness-nightlife-latenightmeals\",\n \"sourceID\": \"APPLE\",\n \"name\": \"Late Night Meals\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"crossbusiness-pets-petfee\",\n \"sourceID\": \"APPLE\",\n \"name\": \"Pet Fee\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"has_all_you_can_eat_always\",\n \"sourceID\": \"GOOGLE_PLACES\",\n \"name\": \"All you can eat\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"requires_temperature_check_staff\",\n \"sourceID\": \"GOOGLE_PLACES\",\n \"name\": \"Staff get temperature checks\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"crossbusiness-restrooms-accessible_restroom\",\n \"sourceID\": \"APPLE\",\n \"name\": \"Accessible Restroom\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"requires_cash_only\",\n \"sourceID\": \"GOOGLE_PLACES\",\n \"name\": \"Cash-only\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"crossbusiness-payments-contactless_pay\",\n \"sourceID\": \"APPLE\",\n \"name\": \"Contactless Pay\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"pay_credit_card\",\n \"sourceID\": \"GOOGLE_PLACES\",\n \"name\": \"Credit cards\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"crossbusiness-payments-membercard\",\n \"sourceID\": \"APPLE\",\n \"name\": \"Member Card\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"crossbusiness-family_kids-kidsclub\",\n \"sourceID\": \"APPLE\",\n \"name\": \"Kids Club\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"crossbusiness-smoking-smoking_allowed\",\n \"sourceID\": \"APPLE\",\n \"name\": \"Smoking Allowed\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"has_delivery\",\n \"sourceID\": \"GOOGLE_PLACES\",\n \"name\": \"Delivery\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"crossbusiness-services-instore_pickup\",\n \"sourceID\": \"APPLE\",\n \"name\": \"In Store Pickup\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"serves_dine_in\",\n \"sourceID\": \"GOOGLE_PLACES\",\n \"name\": \"Dine-in\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"crossbusiness-reservations-appointments_only\",\n \"sourceID\": \"APPLE\",\n \"name\": \"Appointments Only\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"serves_comfort_food\",\n \"sourceID\": \"GOOGLE_PLACES\",\n \"name\": \"Comfort food\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"has_wheelchair_accessible_seating\",\n \"sourceID\": \"GOOGLE_PLACES\",\n \"name\": \"Wheelchair accessible seating\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"is_black_owned\",\n \"sourceID\": \"GOOGLE_PLACES\",\n \"name\": \"Identifies as Black-owned\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"crossbusiness-accessibility_features-accessible_elevator\",\n \"sourceID\": \"APPLE\",\n \"name\": \"Accessible Elevator\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"welcomes_dogs\",\n \"sourceID\": \"GOOGLE_PLACES\",\n \"name\": \"Dogs allowed\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"serves_vegan\",\n \"sourceID\": \"GOOGLE_PLACES\",\n \"name\": \"Vegan options\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"has_bar_onsite\",\n \"sourceID\": \"GOOGLE_PLACES\",\n \"name\": \"Bar onsite\",\n \"type\": \"BOOL\"\n },\n {\n \"id\": \"crossbusiness-transportation-ev_charging_onsite\",\n \"sourceID\": \"APPLE\",\n \"name\": \"Ev Charging Onsite\",\n \"type\": \"BOOL\"\n }\n]"}],"_postman_id":"d888f2f7-4521-47ba-846d-301ecf9a5260"},{"name":"Get Duplicate Locations","id":"430cd4e2-1fed-4d30-bda2-577328d36524","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"x-api-key","value":""}],"url":"{{baseUrl}}/locations-duplicate","description":"

Retrieves location profiles from the Reputation platform that are identified as potential duplicates based on specific criteria. By using this endpoint, you can identify and manage locations that may have been inadvertently entered multiple times or those that appear similar across different sources.

Sample

JavaScript XHR Request

var xhr = new XMLHttpRequest();\nxhr.open(\"GET\", \"https://api.reputation.com/v3/locations-duplicate\", true);\nxhr.setRequestHeader(\"x-api-key\", \"Your API key\");\nxhr.onreadystatechange = function() {\n  // If the request completed successfully, handle the response\n  if (xhr.readyState == 4 && xhr.status == 200) {\n    var response = JSON.parse(xhr.responseText);\n    console.log(response);\n  }\n};\nxhr.send();\n\n

Response Parameters

Parameter	Parent	Data Type	Description
locationID		String	Unique identifier for the location. Example: \"346345\"
sourceID		String	Identifier for the source platform. Example: \"GOOGLE_PLACES\"
duplicateLocationID		String	Unique identifier for the potential duplicate. Example: \"1A02abc3rep\"
businessName	location	String	Name of the business. Example: \"Johns Plumbing Company\"
streetAddress	address	String	Main address line. Example: \"123 Main Blvd\"
streetAddress2	address	String (nullable)	Secondary address line (if available). Example: null
streetNumber	address	String (nullable)	Street number for the address. Example: null
locality	address	String	City or locality. Example: \"Redwood City\"
region	address	String	State or region. Example: \"CA\"
postalCode	address	String	Postal or ZIP code. Example: \"94063\"
country	address	String	Country code. Example: \"US\"
latitude	address	Number	Latitude coordinates. Example: 0
longitude	address	Number	Longitude coordinates. Example: 0
timezone	address	String (nullable)	Timezone for the location. Example: null
phone	location	String (nullable)	Phone number of the business. Example: null
category	location	String	Business category. Example: \"General\"
websiteUrl	location	String (nullable)	Website URL of the business. Example: null
url		String	URL link to the location on the source platform. Example: \"https://maps.google.com/maps\"
status		String	Status of the duplicate detection. Example: \"Potential\"
createdDate		String	Date and time of creation in ISO 8601 format. Example: \"2019-09-20T15:06:25\"
lastUpdated		String	Last updated date and time in ISO 8601 format. Example: \"2019-10-25T14:08:55\"

Response Schema

{\n  \"locationID\": \"string\",\n  \"sourceID\": \"string\",\n  \"duplicateLocationID\": \"string\",\n  \"location\": {\n    \"businessName\": \"string\",\n    \"address\": {\n      \"streetAddress\": \"string\",\n      \"streetAddress2\": \"string\",\n      \"streetNumber\": \"string\",\n      \"locality\": \"string\",\n      \"region\": \"string\",\n      \"postalCode\": \"string\",\n      \"country\": \"string\",\n      \"latitude\": \"Number\",\n      \"longitude\": \"Number\",\n      \"timezone\": \"string\"\n    },\n    \"phone\": \"string\",\n    \"category\": \"string\",\n    \"websiteUrl\": \"string\"\n  },\n  \"url\": \"string\",\n  \"status\": \"string\",\n  \"createdDate\": \"string\",\n  \"lastUpdated\": \"string\"\n}\n\n\n

\n","urlObject":{"path":["locations-duplicate"],"host":["{{baseUrl}}"],"query":[{"disabled":true,"description":{"content":"

A list of location profile identifiers, separated by commas. When provided, the endpoint will filter and return only those profiles that match the given IDs.

Example: \"123,456,789\" will return information related to locations with IDs 123, 456, and 789.

\n","type":"text/plain"},"key":"locationIDs","value":""},{"disabled":true,"description":{"content":"

A list of source identifiers, separated by commas. This parameter allows users to narrow down the results to locations that are associated with specific external sources.

Example: Filtering by \"GOOGLE_PLACES,YELP\" will return duplicate locations specific to Google Places and Yelp.

\n","type":"text/plain"},"key":"sourceIDs","value":""},{"disabled":true,"description":{"content":"

A list of statuses, separated by commas, to filter the results by specific duplicate identification statuses. It provides insight into the stage or category of duplication for each location. By default, if no status is provided, the endpoint will return locations with the \"Potential\" status.

Valid Values: \"Potential\", \"Confirmed\", \"ConfirmedNonDuplicate\", \"Processing\", \"Unknown\", \"Suppressed\"

\n","type":"text/plain"},"key":"status","value":""}],"variable":[]}},"response":[{"id":"047b0a9a-2850-44a4-8a2e-9819037f8372","name":"Success","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"Your API key"}],"url":{"raw":"https://api.reputation.com/v3/locations-duplicate","protocol":"https","host":["api","reputation","com"],"path":["v3","locations-duplicate"],"query":[{"key":"locationIDs","value":"dolor ut","disabled":true},{"key":"sourceIDs","value":"dolor ut","disabled":true},{"key":"status","value":"Potential","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"locationID\": \"346345\",\n \"sourceID\": \"GOOGLE_PLACES\",\n \"duplicateLocationID\": \"1A02abc3rep\",\n \"location\": {\n \"businessName\": \"Johns Plumbing Company\",\n \"address\": {\n \"streetAddress\": \"123 Main Blvd\",\n \"streetAddress2\": null,\n \"streetNumber\": null,\n \"locality\": \"Redwood City\",\n \"region\": \"CA\",\n \"postalCode\": \"94063\",\n \"country\": \"US\",\n \"latitude\": 0,\n \"longitude\": 0,\n \"timezone\": null\n },\n \"phone\": null,\n \"category\": \"General\",\n \"websiteUrl\": null\n },\n \"url\": \"https://maps.google.com/maps\",\n \"status\": \"Potential\",\n \"createdDate\": \"2019-09-20T15:06:25\",\n \"lastUpdated\": \"2019-10-25T14:08:55\"\n}"}],"_postman_id":"430cd4e2-1fed-4d30-bda2-577328d36524"}],"id":"bd746cb3-97d6-4667-a4de-808614798793","description":"

The Locations collection of endpoints offers tools to interact with profiles, encompassing extensive details beyond basic location attributes. These endpoints allow users to fetch, add, or delete the detailed profiles present in the Business Listing Solution.

\n","_postman_id":"bd746cb3-97d6-4667-a4de-808614798793"},{"name":"/Metrics","item":[{"name":"Get Metrics (Deprecated)","id":"977376ce-a793-4b8e-a0cf-bccb0fc9b7f6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"x-api-key","value":""}],"url":"{{baseUrl}}/metrics","description":"

Retrieve a variety of metrics based on specific criteria. These metrics can provide insights into trends, user behavior, and more, over different time intervals and for different sources or locations.

Note: This endpoint is now deprecated and might be removed in future versions. Ensure you check for alternative endpoints or methods to fetch the required data.

Sample

JavaScript XHR Request

var xhr = new XMLHttpRequest();\nxhr.open('GET', 'https://api.reputation.com/v3/metrics', true);\nxhr.setRequestHeader('x-api-key', 'Your API key');\nxhr.onreadystatechange = function() {\n    if (xhr.readyState == 4 && xhr.status == 200) {\n        var response = JSON.parse(xhr.responseText);\n        console.log(response);\n    }\n};\nxhr.send();\n\n

Response Parameters

Parameter	Parent	Data Type	Description
id	metrics	string	Unique identifier (e.g., \"737495_FACEBOOK_page:insights_Day_2023-10-03\")
locationID	metrics	string	Location identifier (e.g., \"DW\")
sourceID	metrics	string	Source of the metric (e.g., \"FACEBOOK\")
date	metrics	string	Date of the metric (e.g., \"2023-10-03T00:00:00\")
type	metrics	string	Type of metric (e.g., \"page:insights\")
interval	metrics	string	Interval/frequency (e.g., \"Day\")
page_views_logged_in_total	metrics	integer	Total logged-in page views
page_video_views_unique	metrics	integer	Unique video page views
page_posts_impressions_paid_unique	metrics	integer	Unique paid post impressions
page_likes_lifetime	metrics	integer	Lifetime page likes
page_actions_post_reactions_like_total	metrics	integer	Total like reactions on posts
page_posts_impressions_unique	metrics	integer	Unique post impressions
page_engaged_users	metrics	integer	Engaged users count
page_fan_adds_unique	metrics	integer	Unique fan additions
page_total_actions	metrics	integer	Total page actions
page_impressions_organic	metrics	integer	Organic page impressions
page_website_clicks_logged_in_count	metrics	integer	Count of website clicks by logged-in users
page_impressions_viral	metrics	integer	Viral page impressions
page_consumptions	metrics	integer	Page consumptions count
page_actions_post_reactions_wow_total	metrics	integer	Total \"wow\" reactions on posts
page_content_activity	metrics	integer	Page content activity count
page_posts_impressions_paid	metrics	integer	Paid post impressions
page_video_views_organic	metrics	integer	Organic video views
page_impressions_paid	metrics	integer	Paid page impressions
page_impressions_viral_unique	metrics	integer	Unique viral page impressions
page_views_logged_in_unique	metrics	integer	Unique logged-in page views
page_post_engagements	metrics	integer	Post engagements count
page_get_directions_clicks_logged_in_count	metrics	integer	Count of direction clicks by logged-in users
page_impressions_unique	metrics	integer	Unique page impressions
page_actions_post_reactions_anger_total	metrics	integer	Total \"anger\" reactions on posts
page_video_views_paid	metrics	integer	Paid video views
page_call_phone_clicks_logged_in_count	metrics	integer	Count of phone call clicks by logged-in users
page:unfollow:count	metrics	integer	Count of page unfollows
page_posts_impressions_viral	metrics	integer	Viral post impressions
page_posts_impressions	metrics	integer	Total post impressions
page_actions_post_reactions_sorry_total	metrics	integer	Total \"sorry\" reactions on posts
page:directions:click	metrics	integer	Count of direction clicks
page_impressions_paid_unique	metrics	integer	Unique paid page impressions
page_actions_post_reactions_love_total	metrics	integer	Total \"love\" reactions on posts
page:views	metrics	integer	Count of page views
page_impressions	metrics	integer	Total page impressions
page_video_views	metrics	integer	Total video views
page_posts_impressions_organic	metrics	integer	Organic post impressions
page_impressions_organic_unique	metrics	integer	Unique organic page impressions
page:phone:click	metrics	integer	Count of phone click actions
page_posts_impressions_organic_unique	metrics	integer	Unique organic post impressions
page_actions_post_reactions_haha_total	metrics	integer	Total \"haha\" reactions on posts
page:website:click	metrics	integer	Count of website click actions
page_negative_feedback	metrics	integer	Count of negative feedback actions
page_places_checkin_total	metrics	integer	Total places check-ins
offset	paging	integer	Pagination offset (e.g., 0)
limit	paging	integer	Determines the number of items returned in the current response. This is distinct from rate limiting and refers to the size of the data set returned, which is controlled by the value you specify. The default limit is 20 metric objects, with a maximum possible limit of 2,000.
next	paging	string	Next page URL (e.g., \"https://api.reputation.com/v3/metrics?offset=20&limit=20\")
range	dateRange	string	Date range type (e.g., \"LifeToDate\")
from	dateRange	string	Start date of the range (e.g., \"-\")
to	dateRange	string	End date of the range (e.g., \"2023-10-04T23:59:59\")

","urlObject":{"path":["metrics"],"host":["{{baseUrl}}"],"query":[{"disabled":true,"description":{"content":"

Offsets the start of each page by the number specified. Max offset is 10k. For instance, offset=50 would start from the 51st record.

\n","type":"text/plain"},"key":"offset","value":""},{"disabled":true,"description":{"content":"

Determines the number of items returned in the current response. This is distinct from rate limiting and refers to the size of the data set returned, which is controlled by the value you specify. The default limit is 20 metric objects, with a maximum possible limit of 2,000.

\n","type":"text/plain"},"key":"limit","value":""},{"disabled":true,"description":{"content":"

The start date for the metric retrieval in ISO Date format, e.g., \"2023-09-21\".

\n","type":"text/plain"},"key":"from","value":""},{"disabled":true,"description":{"content":"

The end date for the metric retrieval in ISO Date format, e.g., \"2023-09-28\".

\n","type":"text/plain"},"key":"to","value":""},{"disabled":true,"description":{"content":"

Specifies a predefined date range. Valid values: \"Today\"\"Yesterday\"\"ThisWeek\"\"PreviousWeek\"\"ThisMonth\"\"PreviousMonth\"\"ThisQuarter\"\"PreviousQuarter\"\"ThisYear\"\"PreviousYear\"\"YearToDate\"\"LifeToDate\"\"Last7Days\"\"Last30Days\"\"Last60Days\"\"Last90Days\"\"Last6Months\"\"Last1Year\"\"Last2Years\"\"Last3Years\"

\n","type":"text/plain"},"key":"range","value":""},{"disabled":true,"description":{"content":"

Comma-separated list of source ids to filter by, e.g., \"SOURCE1,SOURCE2\".

\n","type":"text/plain"},"key":"sourceIDs","value":""},{"disabled":true,"description":{"content":"

Comma-separated list of location ids to filter by, e.g., \"LOC1,LOC2\".

\n","type":"text/plain"},"key":"locationIDs","value":""},{"disabled":true,"description":{"content":"

Specifies the metric types to retrieve. Can specify multiple, comma-separated values. Default value is all.

Valid values: \"page:insights\"\"page:insights:age\"\"page:insights:driving\"\"page:insights:gender\"\"page:insights:phone\"

\n","type":"text/plain"},"key":"type","value":""},{"disabled":true,"description":{"content":"

Specifies the intervals for metric retrieval. Valid values: \"Day\", \"Hour\", \"Week\", \"Lifetime\"

\n","type":"text/plain"},"key":"interval","value":""}],"variable":[]}},"response":[{"id":"683b3bd9-0f21-475b-8f29-4fa8ce999924","name":"Success","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"Your API key"}],"url":{"raw":"https://api.reputation.com/v3/metrics","protocol":"https","host":["api","reputation","com"],"path":["v3","metrics"],"query":[{"key":"offset","value":"45530734","disabled":true},{"key":"limit","value":"45530734","disabled":true},{"key":"from","value":"2001-06-17T15:40:12.790Z","disabled":true},{"key":"to","value":"2001-06-17T15:40:12.790Z","disabled":true},{"key":"range","value":"PreviousWeek","disabled":true},{"key":"sourceIDs","value":"dolor ut","disabled":true},{"key":"locationIDs","value":"dolor ut","disabled":true},{"key":"type","value":"page:insights:age","disabled":true},{"key":"interval","value":"Hour","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"31297"},{"key":"etag","value":"W/\"7a41-c0XYKgOyL1akFvJ9k0kex6Do/yc\""},{"key":"date","value":"Wed, 04 Oct 2023 07:12:24 GMT"},{"key":"x-envoy-upstream-service-time","value":"247"},{"key":"server","value":"istio-envoy"},{"key":"Via","value":"1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"metrics\": [\n {\n \"id\": \"737495_FACEBOOK_page:insights_Day_2023-10-03\",\n \"locationID\": \"DW\",\n \"sourceID\": \"FACEBOOK\",\n \"date\": \"2023-10-03T00:00:00\",\n \"type\": \"page:insights\",\n \"interval\": \"Day\",\n \"metrics\": {\n \"page_views_logged_in_total\": 0,\n \"page_video_views_unique\": 0,\n \"page_posts_impressions_paid_unique\": 0,\n \"page_likes_lifetime\": 0,\n \"page_actions_post_reactions_like_total\": 0,\n \"page_posts_impressions_unique\": 0,\n \"page_engaged_users\": 0,\n \"page_fan_adds_unique\": 0,\n \"page_total_actions\": 0,\n \"page_impressions_organic\": 0,\n \"page_website_clicks_logged_in_count\": 0,\n \"page_impressions_viral\": 0,\n \"page_consumptions\": 0,\n \"page_actions_post_reactions_wow_total\": 0,\n \"page_content_activity\": 0,\n \"page_posts_impressions_paid\": 0,\n \"page_video_views_organic\": 0,\n \"page_impressions_paid\": 0,\n \"page_impressions_viral_unique\": 0,\n \"page_views_logged_in_unique\": 0,\n \"page_post_engagements\": 0,\n \"page_get_directions_clicks_logged_in_count\": 0,\n \"page_impressions_unique\": 0,\n \"page_actions_post_reactions_anger_total\": 0,\n \"page_video_views_paid\": 0,\n \"page_call_phone_clicks_logged_in_count\": 0,\n \"page:unfollow:count\": 0,\n \"page_posts_impressions_viral\": 0,\n \"page_posts_impressions\": 0,\n \"page_actions_post_reactions_sorry_total\": 0,\n \"page:directions:click\": 0,\n \"page_impressions_paid_unique\": 0,\n \"page_actions_post_reactions_love_total\": 0,\n \"page:views\": 0,\n \"page_impressions\": 0,\n \"page_video_views\": 0,\n \"page_posts_impressions_organic\": 0,\n \"page_impressions_organic_unique\": 0,\n \"page:phone:click\": 0,\n \"page_posts_impressions_organic_unique\": 0,\n \"page_actions_post_reactions_haha_total\": 0,\n \"page:website:click\": 0,\n \"page_negative_feedback\": 0,\n \"page_places_checkin_total\": 0\n }\n },\n {\n \"id\": \"737489_FACEBOOK_page:insights_Day_2023-10-03\",\n \"locationID\": \"AAA Waterbury\",\n \"sourceID\": \"FACEBOOK\",\n \"date\": \"2023-10-03T00:00:00\",\n \"type\": \"page:insights\",\n \"interval\": \"Day\",\n \"metrics\": {\n \"page_views_logged_in_total\": 0,\n \"page_video_views_unique\": 0,\n \"page_posts_impressions_paid_unique\": 0,\n \"page_likes_lifetime\": 1,\n \"page_actions_post_reactions_like_total\": 0,\n \"page_posts_impressions_unique\": 0,\n \"page_engaged_users\": 0,\n \"page_fan_adds_unique\": 0,\n \"page_total_actions\": 0,\n \"page_impressions_organic\": 0,\n \"page_website_clicks_logged_in_count\": 0,\n \"page_impressions_viral\": 0,\n \"page_consumptions\": 0,\n \"page_actions_post_reactions_wow_total\": 0,\n \"page_content_activity\": 0,\n \"page_posts_impressions_paid\": 0,\n \"page_video_views_organic\": 0,\n \"page_impressions_paid\": 0,\n \"page_impressions_viral_unique\": 0,\n \"page_views_logged_in_unique\": 0,\n \"page_post_engagements\": 0,\n \"page_get_directions_clicks_logged_in_count\": 0,\n \"page_impressions_unique\": 0,\n \"page_actions_post_reactions_anger_total\": 0,\n \"page_video_views_paid\": 0,\n \"page_call_phone_clicks_logged_in_count\": 0,\n \"page:unfollow:count\": 0,\n \"page_posts_impressions_viral\": 0,\n \"page_posts_impressions\": 0,\n \"page_actions_post_reactions_sorry_total\": 0,\n \"page:directions:click\": 0,\n \"page_impressions_paid_unique\": 0,\n \"page_actions_post_reactions_love_total\": 0,\n \"page:views\": 0,\n \"page_impressions\": 0,\n \"page_video_views\": 0,\n \"page_posts_impressions_organic\": 0,\n \"page_impressions_organic_unique\": 0,\n \"page:phone:click\": 0,\n \"page_posts_impressions_organic_unique\": 0,\n \"page_actions_post_reactions_haha_total\": 0,\n \"page:website:click\": 0,\n \"page_negative_feedback\": 0,\n \"page_places_checkin_total\": 0\n }\n },\n {\n \"id\": \"737476_FACEBOOK_page:insights_Day_2023-10-03\",\n \"locationID\": \"SA\",\n \"sourceID\": \"FACEBOOK\",\n \"date\": \"2023-10-03T00:00:00\",\n \"type\": \"page:insights\",\n \"interval\": \"Day\",\n \"metrics\": {\n \"page_views_logged_in_total\": 0,\n \"page_video_views_unique\": 0,\n \"page_posts_impressions_paid_unique\": 0,\n \"page_likes_lifetime\": 0,\n \"page_actions_post_reactions_like_total\": 0,\n \"page_posts_impressions_unique\": 0,\n \"page_engaged_users\": 0,\n \"page_fan_adds_unique\": 0,\n \"page_total_actions\": 0,\n \"page_impressions_organic\": 0,\n \"page_website_clicks_logged_in_count\": 0,\n \"page_impressions_viral\": 0,\n \"page_consumptions\": 0,\n \"page_actions_post_reactions_wow_total\": 0,\n \"page_content_activity\": 0,\n \"page_posts_impressions_paid\": 0,\n \"page_video_views_organic\": 0,\n \"page_impressions_paid\": 0,\n \"page_impressions_viral_unique\": 0,\n \"page_views_logged_in_unique\": 0,\n \"page_post_engagements\": 0,\n \"page_get_directions_clicks_logged_in_count\": 0,\n \"page_impressions_unique\": 0,\n \"page_actions_post_reactions_anger_total\": 0,\n \"page_video_views_paid\": 0,\n \"page_call_phone_clicks_logged_in_count\": 0,\n \"page:unfollow:count\": 0,\n \"page_posts_impressions_viral\": 0,\n \"page_posts_impressions\": 0,\n \"page_actions_post_reactions_sorry_total\": 0,\n \"page:directions:click\": 0,\n \"page_impressions_paid_unique\": 0,\n \"page_actions_post_reactions_love_total\": 0,\n \"page:views\": 0,\n \"page_impressions\": 0,\n \"page_video_views\": 0,\n \"page_posts_impressions_organic\": 0,\n \"page_impressions_organic_unique\": 0,\n \"page:phone:click\": 0,\n \"page_posts_impressions_organic_unique\": 0,\n \"page_actions_post_reactions_haha_total\": 0,\n \"page:website:click\": 0,\n \"page_negative_feedback\": 0,\n \"page_places_checkin_total\": 0\n }\n },\n {\n \"id\": \"737473_FACEBOOK_page:insights_Day_2023-10-03\",\n \"locationID\": \"CH\",\n \"sourceID\": \"FACEBOOK\",\n \"date\": \"2023-10-03T00:00:00\",\n \"type\": \"page:insights\",\n \"interval\": \"Day\",\n \"metrics\": {\n \"page_views_logged_in_total\": 0,\n \"page_video_views_unique\": 0,\n \"page_posts_impressions_paid_unique\": 0,\n \"page_likes_lifetime\": 34,\n \"page_actions_post_reactions_like_total\": 0,\n \"page_posts_impressions_unique\": 0,\n \"page_engaged_users\": 0,\n \"page_fan_adds_unique\": 0,\n \"page_total_actions\": 0,\n \"page_impressions_organic\": 0,\n \"page_website_clicks_logged_in_count\": 0,\n \"page_impressions_viral\": 0,\n \"page_consumptions\": 0,\n \"page_actions_post_reactions_wow_total\": 0,\n \"page_content_activity\": 0,\n \"page_posts_impressions_paid\": 0,\n \"page_video_views_organic\": 0,\n \"page_impressions_paid\": 0,\n \"page_impressions_viral_unique\": 0,\n \"page_views_logged_in_unique\": 0,\n \"page_post_engagements\": 0,\n \"page_get_directions_clicks_logged_in_count\": 0,\n \"page_impressions_unique\": 0,\n \"page_actions_post_reactions_anger_total\": 0,\n \"page_video_views_paid\": 0,\n \"page_call_phone_clicks_logged_in_count\": 0,\n \"page:unfollow:count\": 0,\n \"page_posts_impressions_viral\": 0,\n \"page_posts_impressions\": 0,\n \"page_actions_post_reactions_sorry_total\": 0,\n \"page:directions:click\": 0,\n \"page_impressions_paid_unique\": 0,\n \"page_actions_post_reactions_love_total\": 0,\n \"page:views\": 0,\n \"page_impressions\": 0,\n \"page_video_views\": 0,\n \"page_posts_impressions_organic\": 0,\n \"page_impressions_organic_unique\": 0,\n \"page:phone:click\": 0,\n \"page_posts_impressions_organic_unique\": 0,\n \"page_actions_post_reactions_haha_total\": 0,\n \"page:website:click\": 0,\n \"page_negative_feedback\": 0,\n \"page_places_checkin_total\": 0\n }\n },\n {\n \"id\": \"737495_FACEBOOK_page:insights_Day_2023-10-02\",\n \"locationID\": \"DW\",\n \"sourceID\": \"FACEBOOK\",\n \"date\": \"2023-10-02T00:00:00\",\n \"type\": \"page:insights\",\n \"interval\": \"Day\",\n \"metrics\": {\n \"page_views_logged_in_total\": 0,\n \"page_video_views_unique\": 0,\n \"page_posts_impressions_paid_unique\": 0,\n \"page_likes_lifetime\": 0,\n \"page_actions_post_reactions_like_total\": 0,\n \"page_posts_impressions_unique\": 0,\n \"page_engaged_users\": 0,\n \"page_fan_adds_unique\": 0,\n \"page_total_actions\": 0,\n \"page_impressions_organic\": 0,\n \"page_website_clicks_logged_in_count\": 0,\n \"page_impressions_viral\": 0,\n \"page_consumptions\": 0,\n \"page_actions_post_reactions_wow_total\": 0,\n \"page_content_activity\": 0,\n \"page_posts_impressions_paid\": 0,\n \"page_video_views_organic\": 0,\n \"page_impressions_paid\": 0,\n \"page_impressions_viral_unique\": 0,\n \"page_views_logged_in_unique\": 0,\n \"page_post_engagements\": 0,\n \"page_get_directions_clicks_logged_in_count\": 0,\n \"page_impressions_unique\": 0,\n \"page_actions_post_reactions_anger_total\": 0,\n \"page_video_views_paid\": 0,\n \"page_call_phone_clicks_logged_in_count\": 0,\n \"page:unfollow:count\": 0,\n \"page_posts_impressions_viral\": 0,\n \"page_posts_impressions\": 0,\n \"page_actions_post_reactions_sorry_total\": 0,\n \"page:directions:click\": 0,\n \"page_impressions_paid_unique\": 0,\n \"page_actions_post_reactions_love_total\": 0,\n \"page:views\": 0,\n \"page_impressions\": 0,\n \"page_video_views\": 0,\n \"page_posts_impressions_organic\": 0,\n \"page_impressions_organic_unique\": 0,\n \"page:phone:click\": 0,\n \"page_posts_impressions_organic_unique\": 0,\n \"page_actions_post_reactions_haha_total\": 0,\n \"page:website:click\": 0,\n \"page_negative_feedback\": 0,\n \"page_places_checkin_total\": 0\n }\n },\n {\n \"id\": \"737489_FACEBOOK_page:insights_Day_2023-10-02\",\n \"locationID\": \"AAA Waterbury\",\n \"sourceID\": \"FACEBOOK\",\n \"date\": \"2023-10-02T00:00:00\",\n \"type\": \"page:insights\",\n \"interval\": \"Day\",\n \"metrics\": {\n \"page_views_logged_in_total\": 0,\n \"page_video_views_unique\": 0,\n \"page_posts_impressions_paid_unique\": 0,\n \"page_likes_lifetime\": 1,\n \"page_actions_post_reactions_like_total\": 0,\n \"page_posts_impressions_unique\": 0,\n \"page_engaged_users\": 0,\n \"page_fan_adds_unique\": 0,\n \"page_total_actions\": 0,\n \"page_impressions_organic\": 0,\n \"page_website_clicks_logged_in_count\": 0,\n \"page_impressions_viral\": 0,\n \"page_consumptions\": 0,\n \"page_actions_post_reactions_wow_total\": 0,\n \"page_content_activity\": 0,\n \"page_posts_impressions_paid\": 0,\n \"page_video_views_organic\": 0,\n \"page_impressions_paid\": 0,\n \"page_impressions_viral_unique\": 0,\n \"page_views_logged_in_unique\": 0,\n \"page_post_engagements\": 0,\n \"page_get_directions_clicks_logged_in_count\": 0,\n \"page_impressions_unique\": 0,\n \"page_actions_post_reactions_anger_total\": 0,\n \"page_video_views_paid\": 0,\n \"page_call_phone_clicks_logged_in_count\": 0,\n \"page:unfollow:count\": 0,\n \"page_follows_lifetime\": 1,\n \"page_posts_impressions_viral\": 0,\n \"page_posts_impressions\": 0,\n \"page_actions_post_reactions_sorry_total\": 0,\n \"page:directions:click\": 0,\n \"page_impressions_paid_unique\": 0,\n \"page_actions_post_reactions_love_total\": 0,\n \"page:views\": 0,\n \"page_impressions\": 0,\n \"page_video_views\": 0,\n \"page_posts_impressions_organic\": 0,\n \"page_impressions_organic_unique\": 0,\n \"page:phone:click\": 0,\n \"page_posts_impressions_organic_unique\": 0,\n \"page_actions_post_reactions_haha_total\": 0,\n \"page:website:click\": 0,\n \"page_negative_feedback\": 0,\n \"page_places_checkin_total\": 0\n }\n },\n {\n \"id\": \"737476_FACEBOOK_page:insights_Day_2023-10-02\",\n \"locationID\": \"SA\",\n \"sourceID\": \"FACEBOOK\",\n \"date\": \"2023-10-02T00:00:00\",\n \"type\": \"page:insights\",\n \"interval\": \"Day\",\n \"metrics\": {\n \"page_views_logged_in_total\": 0,\n \"page_video_views_unique\": 0,\n \"page_posts_impressions_paid_unique\": 0,\n \"page_likes_lifetime\": 0,\n \"page_actions_post_reactions_like_total\": 0,\n \"page_posts_impressions_unique\": 0,\n \"page_engaged_users\": 0,\n \"page_fan_adds_unique\": 0,\n \"page_total_actions\": 0,\n \"page_impressions_organic\": 0,\n \"page_website_clicks_logged_in_count\": 0,\n \"page_impressions_viral\": 0,\n \"page_consumptions\": 0,\n \"page_actions_post_reactions_wow_total\": 0,\n \"page_content_activity\": 0,\n \"page_posts_impressions_paid\": 0,\n \"page_video_views_organic\": 0,\n \"page_impressions_paid\": 0,\n \"page_impressions_viral_unique\": 0,\n \"page_views_logged_in_unique\": 0,\n \"page_post_engagements\": 0,\n \"page_get_directions_clicks_logged_in_count\": 0,\n \"page_impressions_unique\": 0,\n \"page_actions_post_reactions_anger_total\": 0,\n \"page_video_views_paid\": 0,\n \"page_call_phone_clicks_logged_in_count\": 0,\n \"page:unfollow:count\": 0,\n \"page_posts_impressions_viral\": 0,\n \"page_posts_impressions\": 0,\n \"page_actions_post_reactions_sorry_total\": 0,\n \"page:directions:click\": 0,\n \"page_impressions_paid_unique\": 0,\n \"page_actions_post_reactions_love_total\": 0,\n \"page:views\": 0,\n \"page_impressions\": 0,\n \"page_video_views\": 0,\n \"page_posts_impressions_organic\": 0,\n \"page_impressions_organic_unique\": 0,\n \"page:phone:click\": 0,\n \"page_posts_impressions_organic_unique\": 0,\n \"page_actions_post_reactions_haha_total\": 0,\n \"page:website:click\": 0,\n \"page_negative_feedback\": 0,\n \"page_places_checkin_total\": 0\n }\n },\n {\n \"id\": \"737473_FACEBOOK_page:insights_Day_2023-10-02\",\n \"locationID\": \"CH\",\n \"sourceID\": \"FACEBOOK\",\n \"date\": \"2023-10-02T00:00:00\",\n \"type\": \"page:insights\",\n \"interval\": \"Day\",\n \"metrics\": {\n \"page_views_logged_in_total\": 0,\n \"page_video_views_unique\": 0,\n \"page_posts_impressions_paid_unique\": 0,\n \"page_likes_lifetime\": 34,\n \"page_actions_post_reactions_like_total\": 0,\n \"page_posts_impressions_unique\": 2,\n \"page_engaged_users\": 0,\n \"page_fan_adds_unique\": 0,\n \"page_total_actions\": 0,\n \"page_impressions_organic\": 2,\n \"page_website_clicks_logged_in_count\": 0,\n \"page_impressions_viral\": 0,\n \"page_consumptions\": 0,\n \"page_actions_post_reactions_wow_total\": 0,\n \"page_content_activity\": 0,\n \"page_posts_impressions_paid\": 0,\n \"page_video_views_organic\": 0,\n \"page_impressions_paid\": 0,\n \"page_impressions_viral_unique\": 0,\n \"page_views_logged_in_unique\": 0,\n \"page_post_engagements\": 0,\n \"page_get_directions_clicks_logged_in_count\": 0,\n \"page_impressions_unique\": 2,\n \"page_actions_post_reactions_anger_total\": 0,\n \"page_video_views_paid\": 0,\n \"page_call_phone_clicks_logged_in_count\": 0,\n \"page:unfollow:count\": 0,\n \"page_follows_lifetime\": 39,\n \"page_posts_impressions_viral\": 0,\n \"page_posts_impressions\": 2,\n \"page_actions_post_reactions_sorry_total\": 0,\n \"page:directions:click\": 0,\n \"page_impressions_paid_unique\": 0,\n \"page_actions_post_reactions_love_total\": 0,\n \"page:views\": 0,\n \"page_impressions\": 2,\n \"page_video_views\": 0,\n \"page_posts_impressions_organic\": 2,\n \"page_impressions_organic_unique\": 2,\n \"page:phone:click\": 0,\n \"page_posts_impressions_organic_unique\": 2,\n \"page_actions_post_reactions_haha_total\": 0,\n \"page:website:click\": 0,\n \"page_negative_feedback\": 0,\n \"page_places_checkin_total\": 0\n }\n },\n {\n \"id\": \"737495_FACEBOOK_page:insights_Day_2023-10-01\",\n \"locationID\": \"DW\",\n \"sourceID\": \"FACEBOOK\",\n \"date\": \"2023-10-01T00:00:00\",\n \"type\": \"page:insights\",\n \"interval\": \"Day\",\n \"metrics\": {\n \"page_views_logged_in_total\": 0,\n \"page_video_views_unique\": 0,\n \"page_posts_impressions_paid_unique\": 0,\n \"page_likes_lifetime\": 0,\n \"page_actions_post_reactions_like_total\": 0,\n \"page_posts_impressions_unique\": 0,\n \"page_engaged_users\": 0,\n \"page_fan_adds_unique\": 0,\n \"page_total_actions\": 0,\n \"page_impressions_organic\": 0,\n \"page_website_clicks_logged_in_count\": 0,\n \"page_impressions_viral\": 0,\n \"page_consumptions\": 0,\n \"page_actions_post_reactions_wow_total\": 0,\n \"page_content_activity\": 0,\n \"page_posts_impressions_paid\": 0,\n \"page_video_views_organic\": 0,\n \"page_impressions_paid\": 0,\n \"page_impressions_viral_unique\": 0,\n \"page_views_logged_in_unique\": 0,\n \"page_post_engagements\": 0,\n \"page_get_directions_clicks_logged_in_count\": 0,\n \"page_impressions_unique\": 0,\n \"page_actions_post_reactions_anger_total\": 0,\n \"page_video_views_paid\": 0,\n \"page_call_phone_clicks_logged_in_count\": 0,\n \"page:unfollow:count\": 0,\n \"page_posts_impressions_viral\": 0,\n \"page_posts_impressions\": 0,\n \"page_actions_post_reactions_sorry_total\": 0,\n \"page:directions:click\": 0,\n \"page_impressions_paid_unique\": 0,\n \"page_actions_post_reactions_love_total\": 0,\n \"page:views\": 0,\n \"page_impressions\": 0,\n \"page_video_views\": 0,\n \"page_posts_impressions_organic\": 0,\n \"page_impressions_organic_unique\": 0,\n \"page:phone:click\": 0,\n \"page_posts_impressions_organic_unique\": 0,\n \"page_actions_post_reactions_haha_total\": 0,\n \"page:website:click\": 0,\n \"page_negative_feedback\": 0,\n \"page_places_checkin_total\": 0\n }\n },\n {\n \"id\": \"737489_FACEBOOK_page:insights_Day_2023-10-01\",\n \"locationID\": \"AAA Waterbury\",\n \"sourceID\": \"FACEBOOK\",\n \"date\": \"2023-10-01T00:00:00\",\n \"type\": \"page:insights\",\n \"interval\": \"Day\",\n \"metrics\": {\n \"page_views_logged_in_total\": 0,\n \"page_video_views_unique\": 0,\n \"page_posts_impressions_paid_unique\": 0,\n \"page_likes_lifetime\": 1,\n \"page_actions_post_reactions_like_total\": 0,\n \"page_posts_impressions_unique\": 0,\n \"page_engaged_users\": 0,\n \"page_fan_adds_unique\": 0,\n \"page_total_actions\": 0,\n \"page_impressions_organic\": 0,\n \"page_website_clicks_logged_in_count\": 0,\n \"page_impressions_viral\": 0,\n \"page_consumptions\": 0,\n \"page_actions_post_reactions_wow_total\": 0,\n \"page_content_activity\": 0,\n \"page_posts_impressions_paid\": 0,\n \"page_video_views_organic\": 0,\n \"page_impressions_paid\": 0,\n \"page_impressions_viral_unique\": 0,\n \"page_views_logged_in_unique\": 0,\n \"page_post_engagements\": 0,\n \"page_get_directions_clicks_logged_in_count\": 0,\n \"page_impressions_unique\": 0,\n \"page_actions_post_reactions_anger_total\": 0,\n \"page_video_views_paid\": 0,\n \"page_call_phone_clicks_logged_in_count\": 0,\n \"page:unfollow:count\": 0,\n \"page_follows_lifetime\": 1,\n \"page_posts_impressions_viral\": 0,\n \"page_posts_impressions\": 0,\n \"page_actions_post_reactions_sorry_total\": 0,\n \"page:directions:click\": 0,\n \"page_impressions_paid_unique\": 0,\n \"page_actions_post_reactions_love_total\": 0,\n \"page:views\": 0,\n \"page_impressions\": 0,\n \"page_video_views\": 0,\n \"page_posts_impressions_organic\": 0,\n \"page_impressions_organic_unique\": 0,\n \"page:phone:click\": 0,\n \"page_posts_impressions_organic_unique\": 0,\n \"page_actions_post_reactions_haha_total\": 0,\n \"page:website:click\": 0,\n \"page_negative_feedback\": 0,\n \"page_places_checkin_total\": 0\n }\n },\n {\n \"id\": \"737476_FACEBOOK_page:insights_Day_2023-10-01\",\n \"locationID\": \"SA\",\n \"sourceID\": \"FACEBOOK\",\n \"date\": \"2023-10-01T00:00:00\",\n \"type\": \"page:insights\",\n \"interval\": \"Day\",\n \"metrics\": {\n \"page_views_logged_in_total\": 0,\n \"page_video_views_unique\": 0,\n \"page_posts_impressions_paid_unique\": 0,\n \"page_likes_lifetime\": 0,\n \"page_actions_post_reactions_like_total\": 0,\n \"page_posts_impressions_unique\": 0,\n \"page_engaged_users\": 0,\n \"page_fan_adds_unique\": 0,\n \"page_total_actions\": 0,\n \"page_impressions_organic\": 0,\n \"page_website_clicks_logged_in_count\": 0,\n \"page_impressions_viral\": 0,\n \"page_consumptions\": 0,\n \"page_actions_post_reactions_wow_total\": 0,\n \"page_content_activity\": 0,\n \"page_posts_impressions_paid\": 0,\n \"page_video_views_organic\": 0,\n \"page_impressions_paid\": 0,\n \"page_impressions_viral_unique\": 0,\n \"page_views_logged_in_unique\": 0,\n \"page_post_engagements\": 0,\n \"page_get_directions_clicks_logged_in_count\": 0,\n \"page_impressions_unique\": 0,\n \"page_actions_post_reactions_anger_total\": 0,\n \"page_video_views_paid\": 0,\n \"page_call_phone_clicks_logged_in_count\": 0,\n \"page:unfollow:count\": 0,\n \"page_posts_impressions_viral\": 0,\n \"page_posts_impressions\": 0,\n \"page_actions_post_reactions_sorry_total\": 0,\n \"page:directions:click\": 0,\n \"page_impressions_paid_unique\": 0,\n \"page_actions_post_reactions_love_total\": 0,\n \"page:views\": 0,\n \"page_impressions\": 0,\n \"page_video_views\": 0,\n \"page_posts_impressions_organic\": 0,\n \"page_impressions_organic_unique\": 0,\n \"page:phone:click\": 0,\n \"page_posts_impressions_organic_unique\": 0,\n \"page_actions_post_reactions_haha_total\": 0,\n \"page:website:click\": 0,\n \"page_negative_feedback\": 0,\n \"page_places_checkin_total\": 0\n }\n },\n {\n \"id\": \"737473_FACEBOOK_page:insights_Day_2023-10-01\",\n \"locationID\": \"CH\",\n \"sourceID\": \"FACEBOOK\",\n \"date\": \"2023-10-01T00:00:00\",\n \"type\": \"page:insights\",\n \"interval\": \"Day\",\n \"metrics\": {\n \"page_views_logged_in_total\": 0,\n \"page_video_views_unique\": 0,\n \"page_posts_impressions_paid_unique\": 0,\n \"page_likes_lifetime\": 34,\n \"page_actions_post_reactions_like_total\": 0,\n \"page_posts_impressions_unique\": 2,\n \"page_engaged_users\": 0,\n \"page_fan_adds_unique\": 0,\n \"page_total_actions\": 0,\n \"page_impressions_organic\": 2,\n \"page_website_clicks_logged_in_count\": 0,\n \"page_impressions_viral\": 0,\n \"page_consumptions\": 0,\n \"page_actions_post_reactions_wow_total\": 0,\n \"page_content_activity\": 0,\n \"page_posts_impressions_paid\": 0,\n \"page_video_views_organic\": 0,\n \"page_impressions_paid\": 0,\n \"page_impressions_viral_unique\": 0,\n \"page_views_logged_in_unique\": 0,\n \"page_post_engagements\": 0,\n \"page_get_directions_clicks_logged_in_count\": 0,\n \"page_impressions_unique\": 2,\n \"page_actions_post_reactions_anger_total\": 0,\n \"page_video_views_paid\": 0,\n \"page_call_phone_clicks_logged_in_count\": 0,\n \"page:unfollow:count\": 0,\n \"page_follows_lifetime\": 39,\n \"page_posts_impressions_viral\": 0,\n \"page_posts_impressions\": 2,\n \"page_actions_post_reactions_sorry_total\": 0,\n \"page:directions:click\": 0,\n \"page_impressions_paid_unique\": 0,\n \"page_actions_post_reactions_love_total\": 0,\n \"page:views\": 0,\n \"page_impressions\": 2,\n \"page_video_views\": 0,\n \"page_posts_impressions_organic\": 2,\n \"page_impressions_organic_unique\": 2,\n \"page:phone:click\": 0,\n \"page_posts_impressions_organic_unique\": 2,\n \"page_actions_post_reactions_haha_total\": 0,\n \"page:website:click\": 0,\n \"page_negative_feedback\": 0,\n \"page_places_checkin_total\": 0\n }\n },\n {\n \"id\": \"737495_FACEBOOK_page:insights_Day_2023-09-30\",\n \"locationID\": \"DW\",\n \"sourceID\": \"FACEBOOK\",\n \"date\": \"2023-09-30T00:00:00\",\n \"type\": \"page:insights\",\n \"interval\": \"Day\",\n \"metrics\": {\n \"page_views_logged_in_total\": 0,\n \"page_video_views_unique\": 0,\n \"page_posts_impressions_paid_unique\": 0,\n \"page_likes_lifetime\": 0,\n \"page_actions_post_reactions_like_total\": 0,\n \"page_posts_impressions_unique\": 0,\n \"page_engaged_users\": 0,\n \"page_fan_adds_unique\": 0,\n \"page_total_actions\": 0,\n \"page_impressions_organic\": 0,\n \"page_website_clicks_logged_in_count\": 0,\n \"page_impressions_viral\": 0,\n \"page_consumptions\": 0,\n \"page_actions_post_reactions_wow_total\": 0,\n \"page_content_activity\": 0,\n \"page_posts_impressions_paid\": 0,\n \"page_video_views_organic\": 0,\n \"page_impressions_paid\": 0,\n \"page_impressions_viral_unique\": 0,\n \"page_views_logged_in_unique\": 0,\n \"page_post_engagements\": 0,\n \"page_get_directions_clicks_logged_in_count\": 0,\n \"page_impressions_unique\": 0,\n \"page_actions_post_reactions_anger_total\": 0,\n \"page_video_views_paid\": 0,\n \"page_call_phone_clicks_logged_in_count\": 0,\n \"page:unfollow:count\": 0,\n \"page_posts_impressions_viral\": 0,\n \"page_posts_impressions\": 0,\n \"page_actions_post_reactions_sorry_total\": 0,\n \"page:directions:click\": 0,\n \"page_impressions_paid_unique\": 0,\n \"page_actions_post_reactions_love_total\": 0,\n \"page:views\": 0,\n \"page_impressions\": 0,\n \"page_video_views\": 0,\n \"page_posts_impressions_organic\": 0,\n \"page_impressions_organic_unique\": 0,\n \"page:phone:click\": 0,\n \"page_posts_impressions_organic_unique\": 0,\n \"page_actions_post_reactions_haha_total\": 0,\n \"page:website:click\": 0,\n \"page_negative_feedback\": 0,\n \"page_places_checkin_total\": 0\n }\n },\n {\n \"id\": \"737489_FACEBOOK_page:insights_Day_2023-09-30\",\n \"locationID\": \"AAA Waterbury\",\n \"sourceID\": \"FACEBOOK\",\n \"date\": \"2023-09-30T00:00:00\",\n \"type\": \"page:insights\",\n \"interval\": \"Day\",\n \"metrics\": {\n \"page_views_logged_in_total\": 0,\n \"page_video_views_unique\": 0,\n \"page_posts_impressions_paid_unique\": 0,\n \"page_likes_lifetime\": 1,\n \"page_actions_post_reactions_like_total\": 0,\n \"page_posts_impressions_unique\": 0,\n \"page_engaged_users\": 0,\n \"page_fan_adds_unique\": 0,\n \"page_total_actions\": 0,\n \"page_impressions_organic\": 0,\n \"page_website_clicks_logged_in_count\": 0,\n \"page_impressions_viral\": 0,\n \"page_consumptions\": 0,\n \"page_actions_post_reactions_wow_total\": 0,\n \"page_content_activity\": 0,\n \"page_posts_impressions_paid\": 0,\n \"page_video_views_organic\": 0,\n \"page_impressions_paid\": 0,\n \"page_impressions_viral_unique\": 0,\n \"page_views_logged_in_unique\": 0,\n \"page_post_engagements\": 0,\n \"page_get_directions_clicks_logged_in_count\": 0,\n \"page_impressions_unique\": 0,\n \"page_actions_post_reactions_anger_total\": 0,\n \"page_video_views_paid\": 0,\n \"page_call_phone_clicks_logged_in_count\": 0,\n \"page:unfollow:count\": 0,\n \"page_follows_lifetime\": 1,\n \"page_posts_impressions_viral\": 0,\n \"page_posts_impressions\": 0,\n \"page_actions_post_reactions_sorry_total\": 0,\n \"page:directions:click\": 0,\n \"page_impressions_paid_unique\": 0,\n \"page_actions_post_reactions_love_total\": 0,\n \"page:views\": 0,\n \"page_impressions\": 0,\n \"page_video_views\": 0,\n \"page_posts_impressions_organic\": 0,\n \"page_impressions_organic_unique\": 0,\n \"page:phone:click\": 0,\n \"page_posts_impressions_organic_unique\": 0,\n \"page_actions_post_reactions_haha_total\": 0,\n \"page:website:click\": 0,\n \"page_negative_feedback\": 0,\n \"page_places_checkin_total\": 0\n }\n },\n {\n \"id\": \"737476_FACEBOOK_page:insights_Day_2023-09-30\",\n \"locationID\": \"SA\",\n \"sourceID\": \"FACEBOOK\",\n \"date\": \"2023-09-30T00:00:00\",\n \"type\": \"page:insights\",\n \"interval\": \"Day\",\n \"metrics\": {\n \"page_views_logged_in_total\": 0,\n \"page_video_views_unique\": 0,\n \"page_posts_impressions_paid_unique\": 0,\n \"page_likes_lifetime\": 0,\n \"page_actions_post_reactions_like_total\": 0,\n \"page_posts_impressions_unique\": 0,\n \"page_engaged_users\": 0,\n \"page_fan_adds_unique\": 0,\n \"page_total_actions\": 0,\n \"page_impressions_organic\": 0,\n \"page_website_clicks_logged_in_count\": 0,\n \"page_impressions_viral\": 0,\n \"page_consumptions\": 0,\n \"page_actions_post_reactions_wow_total\": 0,\n \"page_content_activity\": 0,\n \"page_posts_impressions_paid\": 0,\n \"page_video_views_organic\": 0,\n \"page_impressions_paid\": 0,\n \"page_impressions_viral_unique\": 0,\n \"page_views_logged_in_unique\": 0,\n \"page_post_engagements\": 0,\n \"page_get_directions_clicks_logged_in_count\": 0,\n \"page_impressions_unique\": 0,\n \"page_actions_post_reactions_anger_total\": 0,\n \"page_video_views_paid\": 0,\n \"page_call_phone_clicks_logged_in_count\": 0,\n \"page:unfollow:count\": 0,\n \"page_posts_impressions_viral\": 0,\n \"page_posts_impressions\": 0,\n \"page_actions_post_reactions_sorry_total\": 0,\n \"page:directions:click\": 0,\n \"page_impressions_paid_unique\": 0,\n \"page_actions_post_reactions_love_total\": 0,\n \"page:views\": 0,\n \"page_impressions\": 0,\n \"page_video_views\": 0,\n \"page_posts_impressions_organic\": 0,\n \"page_impressions_organic_unique\": 0,\n \"page:phone:click\": 0,\n \"page_posts_impressions_organic_unique\": 0,\n \"page_actions_post_reactions_haha_total\": 0,\n \"page:website:click\": 0,\n \"page_negative_feedback\": 0,\n \"page_places_checkin_total\": 0\n }\n },\n {\n \"id\": \"737473_FACEBOOK_page:insights_Day_2023-09-30\",\n \"locationID\": \"CH\",\n \"sourceID\": \"FACEBOOK\",\n \"date\": \"2023-09-30T00:00:00\",\n \"type\": \"page:insights\",\n \"interval\": \"Day\",\n \"metrics\": {\n \"page_views_logged_in_total\": 0,\n \"page_video_views_unique\": 0,\n \"page_posts_impressions_paid_unique\": 0,\n \"page_likes_lifetime\": 34,\n \"page_actions_post_reactions_like_total\": 0,\n \"page_posts_impressions_unique\": 0,\n \"page_engaged_users\": 1,\n \"page_fan_adds_unique\": 0,\n \"page_total_actions\": 0,\n \"page_impressions_organic\": 0,\n \"page_website_clicks_logged_in_count\": 0,\n \"page_impressions_viral\": 0,\n \"page_consumptions\": 0,\n \"page_actions_post_reactions_wow_total\": 0,\n \"page_content_activity\": 1,\n \"page_posts_impressions_paid\": 0,\n \"page_video_views_organic\": 0,\n \"page_impressions_paid\": 0,\n \"page_impressions_viral_unique\": 0,\n \"page_views_logged_in_unique\": 0,\n \"page_post_engagements\": 1,\n \"page_get_directions_clicks_logged_in_count\": 0,\n \"page_impressions_unique\": 0,\n \"page_actions_post_reactions_anger_total\": 0,\n \"page_video_views_paid\": 0,\n \"page_call_phone_clicks_logged_in_count\": 0,\n \"page:unfollow:count\": 0,\n \"page_follows_lifetime\": 39,\n \"page_posts_impressions_viral\": 0,\n \"page_posts_impressions\": 0,\n \"page_actions_post_reactions_sorry_total\": 0,\n \"page:directions:click\": 0,\n \"page_impressions_paid_unique\": 0,\n \"page_actions_post_reactions_love_total\": 0,\n \"page:views\": 0,\n \"page_impressions\": 0,\n \"page_video_views\": 0,\n \"page_posts_impressions_organic\": 0,\n \"page_impressions_organic_unique\": 0,\n \"page:phone:click\": 0,\n \"page_posts_impressions_organic_unique\": 0,\n \"page_actions_post_reactions_haha_total\": 0,\n \"page:website:click\": 0,\n \"page_negative_feedback\": 0,\n \"page_places_checkin_total\": 0\n }\n },\n {\n \"id\": \"737495_FACEBOOK_page:insights_Day_2023-09-29\",\n \"locationID\": \"DW\",\n \"sourceID\": \"FACEBOOK\",\n \"date\": \"2023-09-29T00:00:00\",\n \"type\": \"page:insights\",\n \"interval\": \"Day\",\n \"metrics\": {\n \"page_views_logged_in_total\": 0,\n \"page_video_views_unique\": 0,\n \"page_posts_impressions_paid_unique\": 0,\n \"page_likes_lifetime\": 0,\n \"page_actions_post_reactions_like_total\": 0,\n \"page_posts_impressions_unique\": 0,\n \"page_engaged_users\": 0,\n \"page_fan_adds_unique\": 0,\n \"page_total_actions\": 0,\n \"page_impressions_organic\": 0,\n \"page_website_clicks_logged_in_count\": 0,\n \"page_impressions_viral\": 0,\n \"page_consumptions\": 0,\n \"page_actions_post_reactions_wow_total\": 0,\n \"page_content_activity\": 0,\n \"page_posts_impressions_paid\": 0,\n \"page_video_views_organic\": 0,\n \"page_impressions_paid\": 0,\n \"page_impressions_viral_unique\": 0,\n \"page_views_logged_in_unique\": 0,\n \"page_post_engagements\": 0,\n \"page_get_directions_clicks_logged_in_count\": 0,\n \"page_impressions_unique\": 0,\n \"page_actions_post_reactions_anger_total\": 0,\n \"page_video_views_paid\": 0,\n \"page_call_phone_clicks_logged_in_count\": 0,\n \"page:unfollow:count\": 0,\n \"page_posts_impressions_viral\": 0,\n \"page_posts_impressions\": 0,\n \"page_actions_post_reactions_sorry_total\": 0,\n \"page:directions:click\": 0,\n \"page_impressions_paid_unique\": 0,\n \"page_actions_post_reactions_love_total\": 0,\n \"page:views\": 0,\n \"page_impressions\": 0,\n \"page_video_views\": 0,\n \"page_posts_impressions_organic\": 0,\n \"page_impressions_organic_unique\": 0,\n \"page:phone:click\": 0,\n \"page_posts_impressions_organic_unique\": 0,\n \"page_actions_post_reactions_haha_total\": 0,\n \"page:website:click\": 0,\n \"page_negative_feedback\": 0,\n \"page_places_checkin_total\": 0\n }\n },\n {\n \"id\": \"737489_FACEBOOK_page:insights_Day_2023-09-29\",\n \"locationID\": \"AAA Waterbury\",\n \"sourceID\": \"FACEBOOK\",\n \"date\": \"2023-09-29T00:00:00\",\n \"type\": \"page:insights\",\n \"interval\": \"Day\",\n \"metrics\": {\n \"page_views_logged_in_total\": 0,\n \"page_video_views_unique\": 0,\n \"page_posts_impressions_paid_unique\": 0,\n \"page_likes_lifetime\": 1,\n \"page_actions_post_reactions_like_total\": 0,\n \"page_posts_impressions_unique\": 0,\n \"page_engaged_users\": 0,\n \"page_fan_adds_unique\": 0,\n \"page_total_actions\": 0,\n \"page_impressions_organic\": 0,\n \"page_website_clicks_logged_in_count\": 0,\n \"page_impressions_viral\": 0,\n \"page_consumptions\": 0,\n \"page_actions_post_reactions_wow_total\": 0,\n \"page_content_activity\": 0,\n \"page_posts_impressions_paid\": 0,\n \"page_video_views_organic\": 0,\n \"page_impressions_paid\": 0,\n \"page_impressions_viral_unique\": 0,\n \"page_views_logged_in_unique\": 0,\n \"page_post_engagements\": 0,\n \"page_get_directions_clicks_logged_in_count\": 0,\n \"page_impressions_unique\": 0,\n \"page_actions_post_reactions_anger_total\": 0,\n \"page_video_views_paid\": 0,\n \"page_call_phone_clicks_logged_in_count\": 0,\n \"page:unfollow:count\": 0,\n \"page_follows_lifetime\": 1,\n \"page_posts_impressions_viral\": 0,\n \"page_posts_impressions\": 0,\n \"page_actions_post_reactions_sorry_total\": 0,\n \"page:directions:click\": 0,\n \"page_impressions_paid_unique\": 0,\n \"page_actions_post_reactions_love_total\": 0,\n \"page:views\": 0,\n \"page_impressions\": 0,\n \"page_video_views\": 0,\n \"page_posts_impressions_organic\": 0,\n \"page_impressions_organic_unique\": 0,\n \"page:phone:click\": 0,\n \"page_posts_impressions_organic_unique\": 0,\n \"page_actions_post_reactions_haha_total\": 0,\n \"page:website:click\": 0,\n \"page_negative_feedback\": 0,\n \"page_places_checkin_total\": 0\n }\n },\n {\n \"id\": \"737476_FACEBOOK_page:insights_Day_2023-09-29\",\n \"locationID\": \"SA\",\n \"sourceID\": \"FACEBOOK\",\n \"date\": \"2023-09-29T00:00:00\",\n \"type\": \"page:insights\",\n \"interval\": \"Day\",\n \"metrics\": {\n \"page_views_logged_in_total\": 0,\n \"page_video_views_unique\": 0,\n \"page_posts_impressions_paid_unique\": 0,\n \"page_likes_lifetime\": 0,\n \"page_actions_post_reactions_like_total\": 0,\n \"page_posts_impressions_unique\": 0,\n \"page_engaged_users\": 0,\n \"page_fan_adds_unique\": 0,\n \"page_total_actions\": 0,\n \"page_impressions_organic\": 0,\n \"page_website_clicks_logged_in_count\": 0,\n \"page_impressions_viral\": 0,\n \"page_consumptions\": 0,\n \"page_actions_post_reactions_wow_total\": 0,\n \"page_content_activity\": 0,\n \"page_posts_impressions_paid\": 0,\n \"page_video_views_organic\": 0,\n \"page_impressions_paid\": 0,\n \"page_impressions_viral_unique\": 0,\n \"page_views_logged_in_unique\": 0,\n \"page_post_engagements\": 0,\n \"page_get_directions_clicks_logged_in_count\": 0,\n \"page_impressions_unique\": 0,\n \"page_actions_post_reactions_anger_total\": 0,\n \"page_video_views_paid\": 0,\n \"page_call_phone_clicks_logged_in_count\": 0,\n \"page:unfollow:count\": 0,\n \"page_posts_impressions_viral\": 0,\n \"page_posts_impressions\": 0,\n \"page_actions_post_reactions_sorry_total\": 0,\n \"page:directions:click\": 0,\n \"page_impressions_paid_unique\": 0,\n \"page_actions_post_reactions_love_total\": 0,\n \"page:views\": 0,\n \"page_impressions\": 0,\n \"page_video_views\": 0,\n \"page_posts_impressions_organic\": 0,\n \"page_impressions_organic_unique\": 0,\n \"page:phone:click\": 0,\n \"page_posts_impressions_organic_unique\": 0,\n \"page_actions_post_reactions_haha_total\": 0,\n \"page:website:click\": 0,\n \"page_negative_feedback\": 0,\n \"page_places_checkin_total\": 0\n }\n },\n {\n \"id\": \"737473_FACEBOOK_page:insights_Day_2023-09-29\",\n \"locationID\": \"CH\",\n \"sourceID\": \"FACEBOOK\",\n \"date\": \"2023-09-29T00:00:00\",\n \"type\": \"page:insights\",\n \"interval\": \"Day\",\n \"metrics\": {\n \"page_views_logged_in_total\": 2,\n \"page_video_views_unique\": 0,\n \"page_posts_impressions_paid_unique\": 0,\n \"page_likes_lifetime\": 34,\n \"page_actions_post_reactions_like_total\": 0,\n \"page_posts_impressions_unique\": 0,\n \"page_engaged_users\": 0,\n \"page_fan_adds_unique\": 0,\n \"page_total_actions\": 0,\n \"page_impressions_organic\": 0,\n \"page_website_clicks_logged_in_count\": 0,\n \"page_impressions_viral\": 0,\n \"page_consumptions\": 0,\n \"page_actions_post_reactions_wow_total\": 0,\n \"page_content_activity\": 0,\n \"page_posts_impressions_paid\": 0,\n \"page_video_views_organic\": 0,\n \"page_impressions_paid\": 0,\n \"page_impressions_viral_unique\": 0,\n \"page_views_logged_in_unique\": 1,\n \"page_post_engagements\": 0,\n \"page_get_directions_clicks_logged_in_count\": 0,\n \"page_impressions_unique\": 1,\n \"page_actions_post_reactions_anger_total\": 0,\n \"page_video_views_paid\": 0,\n \"page_call_phone_clicks_logged_in_count\": 0,\n \"page:unfollow:count\": 0,\n \"page_follows_lifetime\": 39,\n \"page_posts_impressions_viral\": 0,\n \"page_posts_impressions\": 0,\n \"page_actions_post_reactions_sorry_total\": 0,\n \"page:directions:click\": 0,\n \"page_impressions_paid_unique\": 0,\n \"page_actions_post_reactions_love_total\": 0,\n \"page:views\": 2,\n \"page_impressions\": 1,\n \"page_video_views\": 0,\n \"page_posts_impressions_organic\": 0,\n \"page_impressions_organic_unique\": 0,\n \"page:phone:click\": 0,\n \"page_posts_impressions_organic_unique\": 0,\n \"page_actions_post_reactions_haha_total\": 0,\n \"page:website:click\": 0,\n \"page_negative_feedback\": 0,\n \"page_places_checkin_total\": 0\n }\n }\n ],\n \"paging\": {\n \"offset\": 0,\n \"limit\": 20,\n \"next\": \"https://api.reputation.com/v3/metrics?offset=20&limit=20\"\n },\n \"dateRange\": {\n \"range\": \"LifeToDate\",\n \"from\": \"-\",\n \"to\": \"2023-10-04T23:59:59\"\n }\n}"}],"_postman_id":"977376ce-a793-4b8e-a0cf-bccb0fc9b7f6"},{"name":"Get Page Metrics","id":"93d775dd-db0a-4ab0-ac48-c9db12fce944","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"x-api-key","value":""}],"url":"{{baseUrl}}/page-metrics","description":"

This endpoint allows for the retrieval of page-specific metrics from the Reputation API. By specifying various query parameters, you can filter and customize the data being fetched, enabling a more detailed and targeted insights analysis.

Sample

JavaScript XHR Request

var xhr = new XMLHttpRequest();\nxhr.open('GET', 'https://api.reputation.com/v3/page-metrics?limit=2', true);\nxhr.setRequestHeader('x-api-key', 'Your API key');\nxhr.onreadystatechange = function() {\n    if (xhr.readyState == 4 && xhr.status == 200) {\n        var jsonResponse = JSON.parse(xhr.responseText);\n        console.log(jsonResponse);\n    }\n};\nxhr.send();\n\n

Response Parameters

Parameter	Parent	Data Type	Description
`metrics`	-	array	Array of metric objects for different sources and dates.
`id`	`metrics`	string	Unique identifier for the metric entry.
`locationID`	`metrics`	string	Identifier for the location related to the metrics.
`sourceID`	`metrics`	string	Source platform for the metrics (e.g., FACEBOOK).
`date`	`metrics`	string	Date for the metrics in ISO format.
`type`	`metrics`	string	Type of metric.
`interval`	`metrics`	string	The interval for which the metric is calculated.
`page_views_logged_in_total`	`metrics.metrics`	integer	Total page views by logged in users.
`page_video_views_unique`	`metrics.metrics`	integer	Unique video views on the page.
`page_posts_impressions_paid_unique`	`metrics.metrics`	integer	Unique paid post impressions on the page.
`page_likes_lifetime`	`metrics.metrics`	integer	Lifetime page likes.
`page_actions_post_reactions_like_total`	`metrics.metrics`	integer	Total \"like\" reactions to posts.
`page_posts_impressions_unique`	`metrics.metrics`	integer	Unique post impressions on the page.
`page_engaged_users`	`metrics.metrics`	integer	Engaged users on the page.
`page_fan_adds_unique`	`metrics.metrics`	integer	Unique new fans added.
`page_total_actions`	`metrics.metrics`	integer	Total actions performed on the page.
`page_impressions_organic`	`metrics.metrics`	integer	Organic impressions on the page.
`page_website_clicks_logged_in_count`	`metrics.metrics`	integer	Count of logged in users clicking on the website link.
`page_impressions_viral`	`metrics.metrics`	integer	Viral impressions on the page.
`page_consumptions`	`metrics.metrics`	integer	Page consumptions.
`page_actions_post_reactions_wow_total`	`metrics.metrics`	integer	Total \"wow\" reactions to posts.
`page_content_activity`	`metrics.metrics`	integer	Content activity on the page.
`page_posts_impressions_paid`	`metrics.metrics`	integer	Paid post impressions on the page.
`page_video_views_organic`	`metrics.metrics`	integer	Organic video views on the page.
`page_impressions_paid`	`metrics.metrics`	integer	Paid impressions on the page.
`page_impressions_viral_unique`	`metrics.metrics`	integer	Unique viral impressions on the page.
`page_views_logged_in_unique`	`metrics.metrics`	integer	Unique logged in users viewing the page.
`page_post_engagements`	`metrics.metrics`	integer	Page post engagements.
`page_get_directions_clicks_logged_in_count`	`metrics.metrics`	integer	Count of logged in users clicking to get directions.
`page_impressions_unique`	`metrics.metrics`	integer	Unique impressions on the page.
`page_actions_post_reactions_anger_total`	`metrics.metrics`	integer	Total \"anger\" reactions to posts.
`page_video_views_paid`	`metrics.metrics`	integer	Paid video views on the page.
`page_call_phone_clicks_logged_in_count`	`metrics.metrics`	integer	Count of logged in users clicking the phone link.
`page:unfollow:count`	`metrics.metrics`	integer	Count of users who unfollowed the page.
`page_posts_impressions_viral`	`metrics.metrics`	integer	Viral post impressions on the page.
`page_posts_impressions`	`metrics.metrics`	integer	Total post impressions on the page.
`page_actions_post_reactions_sorry_total`	`metrics.metrics`	integer	Total \"sorry\" reactions to posts.
`page:directions:click`	`metrics.metrics`	integer	Count of users who clicked for directions.
`page_impressions_paid_unique`	`metrics.metrics`	integer	Unique paid impressions on the page.
`page_actions_post_reactions_love_total`	`metrics.metrics`	integer	Total \"love\" reactions to posts.
`page:views`	`metrics.metrics`	integer	Total page views.
`page_impressions`	`metrics.metrics`	integer	Total impressions on the page.
`page_video_views`	`metrics.metrics`	integer	Total video views on the page.
`page_posts_impressions_organic`	`metrics.metrics`	integer	Organic post impressions on the page.
`page_impressions_organic_unique`	`metrics.metrics`	integer	Unique organic impressions on the page.
`page:phone:click`	`metrics.metrics`	integer	Count of users who clicked the phone link.
`page_posts_impressions_organic_unique`	`metrics.metrics`	integer	Unique organic post impressions on the page.
`page_actions_post_reactions_haha_total`	`metrics.metrics`	integer	Total \"haha\" reactions to posts.
`page:website:click`	`metrics.metrics`	integer	Count of users who clicked the website link.
`page_negative_feedback`	`metrics.metrics`	integer	Count of negative feedback on the page.
`page_places_checkin_total`	`metrics.metrics`	integer	Total check-ins at the place associated with the page.
`paging`	-	object	Pagination details for the metrics data.
`offset`	`paging`	integer	Current offset for pagination.
`limit`	`paging`	integer	Maximum number of results to be returned.
`next`	`paging`	string	URL for the next set of results.
`dateRange`	-	object	Information about the date range of the metrics.
`range`	`dateRange`	string	The type of date range (e.g., \"LifeToDate\").
`from`	`dateRange`	string	Start date of the metrics in ISO format.
`to`	`dateRange`	string	End date of the metrics in ISO format.

","urlObject":{"path":["page-metrics"],"host":["{{baseUrl}}"],"query":[{"disabled":true,"description":{"content":"

Sets the starting point of the data retrieved by specifying the number of initial records to skip. Max offset is 10k.

\n","type":"text/plain"},"key":"offset","value":""},{"disabled":true,"description":{"content":"

Determines the number of items returned in the current response. This is distinct from rate limiting and refers to the size of the data set returned, which is controlled by the value you specify. The default limit is 20 page metric objects, with a maximum possible limit of 2,000.

\n","type":"text/plain"},"key":"limit","value":""},{"disabled":true,"description":{"content":"

Indicates the start date for fetching metrics. The date must be in ISO format.

\n","type":"text/plain"},"key":"from","value":""},{"disabled":true,"description":{"content":"

Indicates the end date for fetching metrics. The date must be in ISO format.

\n","type":"text/plain"},"key":"to","value":""},{"disabled":true,"description":{"content":"

Specifies the predefined date range for fetching metrics. Valid values:

\"Today\"\"Yesterday\"\"ThisWeek\"\"PreviousWeek\"\"ThisMonth\"\"PreviousMonth\"\"ThisQuarter\"\"PreviousQuarter\"\"ThisYear\"\"PreviousYear\"\"YearToDate\"\"LifeToDate\"\"Last7Days\"\"Last30Days\"\"Last60Days\"\"Last90Days\"\"Last6Months\"\"Last1Year\"\"Last2Years\"\"Last3Years\"

\n","type":"text/plain"},"key":"range","value":""},{"disabled":true,"description":{"content":"

Filters the metrics based on specific sources. The IDs should be comma-separated. ex - \"FACEBOOK,TWITTER\"

\n","type":"text/plain"},"key":"sourceIDs","value":""},{"disabled":true,"description":{"content":"

Filters the metrics based on specific locations. The IDs should be comma-separated. Ex - \"LOC123,LOC456\"

\n","type":"text/plain"},"key":"locationIDs","value":""},{"disabled":true,"description":{"content":"

Determines the type of metrics fetched. Multiple types can be comma-separated. The default fetches all available metric types.

Valid values:

\"page:insights\"\"page:insights:age\"\"page:insights:driving\"\"page:insights:gender\"\"page:insights:phone\"

\n","type":"text/plain"},"key":"type","value":""},{"disabled":true,"description":{"content":"

Specifies the frequency or granularity of the data. Multiple intervals can be comma-separated.

Valid values: \"Day\"\"Hour\"\"Week\"\"Lifetime\"

\n","type":"text/plain"},"key":"interval","value":""}],"variable":[]}},"response":[{"id":"33720982-ab2d-4835-9135-39e67aa09d0f","name":"Success","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"7424cd2a39ebe2a0ca8baa6ecab726a0"}],"url":{"raw":"https://api.reputation.com/v3/page-metrics?limit=2","protocol":"https","host":["api","reputation","com"],"path":["v3","page-metrics"],"query":[{"key":"offset","value":"45530734","disabled":true},{"key":"limit","value":"2"},{"key":"from","value":"2001-06-17T15:40:12.790Z","disabled":true},{"key":"to","value":"2001-06-17T15:40:12.790Z","disabled":true},{"key":"range","value":"PreviousWeek","disabled":true},{"key":"sourceIDs","value":"dolor ut","disabled":true},{"key":"locationIDs","value":"dolor ut","disabled":true},{"key":"type","value":"page:insights:age","disabled":true},{"key":"interval","value":"Hour","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"3282"},{"key":"etag","value":"W/\"cd2-TBP+Dx/j7mhjnwQJqfa4CIO6A2Y\""},{"key":"date","value":"Wed, 04 Oct 2023 16:50:32 GMT"},{"key":"x-envoy-upstream-service-time","value":"143"},{"key":"server","value":"istio-envoy"},{"key":"Via","value":"1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"metrics\": [\n {\n \"id\": \"737495_FACEBOOK_page:insights_Day_2023-10-04\",\n \"locationID\": \"DW\",\n \"sourceID\": \"FACEBOOK\",\n \"date\": \"2023-10-04T00:00:00\",\n \"type\": \"page:insights\",\n \"interval\": \"Day\",\n \"metrics\": {\n \"page_views_logged_in_total\": 0,\n \"page_video_views_unique\": 0,\n \"page_posts_impressions_paid_unique\": 0,\n \"page_likes_lifetime\": 0,\n \"page_actions_post_reactions_like_total\": 0,\n \"page_posts_impressions_unique\": 1,\n \"page_engaged_users\": 0,\n \"page_fan_adds_unique\": 0,\n \"page_total_actions\": 0,\n \"page_impressions_organic\": 1,\n \"page_website_clicks_logged_in_count\": 0,\n \"page_impressions_viral\": 0,\n \"page_consumptions\": 0,\n \"page_actions_post_reactions_wow_total\": 0,\n \"page_content_activity\": 0,\n \"page_posts_impressions_paid\": 0,\n \"page_video_views_organic\": 0,\n \"page_impressions_paid\": 0,\n \"page_impressions_viral_unique\": 0,\n \"page_views_logged_in_unique\": 0,\n \"page_post_engagements\": 0,\n \"page_get_directions_clicks_logged_in_count\": 0,\n \"page_impressions_unique\": 1,\n \"page_actions_post_reactions_anger_total\": 0,\n \"page_video_views_paid\": 0,\n \"page_call_phone_clicks_logged_in_count\": 0,\n \"page:unfollow:count\": 0,\n \"page_posts_impressions_viral\": 0,\n \"page_posts_impressions\": 1,\n \"page_actions_post_reactions_sorry_total\": 0,\n \"page:directions:click\": 0,\n \"page_impressions_paid_unique\": 0,\n \"page_actions_post_reactions_love_total\": 0,\n \"page:views\": 0,\n \"page_impressions\": 1,\n \"page_video_views\": 0,\n \"page_posts_impressions_organic\": 1,\n \"page_impressions_organic_unique\": 1,\n \"page:phone:click\": 0,\n \"page_posts_impressions_organic_unique\": 1,\n \"page_actions_post_reactions_haha_total\": 0,\n \"page:website:click\": 0,\n \"page_negative_feedback\": 0,\n \"page_places_checkin_total\": 0\n }\n },\n {\n \"id\": \"737489_FACEBOOK_page:insights_Day_2023-10-04\",\n \"locationID\": \"AAA Waterbury\",\n \"sourceID\": \"FACEBOOK\",\n \"date\": \"2023-10-04T00:00:00\",\n \"type\": \"page:insights\",\n \"interval\": \"Day\",\n \"metrics\": {\n \"page_views_logged_in_total\": 4,\n \"page_video_views_unique\": 0,\n \"page_posts_impressions_paid_unique\": 0,\n \"page_likes_lifetime\": 1,\n \"page_actions_post_reactions_like_total\": 0,\n \"page_posts_impressions_unique\": 2,\n \"page_engaged_users\": 0,\n \"page_fan_adds_unique\": 0,\n \"page_total_actions\": 0,\n \"page_impressions_organic\": 3,\n \"page_website_clicks_logged_in_count\": 0,\n \"page_impressions_viral\": 0,\n \"page_consumptions\": 0,\n \"page_actions_post_reactions_wow_total\": 0,\n \"page_content_activity\": 0,\n \"page_posts_impressions_paid\": 0,\n \"page_video_views_organic\": 0,\n \"page_impressions_paid\": 0,\n \"page_impressions_viral_unique\": 0,\n \"page_views_logged_in_unique\": 1,\n \"page_post_engagements\": 0,\n \"page_get_directions_clicks_logged_in_count\": 0,\n \"page_impressions_unique\": 2,\n \"page_actions_post_reactions_anger_total\": 0,\n \"page_video_views_paid\": 0,\n \"page_call_phone_clicks_logged_in_count\": 0,\n \"page:unfollow:count\": 0,\n \"page_posts_impressions_viral\": 0,\n \"page_posts_impressions\": 3,\n \"page_actions_post_reactions_sorry_total\": 0,\n \"page:directions:click\": 0,\n \"page_impressions_paid_unique\": 0,\n \"page_actions_post_reactions_love_total\": 0,\n \"page:views\": 6,\n \"page_impressions\": 5,\n \"page_video_views\": 0,\n \"page_posts_impressions_organic\": 3,\n \"page_impressions_organic_unique\": 2,\n \"page:phone:click\": 0,\n \"page_posts_impressions_organic_unique\": 2,\n \"page_actions_post_reactions_haha_total\": 0,\n \"page:website:click\": 0,\n \"page_negative_feedback\": 0,\n \"page_places_checkin_total\": 0\n }\n }\n ],\n \"paging\": {\n \"offset\": 0,\n \"limit\": 2,\n \"next\": \"https://api.reputation.com/v3/page-metrics?offset=2&limit=2\"\n },\n \"dateRange\": {\n \"range\": \"LifeToDate\",\n \"from\": \"-\",\n \"to\": \"2023-10-04T23:59:59\"\n }\n}"}],"_postman_id":"93d775dd-db0a-4ab0-ac48-c9db12fce944"},{"name":"Get Post Metrics","id":"6993bd7c-0077-4f56-b628-4635f6118ad3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"x-api-key","value":""}],"url":"{{baseUrl}}/post-metrics","description":"

This endpoint retrieves post metrics from the Reputation platform. It provides detailed insights based on various filtering criteria such as date range, source, location, type, and interval.

Sample

JavaScript XHR

var xhr = new XMLHttpRequest();\nxhr.open('GET', 'https://api.reputation.com/v3/post-metrics?limit=2&sourceIDs=FACEBOOK', true);\nxhr.onreadystatechange = function() {\n    if (xhr.readyState == 4 && xhr.status == 200) {\n        var response = JSON.parse(xhr.responseText);\n        console.log(response);\n    }\n};\nxhr.send();\n\n

Response Parameters

Data returned.

Parameter	Parent	Data Type	Description
metrics	-	Object	Object containing post all response details.
id	metrics	String	Unique identifier. Example: \"737473_FACEBOOK_post:insights_Lifetime_660643843964020_704916364990195\"
locationID	metrics	String	Location identifier. Example: \"CH\"
sourceID	metrics	String	Source of the data. Example: \"FACEBOOK\"
date	metrics	String	Date of the metric. Example: \"2023-10-05T06:05:29\"
type	metrics	String	Type of the insight. Example: \"post:insights\"
interval	metrics	String	Time period of the metric. Example: \"Lifetime\"
metrics	metrics	Object	Object containing an array of metrics and values.
post:other:clicks	metrics	Integer	Number of other clicks on the post. Example: 0
post:link:clicks	metrics	Integer	Number of link clicks on the post. Example: 0
post:photo:clicks	metrics	Integer	Number of photo clicks on the post. Example: 0
post:comments	metrics	Integer	Number of comments on the post. Example: 0
post:totalReactions	metrics	Integer	Total reactions on the post. Example: 0
post:impressions	metrics	Integer	Number of times the post was displayed. Example: 2
post:reach	metrics	Integer	Number of unique users who saw the post. Example: 2
post:reach:organic	metrics	Integer	Number of unique users who saw the post organically. Example: 2
post:impressions:organic	metrics	Integer	Number of times the post was displayed organically. Example: 2
post:likes	metrics	Integer	Number of likes on the post. Example: 3
post:engagement	metrics	Integer	Number of engagements on the post. Example: 1
post:storytellers	metrics	Integer	Number of people who talked about the post. Example: 1
post:clicks	metrics	Integer	Number of clicks on the post. Example: 1
post:saved	metrics	Integer	Number of times the post was saved. Example: 0
post:shares	metrics	Integer	Number of times the post was shared. Example: 0
campaignID	metrics	String	The post's campaign id.
campaignName	metrics	String	The post's campaign name.
campaignType	metrics	String	The post's campaign type.
paging	-	Object	Object containing pagination details.
offset	paging	Integer	Specifies the starting point for the result set, useful for pagination. The maximum allowable offset is 10,000.
limit	paging	Integer	Determines the number of items returned in the current response. This is distinct from rate limiting and refers to the size of the data set returned, which is controlled by the value you specify. The default limit is 20 post metrics, with a maximum possible limit of 2,000.
next	paging	String	The URL for the next page.

","urlObject":{"path":["post-metrics"],"host":["{{baseUrl}}"],"query":[{"disabled":true,"description":{"content":"

Specifies the starting point for the result set, useful for pagination. The maximum allowable offset is 10,000.

\n","type":"text/plain"},"key":"offset","value":""},{"disabled":true,"description":{"content":"

Determines the number of items returned in the current response. This is distinct from rate limiting and refers to the size of the data set returned, which is controlled by the value you specify. The default limit is 20 post metric objects, with a maximum possible limit of 2,000.

\n","type":"text/plain"},"key":"limit","value":""},{"disabled":true,"description":{"content":"

The start date for the metrics, given in ISO format.

\n","type":"text/plain"},"key":"from","value":""},{"disabled":true,"description":{"content":"

The end date for the metrics, given in ISO format.

\n","type":"text/plain"},"key":"to","value":""},{"disabled":true,"description":{"content":"

Specifies the time range for the metrics. Valid Values: Today, Yesterday, ThisWeek, PreviousWeek, ThisMonth, PreviousMonth, ThisQuarter, PreviousQuarter, ThisYear, PreviousYear, YearToDate, LifeToDate, Last7Days, Last30Days, Last60Days, Last90Days, Last6Months, Last1Year, Last2Years, Last3Years.

\n","type":"text/plain"},"key":"range","value":""},{"disabled":true,"description":{"content":"

Filters the metrics based on specific source IDs. Multiple source IDs can be provided, separated by commas. Ex. FACEBOOK

\n","type":"text/plain"},"key":"sourceIDs","value":""},{"disabled":true,"description":{"content":"

Filters the metrics based on specific location IDs. Multiple location IDs can be provided, separated by commas. Ex. SA

\n","type":"text/plain"},"key":"locationIDs","value":""},{"disabled":true,"description":{"content":"

Specifies the type of metrics to retrieve. Valid Value: post:insights

\n","type":"text/plain"},"key":"type","value":""},{"disabled":true,"description":{"content":"

Defines the interval for which the metrics should be aggregated. Valid Values: Day, Hour, Week, Lifetime.

\n","type":"text/plain"},"key":"interval","value":""}],"variable":[]}},"response":[{"id":"af3681ee-07dc-4170-9216-1fa9a1f3f41c","name":"Success","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"Your API key"}],"url":{"raw":"https://api.reputation.com/v3/post-metrics?limit=2&sourceIDs=FACEBOOK","protocol":"https","host":["api","reputation","com"],"path":["v3","post-metrics"],"query":[{"key":"offset","value":"45530734","disabled":true},{"key":"limit","value":"2"},{"key":"from","value":"2001-06-17T15:40:12.790Z","disabled":true},{"key":"to","value":"2001-06-17T15:40:12.790Z","disabled":true},{"key":"range","value":"PreviousWeek","disabled":true},{"key":"sourceIDs","value":"FACEBOOK"},{"key":"locationIDs","value":"dolor ut","disabled":true},{"key":"type","value":"post:insights","disabled":true},{"key":"interval","value":"Hour","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"832"},{"key":"etag","value":"W/\"340-Qo5MyxHvuoC39uRg4cNw8mjWAIw\""},{"key":"date","value":"Tue, 10 Oct 2023 11:31:43 GMT"},{"key":"x-envoy-upstream-service-time","value":"227"},{"key":"server","value":"istio-envoy"},{"key":"Via","value":"1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"metrics\": [\n {\n \"id\": \"737473_FACEBOOK_post:insights_Lifetime_660643843964020_704916364990195\",\n \"locationID\": \"CH\",\n \"sourceID\": \"FACEBOOK\",\n \"date\": \"2023-10-05T06:05:29\",\n \"type\": \"post:insights\",\n \"interval\": \"Lifetime\",\n \"metrics\": {\n \"post:other:clicks\": 0,\n \"post:link:clicks\": 0,\n \"post:photo:clicks\": 0,\n \"post:comments\": 0,\n \"post:totalReactions\": 0\n }\n },\n {\n \"id\": \"737476_FACEBOOK_post:insights_Lifetime_105071211455388_760656512740536\",\n \"locationID\": \"SA\",\n \"sourceID\": \"FACEBOOK\",\n \"date\": \"2023-10-05T06:05:26\",\n \"type\": \"post:insights\",\n \"interval\": \"Lifetime\",\n \"metrics\": {\n \"post:other:clicks\": 0,\n \"post:link:clicks\": 0,\n \"post:photo:clicks\": 0,\n \"post:comments\": 0,\n \"post:totalReactions\": 0\n }\n }\n ],\n \"paging\": {\n \"offset\": 0,\n \"limit\": 2,\n \"next\": \"https://api.reputation.com/v3/post-metrics?offset=2&limit=2&sourceIDs=FACEBOOK\"\n },\n \"dateRange\": {\n \"range\": \"LifeToDate\",\n \"from\": \"-\",\n \"to\": \"2023-10-10T23:59:59\"\n }\n}"}],"_postman_id":"6993bd7c-0077-4f56-b628-4635f6118ad3"},{"name":"Get Aggregate Page Metrics","id":"3c708b21-86bf-4012-9277-8fb615107879","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"x-api-key","value":""}],"url":"{{baseUrl}}/aggregate-page-metrics","description":"

This endpoint retrieves aggregate metrics related to pages on various platforms. The metrics offer insights on page reach, views, clicks, and more, providing a comprehensive understanding of a page's performance over different sources and time frames.

For example:

If you want to know the total number of page views from all sources for a specific location over the past month, the endpoint would \"aggregate\" or sum up all the individual views from each source to provide a total count.
If you choose to group data by \"Date,\" the endpoint might provide daily totals of a specific metric across all chosen sources and locations.
If you group by \"Source,\" you might get totals for each platform (like FACEBOOK, INSTAGRAM, etc.) over the specified time frame.

Sample

JavaScript XHR

var xhr = new XMLHttpRequest();\nxhr.open('GET', 'https://api.reputation.com/v3/aggregate-page-metrics?range=PreviousWeek', true);\nxhr.onreadystatechange = function() {\n    if (xhr.readyState == 4 && xhr.status == 200) {\n        var response = JSON.parse(xhr.responseText);\n        console.log(response);\n    }\n};\nxhr.send();\n\n

Response Parameters

Data returned.

\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

Parameter	Parent	Data Type	Description
date	-	string	The date of the metric, in ISO format. e.g. \"2023-01-01T00:00:00.000-0800\"
sourceID	-	string	The ID representing the source of the metric. e.g. \"INSTAGRAM\"
m.page:reach	-	number	Number of page reaches. e.g. 41
m.page:website:click	-	number	Number of clicks to the website from the page. e.g. 0
m.page:views	-	number	Number of page views. e.g. 9
dim.pID	-	number	Page count. e.g. 103
m.page:phone:click	-	number	Number of phone clicks from the page. e.g. 0
m.page:directions:click	-	number	Number of clicks for directions from the page. e.g. 0
locationId	-	string	The ID representing the location of the metric. e.g. \"BP\"

","urlObject":{"path":["aggregate-page-metrics"],"host":["{{baseUrl}}"],"query":[{"disabled":true,"description":{"content":"

Specifies the start date for the metrics in ISO Date format.

\n","type":"text/plain"},"key":"from","value":""},{"disabled":true,"description":{"content":"

Specifies the end date for the metrics in ISO Date format.

\n","type":"text/plain"},"key":"to","value":""},{"disabled":true,"description":{"content":"

Specifies the date range for the metrics. Valid values include: \"Today\"\"Yesterday\"\"ThisWeek\"\"PreviousWeek\"\"ThisMonth\"\"PreviousMonth\"\"ThisQuarter\"\"PreviousQuarter\"\"ThisYear\"\"PreviousYear\"\"YearToDate\"\"LifeToDate\"\"Last7Days\"\"Last30Days\"\"Last60Days\"\"Last90Days\"\"Last6Months\"\"Last1Year\"\"Last2Years\"\"Last3Years\"

\n","type":"text/plain"},"key":"range","value":""},{"disabled":true,"description":{"content":"

Types to filter by, with the default being all types. Valid value is: \"page:insights\"

\n","type":"text/plain"},"key":"type","value":""},{"disabled":true,"description":{"content":"

Comma-separated location IDs to filter metrics by.

\n","type":"text/plain"},"key":"locationIDs","value":""},{"disabled":true,"description":{"content":"

Comma-separated source IDs to filter metrics by.

\n","type":"text/plain"},"key":"sourceIDs","value":""},{"disabled":true,"description":{"content":"

Specifies how to group the summary data. Valid values include: \"Location\"\n\"Date\" \"Source\"

\n","type":"text/plain"},"key":"groupBy","value":""},{"disabled":true,"description":{"content":"

Comma-separated intervals to filter metrics by. Valid values are: \"Month\"\n\"Year\"

\n","type":"text/plain"},"key":"interval","value":""},{"disabled":true,"description":{"content":"

Comma-separated metric properties to retrieve. Default is to retrieve all metrics. Valid metrics include: \"m.page:views\"\n\"m.page:reach\" \"m.page:website:click\" \"m.page:phone:click\" \"m.page:directions:click\" \"dim.pID\"

\n","type":"text/plain"},"key":"metrics","value":""}],"variable":[]}},"response":[{"id":"e7501b5d-4f83-4b14-ae7b-8e3f24f78650","name":"Success","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"Your API key"}],"url":{"raw":"https://api.reputation.com/v3/aggregate-page-metrics?range=PreviousWeek","protocol":"https","host":["api","reputation","com"],"path":["v3","aggregate-page-metrics"],"query":[{"key":"from","value":"2001-06-17T15:40:12.790Z","disabled":true},{"key":"to","value":"2001-06-17T15:40:12.790Z","disabled":true},{"key":"range","value":"PreviousWeek"},{"key":"type","value":"page:insights","disabled":true},{"key":"locationIDs","value":"dolor ut","disabled":true},{"key":"sourceIDs","value":"dolor ut","disabled":true},{"key":"groupBy","value":"Date","disabled":true},{"key":"interval","value":"Year","disabled":true},{"key":"metrics","value":"m.page:views","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"821"},{"key":"etag","value":"W/\"335-InaozytKe8/rQ0sdMvYZNjy69kA\""},{"key":"date","value":"Tue, 10 Oct 2023 12:12:16 GMT"},{"key":"x-envoy-upstream-service-time","value":"658"},{"key":"server","value":"istio-envoy"},{"key":"Via","value":"1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"date\": \"2023-10-01T00:00:00.000-0700\",\n \"sourceID\": \"FACEBOOK\",\n \"m.page:reach\": 0,\n \"m.page:website:click\": 0,\n \"m.page:views\": 0,\n \"dim.pID\": 7,\n \"m.page:phone:click\": 0,\n \"m.page:directions:click\": 0,\n \"locationId\": \"DW\"\n },\n {\n \"date\": \"2023-10-01T00:00:00.000-0700\",\n \"sourceID\": \"FACEBOOK\",\n \"m.page:reach\": 0,\n \"m.page:website:click\": 0,\n \"m.page:views\": 2,\n \"dim.pID\": 7,\n \"m.page:phone:click\": 0,\n \"m.page:directions:click\": 0,\n \"locationId\": \"CH\"\n },\n {\n \"date\": \"2023-10-01T00:00:00.000-0700\",\n \"sourceID\": \"FACEBOOK\",\n \"m.page:reach\": 0,\n \"m.page:website:click\": 0,\n \"m.page:views\": 12,\n \"dim.pID\": 7,\n \"m.page:phone:click\": 0,\n \"m.page:directions:click\": 0,\n \"locationId\": \"AAA Waterbury\"\n },\n {\n \"date\": \"2023-10-01T00:00:00.000-0700\",\n \"sourceID\": \"FACEBOOK\",\n \"m.page:reach\": 0,\n \"m.page:website:click\": 0,\n \"m.page:views\": 0,\n \"dim.pID\": 7,\n \"m.page:phone:click\": 0,\n \"m.page:directions:click\": 0,\n \"locationId\": \"SA\"\n }\n]"}],"_postman_id":"3c708b21-86bf-4012-9277-8fb615107879"},{"name":"Get Aggregate Post Metrics","id":"3b9d3191-eacf-432e-8514-89013ee69c94","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"x-api-key","value":""}],"url":"{{baseUrl}}/aggregate-post-metrics","description":"

This endpoint retrieves aggregate metrics pertaining to posts from various sources. These metrics provide insights on aspects like post impressions, organic reach, and other related dimensions for a given period and set of filtering criteria.

Sample

JavaScript XHR Sample

var xhr = new XMLHttpRequest();\nxhr.open('GET', 'https://api.reputation.com/v3/aggregate-post-metrics?locationIDs=SA&sourceIDs=FACEBOOK', true);\nxhr.onreadystatechange = function() {\n    if (xhr.readyState == 4 && xhr.status == 200) {\n        var response = JSON.parse(xhr.responseText);\n        console.log(response);\n    }\n};\nxhr.send();\n\n

Response Parameters

Data returned.

\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

Parameter	Data Type	Description
date	string	Date of the metric - ex. \"2023-10-01T00:00:00.000-0700\"
sourceID	string	ID of the source - ex. \"FACEBOOK\"
dim.pID	number	Page count - ex. 2
m.post:impressions	number	Number of post impressions - ex. 0
m.post:reach:organic	number	Number of organic post reaches - ex. 0
locationId	string	ID of the location - \"SA\"

","urlObject":{"path":["aggregate-post-metrics"],"host":["{{baseUrl}}"],"query":[{"disabled":true,"description":{"content":"

Specifies the starting date for which to fetch post metrics. It must be in ISO Date format, e.g., \"2023-01-01T00:00:00.000-0800\"

\n","type":"text/plain"},"key":"from","value":""},{"disabled":true,"description":{"content":"

Specifies the end date for which to fetch post metrics. It must be in ISO Date format, e.g., \"2023-12-31T00:00:00.000-0800\"

\n","type":"text/plain"},"key":"to","value":""},{"disabled":true,"description":{"content":"

Determines the date range for which to fetch the metrics. Valid values include:\n\"Today\", \"Yesterday\", \"ThisWeek\", \"PreviousWeek\", \"ThisMonth\", \"PreviousMonth\", \"ThisQuarter\", \"PreviousQuarter\", \"ThisYear\", \"PreviousYear\", \"YearToDate\", \"LifeToDate\", \"Last7Days\", \"Last30Days\", \"Last60Days\", \"Last90Days\", \"Last6Months\", \"Last1Year\", \"Last2Years\", \"Last3Years\".

\n","type":"text/plain"},"key":"range","value":""},{"disabled":true,"description":{"content":"

A comma-separated list of types to filter by. The default value includes all types. Currently, the valid type is \"post:insights\".

\n","type":"text/plain"},"key":"type","value":""},{"disabled":true,"description":{"content":"

A comma-separated list of location IDs to filter the results by, which refers to specific locations or branches.

\n","type":"text/plain"},"key":"locationIDs","value":""},{"disabled":true,"description":{"content":"

A comma-separated list of source IDs to filter by. These source IDs represent various platforms or channels, e.g., \"FACEBOOK\".

\n","type":"text/plain"},"key":"sourceIDs","value":""},{"disabled":true,"description":{"content":"

Determines how the summary should be grouped. Valid options include:

\"Location\", \"Date\", \"Source\". By default, it groups by all these criteria.

\n","type":"text/plain"},"key":"groupBy","value":""},{"disabled":true,"description":{"content":"

Defines the intervals to filter the results by. Valid values include \"Month\" and \"Year\".

\n","type":"text/plain"},"key":"interval","value":""},{"disabled":true,"description":{"content":"

A comma-separated list of metric properties to retrieve. The default value fetches all available metrics. Some examples are: \"m.post:impressions\", \"m.post:reach:organic\", \"dim.pID\".

\n","type":"text/plain"},"key":"metrics","value":""}],"variable":[]}},"response":[{"id":"0b9520b7-7e56-4ee9-bcd1-5e257ea96630","name":"Success","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"Your API key"}],"url":{"raw":"https://api.reputation.com/v3/aggregate-post-metrics?locationIDs=SA&sourceIDs=FACEBOOK","protocol":"https","host":["api","reputation","com"],"path":["v3","aggregate-post-metrics"],"query":[{"key":"from","value":"2001-06-17T15:40:12.790Z","disabled":true},{"key":"to","value":"2001-06-17T15:40:12.790Z","disabled":true},{"key":"range","value":"PreviousWeek","disabled":true},{"key":"type","value":"post:insights","disabled":true},{"key":"locationIDs","value":"SA"},{"key":"groupBy","value":"Date","disabled":true},{"key":"interval","value":"Year","disabled":true},{"key":"metrics","value":"dim.pID","disabled":true},{"key":"sourceIDs","value":"FACEBOOK"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"1374"},{"key":"etag","value":"W/\"55e-d4Q2TV45nO007SZAYQE0B/oRLRg\""},{"key":"date","value":"Tue, 10 Oct 2023 12:54:36 GMT"},{"key":"x-envoy-upstream-service-time","value":"338"},{"key":"server","value":"istio-envoy"},{"key":"Via","value":"1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"date\": \"2023-10-01T00:00:00.000-0700\",\n \"sourceID\": \"FACEBOOK\",\n \"dim.pID\": 2,\n \"m.post:impressions\": 0,\n \"m.post:reach:organic\": 0,\n \"locationId\": \"SA\"\n },\n {\n \"date\": \"2023-09-01T00:00:00.000-0700\",\n \"dim.pID\": 0,\n \"m.post:impressions\": 0,\n \"m.post:reach:organic\": 0\n },\n {\n \"date\": \"2023-08-01T00:00:00.000-0700\",\n \"sourceID\": \"FACEBOOK\",\n \"dim.pID\": 9,\n \"m.post:impressions\": 41,\n \"m.post:reach:organic\": 39,\n \"locationId\": \"SA\"\n },\n {\n \"date\": \"2023-07-01T00:00:00.000-0700\",\n \"sourceID\": \"FACEBOOK\",\n \"dim.pID\": 3,\n \"m.post:impressions\": 8,\n \"m.post:reach:organic\": 8,\n \"locationId\": \"SA\"\n },\n {\n \"date\": \"2023-06-01T00:00:00.000-0700\",\n \"sourceID\": \"FACEBOOK\",\n \"dim.pID\": 2,\n \"m.post:impressions\": 15,\n \"m.post:reach:organic\": 13,\n \"locationId\": \"SA\"\n },\n {\n \"date\": \"2023-05-01T00:00:00.000-0700\",\n \"sourceID\": \"FACEBOOK\",\n \"dim.pID\": 2,\n \"m.post:impressions\": 8,\n \"m.post:reach:organic\": 8,\n \"locationId\": \"SA\"\n },\n {\n \"date\": \"2023-04-01T00:00:00.000-0700\",\n \"sourceID\": \"FACEBOOK\",\n \"dim.pID\": 6,\n \"m.post:impressions\": 26,\n \"m.post:reach:organic\": 26,\n \"locationId\": \"SA\"\n },\n {\n \"date\": \"2023-03-01T00:00:00.000-0800\",\n \"sourceID\": \"FACEBOOK\",\n \"dim.pID\": 32,\n \"m.post:impressions\": 94,\n \"m.post:reach:organic\": 93,\n \"locationId\": \"SA\"\n },\n {\n \"date\": \"2023-02-01T00:00:00.000-0800\",\n \"sourceID\": \"FACEBOOK\",\n \"dim.pID\": 8,\n \"m.post:impressions\": 10,\n \"m.post:reach:organic\": 10,\n \"locationId\": \"SA\"\n },\n {\n \"date\": \"2023-01-01T00:00:00.000-0800\",\n \"sourceID\": \"FACEBOOK\",\n \"dim.pID\": 8,\n \"m.post:impressions\": 29,\n \"m.post:reach:organic\": 29,\n \"locationId\": \"SA\"\n }\n]"}],"_postman_id":"3b9d3191-eacf-432e-8514-89013ee69c94"}],"id":"b3c4f32e-30ba-4d42-9953-30175eceb2e6","description":"

The Metrics API collection provides a comprehensive suite of endpoints designed to manage, track, and analyze metrics crucial to your profiles. Use the following endpoints to track Business Listings, Social Post and Page metrics.

\n","_postman_id":"b3c4f32e-30ba-4d42-9953-30175eceb2e6"},{"name":"/Reports","item":[{"name":"Run Report","id":"1594b78b-10d9-48ea-991a-3842767a07db","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"x-api-key","value":""}],"body":{"mode":"raw","raw":"{\n \"configuration\": {\n \"runAsLocale\": \"string\",\n \"runDate\": \"integer\",\n \"overrideConfigurations\": {\n \"__report_config__\": {\n \"filters\": [],\n \"parameters\": {\n \"period\": \"string\"\n }\n }\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/reports/:reportID/export","description":"

Execute a specific report within the Reputation platform. By sending a PUT request to this endpoint, you can define how and when the report is exported, with the capability to override its configurations, specify the locale, and select a user context. This ensures that the generated report caters to the precise analytical needs for a given scenario.

Finding the Report ID

See this article to learn how to find the report ID for the report you wish to export.

Sample

JavaScript XHR Request

var xhr = new XMLHttpRequest();\nxhr.open(\"PUT\", \"https://api.reputation.com/v3/reports/report-reviews-sentiment-over-time/export\", true);\nxhr.setRequestHeader(\"x-api-key\", \"Your API key\");\nxhr.setRequestHeader(\"Content-Type\", \"application/json;charset=UTF-8\");\nxhr.onreadystatechange = function () {\n    if (xhr.readyState == 4 && xhr.status == 200) {\n        var response = JSON.parse(xhr.responseText);\n        console.log(response);\n    }\n};\nvar data = JSON.stringify({\n    \"configuration\": {\n        \"runAsLocale\": \"en_US\",\n        \"runDate\": 1684752000000,\n        \"overrideConfigurations\": {\n            \"__report_config__\": {\n                \"filters\": [],\n                \"parameters\": {\n                    \"period\": \"month_last_1_year\"\n                }\n            }\n        }\n    }\n});\nxhr.send(data);\n\n

Request Body Parameters

\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

Parameter	Parent	Data Type	Description
runAsLocale	configuration	String	Locale to run report as. Valid values: de_CH, de_DE, es_ES, es_MX, en_GB, en_US, fr_CA, fr_FR. Defaults to en_US.
runDate	configuration	Integer	Date to run report on. For example: 1684752000000 represents June 20, 2023.
runAsUserId	configuration	String	User to run report as.
overrideConfigurations	configuration	Object	Report Configurations to override.
report_config	overrideConfigurations	Object	Contains report configurations.
filters	report_config	String Array	An array of filters for the report. Can be provided as an empty array if no filters are used.
parameters	report_config	Object	Contains parameters for the report.
period	parameters	String	Defines the report period. Valid value: \"month_last_1_year\".

Data Returned

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Data Type	Description
Data	Object	Report data

The specific response parameters and data structure returned by the API largely depend on the type of report being fetched. For instance, when accessing the Review Sentiment Trend report, the response encapsulates monthly sentiment trends, detailing the number of positive, neutral, and negative reviews for each month. Each data point provides a breakdown for a specific period, such as May 2022 or Jun 2022, and enumerates the total reviews alongside the sentiment categories. Different reports may return varied structures and metrics tailored to their unique purposes.

Period Parameter Values

Possible values for the period parameter.

Value	Description
(leave blank)	All time data
month_last_1_year	Data from the last year
this_year	Data from the current year
previous_year	Data from the previous year
previous_2_years	Data from two years ago
previous_3_years	Data from three years ago
ago_2_years	Calendar year (CY) 2022
ago_3_years	CY 2021
this_quarter	Data from the current quarter
previous_quarter	Data from the previous quarter
this_month	Data from the current month
previous_month	Data from the previous month
previous_2_months	Data from two months ago
previous_3_months	Data from three months ago
previous_6_months	Data from six months ago
previous_12_months	Data from the last twelve months
this_week	Data from the current week
previous_week	Data from the previous week
today	Data from today
yesterday	Data from yesterday
day_last_7_days	Data from the past seven days
day_last_30_days	Data from the past thirty days
day_last_60_days	Data from the past sixty days
day_last_90_days	Data from the past ninety days
month_last_6_months	Data from the past six months
month_last_2_years	Data from the past two years
month_last_3_years	Data from the past three years
MM/DD/YYYY 00:00	Custom start date and time (format: MM/DD/YYYY)
MM/DD/YYYY 23:59:59	Custom end date and time (format: MM/DD/YYYY)

","urlObject":{"path":["reports",":reportID","export"],"host":["{{baseUrl}}"],"query":[],"variable":[{"description":{"content":"

(Required) The unique identifier associated with the report you wish to run.

\n","type":"text/plain"},"type":"any","value":"","key":"reportID"}]}},"response":[{"id":"71b6c177-1d97-46f1-9424-61535b7b4cc5","name":"Success","originalRequest":{"method":"PUT","header":[{"key":"x-api-key","value":"Your API key"}],"body":{"mode":"raw","raw":"{\n \"configuration\": {\n \"runAsLocale\": \"en_US\",\n \"runDate\": 1684752000000,\n \"overrideConfigurations\": {\n \"__report_config__\": {\n \"filters\": [],\n \"parameters\": {\n \"period\": \"month_last_1_year\"\n }\n }\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.reputation.com/v3/reports/:reportID/run","protocol":"https","host":["api","reputation","com"],"path":["v3","reports",":reportID","run"],"variable":[{"key":"reportID","value":"report-reviews-sentiment-over-time"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"1273"},{"key":"etag","value":"W/\"4f9-HlHOZ2XQnCnaI2viHEnSkZ9yk/4\""},{"key":"date","value":"Wed, 11 Oct 2023 04:58:03 GMT"},{"key":"x-envoy-upstream-service-time","value":"516"},{"key":"server","value":"istio-envoy"},{"key":"Via","value":"1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"Current Period\": \"May 2022\",\n \"Total Reviews\": \"49\",\n \"Positive\": \"42\",\n \"Neutral\": \"2\",\n \"Negative\": \"5\"\n },\n {\n \"Current Period\": \"Jun 2022\",\n \"Total Reviews\": \"120\",\n \"Positive\": \"101\",\n \"Neutral\": \"7\",\n \"Negative\": \"12\"\n },\n {\n \"Current Period\": \"Jul 2022\",\n \"Total Reviews\": \"124\",\n \"Positive\": \"108\",\n \"Neutral\": \"5\",\n \"Negative\": \"11\"\n },\n {\n \"Current Period\": \"Aug 2022\",\n \"Total Reviews\": \"126\",\n \"Positive\": \"112\",\n \"Neutral\": \"3\",\n \"Negative\": \"11\"\n },\n {\n \"Current Period\": \"Sep 2022\",\n \"Total Reviews\": \"122\",\n \"Positive\": \"101\",\n \"Neutral\": \"5\",\n \"Negative\": \"16\"\n },\n {\n \"Current Period\": \"Oct 2022\",\n \"Total Reviews\": \"112\",\n \"Positive\": \"94\",\n \"Neutral\": \"7\",\n \"Negative\": \"11\"\n },\n {\n \"Current Period\": \"Nov 2022\",\n \"Total Reviews\": \"106\",\n \"Positive\": \"92\",\n \"Neutral\": \"5\",\n \"Negative\": \"9\"\n },\n {\n \"Current Period\": \"Dec 2022\",\n \"Total Reviews\": \"71\",\n \"Positive\": \"55\",\n \"Neutral\": \"9\",\n \"Negative\": \"7\"\n },\n {\n \"Current Period\": \"Jan 2023\",\n \"Total Reviews\": \"76\",\n \"Positive\": \"68\",\n \"Neutral\": \"4\",\n \"Negative\": \"4\"\n },\n {\n \"Current Period\": \"Feb 2023\",\n \"Total Reviews\": \"59\",\n \"Positive\": \"55\",\n \"Neutral\": \"1\",\n \"Negative\": \"3\"\n },\n {\n \"Current Period\": \"Mar 2023\",\n \"Total Reviews\": \"61\",\n \"Positive\": \"50\",\n \"Neutral\": \"2\",\n \"Negative\": \"9\"\n },\n {\n \"Current Period\": \"Apr 2023\",\n \"Total Reviews\": \"88\",\n \"Positive\": \"80\",\n \"Neutral\": \"4\",\n \"Negative\": \"4\"\n },\n {\n \"Current Period\": \"May 2023\",\n \"Total Reviews\": \"48\",\n \"Positive\": \"44\",\n \"Neutral\": \"1\",\n \"Negative\": \"3\"\n }\n ]\n}"}],"_postman_id":"1594b78b-10d9-48ea-991a-3842767a07db"}],"id":"cf446459-2d3c-40ab-bf48-9ac94004122f","description":"

Use this collection to configure and interpret reports on the Reputation platform.

\n","_postman_id":"cf446459-2d3c-40ab-bf48-9ac94004122f"},{"name":"/Request-URLs (Deprecated Collection)","item":[{"name":"Get Request URLs (Deprecated)","id":"c2ee1cb9-8dcd-4592-845a-7de7f5080e48","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"x-api-key","value":""}],"url":"{{baseUrl}}/request-urls","description":"

Retrieve specific request URLs associated with given parameters. This endpoint allows users to fetch URLs based on specified location IDs, source IDs and optional template names, and source IDs.

A \"request URL\" refers to a specific web address (or URL) associated with a certain platform, source, or service where reviews, feedback, or other user-generated content related to a business or entity can be found or requested.

Note: This endpoint is now deprecated, and support for it has been discontinued.

Sample Request

JavaScript XHR

var xhr = new XMLHttpRequest();\nxhr.open('GET', 'https://api.reputation.com/v3/request-urls?locationID=SA&sourceIDs=FACEBOOK', true);\nxhr.setRequestHeader('Content-Type', 'application/json');\nxhr.onreadystatechange = function() {\n    if (xhr.readyState === 4 && xhr.status === 200) {\n        var response = JSON.parse(xhr.responseText);\n        console.log(response);\n    }\n};\nxhr.send();\n\n

Response Parameters

Data returned.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Data Type	Description
sourceID	String	Request URL source ID - ex. \"FACEBOOK\"
url	String	Request URL - ex. \"https://www.facebook.com/business-name\"

","urlObject":{"path":["request-urls"],"host":["{{baseUrl}}"],"query":[{"disabled":true,"description":{"content":"

(Required) Location id of request urls.

\n","type":"text/plain"},"key":"locationID","value":""},{"disabled":true,"description":{"content":"

Template name to use.

\n","type":"text/plain"},"key":"templateName","value":""},{"disabled":true,"description":{"content":"

Comma separated source ids of request urls.

\n","type":"text/plain"},"key":"sourceIDs","value":""}],"variable":[]}},"response":[{"id":"ae5b1bea-2e98-4803-9b20-9007392bcc1e","name":"Success","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"Your API key"}],"url":{"raw":"https://api.reputation.com/v3/request-urls?locationID=SA&sourceIDs=FACEBOOK","protocol":"https","host":["api","reputation","com"],"path":["v3","request-urls"],"query":[{"key":"locationID","value":"SA"},{"key":"templateName","value":"","disabled":true},{"key":"sourceIDs","value":"FACEBOOK"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"sourceID\": \"FACEBOOK\",\n \"url\": \"https://www.facebook.com/business-name\"\n }\n]"}],"_postman_id":"c2ee1cb9-8dcd-4592-845a-7de7f5080e48"}],"id":"73797b4d-425c-4f5c-bc0f-6da5878472ff","description":"

The Request URLs offers a set of endpoints aimed at managing and retrieving the URLs associated with various sources and locations on the Reputation platform.

\n","_postman_id":"73797b4d-425c-4f5c-bc0f-6da5878472ff"},{"name":"/Requests","item":[{"name":"Get Metrics","id":"dc09b373-371d-4e22-8c99-02c311d3f2bf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"x-api-key","value":""}],"url":"{{baseUrl}}/requests/metrics","description":"

Retrieve key metrics related to the request processes within the Reputation platform. This endpoint offers insight into request analytics segmented by various criteria such as mode, location, or requester role. It's tailored to provide a comprehensive view of request-related activities, ensuring users have the data needed to optimize their strategies and ensure effective engagement.

Sample

JavaScript XHR Request

var xhr = new XMLHttpRequest();\nxhr.open('GET', 'https://api.reputation.com/v3/requests/metrics?range=Last30Days&mode=Email&groupBy=LocationID', true);\nxhr.setRequestHeader('x-api-key', 'Your API key');\nxhr.onreadystatechange = function() {\n    // If the request completed successfully, handle the response\n    if (xhr.readyState === 4 && xhr.status === 200) {\n        var response = JSON.parse(xhr.responseText);\n        console.log(response);\n    }\n};\nxhr.send();\n\n

Response Parameters

Data returned.

Parameter Name	Type	Description
locationID	String	The identifier for the location, which can be any combination of letters and numbers. e.g., \"CH\", \"SA\", \"WW 124\"\"
mode	String	The mode of the request when grouping by mode.
requester	String	The role/type of the requester when grouped by requester - e.g. \"Admin\"
templateName	String	The name of the template when grouped by template name.
received	String	Total number of requests received.
sent	String	Total number of requests sent.
delivered	String	Total number of requests successfully delivered.
uniqueOpened	String	Number of requests opened by unique users.
opened	String	Total number of requests opened.
uniqueClicked	String	Number of requests uniquely clicked on.
clicked	String	Total number of requests clicked on.
deduped	String	Total number of requests deduplicated and not sent.
unsubscribes	String	Total number of users who clicked unsubscribe but did not complete the process.
failures	String	Total number of requests that failed to send.
dropped	String	Total number of requests dropped.
bounced	String	Total number of requests that bounced back.
spammed	String	Total number of requests marked as spam.
unsubscribed	String	Total number of users who successfully unsubscribed.

","urlObject":{"path":["requests","metrics"],"host":["{{baseUrl}}"],"query":[{"disabled":true,"description":{"content":"

Define the timeframe for which you want to fetch the metrics. Available values include: \"LifeToDate\", \"Last7Days\", \"Last30Days\", \"Last90Days\", \"Last6Months\", and \"Last1Year\". The default value, if not specified, is \"Last90Days\".

\n","type":"text/plain"},"key":"range","value":""},{"disabled":true,"description":{"content":"

(Required) Filter the metrics by the mode of the request. Valid values are: \"SMS\", \"Email\", \"Kiosk\", and \"All\". You can specify multiple modes using comma separation.

\n","type":"text/plain"},"key":"mode","value":""},{"disabled":true,"description":{"content":"

Determine which specific metrics you want to retrieve. Available metrics are: \"bounced\", \"clicked\", \"deduped\", \"delivered\", \"dropped\", \"failures\", \"opened\", \"received\", \"sent\", \"spammed\", \"uniqueClicked\", \"uniqueOpened\", \"unsubscribed\", and \"unsubscribes\". If not defined, all metrics will be returned by default. Filter multiple metrics using comma seperation.

\n","type":"text/plain"},"key":"metrics","value":""},{"disabled":true,"description":{"content":"

Define the criteria by which you want to group the returned metrics. Options are: \"LocationID\", \"Mode\", \"Requester\", \"TemplateName\", \"Day\", \"Week\", \"Month\", and \"Quarter\". Note that you can only specify one among \"Day\", \"Week\", \"Month\", or \"Quarter\". Tenant-specific filter names can also be used. The default grouping is by \"Month\" and \"LocationID\". Filter multiple groups using comma seperation.

\n","type":"text/plain"},"key":"groupBy","value":""},{"disabled":true,"description":{"content":"

When grouping by \"Requester\", you must specify the role IDs for which you want to fetch the metrics using comma separation.

\n","type":"text/plain"},"key":"requesterRoleIds","value":""},{"disabled":true,"description":{"content":"

Filter the metrics by specific location IDs. List multiple IDs using comma separation.

\n","type":"text/plain"},"key":"locationIDs","value":""}],"variable":[]}},"response":[{"id":"a101faf3-54cf-4ff2-b54b-ee5d0e1305f8","name":"Success","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"Your API key"}],"url":{"raw":"https://api.reputation.com/v3/requests/metrics?range=Last30Days&mode=Email&groupBy=LocationID","protocol":"https","host":["api","reputation","com"],"path":["v3","requests","metrics"],"query":[{"key":"range","value":"Last30Days"},{"key":"mode","value":"Email"},{"key":"metrics","value":"","disabled":true},{"key":"groupBy","value":"LocationID"},{"key":"requesterRoleIds","value":"dolor ut","disabled":true},{"key":"locationIDs","value":"dolor ut","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"640"},{"key":"etag","value":"W/\"280-GmOnkP/Mhu33XVKyzkeGtDWtFJ4\""},{"key":"date","value":"Mon, 16 Oct 2023 08:07:02 GMT"},{"key":"x-envoy-upstream-service-time","value":"97"},{"key":"server","value":"istio-envoy"},{"key":"Via","value":"1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"failures\": 0,\n \"unsubscribes\": 0,\n \"dropped\": 0,\n \"delivered\": 1,\n \"opened\": 2,\n \"received\": 1,\n \"uniqueOpened\": 1,\n \"bounced\": 0,\n \"clicked\": 0,\n \"sent\": 1,\n \"unsubscribed\": 0,\n \"spammed\": 0,\n \"uniqueClicked\": 0,\n \"deduped\": 0,\n \"locationID\": \"CH\"\n },\n {\n \"failures\": 0,\n \"unsubscribes\": 0,\n \"dropped\": 0,\n \"delivered\": 2,\n \"opened\": 4,\n \"received\": 2,\n \"uniqueOpened\": 2,\n \"bounced\": 0,\n \"clicked\": 0,\n \"sent\": 2,\n \"unsubscribed\": 0,\n \"spammed\": 0,\n \"uniqueClicked\": 0,\n \"deduped\": 0,\n \"locationID\": \"SA\"\n },\n {\n \"failures\": 0,\n \"unsubscribes\": 0,\n \"dropped\": 0,\n \"delivered\": 102,\n \"opened\": 52,\n \"received\": 102,\n \"uniqueOpened\": 48,\n \"bounced\": 0,\n \"clicked\": 0,\n \"sent\": 102,\n \"unsubscribed\": 0,\n \"spammed\": 0,\n \"uniqueClicked\": 0,\n \"deduped\": 0,\n \"locationID\": \"costco\"\n }\n]"}],"_postman_id":"dc09b373-371d-4e22-8c99-02c311d3f2bf"},{"name":"Get Request Urls","id":"cb60ac6d-d463-4e77-b325-e1313df5f1dc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"x-api-key","value":"Your API key"}],"url":"{{baseUrl}}/requests/request-urls","description":"

Retrieve specific request URLs associated with given parameters. This endpoint allows users to fetch URLs based on specified location IDs, optional template names, and source ID

A Request URL refers to a specific web address (or URL) associated with a certain platform, source, or service where reviews, feedback, or other user-generated content related to a business or entity can be found or requested.

Sample

JavaScript XHR Request

var xhr = new XMLHttpRequest();\nxhr.open('GET', 'https://api.reputation.com/v3/requests/request-urls?locationID=SA&sourceIDs=FACEBOOK', true);\nxhr.setRequestHeader('Accept', 'application/json');\nxhr.setRequestHeader('x-api-key', 'Your API key');\n\nxhr.onreadystatechange = function() {\n    if (xhr.readyState == 4 && xhr.status == 200) {\n        var response = JSON.parse(xhr.responseText);\n        console.log(response);\n    }\n};\n\nxhr.send();\n\n\n

Response Parameters

Data returned.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Data Type	Description
sourceID	String	Request URL source ID - ex. \"FACEBOOK\"
url	String	Request URL - ex. \"https://www.facebook.com/business-name\"

","urlObject":{"path":["requests","request-urls"],"host":["{{baseUrl}}"],"query":[{"disabled":true,"description":{"content":"

(Required) Location id of request urls

\n","type":"text/plain"},"key":"locationID","value":"SA"},{"disabled":true,"description":{"content":"

Template name to use. One of templateName or sourceIDs is required.

\n","type":"text/plain"},"key":"templateName","value":"Test_Template"},{"disabled":true,"description":{"content":"

Comma separated source ids of request urls. One of templateName or sourceIDs is required.

\n","type":"text/plain"},"key":"sourceIDs","value":"FACEBOOK"}],"variable":[]}},"response":[{"id":"73cd48f7-4d33-4f81-8459-03a17966b068","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"x-api-key","value":"Your API key"}],"url":{"raw":"{{baseUrl}}/requests/request-urls?locationID=SA&sourceIDs=FACEBOOK","host":["{{baseUrl}}"],"path":["requests","request-urls"],"query":[{"key":"locationID","value":"SA","description":"(Required) Location id of request urls"},{"key":"templateName","value":"Test_Template","description":"Template name to use. One of templateName or sourceIDs is required.","disabled":true},{"key":"sourceIDs","value":"FACEBOOK","description":"Comma separated source ids of request urls. One of templateName or sourceIDs is required."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"183"},{"key":"etag","value":"W/\"b7-aYucZtdWhugx312iRVFoqquRpvw\""},{"key":"date","value":"Mon, 16 Oct 2023 08:42:49 GMT"},{"key":"x-envoy-upstream-service-time","value":"50"},{"key":"server","value":"istio-envoy"},{"key":"Via","value":"1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"sourceID\": \"FACEBOOK\",\n \"url\": \"https://service.reputation.com/r?metrics=%7B%22lC%22%3A%22SA%22%7D&u=https%3A%2F%2Fwww.facebook.com%2F845842458799728&tk=f631eb0f561&sid=FACEBOOK&n=y\"\n }\n]"}],"_postman_id":"cb60ac6d-d463-4e77-b325-e1313df5f1dc"},{"name":"Send Email","id":"46f4ab8e-a96a-4b05-bde9-f0e1cde33cc0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"x-api-key","value":"Your API key"}],"body":{"mode":"raw","raw":"{\n \"id\": \"String\",\n \"templateName\": \"String\",\n \"from\": {\n \"name\": \"String\",\n \"email\": \"String\"\n },\n \"to\": {\n \"name\": \"String\",\n \"email\": \"String\",\n \"phone\": \"String\"\n },\n \"bcc\": {\n \"name\": \"String\",\n \"email\": \"String\",\n \"phone\": \"String\"\n },\n \"subject\": \"String\",\n \"sourceSelection\": \"String\",\n \"sourceIDs\": [\"String Array\"],\n \"excludedSourceIDs\": [\"String Array\"],\n \"locationID\": \"String\",\n \"variables\": [\n {\n \"name\": \"String\",\n \"value\": \"String\"\n }\n ]\n}\n","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/requests/send-email","description":"

Facilitates the sending of email requests, leveraging customizable templates and personalization through variables. The emails can be tailored based on location, sources, and other criteria.

Sample

JavaScript XHR Request

var xhr = new XMLHttpRequest();\nxhr.open('POST', 'https://api.reputation.com/v3/requests/send-email', true);\nxhr.setRequestHeader('Content-Type', 'application/json');\nxhr.setRequestHeader('x-api-key', 'Your API key');\nxhr.onreadystatechange = function() {\n    if (xhr.readyState == 4 && xhr.status == 200) {\n        var jsonResponse = JSON.parse(xhr.responseText);\n        console.log(jsonResponse);\n    }\n};\nvar data = JSON.stringify({\n    \"templateName\": \"Basic Template 1\",\n    \"locationID\": \"SA\",\n    \"from\": {\n        \"name\": \"Jane Smith\",\n        \"email\": \"janesmith@reputation.com\"\n    },\n    \"to\": {\n        \"name\": \"John Doe\",\n        \"email\": \"johndoe@customer.com\",\n        \"phone\": \"6501235678\"\n    },\n    \"sourceIDs\": [\"FACEBOOK\"],\n    \"variables\": [\n        {\n            \"name\": \"recipient-name\",\n            \"value\": \"John\"\n        },\n        {\n            \"name\": \"recipient-last\",\n            \"value\": \"Doe\"\n        }\n    ]\n});\nxhr.send(data);\n\n

Request Body Parameters

Below are descriptions for parameters included in the request body, accompanied by a sample of the raw JSON structure in the Body section below.

Parameter	Parent	Data Type	Description
id		String	Unique id for request.
templateName		String	Required. Request Template Name to use. Example: \"Basic Template 1\".
from		Object	Details of the person sending the request.
name	from	String	Name of the person sending request. Example: \"Jane Smith\".
email	from	String	Email address of the person sending request. Example: \"janesmith@gmail.com\".
to		Object	Required. Details of the person to whom the request is being sent.
name	to	String	Name of the person receiving the request. Example: \"John Doe\".
email	to	String	Required. Email of the person receiving request. Example: \"johndoe@gmail.com\".
phone	to	String	Phone of the person receiving request. Example: \"6501235678\".
bcc		Object	Details of the person to receive a blind copy of the request.
name	bcc	String	Name of the person receiving the request.
email	bcc	String	Required. Email of the person receiving the blind copy.
phone	bcc	String	Phone of the person receiving the blind copy.
subject		String	Subject of the email.
sourceSelection		String	Options: \"Auto\", \"Manual\", \"Template\". Defines which sources to include. Default is \"Template\".
sourceIDs		String	Source IDs to include in the request. Example: [\"FACEBOOK\"].
excludedSourceIDs		String	Source IDs to exclude from the request.
locationID		String	Required. Location ID of request. Example: \"346345\".
variables		Array	Custom variables for the request.
name	variables	String	Required. Name of the variable. Example: \"recipient-name\".
value	variables	String	Required. Value of the variable. Example: \"John\".

Response Parameters

The following is a table describing the data returned by this endpoint.

Parameter	Parent	Data Type	Description
id		String	Unique id for request. Example: \"b0c6a1c1-8ddc-4cc4-b552-7d29fd991e66\".
type		String	Denotes the request type. Example: \"Email\".
templateName		String	Name of the request template used. Example: \"Basic Template 1\".
from		Object	Details about the sender.
name	from	String	Name of the person sending the request. Example: \"Jane Smith\".
email	from	String	Email of the person sending the request. Example: \"janesmith@reputation.com\".
to		Object	Details about the receiver.
name	to	String	Name of the person receiving the request. Example: \"j**\".
email	to	String	Email of the person receiving the request. Example: \"j**\".
subject		String	Subject of the email. Example: \"Reviewing Simple Art\".
sourceSelection		String	Source selection method. Example: \"Auto\".
sourceIDs		Array	Array of source IDs to include in the request. Example: [\"FACEBOOK\"].
excludedSourceIDs		Array	Array of source IDs to exclude from the request. Example: null.
locationID		String	Location ID associated with the request. Example: \"SA\".
variables		Object	Custom variables associated with the request.
[Variable Name]	variables	String	The name and corresponding value of the variable. Examples: \"recipient-name\": \"John\", \"recipient-last\": \"Doe\".

","urlObject":{"path":["requests","send-email"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"154a4fe6-2efd-4cd3-a2c0-4fad73d54c29","name":"Send Email","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"Your API key"}],"body":{"mode":"raw","raw":"{\n \"templateName\": \"Basic Template 1\",\n \"locationID\": \"SA\",\n \"from\": {\n \"name\": \"Jane Smith\",\n \"email\": \"janesmith@reputation.com\"\n },\n \"to\": {\n \"name\": \"John Doe\",\n \"email\": \"johndoe@customer.com\",\n \"phone\": \"6501235678\"\n },\n \"sourceIDs\": [\n \"FACEBOOK\"\n ],\n \"variables\": [\n {\n \"name\": \"recipient-name\",\n \"value\": \"John\"\n },\n {\n \"name\": \"recipient-last\",\n \"value\": \"Doe\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.reputation.com/v3/requests/send-email","protocol":"https","host":["api","reputation","com"],"path":["v3","requests","send-email"],"query":[{"key":"","value":"","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"403"},{"key":"etag","value":"W/\"193-o37RF5aLqYdOQ1ibmaYQzaEAmyI\""},{"key":"date","value":"Mon, 16 Oct 2023 08:54:24 GMT"},{"key":"x-envoy-upstream-service-time","value":"148"},{"key":"server","value":"istio-envoy"},{"key":"Via","value":"1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"b0c6a1c1-8ddc-4cc4-b552-7d29fd991e66\",\n \"type\": \"Email\",\n \"templateName\": \"Basic Template 1\",\n \"from\": {\n \"name\": \"Jane Smith\",\n \"email\": \"janesmith@reputation.com\"\n },\n \"to\": {\n \"name\": \"j**************\",\n \"email\": \"j**************\"\n },\n \"subject\": \"Reviewing Simple Art\",\n \"sourceSelection\": \"Auto\",\n \"sourceIDs\": [\n \"FACEBOOK\"\n ],\n \"excludedSourceIDs\": null,\n \"locationID\": \"SA\",\n \"variables\": {\n \"recipient-last\": \"Doe\",\n \"recipient-name\": \"John\"\n }\n}"}],"_postman_id":"46f4ab8e-a96a-4b05-bde9-f0e1cde33cc0"},{"name":"Send SMS","id":"b8217aa2-b325-4d24-b0a0-579ffd93d325","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"x-api-key","value":"Your API key"}],"body":{"mode":"raw","raw":"{\n \"id\": \"String\",\n \"templateName\": \"String\",\n \"to\": {\n \"name\": \"String\",\n \"email\": \"String\",\n \"phone\": \"String\"\n },\n \"sourceSelection\": \"String\",\n \"sourceIDs\": [\"String Array\"],\n \"excludedSourceIDs\": [\"String Array\"],\n \"locationID\": \"String\",\n \"variables\": [\n {\n \"name\": \"String\",\n \"value\": \"String\"\n }\n ]\n}\n","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/requests/send-sms","description":"

Send an SMS request to a client. By using specific templates and defining the recipient, you can send tailored SMS messages to your desired audience.

Sample

JavaScript XHR Request

var xhr = new XMLHttpRequest();\nxhr.open('POST', 'https://api.reputation.com/v3/requests/send-sms', true);\nxhr.setRequestHeader('x-api-key', 'Your API key');\nxhr.setRequestHeader('Content-Type', 'application/json');\nxhr.onreadystatechange = function() {\n  if (xhr.readyState == 4 && xhr.status == 200) {\n    var response = JSON.parse(xhr.responseText);\n    console.log(response);\n  }\n};\nvar data = JSON.stringify({\n  \"templateName\": \"Basic Template 1\",\n  \"locationID\": \"SA\",\n  \"to\": {\n    \"name\": \"John Doe\",\n    \"email\": \"johndoe@customer.com\",\n    \"phone\": \"78553863263\"\n  },\n  \"sourceIDs\": [\"FACEBOOK\"],\n  \"variables\": [\n    {\n      \"name\": \"recipient-name\",\n      \"value\": \"John\"\n    },\n    {\n      \"name\": \"recipient-last\",\n      \"value\": \"Doe\"\n    }\n  ]\n});\nxhr.send(data);\n\n

Request Body Parameters

Below are descriptions for parameters included in the request body, accompanied by a sample of the raw JSON structure in the Body section below.

\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\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Parent	Data Type	Description
id		String	A unique identifier for the request.
templateName		String	The name of the request template to be used. For instance, if the template is overridden at the Tenant or Location level, that specific template will be utilized. Example: \"Basic Template 1\".
to		Object	Specifies the recipient's details.
name	to	String	The name of the individual receiving the request. Example: \"John Doe\".
email	to	String	The email address of the individual receiving the request. Example: \"johndoe@gmail.com\".
phone	to	String	The phone number where the SMS will be sent. It's a required field. Example: \"6501235678\".
sourceSelection		String	Method to determine which sources to include. Options are \"Auto\", \"Manual\", and \"Template\". The default selection is \"Template\".
sourceIDs		Array	A list of source IDs to be included in the request. Example: [\"FACEBOOK\"].
excludedSourceIDs		Array	A list of source IDs to be excluded from the request.
locationID		String	The location ID associated with the request. Example: \"346345\".
variables		Object	Defines custom variables for the request.
name	variables	String	The specific name of the custom variable. Example: \"recipient-name\".
value	variables	String	The corresponding value of the custom variable. Example: \"John\".

Response Parameters

The following is a table describing the data returned by this endpoint.

\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\n\n\n\n\n

Parameter	Parent	Data Type	Description
id		String	Unique id for request. Example: \"75634d4e-9b5b-449f-83f5-da3b3283764d\"
type		String	Denotes the request type. Example: \"SMS\"
templateName		String	Request Template Name to use. Example: \"Basic Template 1\"
to		Object	Object containing recipient's details
name	to	String	Name of the person receiving request. Example: \"j**\"
phone	to	String	Phone number of the person receiving request. Example: \"+**\"
sourceSelection		String	Which sources to include? Example: \"Auto\"
sourceIDs		Array	List of Source IDs to include in the request. Example: [\"FACEBOOK\"]
excludedSourceIDs		Array	List of Source IDs to exclude from the request. Can be null.
locationID		String	Location ID of the request. Example: \"SA\"
variables		Object	Custom variables for the request. Example: {\"recipient-name\": \"John\", \"recipient-last\": \"Doe\"}

","urlObject":{"path":["requests","send-sms"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"eaeca224-fe7b-4487-beef-9429c378e22d","name":"Success","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"Your API key"}],"body":{"mode":"raw","raw":"{\n \"templateName\": \"Basic Template 1\",\n \"locationID\": \"SA\",\n \"to\": {\n \"name\": \"John Doe\",\n \"email\": \"johndoe@customer.com\",\n \"phone\": \"78553863263\"\n },\n \"sourceIDs\": [\n \"FACEBOOK\"\n ],\n \"variables\": [\n {\n \"name\": \"recipient-name\",\n \"value\": \"John\"\n },\n {\n \"name\": \"recipient-last\",\n \"value\": \"Doe\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.reputation.com/v3/requests/send-sms"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"304"},{"key":"etag","value":"W/\"130-tGOVKonueR+hPsgGz28t6QEKsKg\""},{"key":"date","value":"Mon, 16 Oct 2023 09:36:52 GMT"},{"key":"x-envoy-upstream-service-time","value":"254"},{"key":"server","value":"istio-envoy"},{"key":"Via","value":"1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"75634d4e-9b5b-449f-83f5-da3b3283764d\",\n \"type\": \"SMS\",\n \"templateName\": \"Basic Template 1\",\n \"to\": {\n \"name\": \"j**************\",\n \"phone\": \"+**************\"\n },\n \"sourceSelection\": \"Auto\",\n \"sourceIDs\": [\n \"FACEBOOK\"\n ],\n \"excludedSourceIDs\": null,\n \"locationID\": \"SA\",\n \"variables\": {\n \"recipient-last\": \"Doe\",\n \"recipient-name\": \"John\"\n }\n}"}],"_postman_id":"b8217aa2-b325-4d24-b0a0-579ffd93d325"},{"name":"Unsubscribe Email","id":"32557391-1859-4d2c-8b24-6fbd785b20f4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"x-api-key","value":""}],"body":{"mode":"raw","raw":"{\n \"email\": \"String\"\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/requests/unsubscribe-email","description":"

Unsubscribe a client's email from your marketing. Once requested the email address will no longer recieve emails.

Sample

JavaScript XHR Request

var xhr = new XMLHttpRequest();\nxhr.open(\"POST\", \"https://api.reputation.com/v3/requests/unsubscribe-email\", true);\nxhr.setRequestHeader(\"Content-Type\", \"application/json;charset=UTF-8\");\nxhr.setRequestHeader(\"x-api-key\", \"Your API key\");\nxhr.onreadystatechange = function() {\n  if (xhr.readyState == 4 && xhr.status == 200) {\n    console.log(xhr.responseText);\n  }\n};\nvar data = {\n  email: \"john@doe.com\"\n};\nxhr.send(JSON.stringify(data));\n\n

Request Body Parameters

Below are descriptions for parameters included in the request body, accompanied by a sample of the raw JSON structure in the Body section below.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Data Type	Description
email	String	The email address to be unsubscribed. Example: \"john@doe.com\"

Response Parameters

The following is a table describing the data returned by this endpoint.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Data Type	Description
email	String	The email address unsubscribed. Example: \"john@doe.com\"

","urlObject":{"path":["requests","unsubscribe-email"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"a3008574-947d-4e83-9149-5cce7227ad04","name":"Success","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"Your API key"}],"body":{"mode":"raw","raw":"{\n \"email\": \"john@doe.com\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.reputation.com/v3/requests/unsubscribe-email"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"24"},{"key":"etag","value":"W/\"18-I9hRbkB/t441uui5lOoEdDAb8dA\""},{"key":"date","value":"Mon, 16 Oct 2023 10:01:57 GMT"},{"key":"x-envoy-upstream-service-time","value":"124"},{"key":"server","value":"istio-envoy"},{"key":"Via","value":"1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"email\": \"john@doe.com\"\n}"}],"_postman_id":"32557391-1859-4d2c-8b24-6fbd785b20f4"},{"name":"Unsubscribe Phone","id":"4b6ef9de-7ab1-4919-bd0d-ffcbe3ac9738","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"x-api-key","value":""}],"body":{"mode":"raw","raw":"{\n \"phone\": \"String\"\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/requests/unsubscribe-phone","description":"

Unsubscribe a client's phone number from your marketing. Once requested the phone number will no longer recieve SMSs.

Sample

JavaScript XHR Request

var xhr = new XMLHttpRequest();\nxhr.open(\"POST\", \"https://api.reputation.com/v3/requests/unsubscribe-phone\", true);\nxhr.setRequestHeader(\"Content-Type\", \"application/json;charset=UTF-8\");\nxhr.setRequestHeader(\"x-api-key\", \"Your API key\");\nxhr.onreadystatechange = function() {\n  if (xhr.readyState == 4 && xhr.status == 200) {\n    console.log(xhr.responseText);\n  }\n};\nvar data = {\n  phone: \"+16501237890\"\n};\nxhr.send(JSON.stringify(data));\n\n

Request Body Parameters

Below are descriptions for parameters included in the request body, accompanied by a sample of the raw JSON structure in the Body section below.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Data Type	Description
phone	String	The phone number to be unsubscribed in E.164 format. Example: \"+16501237890\"

Response Parameters

The following is a table describing the data returned by this endpoint.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Data Type	Description
email	String	The phone number that was unsubscribed. Example: \"+16501237890\"

","urlObject":{"path":["requests","unsubscribe-phone"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"f2aa3575-8548-40ba-8613-146b0dcc11ed","name":"Success","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"Your API key"}],"body":{"mode":"raw","raw":"{\n \"phone\": \"+16501237890\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.reputation.com/v3/requests/unsubscribe-phone"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"24"},{"key":"etag","value":"W/\"18-dlO7A/7p+dbJTu7eepND0xpH+J0\""},{"key":"date","value":"Mon, 16 Oct 2023 10:16:27 GMT"},{"key":"x-envoy-upstream-service-time","value":"192"},{"key":"server","value":"istio-envoy"},{"key":"Via","value":"1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"phone\": \"+16501237890\"\n}"}],"_postman_id":"4b6ef9de-7ab1-4919-bd0d-ffcbe3ac9738"},{"name":"Get Unsubscribes","id":"63e8429c-d55b-45de-9fe6-2d9266e71f59","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"x-api-key","value":"Your API key"}],"url":"{{baseUrl}}/requests/unsubscribes","description":"

Retrieve a list of unsubscribes based on a specified date range and pagination constraints. This endpoint is useful for monitoring customers who have opted out of communications, whether via email or phone.

Sample

JavaScript XHR Request

var xhr = new XMLHttpRequest();\nxhr.open('GET', 'https://api.reputation.com/v3/requests/unsubscribes?offset=0&limit=20', true);\nxhr.setRequestHeader('x-api-key', 'Your API key');\nxhr.onreadystatechange = function() {\n    if (xhr.readyState == 4 && xhr.status == 200) {\n        var jsonResponse = JSON.parse(xhr.responseText);\n        console.log(jsonResponse);\n    }\n};\nxhr.send();\n\n

Response Parameters

The following is a table describing the data returned by this endpoint.

\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

Parameter	Parent	Data Type	Description
unsubscribes	-	Object	An array containing details of unsubscribed entities.
customerID	unsubscribes	String	Unique identifier for the customer. Can be null. Example: null
email	unsubscribes	String	Email address that was unsubscribed. Can be null. Example: \"john@doe.com\" or null
phone	unsubscribes	String	Phone number that was unsubscribed. Can be null. Example: \"+16501237890\" or null
date	unsubscribes	String	Date when the unsubscribe action occurred in Datetime ISO 8601 format. Example: \"2023-10-16T03:16:27\"
paging	-	Object	Contains details about the pagination of the result. Example: { \"offset\": 0, \"limit\": 20 }
offset	paging	Integer	This offsets the start of each page by the number specified. Example: 0
limit	paging	Integer	Maximum number of objects returned for the query. Example: 20

","urlObject":{"path":["requests","unsubscribes"],"host":["{{baseUrl}}"],"query":[{"disabled":true,"description":{"content":"

Specifies the date range for which unsubscribes will be retrieved.\nValid Values: \"Today\", \"Yesterday\", \"ThisWeek\", \"PreviousWeek\", \"ThisMonth\", \"PreviousMonth\", \"ThisQuarter\", \"PreviousQuarter\", \"ThisYear\", \"PreviousYear\", \"YearToDate\", \"LifeToDate\", \"Last7Days\", \"Last30Days\", \"Last60Days\", \"Last90Days\", \"Last6Months\", \"Last1Year\", \"Last2Years\", \"Last3Years\"

\n","type":"text/plain"},"key":"range","value":""},{"disabled":true,"description":{"content":"

Offsets the start of each page by the specified number. This is useful for paginating through larger datasets. The maximum allowed offset is 100k.

\n","type":"text/plain"},"key":"offset","value":""},{"disabled":true,"description":{"content":"

Limits the number of results that may be returned. Though the query may return fewer results due to filtering, the default limit is set to 20, with a maximum permissible limit of 2000.

\n","type":"text/plain"},"key":"limit","value":""}],"variable":[]}},"response":[{"id":"80971ea1-e570-4a3a-8838-bf084d0759ff","name":"Success","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"Your API key"}],"url":{"raw":"https://api.reputation.com/v3/requests/unsubscribes?offset=0&limit=20","protocol":"https","host":["api","reputation","com"],"path":["v3","requests","unsubscribes"],"query":[{"key":"range","value":"","description":"Specifies the date range for which unsubscribes will be retrieved.\nValid Values: \"Today\", \"Yesterday\", \"ThisWeek\", \"PreviousWeek\", \"ThisMonth\", \"PreviousMonth\", \"ThisQuarter\", \"PreviousQuarter\", \"ThisYear\", \"PreviousYear\", \"YearToDate\", \"LifeToDate\", \"Last7Days\", \"Last30Days\", \"Last60Days\", \"Last90Days\", \"Last6Months\", \"Last1Year\", \"Last2Years\", \"Last3Years\"","disabled":true},{"key":"offset","value":"0","description":"Offsets the start of each page by the specified number. This is useful for paginating through larger datasets. The maximum allowed offset is 100k."},{"key":"limit","value":"20","description":"Limits the number of results that may be returned. Though the query may return fewer results due to filtering, the default limit is set to 20, with a maximum permissible limit of 2000."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"221"},{"key":"etag","value":"W/\"dd-1FnRQPeYQb4b/H9hRaEoNiy24us\""},{"key":"date","value":"Mon, 16 Oct 2023 10:33:28 GMT"},{"key":"x-envoy-upstream-service-time","value":"67"},{"key":"server","value":"istio-envoy"},{"key":"Via","value":"1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"unsubscribes\": [\n {\n \"customerID\": null,\n \"email\": null,\n \"phone\": \"+16501237890\",\n \"date\": \"2023-10-16T03:16:27\"\n },\n {\n \"customerID\": null,\n \"email\": \"john@doe.com\",\n \"phone\": null,\n \"date\": \"2023-10-16T03:01:57\"\n }\n ],\n \"paging\": {\n \"offset\": 0,\n \"limit\": 20\n }\n}"}],"_postman_id":"63e8429c-d55b-45de-9fe6-2d9266e71f59"},{"name":"Get Request Templates","id":"fe34da1a-fda2-48c1-b065-c6c4b7c9d23b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":""}],"url":"{{baseUrl}}/requests/templates","description":"

This endpoint allows you to retrieve a list of available request templates based on the specified template type. The request templates define preset formats and structures for various types of requests such as Kiosk, Request Review, or SMS. By passing the appropriate templateType parameter, you can filter out the templates that match the desired type.

Sample

JavaScript XHR Request

var xhr = new XMLHttpRequest();\n\nxhr.open('GET', 'https://api.reputation.com/v3/requests/templates?templateType=3', true);\nxhr.setRequestHeader('x-api-key', 'Your API key');\n\nxhr.onreadystatechange = function() {\n    if (xhr.readyState == 4 && xhr.status == 200) {\n        var response = JSON.parse(xhr.responseText);\n        console.log(response);\n    }\n};\n\nxhr.send();\n\n\n

Response Parameters

The following is a table describing the data returned by this endpoint.

\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

Parameter	Parent	Data Type	Description
requestTemplates	-	Object	Object containing template information.
id	requestTemplates	String (hexadecimal)	System-generated ID representing the Request template. For example, \"5ba908637b7b4704d80f2f2f\".
templateName	requestTemplates	String	Name of the Request Template. For example, \"BRP Appointment Reminder\".
templateType	requestTemplates	String	Type of the request template, such as SMS, Email, or Kiosk. For instance, \"SMS\".
templateLevel	requestTemplates	String	Level of the request template, which can be System, Tenant, or Location. Example: \"Tenant\".
createdDate	requestTemplates	Integer (int64)	Date in milliseconds when the Request template was created. Example: 0 denotes the Unix epoch.

","urlObject":{"path":["requests","templates"],"host":["{{baseUrl}}"],"query":[{"disabled":true,"description":{"content":"

Template type of Request Template to retrieve. Options are '1' for Kiosk, '2' for Request Review, and '3' for SMS. For example, '2' corresponds to \"Request Review\".

\n","type":"text/plain"},"key":" templateType","value":""}],"variable":[]}},"response":[{"id":"ab850564-1e88-4969-b66a-28a96b400a1f","name":"Success","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"Your API key"}],"url":{"raw":"https://api.reputation.com/v3/requests/templates?templateType=3","protocol":"https","host":["api","reputation","com"],"path":["v3","requests","templates"],"query":[{"key":"templateType","value":"3","description":"Template type of Request Template to retrieve. Valid valuues: \"'1' for Kiosk\"\"'2' for Request Review\"\"'3' for SMS\""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"5138"},{"key":"etag","value":"W/\"1412-8x0+zn1ejvWx7W9FIc5REGGhw+c\""},{"key":"date","value":"Mon, 16 Oct 2023 10:54:21 GMT"},{"key":"x-envoy-upstream-service-time","value":"108"},{"key":"server","value":"istio-envoy"},{"key":"Via","value":"1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"requestTemplates\": [\n {\n \"id\": \"5ba908637b7b4704d80f2f2f\",\n \"templateName\": \"BRP Appointment Reminder\",\n \"templateType\": \"SMS\",\n \"createdDate\": 0,\n \"templateLevel\": \"Tenant\"\n },\n {\n \"id\": \"60592439671227085d4dc6dc\",\n \"templateName\": \"Conversational Request\",\n \"templateType\": \"SMS\",\n \"createdDate\": 0,\n \"templateLevel\": \"System\"\n }\n ]\n}\n"}],"_postman_id":"fe34da1a-fda2-48c1-b065-c6c4b7c9d23b"}],"id":"c72ddb2c-ea62-4a74-a34d-3f26dfa59ec2","description":"

The Requests API collection offers a suite of endpoints designed to handle various communication requests. It facilitates the process of sending tailored communications, such as emails and SMS messages, while also providing the ability to manage user preferences, like unsubscribing from email communications. Key functionalities include Send Email, Send SMS, and Unsubscribe Email, ensuring that businesses can effectively engage with their audience while respecting their communication preferences.

\n","_postman_id":"c72ddb2c-ea62-4a74-a34d-3f26dfa59ec2"},{"name":"/Reviews","item":[{"name":"Get Reviews","id":"3d49e7e1-2b16-45f2-8211-22d0cbb0082d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"x-api-key","value":"Your API key"}],"url":"{{baseUrl}}/reviews","description":"

Retrieves a list of reviews based on various filter criteria. This endpoint allows for a wide range of parameters to narrow down and organize the list of reviews, providing flexibility to retrieve reviews from different time periods, sources, locations, and more.

Sample

JavaScript XHR Request

var xhr = new XMLHttpRequest();\nxhr.open('GET', 'https://api.reputation.com/v3/reviews?range=PreviousWeek&offset=0&limit=3', true);\nxhr.setRequestHeader('x-api-key', 'Your API key');\nxhr.onreadystatechange = function() {\n    // If the request is complete\n    if (xhr.readyState == 4) {\n        // If the request was successful\n        if (xhr.status == 200) {\n            console.log(xhr.responseText);\n        } else {\n            console.error('Request failed with status:', xhr.status);\n        }\n    }\n};\nxhr.send();\n\n

Response Parameters

The following is a table describing the data returned by this endpoint.

Parameter	Parent	Data Type	Description
reviews	-	object	Array of reviews.
id	reviews	string	Unique identifier for the review.
tenantID	reviews	string	Tenant identifier. Modifiable only when creating a location.
locationID	reviews	string	Identifier for the location.
sourceID	reviews	string	Identifier for the source.
url	reviews	string	URL of the review.
date	reviews	string	Date of the review in ISO 8601 format.
reviewer	reviews	object	Details of the reviewer.
name	reviewer	string	Name of the reviewer.
rating	reviews	number	Rating given by the reviewer on the review site.
normalizedRating	reviews	number	Rating normalized to a scale of 1.
sentiment	reviews	string	Review sentiment. Values: Positive, Negative, Neutral, None.
commentTitle	reviews	string	Title of the review comment.
comment	reviews	string	Body of the review comment.
published	reviews	boolean	Indicates if the review is published.
canRespond	reviews	boolean	Indicates if a response can be made to the review.
hasResponses	reviews	boolean	Indicates if the review already has responses.
responseUrl	reviews	string	URL for responding to the review. Exists only if a response can be made.
reviewUrl	reviews	string	URL to read the full review.
categories	reviews	string array	Categories associated with the review.
updated	reviews	boolean	Indicates if the review has been updated.
paging	-	Paging	Pagination details.
offset	paging	integer	The starting point of the page based on the offset value.
limit	paging	integer	Maximum number of objects returned. Can be fewer due to filtering.
previous	paging	string	API endpoint returning the previous page of data. Absent if this is the first page.
next	paging	string	API endpoint returning the next page of data. Absent if this is the last page.

","urlObject":{"path":["reviews"],"host":["{{baseUrl}}"],"query":[{"disabled":true,"description":{"content":"

Specifies the starting date for the review search. The date should be in ISO 8601 format.

\n","type":"text/plain"},"key":"from","value":""},{"disabled":true,"description":{"content":"

Specifies the ending date for the review search. The date should be in ISO 8601 format.

\n","type":"text/plain"},"key":"to","value":""},{"disabled":true,"description":{"content":"

Specifies a predefined date range for retrieving reviews. Valid Values:\n\"Today\", \"Yesterday\", \"ThisWeek\", \"PreviousWeek\", \"ThisMonth\", \"PreviousMonth\", \"ThisQuarter\", \"PreviousQuarter\", \"ThisYear\", \"PreviousYear\", \"YearToDate\", \"LifeToDate\", \"Last7Days\", \"Last30Days\", \"Last60Days\", \"Last90Days\", \"Last6Months\", \"Last1Year\", \"Last2Years\", \"Last3Years\"

\n","type":"text/plain"},"key":"range","value":""},{"disabled":true,"description":{"content":"

Comma-separated list of source IDs to filter the reviews by.

\n","type":"text/plain"},"key":"sourceID","value":""},{"disabled":true,"description":{"content":"

Comma-separated list of location IDs to filter the reviews by.

\n","type":"text/plain"},"key":"locationID","value":""},{"disabled":true,"description":{"content":"

Offsets the start of each page by the number specified, useful for pagination. Maximum offset value is 100,000.

\n","type":"text/plain"},"key":"offset","value":""},{"disabled":true,"description":{"content":"

Determines the maximum number of review objects that may be returned in the response. The actual number of returned reviews may be less than this value due to filtering. The default value is 20, and the maximum allowed limit is 2,000.

\n","type":"text/plain"},"key":"limit","value":""},{"disabled":true,"description":{"content":"

Specifies the fields by which the results should be sorted. Multiple fields can be separated by commas, and the sort order for each field is designated by appending the field name with a colon and the order (ASC or DESC).\nExample: \"date:ASC\"

\n","type":"text/plain"},"key":"sort","value":""}],"variable":[]}},"response":[{"id":"86859c7d-884c-4d8d-a799-87bb79e9f749","name":"Success","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"Your API key"}],"url":{"raw":"https://api.reputation.com/v3/reviews?range=PreviousWeek&offset=0&limit=3","protocol":"https","host":["api","reputation","com"],"path":["v3","reviews"],"query":[{"key":"from","value":"2001-06-17T15:40:12.790Z","disabled":true},{"key":"to","value":"2001-06-17T15:40:12.790Z","disabled":true},{"key":"range","value":"PreviousWeek"},{"key":"sourceID","value":"FACEBOOK","disabled":true},{"key":"locationID","value":"SA","disabled":true},{"key":"offset","value":"0"},{"key":"limit","value":"3"},{"key":"sort","value":"dolor ut","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"3483"},{"key":"etag","value":"W/\"d9b-37bff5zhv8ol8VXVq6i9eSur2XI\""},{"key":"date","value":"Mon, 16 Oct 2023 11:30:50 GMT"},{"key":"x-envoy-upstream-service-time","value":"579"},{"key":"server","value":"istio-envoy"},{"key":"Via","value":"1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"reviews\": [\n {\n \"id\": \"DEALER_RATER.TmWnT_Usk12NtV4Axr2rMA.11331749\",\n \"tenantID\": \"TXR123\",\n \"locationID\": \"WF\",\n \"locationName\": \"AutoNation Toyota Spokane Valley\",\n \"sourceID\": \"DEALER_RATER\",\n \"url\": \"http://www.dealerrater.com/dealer/AutoNation-Toyota-Spokane-Valley-Service-Center-review-875/\",\n \"date\": \"2023-10-14T00:00:00\",\n \"reviewer\": {\n \"name\": \"aemami\"\n },\n \"rating\": 1,\n \"normalizedRating\": 0.2,\n \"sentiment\": \"Negative\",\n \"commentTitle\": \"Disappointed with the Appointment Process\",\n \"comment\": \"I scheduled an appointment to buy the car. However, shortly before my visit, they informed me that someone else had reserved the car. It felt like they used my interest to pressure someone else to purchase. Very unprofessional. I won't be returning.\",\n \"published\": false,\n \"canRespond\": true,\n \"hasResponses\": false,\n \"responseUrl\": null,\n \"reviewUrl\": \"http://www.dealerrater.com/dealer/AutoNation-Toyota-Spokane-Valley-Service-Center-review-875/#link\",\n \"categories\": [\n \"Customer Service\",\n \"Sales\",\n \"Salesperson\"\n ],\n \"attributions\": null,\n \"updated\": false\n },\n {\n \"id\": \"DEALER_RATER.TmWnT_Usk12NtV4Axr2rMA.11333510\",\n \"tenantID\": \"TXR124\",\n \"locationID\": \"WF\",\n \"locationName\": \"AutoNation Toyota Spokane Valley\",\n \"sourceID\": \"DEALER_RATER\",\n \"url\": \"http://www.dealerrater.com/dealer/AutoNation-Toyota-Spokane-Valley-Service-Center-review-875/\",\n \"date\": \"2023-10-14T00:00:00\",\n \"reviewer\": {\n \"name\": \"Craigf68\"\n },\n \"rating\": 5,\n \"normalizedRating\": 1,\n \"sentiment\": \"Positive\",\n \"commentTitle\": \"Exceptional Salesperson Experience\",\n \"comment\": \"Our experience was highlighted by our salesperson, Sawyer. He was knowledgeable, sincere, and truly looked out for our best interests. He made the car buying process smooth and memorable. I highly recommend them.\",\n \"published\": false,\n \"canRespond\": true,\n \"hasResponses\": false,\n \"responseUrl\": null,\n \"reviewUrl\": \"http://www.dealerrater.com/dealer/AutoNation-Toyota-Spokane-Valley-Service-Center-review-875/#link\",\n \"categories\": [\n \"Customer Service\",\n \"Sales\",\n \"Salesperson\"\n ],\n \"attributions\": null,\n \"updated\": false\n },\n {\n \"id\": \"DEALER_RATER.TmWnT_Usk12NtV4Axr2rMA.11333362\",\n \"tenantID\": \"TXR125\",\n \"locationID\": \"WF\",\n \"locationName\": \"AutoNation Toyota Spokane Valley\",\n \"sourceID\": \"DEALER_RATER\",\n \"url\": \"http://www.dealerrater.com/dealer/AutoNation-Toyota-Spokane-Valley-Service-Center-review-875/\",\n \"date\": \"2023-10-14T00:00:00\",\n \"reviewer\": {\n \"name\": \"Debbiedooda\"\n },\n \"rating\": 5,\n \"normalizedRating\": 1,\n \"sentiment\": \"Positive\",\n \"commentTitle\": \"Efficient and Transparent Service\",\n \"comment\": \"Adam was our point of contact and he kept us in the loop throughout the entire process. His professionalism and straightforward approach made our transaction very smooth. Highly satisfied.\",\n \"published\": false,\n \"canRespond\": true,\n \"hasResponses\": false,\n \"responseUrl\": null,\n \"reviewUrl\": \"http://www.dealerrater.com/dealer/AutoNation-Toyota-Spokane-Valley-Service-Center-review-875/#link\",\n \"categories\": [\n \"Customer Service\",\n \"Sales\",\n \"Salesperson\"\n ],\n \"attributions\": null,\n \"updated\": false\n }\n ],\n \"paging\": {\n \"offset\": 0,\n \"limit\": 3,\n \"next\": \"https://api.reputation.com/v3/reviews?offset=3&limit=3&range=PreviousWeek\"\n },\n \"dateRange\": {\n \"range\": \"PreviousWeek\",\n \"from\": \"2023-10-08T00:00:00\",\n \"to\": \"2023-10-14T23:59:59\"\n }\n}\n"}],"_postman_id":"3d49e7e1-2b16-45f2-8211-22d0cbb0082d"},{"name":"Get Review Responses","id":"db37a8b0-cd84-4342-92cd-0f6885434565","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"{{baseUrl}}/reviews/:reviewID/responses","description":"

This endpoint retrieves responses associated with a specific review from the Reputation.com API. Each review in the system has a unique identifier known as a reviewID. By providing this ID in the endpoint, you can fetch the associated responses given to that review, whether they are public comments or private messages. The data returned includes the name of the responder, their comment, the type of response (public or private), and the date of the response.

Sample

JavaScript XHR Request

var xhr = new XMLHttpRequest();\nxhr.open('GET', 'https://api.reputation.com/v3/reviews/DEALER_RATER.TmWnT_Usk12NtV4Axr2rMA.11331749/responses?offset=0&limit=25', true);\nxhr.setRequestHeader('x-api-key', 'Your API key');\nxhr.onreadystatechange = function() {\n    if (xhr.readyState == 4 && xhr.status == 200) {\n        var response = JSON.parse(xhr.responseText);\n        console.log(response);\n    }\n};\nxhr.send();\n\n

Response Parameters

The following is a table describing the data returned by this endpoint.

\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

Parameter	Parent	Data Type	Description
responses	-	Object	Responses related to a particular review.
name	responses	string	Name of the individual or entity who responded.
comment	responses	string	Message or comment given as a response to a review.
privateMsg	responses	boolean	Indicates if the response is private or can be viewed by the public.
responseDate	responses	string	The date and time when the response was made, formatted in ISO 8601 standard.
paging	-	Object	Provides pagination details for the list of responses.
offset	paging	integer	Specifies the starting point from which the results are displayed.
limit	paging	integer	The maximum number of response objects that can be returned. It may return fewer due to filtering or limited data.
previous	paging	string	API endpoint that will return the previous page of data. Not included if it's the first page.
next	paging	string	API endpoint that will return the next page of data. Not included if it's the last page.

","urlObject":{"path":["reviews",":reviewID","responses"],"host":["{{baseUrl}}"],"query":[{"disabled":true,"description":{"content":"

Offsets the start of each page by the number specified, useful for pagination.

\n","type":"text/plain"},"key":"offset","value":""},{"disabled":true,"description":{"content":"

Determines the maximum number of review objects that may be returned in the response.

\n","type":"text/plain"},"key":"limit","value":""},{"disabled":true,"key":"","value":""},{"disabled":true,"key":"","value":""}],"variable":[{"description":{"content":"

(Required) A unique identifier for each review in the system. It serves as a reference to fetch specific review details or associated responses.

\n","type":"text/plain"},"type":"any","value":"","key":"reviewID"}]}},"response":[{"id":"c71251d8-a7e6-4e2d-92f6-2635b6dff36f","name":"Success","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"Your API key"}],"url":{"raw":"https://api.reputation.com/v3/reviews/:reviewID/responses?offset=0&limit=25","protocol":"https","host":["api","reputation","com"],"path":["v3","reviews",":reviewID","responses"],"query":[{"key":"offset","value":"0"},{"key":"limit","value":"25"}],"variable":[{"key":"reviewID","value":"DEALER_RATER.TmWnT_Usk12NtV4Axr2rMA.11331749","description":"(Required) Review id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"responses\": [\n {\n \"name\": \"Jessica Adams\",\n \"comment\": \"Hello! We're delighted to hear that you had a positive experience with us. Your feedback is greatly appreciated. Please let us know if there's anything else we can do for you!\",\n \"privateMsg\": false,\n \"responseDate\": \"2023-04-10T09:47:32\"\n },\n {\n \"name\": \"John D'Costa\",\n \"comment\": \"Thank you for taking the time to share your experience. We value every piece of feedback and work on making our services even better. Hope to see you again soon!\",\n \"privateMsg\": true,\n \"responseDate\": \"2023-06-15T12:21:45\"\n },\n {\n \"name\": \"Linda White\",\n \"comment\": \"We apologize for any inconvenience you might have faced. Please reach out to our support team for further assistance. Your satisfaction is our top priority.\",\n \"privateMsg\": false,\n \"responseDate\": \"2023-07-05T14:30:01\"\n }\n ],\n \"paging\": {\n \"offset\": 0,\n \"limit\": 25,\n \"previous\": \"https://api.reputation.com/v3/{resource}?limit=25&offset=0\",\n \"next\": \"https://api.reputation.com/v3/{resource}?limit=25&offset=50\"\n }\n}\n"}],"_postman_id":"db37a8b0-cd84-4342-92cd-0f6885434565"},{"name":"Respond To Review","id":"dcc01ca9-c4a9-43ef-8d7d-48e4e5ce95aa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"x-api-key","value":""}],"body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"comment\": \"string\",\n \"privateMsg\": \"boolean\"\n}\n","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/reviews/:reviewID/respond","description":"

This endpoint allows you to respond to a specific review on the Reputation platform. By specifying the review's unique identifier reviewID in the path parameter, you can craft and send a response directly to that review. This is particularly useful for businesses looking to engage with their customers by addressing their reviews, whether they're positive, negative, or neutral.

Sample

JavaScript XHR Request

var xhr = new XMLHttpRequest();\nxhr.open('POST', 'https://api.reputation.com/v3/reviews/DEALER_RATER.TmWnT_Usk12NtV4Axr2rMA.11331749/respond', true);\nxhr.setRequestHeader('x-api-key', 'Your API key');\nxhr.setRequestHeader('Content-Type', 'application/json');\nxhr.onreadystatechange = function() {\n    if (xhr.readyState == 4 && xhr.status == 200) {\n        var response = JSON.parse(xhr.responseText);\n        console.log(response);\n    }\n};\nvar data = {\n    \"name\": \"Mike Harrison, General Manager at Harrison Auto Dealership\",\n    \"comment\": \"Hello! We're thrilled to hear about your experience at Harrison Auto Dealership. Every member of our team strives to ensure our customers drive away satisfied. If you have any further questions about your vehicle or need assistance in the future, please don't hesitate to visit or call us. Safe travels and thank you for choosing us!\",\n    \"privateMsg\": false\n};\nxhr.send(JSON.stringify(data));\n\n

Request Body Parameters

\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

Parameter	Data Type	Description
name	string	Required. Responder name.
comment	string	Required. Response message.
privateMsg	boolean	Optional. Whether the response is private. Defaults to false.

Response Parameters

Data returned.

\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

Parameter	Data Type	Description
name	string	Name of the responder.
comment	string	The response message provided by the responder.
responseDate	string	Datetime in ISO 8601 format, indicating when the response was made.
privateMsg	boolean	Indicates whether the response is private. A value of true means the response is private, false indicates public.

","urlObject":{"path":["reviews",":reviewID","respond"],"host":["{{baseUrl}}"],"query":[],"variable":[{"description":{"content":"

(Required) The unique identifier for the review you intend to respond to. This is required to ensure the response gets linked to the appropriate review.

\n","type":"text/plain"},"type":"any","value":"","key":"reviewID"}]}},"response":[{"id":"df61b16f-7ef0-4cb6-b902-dc04aaa88f1c","name":"Success","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"Your API key"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Mike Harrison, General Manager at Harrison Auto Dealership\",\n \"comment\": \"Hello! We're thrilled to hear about your experience at Harrison Auto Dealership. Every member of our team strives to ensure our customers drive away satisfied. If you have any further questions about your vehicle or need assistance in the future, please don't hesitate to visit or call us. Safe travels and thank you for choosing us!\",\n \"privateMsg\": false\n}\n","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.reputation.com/v3/reviews/:reviewID/respond","protocol":"https","host":["api","reputation","com"],"path":["v3","reviews",":reviewID","respond"],"variable":[{"key":"reviewID","value":"DEALER_RATER.TmWnT_Usk12NtV4Axr2rMA.11331749","description":"(Required) Review id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"471"},{"key":"etag","value":"W/\"1d7-nhQK37jgMGGgn243K9Rhd6/pBMI\""},{"key":"date","value":"Tue, 17 Oct 2023 22:09:20 GMT"},{"key":"x-envoy-upstream-service-time","value":"685"},{"key":"server","value":"istio-envoy"},{"key":"Via","value":"1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"name\": \"Mike Harrison, General Manager at Harrison Auto Dealership\",\n \"comment\": \"Hello! We're thrilled to hear about your experience at Harrison Auto Dealership. Every member of our team strives to ensure our customers drive away satisfied. If you have any further questions about your vehicle or need assistance in the future, please don't hesitate to visit or call us. Safe travels and thank you for choosing us!\",\n \"responseDate\": \"2023-10-17T15:09:20\",\n \"privateMsg\": false\n}"}],"_postman_id":"dcc01ca9-c4a9-43ef-8d7d-48e4e5ce95aa"}],"id":"66ed906a-7881-4ad5-9088-52d02132cd6c","_postman_id":"66ed906a-7881-4ad5-9088-52d02132cd6c","description":""},{"name":"/Reviews3","item":[{"name":"Get Reviews3","id":"28d94ac1-7a58-4dff-a34d-a4362ecb87ed","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"x-api-key","value":"Your API key"}],"url":"{{baseUrl}}/reviews3","description":"

Sample

JavaScript XHR Request

var xhr = new XMLHttpRequest();\nxhr.open('GET', 'https://api.reputation.com/v3/reviews3?range=PreviousWeek&offset=0&limit=3', true);\nxhr.setRequestHeader('x-api-key', 'Your API key');\nxhr.onreadystatechange = function() {\n    // If the request is complete\n    if (xhr.readyState == 4) {\n        // If the request was successful\n        if (xhr.status == 200) {\n            console.log(xhr.responseText);\n        } else {\n            console.error('Request failed with status:', xhr.status);\n        }\n    }\n};\nxhr.send();\n\n

Response Parameters

The following is a table describing the data returned by this endpoint.

Parameter	Parent	Data Type	Description
reviews	-	object	Array of reviews.
id	reviews	string	Unique identifier for the review.
tenantID	reviews	string	Tenant identifier. Modifiable only when creating a location.
locationID	reviews	string	Identifier for the location.
sourceID	reviews	string	Identifier for the source.
url	reviews	string	URL of the review.
date	reviews	string	Date of the review in ISO 8601 format.
reviewer	reviews	object	Details of the reviewer.
name	reviewer	string	Name of the reviewer.
rating	reviews	number	Rating given by the reviewer on the review site.
normalizedRating	reviews	number	Rating normalized to a scale of 1.
sentiment	reviews	string	Review sentiment. Values: Positive, Negative, Neutral, None.
commentTitle	reviews	string	Title of the review comment.
comment	reviews	string	Body of the review comment.
published	reviews	boolean	Indicates if the review is published.
canRespond	reviews	boolean	Indicates if a response can be made to the review.
hasResponses	reviews	boolean	Indicates if the review already has responses.
responseUrl	reviews	string	URL for responding to the review. Exists only if a response can be made.
reviewUrl	reviews	string	URL to read the full review.
categories	reviews	string array	Categories associated with the review.
attributions	reviews	object array	User attributions for the review
updated	reviews	boolean	Indicates if the review has been updated.
paging	-	Paging	Pagination details.
offset	paging	integer	The starting point of the page based on the offset value.
limit	paging	integer	Maximum number of objects returned. Can be fewer due to filtering.
previous	paging	string	API endpoint returning the previous page of data. Absent if this is the first page.
next	paging	string	API endpoint returning the next page of data. Absent if this is the last page.

","urlObject":{"path":["reviews3"],"host":["{{baseUrl}}"],"query":[{"disabled":true,"description":{"content":"