Performance reports

A API Merchant oferece relatórios de desempenho, como ProductPerformanceView. Esta página explica a estrutura dos Relatórios de desempenho.

Métricas

É possível consultar as métricas (por exemplo, clicks e impressions) que você quer que sejam retornadas. Adicione um filtro no período para consultar os dados de desempenho do serviço de relatórios.

Este é um exemplo de consulta que retorna uma única linha com o número total de cliques no período especificado:

SELECT clicks
FROM ProductPerformanceView
WHERE date BETWEEN '2020-12-01' AND '2020-12-21'

É necessário especificar os dados que você quer retornar. Caracteres curinga (por exemplo, SELECT *) retornam um erro.

O exemplo de resposta a seguir mostra que o comerciante recebeu 4.440 cliques no total em todos os produtos e métodos de marketing entre 1o de dezembro de 2020 e 21 de dezembro de 2020.

{
  "results": [
    {
      "productPerformanceView": {
        "clicks": "4,440"
      }
    }
  ]
}

Segmentos

Você pode usar o MCQL para consultar campos de segmentos. Os campos de segmentos podem ser atributos do produto (por exemplo, offerId, brand e category) ou de eventos (por exemplo, date e marketingMethod).

Os campos de segmentos agem de forma semelhante a um GROUP BY no SQL. Os campos de segmentos dividem as métricas selecionadas, agrupando por cada segmento na cláusula SELECT.

Veja um exemplo de consulta que retorna cliques por dia, em ordem decrescente por clicks, na condição adicionada de um período. Somente as linhas em que pelo menos uma métrica solicitada é diferente de zero são retornadas.

SELECT
  date,
  clicks
FROM ProductPerformanceView
WHERE date BETWEEN '2020-12-01' AND '2020-12-03'
ORDER BY clicks DESC

O exemplo de resposta a seguir mostra que o comerciante recebeu 1.546 cliques em todos os produtos, em todos os métodos de marketing, em 1o de dezembro de 2020, e 829 cliques em todos os produtos e métodos de marketing, em 2 de dezembro de 2020. O comerciante não teve cliques em 3 de dezembro de 2020. Por isso, nada é retornado para essa data.

{
  "results": [
    {
      "productPerformanceView": {
        "date": {
          "year": 2020,
          "month": 12,
          "day": 1
        },
        "clicks": "1546"
      }
    },
    {
      "productPerformanceView": {
        "date": {
          "year": 2020,
          "month": 12,
          "day": 2
        },
        "clicks": "829"
      }
    }
  ]
}