{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"7b01abc4-7031-44c0-a90e-39bd83378616","name":"Explorer","description":"## Overview\nExplorer is a REST API that provides resource URLs to access reviews in the project data. Use the API endpoints to accesses data that is correlated for a specific endpoint. Using the API you can test your own examples for use in different applications. Each endpoint shows the proper the request structure and a sample of code with acceptable key value pairs. Use the key value pairs in each of the categories to build filters to improve the search results. A successful request returns a JSON object based on the applied filters. \n\n## Authorization\nTo use the API you will need an access token. To generate a token, use the [`Authentication`](#Authentication) API call. The token needs to be in the header of each request. If you are testing the APIs using Postman, add your token to the collection folder so that the same token will be used for every request in the collection. Make sure that the variable is set to `Bearer Token`. You can override this by specifying a token in the request.\n\n> **Note: Tokens are case sensitive.**\n\n## Structure and Use\nEach API request key value parameters are sent to the endpoint in the body of the request ans is in JSON format. Each request has a specific set of parameters and key value pairs that are mandatory.\n\n> **Note: All key:value pairs are case sensitive.**\n\n### Header\nThe `project_uuid` is a mandatory field that needs to be in each request. If you are testing the APIs using Postman, add your UUID as an environment variable in the collection folder so that it will be used for every request in the collection. \n\nThe `lang` is a mandatory field that needs to be in each request. If you are testing the APIs using Postman, add your UUID as an environment variable in the collection folder so that it will be used for every request in the collection. Supported languages are:\n\n|Language|Langujage Code|\n|---|---|\n|Spanish (Mexico)|`es_MX`|\n|German (Germany)|`de_DE`|\n|Spanish (Spain)|`es_ES`|\n|French (France)|`fr_FR`|\n|Chinese (Simplified)|`zh_CN`|\n|English (United States|`en_US`|\n|English (Great Brittain)|`en_GB`|\n\nThe `fromDate` and `toDate` are mandatory body parameters to search through your project.\n\nSet or make sure that the `content type` in the header is `application/json`.\n\n### Body\nEach API call uses the body to send the request to the endpoint. The body contains a list of keys:value pairs which act as filters to retrieve the requested data.\nThe following table outlines the key:value pairs that are needed to complete a successful search of the data lake.\n\n#### Filter Table \n|Key|||Value Type / Format|Description|\n|---|---|---|---|---|\n|`toDate`|Mandatory||Date format YYYY/MM/DD|The last date in the search range|\n|`fromDate`|Mandatory||Date format YYYY/MM/DD|The start date in the search range|\n|`hierarchies`|||Array of Strings|Search through selected Hierarchies. You can find these using the dashboard.|\n|`sources`|||Array of Strings|The source of the data being searched for. You can find these using the dashboard.|\n|`groups`|||Array of Strings|The group classification of the data. You can find these using the dashboard.|\n|`review_text`|||Array of Strings|Search for specific text within the project data|\n|`brands`|||Array of objects|. You can find these using the dashboard.|\n||`name`||String||\n||`uuid`||String||\n|`entities`|||Array of objects||\n||`name`||String||\n||`uuid`||String||\n|`star_ratings`|||Array of Strings|The star ratings to search for|\n|`topics`|||Array of objects||\n||`name`||String||\n||`uuid`||String||\n|`mega_topics`|||Array of objects||\n||`name`||String||\n||`uuid`||String||\n|`text`|||Array of Strings|Specific text to search for in the data|\n|`price`|||Array of Floating point numbers|The prices to search for in the data|\n|`promotion`|||Boolean|Search for promotions in the data|\n|`custom_filters`||| Array of objects|\n||`name`||String||\n||`data`||Array of objects||\n|||`id`|Integer||\n|||`name`|String|Name to search through the data|\n|`quote_text`|||Array of Strings|Specific quotes to search for|\n|`selectedRange`|||String||\n|`objectPaging`|||List of Objects||\n||`numberOfRows`||integer|number of rows to return|\n||`page`||integer|page to return|\n||`searchText`||String|text to search|\n||`sort`|||list of objects|\n|||`column`||Use the volume, starRating, or post_date as filter criteria|\n|||`order`|`asc` / `desc`|sort by ascending or descending order|\n\n\nIn addition to the `Filters` object, you will need to configure the `OnlyUniqueReviews` key. This is a Boolean key that will filter based on unique (`True`) reviews only. When set to `False` all reviews will be returned.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"12145274","collectionId":"7b01abc4-7031-44c0-a90e-39bd83378616","publishedId":"Tzz8tczL","public":true,"publicUrl":"https://edocs.revuze.it","privateUrl":"https://go.postman.co/documentation/12145274-7b01abc4-7031-44c0-a90e-39bd83378616","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"documentationLayout":"classic-double-column","customisation":null,"version":"8.10.1","publishDate":"2021-08-17T10:09:09.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/768118b36f06c94b0306958b980558e6915839447e859fe16906e29d683976f0","favicon":"https://revuze.it/favicon.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://edocs.revuze.it/view/metadata/Tzz8tczL"}