Referência de API de Relatórios de AMP (REST)

O objetivo dessa guia é ajudar desenvolvedores a utilizar as APIs de relatórios de AMP. São assumidos conhecimentos básicos sobre serviços web tipo REST e programação em geral.

Referência

A API de relatórios de AMP possui os seguintes métodos:

Método

Descrição

ampReports/getRoasChannelPerformance Devolve um relatório de performance por canal de acordo com as informações de período e tempo.
ampReports/getRecognizedTransactions Devolve um relatório com as transações reconhecidas em um período e tempo.
ampReports/getTransactions Devolve um relatório com todas as transações em um período e tempo.

A seguir são detalhados os parâmetros e retorno de cada método.

getRoasChannelPerformance

Parâmetro do método:

Parâmetros

Tipo

Descrição

start String Data de início do relatório. Formato: yyyy-mm-dd
end String Data de término do relatório. Formato: yyyy-mm-dd
timedetail String Informação de tempo do relatório. As opções são: “none”, “day”, “month”.

Parâmetros necessários no cabeçalho:

Parâmetros

Tipo

Descrição

authtoken String Token de Autenticação

Possíveis erros:

Código

Descrição

1

Access Denied

2

Invalid Client Code

3

Invalid Authentication Token

4

Authentaction Token Not Found

5

Expired Authentaction Token

100

General Unkown Error

101

Invalid Required Parameters

102

Invalid Header Format

URL a ser utilizada:

https://api.admotion.com/AEPReportService.svc/rest/ampReports/getRoasChannelPerformance?start=2018-05-01&end=2018-05-04&timedetail=day

Parâmetro no cabeçalho:

  • authtoken: Token de autenticação gerado anteriormente

Exemplo de retorno:

[
  {
    'start_date': '/Date(1525057200000-0300)',
    'end_date': '/Date(1525057200000-0300)',
    'channel_name': 'Facebook',
    'impressions': 2228215,
    'clicks': 62255,
    'ctr': 2.79,
    'spending': 8824.2,
    'revenue': 61724.7,
    'products': 211,
    'transactions': 183,
    'roas': 6.99
  },
  {
    'start_date': '/Date(1525057200000-0300)',
    'end_date': '/Date(1525057200000-0300)',
    'channel_name': 'APN',
    'impressions': 155686,
    'clicks': 25145,
    'ctr': 4.71,
    'spending': 5824.7,
    'revenue': 51724.4,
    'products': 156,
    'transactions': 123,
    'roas': 8.75
  }
]

Para cada linha do relatório, você terá um objeto com os seguintes campos:

Campo

Tipo

Descrição

start_date String Data de início do período da linha
end_date String Data de término do período da linha
channel_name String Nome do canal da linha
impressions Numeric Quantidade de impressões do canal no período da linha.
clicks Numeric Quantidade de cliques do canal no período da linha.
ctr Numeric CTR do canal no período da linha.
spending Numeric Investimento do canal no período da linha.
revenue Numeric Renda atribuída atribuídos ao canal no período da linha.
products Numeric Quantidade de produtos vendidos atribuídos ao canal no período da linha.
transactions Numeric Quantidade de transações atribuídas ao canal no período da linha.
roas Numeric ROAS do canal no período da linha.

getRecognizedTransactions

Parâmetro do método:

Parâmetros

Tipo

Descrição

start String Data de início do período do relatório. Formato: yyyy-mm-dd
end String Data de término do período do relatório. Formato: yyyy-mm-dd

Parâmetros necessários no cabeçalho:

Parâmetros

Tipo

Descrição

authtoken String Token de Autenticação

Possíveis erros:

Código

Descrição

1

Access Denied

2

Invalid Client Code

3

Invalid Authentication Token

4

Authentaction Token Not Found

5

Expired Authentaction Token

100

General Unkown Error

101

Invalid Required Parameters

102

Invalid Header Format

URL a utilizar:

https://api.admotion.com/AEPReportService.svc/rest/ampReports/getRecognizedTransactions?start=2018-05-01&end=2018-05-04

Parâmetros no cabeçalho:

  • authtoken: Token de autenticação gerado anteriormente.

Exemplo de retorno:

[
  {
    'campaign': 'fb_rt_mobile',
    'campaign_type': 'Facebook Retargeting',
    'channel_name': 'Facebook',
    'click_date': '/Date(1525057200000-0300)',
    'click_device': 'Mobile',
    'date': '/Date(1525057200000-0300)',
    'device': 'Mobile',
    'ga_attribution': 'Admotion',
    'ga_campaign': 'fb_rt_mobile',
    'ga_keyword': '(not set)',
    'ga_source_medium': 'social / admotion',
    'ip': '200.10.1.52',
    'muntes_lag': 15,
    'placement': 'Facebook',
    'site': '',
    'transaction_id': '65165421',
    'value': 1999.00
  },
  {
    'campaign': 'apn_rt_desktop',
    'campaign_type': 'Plain Retargeting',
    'channel_name': 'APN',
    'click_date': '/Date(1525057200000-0300)',
    'click_device': 'Desktop',
    'date': '/Date(1525057200000-0300)',
    'device': 'Desktop',
    'ga_attribution': 'Admotion',
    'ga_campaign': 'apn_rt_desktop',
    'ga_keyword': '(not set)',
    'ga_source_medium': 'apn / admotion',
    'ip': '170.1.10.72',
    'muntes_lag': 128,
    'placement': 'home',
    'site': 'MSN',
    'transaction_id': '65165888',
    'value': 8000.00
  }
]

Para cada linha do relatório, você terá um objeto com os seguintes campos:

Campo

Tipo

Descrição

campaign String Nome da campanha a que se atribui a transação
campaign_type String Tipo de campanha a que se atribui a transação
channel_name String Canal a que se atribui a transação
click_date Date Data e hora em que o usuário clicou no anúncio
click_device String Dispositivo em que o usuário fez o clique no anúncio
date Date Data e hora em que o usuário fez a transação
device String Dispositivo em que o usuário fez a transação
ga_attribution String Tipo de atribuição segundo Google Analytics. Os valores possíveis são: ‘Not attributed’, ‘Admotion’ e ‘Other’.
ga_campaign String Nome da campanha a que se atribui a transação segundo o Google Analytics
ga_keyword String Palavra chave a que se atribui a transação segundo o Google Analytics
ga_source_medium String Fonte e origem a que se atribui a transação segundo o Google Analytics
ip String IP do usuário que realizou a transação
minutes_lag Numeric Quantidade de minutos transcorridos desde o clique no anúncio até a concretização da transação
placement String Localização do anúncio em que o clique foi feito
site String Site do anúncio em que o clique foi feito
transaction_id String Identificador da transação
value Numeric Valor total da transação

getTransactions

Parâmetro do método:

Parâmetros

Tipo

Descrição

start String Data de início do período do relatório. Formato: yyyy-mm-dd
end String Data de término do período do relatório. Formato: yyyy-mm-dd

Parâmetros necessários no cabeçalho:

Parâmetros

Tipo

Descrição

authtoken String Token de Autenticação

Possíveis erros:

Código

Descrição

1

Access Denied

2

Invalid Client Code

3

Invalid Authentication Token

4

Authentaction Token Not Found

5

Expired Authentaction Token

100

General Unkown Error

101

Invalid Required Parameters

102

Invalid Header Format

URL a utilizar:

https://api.admotion.com/AEPReportService.svc/rest/ampReports/getTransactions?start=2018-05-01&end=2018-05-04

Parâmetros no cabeçalho:

  • authtoken: Token de autenticação gerado anteriormente.

Exemplo de retorno:

[
  {
    'campaign': 'fb_rt_mobile',
    'campaign_type': 'Facebook Retargeting',
    'channel_name': 'Facebook',
    'click_date': '/Date(1525057200000-0300)',
    'click_device': 'Mobile',
    'date': '/Date(1525057200000-0300)',
    'device': 'Mobile',
    'ga_attribution': 'Admotion',
    'ga_campaign': 'fb_rt_mobile',
    'ga_keyword': '(not set)',
    'ga_source_medium': 'social / admotion',
    'ip': '200.10.1.52',
    'muntes_lag': 15,
    'placement': 'Facebook',
    'site': '',
    'transaction_id': '65165421',
    'value': 1999.00
  },
  {
    'campaign': 'apn_rt_desktop',
    'campaign_type': 'Plain Retargeting',
    'channel_name': 'APN',
    'click_date': '/Date(1525057200000-0300)',
    'click_device': 'Desktop',
    'date': '/Date(1525057200000-0300)',
    'device': 'Desktop',
    'ga_attribution': 'Admotion',
    'ga_campaign': 'apn_rt_desktop',
    'ga_keyword': '(not set)',
    'ga_source_medium': 'apn / admotion',
    'ip': '170.1.10.72',
    'muntes_lag': 128,
    'placement': 'home',
    'site': 'MSN',
    'transaction_id': '65165888',
    'value': 8000.00
  }
]

Para cada linha do relatório, você terá um objeto com os seguintes campos:

Campo

Tipo

Descrição

campaign String Nome da campanha a que se atribui a transação
campaign_type String Tipo de campanha a que se atribui a transação
channel_name String Canal a que se atribui a transação
click_date Date Data e hora em que o usuário clicou no anúncio
click_device String Dispositivo em que o usuário fez o clique no anúncio
date Date Data e hora em que o usuário fez a transação
device String Dispositivo em que o usuário fez a transação
ga_attribution String Tipo de atribuição segundo Google Analytics. Os valores possíveis são: ‘Not attributed’, ‘Admotion’ e ‘Other’.
ga_campaign String Nome da campanha a que se atribui a transação segundo o Google Analytics
ga_keyword String Palavra chave a que se atribui a transação segundo o Google Analytics
ga_source_medium String Fonte e origem a que se atribui a transação segundo o Google Analytics
ip String IP do usuário que realizou a transação
minutes_lag Numeric Quantidade de minutos transcorridos desde o clique no anúncio até a concretização da transação
placement String Localização do anúncio em que o clique foi feito
site String Site do anúncio em que o clique foi feito
transaction_id String Identificador da transação
value Numeric Valor total da transação