{"info":{"_postman_id":"b8754ee9-f2be-4b71-8eeb-4b5d573eb809","name":"SearchBar.org Public API","description":"

Searchbar.org API Reference

This document details the main API routes for developer users and integration with Searchbar.

Before you start

The base URL of the Searchbar API is

https://api.searchbar.org/v1\n

Generic Errors

| Code | Description |\n|: ---------- |: -----\n| 401 | Unauthorized user or invalid token |\n| 400 | Malformed or Bad request |\n| 404 | Resource not found |\n| 422 | Payload / json with missing fields |

All requests have Rate Control (in order to avoid DDoS attacks or super heavy use). Therefore, consider the limit of 3 simultaneous requests, waiting for response before make new requests.

Authentication

To access the Searchbar API, it is necessary to obtain an authorization token, which must be included as a Bearer Token in the \"Authentication\" header in all other requests.\n\"Authorization\": \"Bearer [your_authorization_token]\"

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Searchbar.org API Reference","slug":"searchbarorg-api-reference"}],"owner":"3227776","collectionId":"b8754ee9-f2be-4b71-8eeb-4b5d573eb809","publishedId":"TzCS4km9","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"444444","highlight":"007CFF"},"publishDate":"2021-04-09T00:06:19.000Z"},"item":[{"name":"Account","item":[{"name":"Login / Get Token","id":"9e6d6ea3-0248-4925-ba79-fa9ba41f4941","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"email\": \"myemail@example.com\",\n\t\"password\": \"mYpassw0rD\"\n}"},"url":"{{host}}/v1/account/login","description":"

Returns authentication data. This request does not requires authentication header.

\n","urlObject":{"path":["v1","account","login"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"e7c9d941-e248-4844-9b7e-91288fc94337","name":"Login / Get Token","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"email\": \"myemail@example.com\",\n\t\"password\": \"mYpassw0rD\"\n}"},"url":"{{host}}/v1/account/login"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 06 Apr 2021 23:49:43 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"ETag","value":"W/\"209-k/fB3V/3Cgte0hU/oWnFxGDzA6M\""},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"cf-request-id","value":"094b309b6d000051d11a8fd000000001"},{"key":"Expect-CT","value":"max-age=604800, report-uri=\"https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct\""},{"key":"Report-To","value":"{\"group\":\"cf-nel\",\"max_age\":604800,\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report?s=H4%2FCHPXRIZ8KBHi3OX0g6gaai8zxcBF4RniAQUNYI6BQxHv0RBZW0f7nymUlSvb61eNhrqhN1laMoeSlCks3xvCcaZz6SsbuoqPRscSjk2bVyw%3D%3D\"}]}"},{"key":"NEL","value":"{\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"63beea0bee3251d1-GRU"},{"key":"Content-Encoding","value":"br"},{"key":"alt-svc","value":"h3-27=\":443\"; ma=86400, h3-28=\":443\"; ma=86400, h3-29=\":443\"; ma=86400"}],"cookie":[],"responseTime":null,"body":"{\n \"user\": \"myemail@example.com\",\n \"token\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjYwNmNmMzc4Yzc5ZGEzNjc2OGZjOWE2NiIsInRva2VuVHlwZSI6InByaXZhdGUiLCJyb2xlIjoiVVNFUiIsImlhdCI6MTYxNzc1Mjk4MywiZXhwIjoxNjE3ODM5MzgzfQ._9HJ-TEzy1WMJ6A-Ck30CPI-uc5l2BAvtVqJrJoZDB4\",\n \"publicToken\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjYwNmNmMzc4Yzc5ZGEzNjc2OGZjOWE2NiIsInRva2VuVHlwZSI6InB1YmxpYyIsImlhdCI6MTYxNzc1Mjk4MywiZXhwIjozMjcyMTc1Mjk4M30.fSxwYj6CFSxWGYGsXlkCSWHokjRXNWmfvWK6YFiHRGw\",\n \"expirationDate\": \"2021-04-07T23:49:43.000Z\"\n}"}],"_postman_id":"9e6d6ea3-0248-4925-ba79-fa9ba41f4941"},{"name":"Account","id":"b1e48971-db2d-41bc-8b1c-8a538a3fc6aa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{host}}/v1/account","description":"

Returns Searchbar account details such as personal data and payment information.

\n","urlObject":{"path":["v1","account"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"ea709541-48e5-4ed0-86ee-53e15f966742","name":"Account","originalRequest":{"method":"GET","header":[],"url":"{{host}}/v1/account"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"220"},{"key":"ETag","value":"W/\"dc-GBtkvxpB3qisLFoTd5Etoa5eTa4\""},{"key":"Date","value":"Wed, 07 Apr 2021 00:05:25 GMT"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"user\": \"myemail@example.com\",\n \"id\": \"606cf5f8a57aee073506ec53\",\n \"info\": {\n \"name\": \"John Doe\"\n },\n \"plan\": {\n \"planName\": \"Essential\",\n \"expires\": \"2022-04-07T23:49:43.000Z\",\n \"amount\": 9.9,\n \"currency\": \"USD\",\n \"interval\": \"year\"\n },\n \"role\": \"USER\"\n}"}],"_postman_id":"b1e48971-db2d-41bc-8b1c-8a538a3fc6aa"},{"name":"SIte","id":"3c60658c-39f9-4c06-98aa-9d54db3e5e7c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"site\":\"https://searchbar.org\"\n}"},"url":"{{host}}/v1/account/site","description":"

Sets the default website for your account. This tells to our crowler where to go on each indexing cycle and look for pages.

The response time depends on how big is the target website. It can return even detailed data of added pages and error reports or a Job ID that can be tracked via GET /v1/job/[jobId].

Caution: this endpoint updates all pages in your account, except those entered manually via POST /v1/page.

\n","urlObject":{"path":["v1","account","site"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"132a1484-25de-4539-8449-cabaa7749ab2","name":"SIte","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"site\":\"https://searchbar.org\"\n}"},"url":"{{host}}/v1/account/site"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"2265"},{"key":"ETag","value":"W/\"8d9-O538yyCuw1BlcJlJcQKRBcGL+jE\""},{"key":"Date","value":"Wed, 07 Apr 2021 00:19:38 GMT"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": {\n \"duplicatedPages\": [],\n \"other\": []\n },\n \"addedPages\": [\n \"https://www.searchbar.org/en-us/blog\",\n \"https://www.searchbar.org/en-us/plans-prices\",\n \"https://www.searchbar.org/en-us/contact\",\n \"https://www.searchbar.org/en-us/help-center\",\n \"https://www.searchbar.org/pt-br/planos-e-precos\",\n \"https://www.searchbar.org/pt-br/artigos\",\n \"https://www.searchbar.org/pt-br/central-de-ajuda\",\n \"https://www.searchbar.org/pt-br/contato\",\n \"https://www.searchbar.org/en-us/success\",\n \"https://www.searchbar.org/en-us/features\"\n ],\n \"ignoredPages\": [],\n \"totalPages\": 9,\n \"jobID\": \"e2dc1d3a-5720-4cbe-a134-185db42e1bb0\",\n \"message\": \"All pages addeded, now processing metadata. Follow up by the jobID\"\n}"}],"_postman_id":"3c60658c-39f9-4c06-98aa-9d54db3e5e7c"},{"name":"SIte","id":"7042250e-8221-430e-97f4-fbfdae3a78b4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"{{host}}/v1/account/site","description":"

Returns indexed website informations.

\n","urlObject":{"path":["v1","account","site"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"fe04a49d-644d-49b9-9d3e-521f93539372","name":"SIte","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"{{host}}/v1/account/site"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"124"},{"key":"ETag","value":"W/\"7c-DxGZeJRiCvviFCM//lhf3Vn85Dc\""},{"key":"Date","value":"Wed, 07 Apr 2021 00:25:54 GMT"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"name\": \"Searchbar.org\",\n \"sitemap\": \"https://www.searchbar.org/sitemap.xml\",\n \"site\": \"https://searchbar.org\",\n \"active\": true,\n \"categories\": []\n }\n]"}],"_postman_id":"7042250e-8221-430e-97f4-fbfdae3a78b4"},{"name":"Logout","id":"7f6e82ed-3829-43cf-9e8c-c40b00e42cbf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{host}}/v1/account/logout","urlObject":{"path":["v1","account","logout"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"b8fb70ce-482e-4ff9-924a-fdeacc4e2686","name":"Logout","originalRequest":{"method":"GET","header":[],"url":"{{host}}/v1/account/logout"},"status":"OK","code":200,"_postman_previewlanguage":"html","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"text/html; charset=utf-8"},{"key":"Content-Length","value":"23"},{"key":"ETag","value":"W/\"17-E3hA/z/aQEzU8fw6jAvkL2bHzbU\""},{"key":"Date","value":"Fri, 09 Apr 2021 00:00:33 GMT"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"Successfully logged out"}],"_postman_id":"7f6e82ed-3829-43cf-9e8c-c40b00e42cbf"}],"id":"67af266d-bac0-4db0-b81f-8d91af95848a","description":"

This section contains the description of the routes related to maintaining the Searchbar account and obtaining authentication data.

\n","_postman_id":"67af266d-bac0-4db0-b81f-8d91af95848a"},{"name":"Page","item":[{"name":"Refresh Pages","id":"96b5f128-bb87-4d27-9863-6035a37eb871","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"{{host}}/v1/page/refresh","description":"

Completely updates the entire index of pages automatically indexed by the crowler and refresh all page matadata, such as title and description.

The response time depends on how big is the target website. It can return even detailed data of added pages and error reports or a Job ID that can be tracked via GET /v1/job/[jobId].

Does not affect pages added manually via POST / page

\n","urlObject":{"path":["v1","page","refresh"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"c0604d2a-3a64-4f1a-8041-81aeff3670ac","name":"Refresh Pages","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"","value":"","disabled":true}],"body":{"mode":"raw","raw":""},"url":"{{host}}/v1/page/refresh"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"PUT, GET, POST, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"Content-Type, Authorization"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"510"},{"key":"ETag","value":"W/\"1fe-sN2TfEmEq15zmyngWhLh0KseF6k\""},{"key":"Date","value":"Thu, 08 Apr 2021 23:14:10 GMT"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": {\n \"duplicatedPages\": [],\n \"other\": []\n },\n \"addedPages\": [\n \"https://www.searchbar.org/en-us/success\",\n \"https://www.searchbar.org/en-us/membership-successfully-adquired\",\n \"https://www.searchbar.org/en-us/test\",\n \"https://www.searchbar.org/pt-br/sucesso\",\n \"https://www.searchbar.org/pt-br/plano-adquirido-com-sucesso\",\n \"https://www.searchbar.org/pt-br/erro\"\n ],\n \"ignoredPages\": [],\n \"totalPages\": 35,\n \"jobID\": \"1f8d2090-8137-42ac-a369-5fa23bb8379a\",\n \"message\": \"All pages addeded, now processing metadata. Follow up by the jobID\"\n}"}],"_postman_id":"96b5f128-bb87-4d27-9863-6035a37eb871"},{"name":"Refresh Metadatas","id":"dc74a424-204f-4c89-b9b1-027294b0a32c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"url":"{{host}}/v1/page/metadata","description":"

Refresh metadata of all indexed pages. Does not affect pages added manually via POST / page

Calling this route will trigger an asynchronous job that can be followed up via GET /v1/job/[jobId].

\n","urlObject":{"path":["v1","page","metadata"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"1a45caf0-33b0-4c09-a241-62f1afa88cf3","name":"Refresh Metadatas","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"file","file":{"src":""}},"url":"{{host}}/v1/page/metadata"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"PUT, GET, POST, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"Content-Type, Authorization"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"99"},{"key":"ETag","value":"W/\"63-e3H/iyKlJZjVRd+Px6GdN6ta0/0\""},{"key":"Date","value":"Thu, 08 Apr 2021 23:20:57 GMT"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Job is running, follow up using Job ID\",\n \"jobID\": \"1dd5bce0-d0a5-4f89-98c8-cfee4cc552e2\"\n}"}],"_postman_id":"dc74a424-204f-4c89-b9b1-027294b0a32c"},{"name":"Pages","id":"4dca270a-d9fe-4869-9769-10611925af4d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"pages\": [\n {\n \"url\": \"http://example.com/1\",\n \"title\": \"This is a title example\",\n \"description\": \"This is the description from the page. It can be a large text.\",\n \"tags\": [\n \"Tag1\",\n \"Tag2\"\n ]\n },\n {\n \"url\": \"http://example.com/2\",\n \"title\": \"This is a title example 2\",\n \"description\": \"This is the description from the page. It can be a large text.\",\n \"image\": \"https://upload.wikimedia.org/wikipedia/commons/b/b6/Image_created_with_a_mobile_phone.png\"\n },\n {\n \"url\": \"http://example.com/3\",\n \"title\": \"This is a title example\",\n \"description\": \"This is the description from the page. It can be a large text.\"\n }\n ]\n}"},"url":"{{host}}/v1/page","description":"

Allows customized pages to be manually inserted into the search engine's index.

Pages inserted by this mechanism are the user's responsibility and will not be affected when using POST /page/refresh or POST /page/metadata

\n","urlObject":{"path":["v1","page"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"4c54fab2-0e88-4c92-82ba-d0cd76765393","name":"Pages","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"","value":"","disabled":true}],"body":{"mode":"raw","raw":"{\n \"pages\": [\n {\n \"url\": \"http://example.com/1\",\n \"title\": \"This is a title example\",\n \"description\": \"This is the description from the page. It can be a large text.\",\n \"tags\": [\n \"Tag1\",\n \"Tag2\"\n ]\n },\n {\n \"url\": \"http://example.com/2\",\n \"title\": \"This is a title example 2\",\n \"description\": \"This is the description from the page. It can be a large text.\",\n \"image\": \"https://upload.wikimedia.org/wikipedia/commons/b/b6/Image_created_with_a_mobile_phone.png\"\n },\n {\n \"url\": \"http://example.com/3\",\n \"title\": \"This is a title example\",\n \"description\": \"This is the description from the page. It can be a large text.\"\n }\n ]\n}"},"url":"{{host}}/v1/page"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"PUT, GET, POST, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"Content-Type, Authorization"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"119"},{"key":"ETag","value":"W/\"77-gjIlOaVoAovZCqQhryXZD0+3THQ\""},{"key":"Date","value":"Thu, 08 Apr 2021 23:41:35 GMT"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"errorPages\": [],\n \"addedPages\": [\n \"http://example.com/1\",\n \"http://example.com/2\"\n ],\n \"updatedPages\": [\n \"http://example.com/3\"\n ]\n}"}],"_postman_id":"4dca270a-d9fe-4869-9769-10611925af4d"},{"name":"Status","id":"3d27de99-a8ac-4690-824c-164e6f18b8f4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{host}}/v1/page/metadata/status","description":"

Returns status of all indexed pages.

\n","urlObject":{"path":["v1","page","metadata","status"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"58f3c1a6-b540-4d63-a9ad-adc319573a00","name":"Status","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded","disabled":true}],"url":"{{host}}/v1/page/metadata/status"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"PUT, GET, POST, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"Content-Type, Authorization"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"73"},{"key":"ETag","value":"W/\"49-J0OnUVqyzUXob/0ZY2rULoGpovw\""},{"key":"Date","value":"Thu, 08 Apr 2021 23:57:50 GMT"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"totalPages\": 32,\n \"totalProcessed\": 32,\n \"totalUnprocessed\": 0,\n \"totalError\": 0\n}"}],"_postman_id":"3d27de99-a8ac-4690-824c-164e6f18b8f4"},{"name":"Page","id":"51a1059f-c355-4426-a8d9-f374ae9155c6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"_id\": \"614126d6238d970f53f82439\",\n \"weight\": 3,\n \"title\": \"New title and weight for this page\"\n}"},"url":"{{host}}/v1/page","description":"

Allows to update data of a page with specific _id.

It allows you to update following params: url, title, description, image, tags and weight.

\n","urlObject":{"path":["v1","page"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"51a1059f-c355-4426-a8d9-f374ae9155c6"},{"name":"Pages","id":"14cab808-bb29-4e04-bdc3-8b2eef5fc33a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"{{host}}/v1/page/?q=example&size=10&offset=0&tag=tag1&tag=tag2","description":"

This route is indicated for production use, because it returns results that match the search criteria sorted by a score number dynamically calculated on some variables.

Which variables affects the page score?

Exact Title
Exact starts with Title
Exact Description
Title Contains
Description Contains
Number of word matches
Number of approximated words (with fuzziness)
Page Lastmod Date
Page individual weight
Typos similarity

It also retrieves highlighted words between <em> tags in the highlight object.

Caution: If you intend to publish your search on a public page or on a website, it is imperative that you use your public Token as a Bearer Token. This is one of the few routes compatible with the public token returned in the POST /account/login route.

\n","urlObject":{"path":["v1","page",""],"host":["{{host}}"],"query":[{"description":{"content":"

Query String. Required.

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

Pagination size. Default 12.

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

Start index offset. Default 0.

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

Filter tag. Optional.

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

You can set multi tag params

\n","type":"text/plain"},"key":"tag","value":"tag2"}],"variable":[]}},"response":[{"id":"8891a4aa-ad5c-4b48-96c3-6813a5fd75c2","name":"Pages","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{host}}/v1/page/?offset=0&size=10&tag=tag1&tag=tag2&q=example","host":["{{host}}"],"path":["v1","page",""],"query":[{"key":"offset","value":"0","description":"Start index offset. Default 0."},{"key":"size","value":"10","description":"Pagination size. Default 12."},{"key":"tag","value":"tag1","description":"Filter tag. Optional."},{"key":"tag","value":"tag2","description":"You can set multi tag params"},{"key":"q","value":"example","description":"Query String. Required."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"PUT, GET, POST, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"Content-Type, Authorization"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"570"},{"key":"ETag","value":"W/\"23a-zqW5E2C9+4zlp/u3zfKpkjIPc6g\""},{"key":"Date","value":"Mon, 12 Apr 2021 22:41:58 GMT"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"term\": \"example\",\n \"total\": 1,\n \"from\": 0,\n \"to\": 10,\n \"tags\": [\n {\n \"key\": \"Tag1\",\n \"doc_count\": 1\n },\n {\n \"key\": \"Tag2\",\n \"doc_count\": 1\n }\n ],\n \"results\": [\n {\n \"_index\": \"pages\",\n \"_type\": \"page\",\n \"_id\": \"606f94af83f6c306c9fa59dd\",\n \"_score\": 12.860958,\n \"_source\": {\n \"url\": \"http://example.com/1\",\n \"title\": \"This is a title example\",\n \"description\": \"This is the description from the page. It can be a large text.\",\n \"account\": \"606cf5f8a57aee073506ec53\",\n \"status\": \"PROCESSED\",\n \"lastmod\": \"2021-04-08T23:41:35.956Z\",\n \"origin\": \"CUSTOM\",\n \"weight\": 1,\n \"tags\": [\n \"Tag1\",\n \"Tag2\"\n ]\n },\n \"highlight\": {\n \"title\": [\n \"This is a title example\"\n ]\n }\n }\n ]\n}"}],"_postman_id":"14cab808-bb29-4e04-bdc3-8b2eef5fc33a"},{"name":"Pages Raw","id":"ce930ffa-4bc1-4cf6-8c84-700909ab3918","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"{{host}}/v1/page/raw/?q=widget&offset=0&size=50&url=https://example.com/myPageUrl&title=This is a example Title&description=Description to search&origin=CUSTOM&tag=tag1&sort=weight&order=desc","description":"

Important: Do not use this endpoint in your publish website. It requires your private Auth Token and is not recommended for fast search use.

Returns Raw data of your indexed pages. It allows you to manage all your results.

\n","urlObject":{"path":["v1","page","raw",""],"host":["{{host}}"],"query":[{"description":{"content":"

Query String. Optional. Returns pages that contains the target text in title, description, url or even tags.

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

Start index offset. Optional. Default 0.

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

Pagination size. Optional. Default 12.

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

Optional. Returns pages that contains target text in the Url field.

\n","type":"text/plain"},"key":"url","value":"https://example.com/myPageUrl"},{"description":{"content":"

Optional. Returns pages that contains target text in the Title field.

\n","type":"text/plain"},"key":"title","value":"This is a example Title"},{"description":{"content":"

Optional. Returns pages that contains target text in the Description field.

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

Optional. Specifies the origin of pages. Possible values are CUSTOM or SITEMAP.

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

Optional. Returns pages that contains specifield tag. You can set multi Tag params.

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

Optional. Specifies the sort criteria. Possible values are url, title, description, weight, lastmod, status, processdate

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

Optional. Complements the Sort param. Possible values are asc and desc.

\n","type":"text/plain"},"key":"order","value":"desc"}],"variable":[]}},"response":[{"id":"5cc2ada5-a75b-4572-8407-41b2608e9551","name":"Get Pages Raw","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{host}}/v1/page/raw/?offset=0&size=50&sort=weight&order=desc&q=widget","host":["{{host}}"],"path":["v1","page","raw",""],"query":[{"key":"offset","value":"0"},{"key":"size","value":"50"},{"key":"sort","value":"weight"},{"key":"order","value":"desc"},{"key":"q","value":"widget","type":"text"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"PUT, GET, POST, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"Content-Type, Authorization"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"1310"},{"key":"ETag","value":"W/\"51e-xG/x4AYLx+x3tbT5a6Szpbdmw58\""},{"key":"Date","value":"Tue, 14 Sep 2021 23:14:06 GMT"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"pages\": [\n {\n \"_id\": \"614126d6238d970f53f8243b\",\n \"status\": \"PROCESSED\",\n \"origin\": \"SITEMAP\",\n \"weight\": 1,\n \"tags\": [],\n \"url\": \"https://www.searchbar.org/en-us/help-center\",\n \"account\": \"5bec63217b0a7022e0578ce3\",\n \"__v\": 0,\n \"description\": \"Having troubles installing your custom search widget? You are in the rights place.\",\n \"processdate\": \"2021-09-14T22:48:56.425Z\",\n \"title\": \"Help Center\"\n },\n {\n \"_id\": \"614126d6238d970f53f8244e\",\n \"status\": \"PROCESSED\",\n \"origin\": \"SITEMAP\",\n \"weight\": 1,\n \"tags\": [],\n \"url\": \"https://www.searchbar.org/blog/search-results\",\n \"account\": \"5bec63217b0a7022e0578ce3\",\n \"__v\": 0,\n \"description\": \"Tips to have a perfect search results within Searchbar.org widget.\",\n \"image\": \"https://uploads-ssl.webflow.com/5debdd31cd17300a5e959985/5e7196654626f1ea1bee62c2_Predict.svg\",\n \"processdate\": \"2021-09-14T22:48:59.695Z\",\n \"title\": \"Search results\"\n },\n {\n \"_id\": \"614126d6238d970f53f82458\",\n \"status\": \"PROCESSED\",\n \"origin\": \"SITEMAP\",\n \"weight\": 1,\n \"tags\": [],\n \"url\": \"https://www.searchbar.org/blog/resultados-de-pesquisas\",\n \"account\": \"5bec63217b0a7022e0578ce3\",\n \"__v\": 0,\n \"description\": \"Dicas para obter resultados de pesquisa perfeitos no widget Searchbar.org.\",\n \"image\": \"https://uploads-ssl.webflow.com/5debdd31cd17300a5e959985/5e79259e8357a190f7720321_predict.png\",\n \"processdate\": \"2021-09-14T22:49:01.268Z\",\n \"title\": \"Resultados de pesquisas\"\n }\n ],\n \"total\": [\n {\n \"count\": 3\n }\n ]\n}"}],"_postman_id":"ce930ffa-4bc1-4cf6-8c84-700909ab3918"},{"name":"Pages Sugestions","id":"a71262bc-da27-441b-acd3-efab96a7f648","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"{{host}}/v1/page/suggestions/?q=Exam&size=4&offset=0","description":"

Retrieves only pages where the title contains the searched query string (without fuzziness). It is often used for Search-as-you-type and autocomplete searches. The results are sorted by the score result, which is calculated, considering:

Exact Title
Exact starts with Title
Title Contains
Number of word matches
Page Lastmod Date
Page individual weight
Typos similarity

Matched words are highlighted between <em> tags in the highlight object.

\n","urlObject":{"path":["v1","page","suggestions",""],"host":["{{host}}"],"query":[{"description":{"content":"

Query String. Required.

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

Pagination size. Default 10.

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

Start index offset. Default 0.

\n","type":"text/plain"},"key":"offset","value":"0"}],"variable":[]}},"response":[{"id":"db43545b-b2ce-4587-a298-f3d5d78c93a1","name":"Pages Sugestions","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{host}}/v1/page/suggestions/?q=Exam&size=4&offset=0","host":["{{host}}"],"path":["v1","page","suggestions",""],"query":[{"key":"q","value":"Exam","description":"Query String. Required."},{"key":"size","value":"4","description":"Pagination size. Default 10. "},{"key":"offset","value":"0","description":"Start index offset. Default 0."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"PUT, GET, POST, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"Content-Type, Authorization"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"351"},{"key":"ETag","value":"W/\"15f-dImcY8L6xdWt0hx6oJzfn6HyCas\""},{"key":"Date","value":"Mon, 12 Apr 2021 23:09:04 GMT"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"term\": \"Exam\",\n \"suggestions\": [\n {\n \"title\": \"This is a title example\",\n \"url\": \"http://example.com/3\",\n \"id\": \"606f94af83f6c306c9fa59df\"\n },\n {\n \"title\": \"This is a title example 2\",\n \"url\": \"http://example.com/2\",\n \"id\": \"606f94af83f6c306c9fa59de\"\n },\n {\n \"title\": \"This is a title example\",\n \"url\": \"http://example.com/1\",\n \"id\": \"606f94af83f6c306c9fa59dd\"\n }\n ]\n}"}],"_postman_id":"a71262bc-da27-441b-acd3-efab96a7f648"},{"name":"Pages","id":"4f2f5826-41f9-4165-91e9-80beb917d472","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"DELETE","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"deleteAll\": false,\n \"deleteList\": [\n \t\"http://example.com/1\",\n \t\"http://example.com/2\",\n \t\"http://example.com/3\",\n \t\"http://example.com/5\"\n \t]\n}"},"url":"{{host}}/v1/page","description":"

Delete all indexed pages or only specified list of page URLs.

\n","urlObject":{"path":["v1","page"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"78684ed5-69e3-4977-8ebf-dbd01221cd7f","name":"Pages","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"deleteAll\": false,\n \"deleteList\": [\n \t\"http://example.com/1\",\n \t\"http://example.com/2\",\n \t\"http://example.com/3\",\n \t\"http://example.com/5\"\n \t]\n}"},"url":"{{host}}/v1/page"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"PUT, GET, POST, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"Content-Type, Authorization"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"120"},{"key":"ETag","value":"W/\"78-/H/DGEc/jr6ZbmOK+ZgxM3WBxrM\""},{"key":"Date","value":"Mon, 12 Apr 2021 23:25:32 GMT"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Deleted list of pages\",\n \"deletedList\": [\n \"http://example.com/1\",\n \"http://example.com/2\",\n \"http://example.com/3\"\n ]\n}"}],"_postman_id":"4f2f5826-41f9-4165-91e9-80beb917d472"},{"name":"Click","id":"23cc53f9-2718-4647-8f41-02ffa3e9853f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"type\": \"SUGGESTION\",\n\t\"url\": \"http://example.com/1\",\n\t\"title\": \"Click Feedback\",\n\t\"pageId\": \"5bec63217b0a7022e0578ce3\",\n\t\"searchText\": \"Exam\"\n}"},"url":"{{host}}/v1/page/click","description":"

This route can be used to register user clicks on search results. You can use for SUGGESTION or RESULT types

\n","urlObject":{"path":["v1","page","click"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"41ad4272-992c-47f1-8e53-879cd4817677","name":"Click","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"type\": \"SUGGESTION\",\n\t\"url\": \"http://example.com/1\",\n\t\"title\": \"Click Feedback\",\n\t\"pageId\": \"5bec63217b0a7022e0578ce3\",\n\t\"searchText\": \"Exam\"\n}"},"url":"{{host}}/v1/page/click"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"PUT, GET, POST, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"Content-Type, Authorization"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"50"},{"key":"ETag","value":"W/\"32-LH/Z/BSmGdqOkBgCrpydioAx9gw\""},{"key":"Date","value":"Mon, 12 Apr 2021 23:28:48 GMT"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"User click feedback saved succefully\"\n}"},{"id":"f15f7e9c-913b-4890-8fa4-c3f482766f48","name":"Click","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"type\": \"SUGGESTION\",\n\t\"url\": \"http://example.com/1\",\n\t\"title\": \"Click Feedback\",\n\t\"pageId\": \"5bec63217b0a7022e0578ce3\",\n\t\"searchText\": \"Exam\"\n}"},"url":"{{host}}/v1/page/click"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"PUT, GET, POST, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"Content-Type, Authorization"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"50"},{"key":"ETag","value":"W/\"32-LH/Z/BSmGdqOkBgCrpydioAx9gw\""},{"key":"Date","value":"Mon, 12 Apr 2021 23:28:48 GMT"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"User click feedback saved succefully\"\n}"}],"_postman_id":"23cc53f9-2718-4647-8f41-02ffa3e9853f"}],"id":"a2ad9bec-8c1d-47ed-9b88-532e05585894","description":"

This section contains descriptions of the routes intended for the maintenance and consultation of indexed pages.

\n","_postman_id":"a2ad9bec-8c1d-47ed-9b88-532e05585894"},{"name":"Job","item":[{"name":"Jobs","event":[{"listen":"prerequest","script":{"id":"5b60a04f-4145-46b4-a4d5-ba21e258993e","exec":[""],"type":"text/javascript"}}],"id":"d038e9bc-d16e-40bd-97fe-503de9d39dca","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{host}}/v1/job","description":"

Return a list of all running Jobs for your account. It's very useful for tracking heavy processing in your pages.

Returns an empty array if no Job is running.

\n","urlObject":{"path":["v1","job"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"7fbad75c-cb42-47be-9147-c809b4c57d27","name":"Jobs","originalRequest":{"method":"GET","header":[],"url":"{{host}}/v1/job"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"PUT, GET, POST, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"Content-Type, Authorization"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"770"},{"key":"ETag","value":"W/\"302-Wbuw0AX99hy0JefEuzuFFuOeXmQ\""},{"key":"Date","value":"Mon, 12 Apr 2021 23:36:51 GMT"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"UUID\": \"4de5ecfe-efe5-4750-842f-3cce037e92f1\",\n \"parentJob\": null,\n \"created\": \"Mon Apr 12 2021 20:36:47 GMT-0300 (Brasilia Standard Time)\",\n \"identifier\": \"606cf5f8a57aee073506ec53\",\n \"description\": \"Processing Sites from specific account\",\n \"totalTasks\": 1,\n \"remainingTasks\": 0,\n \"jobProgress\": 1,\n \"status\": \"Running\",\n \"expiration\": \"Mon Apr 12 2021 20:37:06 GMT-0300 (Brasilia Standard Time)\"\n },\n {\n \"UUID\": \"c8b2a30b-0694-4292-ba33-3c71500c3fa5\",\n \"parentJob\": \"4de5ecfe-efe5-4750-842f-3cce037e92f1\",\n \"created\": \"Mon Apr 12 2021 20:36:47 GMT-0300 (Brasilia Standard Time)\",\n \"identifier\": \"606cf5f8a57aee073506ec53\",\n \"description\": \"Crowling site for pages\",\n \"totalTasks\": 2,\n \"remainingTasks\": 1,\n \"jobProgress\": 0.5,\n \"status\": \"Running\",\n \"expiration\": \"Mon Apr 12 2021 20:37:05 GMT-0300 (Brasilia Standard Time)\"\n }\n]"}],"_postman_id":"d038e9bc-d16e-40bd-97fe-503de9d39dca"},{"name":"Job/:uuid","id":"0f605c76-a1e9-406b-8e91-fa423e3e0708","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{host}}/v1/job/c8b2a30b-0694-4292-ba33-3c71500c3fa5","description":"

Return details for a specific Job. It's very useful for tracking heavy processing in your pages.

\n","urlObject":{"path":["v1","job","c8b2a30b-0694-4292-ba33-3c71500c3fa5"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"6ee4ceda-2cd9-4655-8166-182af29371cd","name":"Job (uuid)","originalRequest":{"method":"GET","header":[],"url":"{{host}}/v1/job/c8b2a30b-0694-4292-ba33-3c71500c3fa5"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"PUT, GET, POST, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"Content-Type, Authorization"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"336"},{"key":"ETag","value":"W/\"150-2OVBb2LazPGfF+hL/35CGLrY8ag\""},{"key":"Date","value":"Mon, 12 Apr 2021 23:37:29 GMT"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"UUID\": \"c8b2a30b-0694-4292-ba33-3c71500c3fa5\",\n \"parentJob\": \"4de5ecfe-efe5-4750-842f-3cce037e92f1\",\n \"created\": \"Mon Apr 12 2021 20:36:47 GMT-0300 (Brasilia Standard Time)\",\n \"identifier\": \"606cf5f8a57aee073506ec53\",\n \"description\": \"Crowling site for pages\",\n \"totalTasks\": 17,\n \"remainingTasks\": 1,\n \"jobProgress\": 0.9411764705882353,\n \"status\": \"Running\"\n}"}],"_postman_id":"0f605c76-a1e9-406b-8e91-fa423e3e0708"}],"id":"ab4f1dcc-c51e-46b3-a989-6ee857d20a45","_postman_id":"ab4f1dcc-c51e-46b3-a989-6ee857d20a45","description":""},{"name":"Analytics","item":[{"name":"Analytics","id":"f447aaea-5c30-4b01-8a70-d26be352d73e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{host}}/v1/analytics?startDate=2025-11-18T00:00:00.000Z&endDate=2025-11-18T23:59:59.999Z&size=10","description":"

Returns analytics data for a specific date range.

\n","urlObject":{"path":["v1","analytics"],"host":["{{host}}"],"query":[{"description":{"content":"

Start Date. Required.

\n","type":"text/plain"},"key":"startDate","value":"2025-11-18T00:00:00.000Z"},{"description":{"content":"

End Date. Required.

\n","type":"text/plain"},"key":"endDate","value":"2025-11-18T23:59:59.999Z"},{"description":{"content":"

Top size. Default 10.

\n","type":"text/plain"},"key":"size","value":"10"}],"variable":[]}},"response":[{"id":"7475656d-dcf1-4864-aeb2-ac54f5d521b3","name":"Analytics","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded","disabled":true}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"{{host}}/v1/analytics?startDate=2021-01-25T12:02:05.956Z&endDate=2021-03-26T22:30:05.956Z&size=3","host":["{{host}}"],"path":["v1","analytics"],"query":[{"key":"startDate","value":"2021-01-25T12:02:05.956Z","description":"Start Date. Required."},{"key":"endDate","value":"2021-03-26T22:30:05.956Z","description":"End Date. Required."},{"key":"size","value":"3","description":"Top size. Default 10."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET, POST"},{"key":"Access-Control-Allow-Headers","value":"Content-Type, Authorization"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"165"},{"key":"ETag","value":"W/\"a5-O1la+JYibHbD+nX1sJER9+S817s\""},{"key":"Date","value":"Mon, 12 Apr 2021 23:40:01 GMT"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"pages\": {\n \"total\": 102\n },\n \"searches\": {\n \"count\": 254,\n \"distinctUUIDCount\": 33,\n \"top\": [\n {\n \"_id\": \"price\",\n \"count\": 54\n },\n {\n \"_id\": \"support\",\n \"count\": 12\n },\n {\n \"_id\": \"custom search\",\n \"count\": 7\n }\n ]\n },\n \"clicks\": {\n \"top\": [\n {\n \"_id\": \"https://example.com/plans-&-prices\",\n \"count\": 11\n },\n {\n \"_id\": \"https://example.com/support\",\n \"count\": 6\n },\n {\n \"_id\": \"https://example.com/our-product\",\n \"count\": 2\n }\n ],\n \"count\": 37,\n \"distinctUUIDCount\": 1\n },\n \"searchesWithZeroResults\": {\n \"top\": [\n {\n \"_id\": \"San Diego\",\n \"count\": 8\n },\n {\n \"_id\": \"SportCar\",\n \"count\": 8\n },\n {\n \"_id\": \"blablabla\",\n \"count\": 7\n }\n ]\n }\n}"}],"_postman_id":"f447aaea-5c30-4b01-8a70-d26be352d73e"}],"id":"0e81079f-ead1-4651-8ae9-ffb14610fe15","_postman_id":"0e81079f-ead1-4651-8ae9-ffb14610fe15","description":""}],"event":[{"listen":"prerequest","script":{"id":"6cf5a5f9-218f-463a-ad9f-b6d951d89363","type":"text/javascript","requests":{},"exec":[""]}},{"listen":"test","script":{"id":"316d0ee4-e8da-446f-aba6-f23bc12984e9","type":"text/javascript","requests":{},"exec":[""]}}]}