{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/pages","auth":"required","method":"get","results":{"codes":[{"name":"","code":"HTTP/1.1 200 OK\nX-Linx-Request-Id: 9957959ec1ef72512ee7c18fa4a377b8\nX-Linx-Request-Time: 1484242345843\n\n{\n\t\tletters: {\n        numeric: [ ],\n        a: [\n            {\n                query: \"air+max+97\",\n                link: \"/searchapi/v3/search?apikey=loja&origin=seo&terms=air+max+97\"\n            },\n            {\n                query: \"air+max+90\",\n                link: \"/searchapi/v3/search?apikey=loja&origin=seo&terms=air+max+90\"\n            }\n        ],\n     queries: [\n        {\n            query: \"air+max+97\",\n            link: \"/searchapi/v3/search?apikey=loja&origin=seo&terms=air+max+97\"\n        },\n        {\n            query: \"air+max+90\",\n            link: \"/searchapi/v3/search?apikey=loja&origin=seo&terms=air+max+90\"\n        }\n     ]\n}\n    ","language":"json","status":200},{"name":"OK Letter","code":"HTTP/1.1 200 OK\nX-Linx-Request-Id: 9957959ec1ef72512ee7c18fa4a377b8\nX-Linx-Request-Time: 1484242345843\n\n{\n   \"letter\": \"a\",\n   \"queries\": [\n     {\n       \"query\": \"asus\",\n       \"link\": \"https://search.neemu.chaordic.com/v3/query/:apikey/asus\"\n     },\n     {\n       \"query\": \"almofada\",\n       \"link\": \"https://search.neemu.chaordic.com/v3/query/:apikey/almofada\"\n     },\n     {\n       \"query\": \"ar condicionado\",\n       \"link\": \"https://search.neemu.chaordic.com/v3/query/:apikey/ar+condicionado\"\n     }\n   ]\n}","language":"json","status":200},{"code":"HTTP/1.1 404 Not Found\n{\n \"message\": \"Not found\"\n}","language":"json","status":404},{"code":"HTTP/1.1 401 Unauthorized\n{\n    \"code\": 1008,\n    \"message\": \"Invalid Secret Key\"\n}","language":"json","status":401},{"code":"HTTP/1.1 400 Bad Request\n{\n \"message\": \"Invalid request: missing parameters\"\n}","language":"json","status":400},{"code":"HTTP/1.1 500 Internal Server Error\n{\n \"message\": \"Error: Internal Server Error\"\n}","language":"json","status":500}]},"settings":"58bd78f5816ab10f00d45fd6","params":[{"name":"apikey","type":"string","default":"","desc":"Não sabe qual a apiKey da sua loja? Solicite ao responsável técnico de integração enviando um email para atendimento:::at:::chaordic.com.br","required":true,"in":"query","ref":"","_id":"58bd80d4e242b31b00818b77"},{"name":"secretkey","type":"string","default":"","desc":"Não sabe qual a secretKey da sua loja? Solicite ao responsável técnico de integração enviando um email para [email protected]","required":true,"in":"query","ref":"","_id":"592edd551cd2c400257ef22f"},{"name":"letter","type":"string","default":"","desc":"Primeira letra das consultas contidas na lista.","required":false,"in":"query","ref":"","_id":"58bd80f38bea2c0f00ea6b27"},{"name":"hide","type":"string","default":"","desc":"Desativa retorno de campos na resposta. Por padrão todos os campos são ativos. Para incluir mais de uma opção, insira um campo adicional. <br> Valores permitidos: <li>queries</li> <li>letters</li>","required":false,"in":"query","ref":"","_id":"58bd80d4e242b31b00818b76"}],"examples":{"codes":[]}},"next":{"description":"","pages":[]},"title":"/pages","type":"endpoint","slug":"pages","excerpt":"Pages é responsável por gerar URLs amigáveis para campanhas específicas e acompanhamento de métricas sem a interferência nos resultados da busca interna na loja. Ou seja, é um mecanismo automático de indexação de links para geração de tráfego orgânico. Esta requisição é utilizada para obter a lista de urls de consultas populares, separadas por letra inicial e por consultas.","body":"<h3>Como fazer a consulta?</h3>\nPara realizar uma consulta que retorne as consultas para todas as letras, utilize diretamente a rota.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"https://api.linximpulse.com/engage/search/v3/pages?apiKey=<loja>&secretKey=<secretKey>\",\n      \"language\": \"curl\"\n    }\n  ]\n}\n[/block]\nVocê também pode filtrar por letra\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"https://api.linximpulse.com/engage/search/v3/pages?apiKey=<loja>&secretKey=<secretKey>&letter=a\",\n      \"language\": \"curl\"\n    }\n  ]\n}\n[/block]\n<h3>Como é a resposta?</h3>\n\nAs consultas são separadas por letra no campo **letters**, e por queries no campo **queries**","updates":[],"order":11,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5d00029d39c2920014e31713","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"API de busca","slug":"api-de-busca","order":8,"from_sync":false,"reference":false,"_id":"5d00029d39c2920014e316e3","project":"55c3572a57f7f32d0016ec3d","createdAt":"2017-03-06T13:18:21.954Z","__v":0,"version":"5d00029d39c2920014e31722"},"user":"5760739a30e27d0e00002a9f","createdAt":"2017-03-06T15:27:06.419Z","githubsync":"","__v":6,"project":"55c3572a57f7f32d0016ec3d","version":{"version":"3-search","version_clean":"3.0.0-search","codename":"API de Busca pelo time de Integração","is_stable":false,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["5d00029d39c2920014e316db","5d00029d39c2920014e316dc","5d00029d39c2920014e316dd","5d00029d39c2920014e316de","5d00029d39c2920014e316df","5d00029d39c2920014e316e0","5d00029d39c2920014e316e1","5d00029d39c2920014e316e2","5d00029d39c2920014e316e3","5d00029d39c2920014e316e4","5d00029d39c2920014e316e5","5d00029d39c2920014e316e6"],"_id":"5d00029d39c2920014e31722","project":"55c3572a57f7f32d0016ec3d","__v":0,"forked_from":"590a413d12d47a3700f83c8e","createdAt":"2017-05-03T20:44:45.480Z","releaseDate":"2017-05-03T20:44:45.480Z"},"parentDoc":null}

get/pages

Pages é responsável por gerar URLs amigáveis para campanhas específicas e acompanhamento de métricas sem a interferência nos resultados da busca interna na loja. Ou seja, é um mecanismo automático de indexação de links para geração de tráfego orgânico. Esta requisição é utilizada para obter a lista de urls de consultas populares, separadas por letra inicial e por consultas.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

apikey:
required
string
Não sabe qual a apiKey da sua loja? Solicite ao responsável técnico de integração enviando um email para ate[email protected]
secretkey:
required
string
Não sabe qual a secretKey da sua loja? Solicite ao responsável técnico de integração enviando um email para [email protected]
letter:
string
Primeira letra das consultas contidas na lista.
hide:
string
Desativa retorno de campos na resposta. Por padrão todos os campos são ativos. Para incluir mais de uma opção, insira um campo adicional. <br> Valores permitidos: <li>queries</li> <li>letters</li>

Result Format


Documentation

<h3>Como fazer a consulta?</h3> Para realizar uma consulta que retorne as consultas para todas as letras, utilize diretamente a rota. [block:code] { "codes": [ { "code": "https://api.linximpulse.com/engage/search/v3/pages?apiKey=<loja>&secretKey=<secretKey>", "language": "curl" } ] } [/block] Você também pode filtrar por letra [block:code] { "codes": [ { "code": "https://api.linximpulse.com/engage/search/v3/pages?apiKey=<loja>&secretKey=<secretKey>&letter=a", "language": "curl" } ] } [/block] <h3>Como é a resposta?</h3> As consultas são separadas por letra no campo **letters**, e por queries no campo **queries**

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}