Evento de Visualização de Categoria

Registra um evento de visualização de uma página de categoria. Sempre que uma página de categoria for visualizada, este evento deve ser enviado.

Body Params

categories
string[]required

Um array com as categorias de maneira hierárquica.Exemplo: ["calçados"]

tags
string[]

Um array com as tags da página; se houverem.Exemplo: ["novidades", "descontos"]

searchId
string

Apenas para usuários da API de Busca

Identificador da busca conforme o retorno da API de busca

apiKey
stringrequired

ID interno de identificação da sua loja.

Não sabe qual a apiKey da sua loja? Solicite ao responsável técnico de integração enviando um email para suporteimpulse@linx.com.br

secretKey
stringrequired

Chave de acesso para autenticar a requisição. Pode ser substituída pelo parâmetro origin quando a requisição é feita via frontend para não expor a chave.

Não sabe qual a secretKey da sua loja? Solicite ao responsável técnico de integração enviando um email para suporteimpulse@linx.com.br

source
stringrequired

Origem do dispositivo utilizado. Os tipos suportados são:
  • desktop
  • mobile
  • app

deviceId
stringrequired

Identificador único do dispositivo. Todas as requisições feitas a partir do mesmo dispositivo devem possuir o mesmo deviceId.

salesChannel
string

Identificador do canal de venda.

user
User
Objeto contendo informações do usuário logado

Se torna obrigatório se o usuário estiver logado

Edit this page on GitHub
SDK
import { EventClient } from '@linximpulse/impulse-sdk-js'

const event = new EventClient({
  type: 'backend',
  apiKey: '<my-api-key>',
  secretKey: '<my-secret-key>',
  deviceId: '<my-device-id>'
})

await event.category()
  .source('desktop')
  .deviceId('<my-device-id>')
  .categories([
    {
      id: "0",
      name: "Calçados"
    }
  ])
  .send()
Typescript
import axios from 'axios'

await axios.post("https://api.event.linximpulse.net/v7/events/views/category", {
  apiKey: "<my-api-key>",
  secretKey: "<my-secret-key>",
  deviceId: "<my-device-id>",
  source: "desktop",
  categories: [
    "calçados"
  ]
})
curl
curl -0 -v -X POST "https://api.event.linximpulse.net/v7/events/views/category" \
-H "Content-type: application/json" \
-d @- << EOF
{
  "apiKey": "<my-api-key>",
  "secretKey": "<my-secret-key>",
  "deviceId": "<my-device-id>",
  "source": "desktop",
  "categories": [
    "calçados"
  ]
}
EOF