Saltar para o conteúdo principal
GET
/
public
/
v1
/
reporting-service
/
campaigns
/
{campaign-id}
/
daily
Get Campaign Daily Report
curl --request GET \
  --url https://api.topsort.com/public/v1/reporting-service/campaigns/{campaign-id}/daily \
  --header 'Authorization: Bearer <token>'
{
  "hasMore": true,
  "reports": [
    {
      "impressions": {
        "total": 123,
        "charged": 123,
        "adSpent": 123,
        "adSpentDecimal": "<string>"
      },
      "clicks": {
        "total": 123,
        "charged": 123,
        "adSpent": 123,
        "adSpentDecimal": "<string>"
      },
      "purchases": {
        "amount": 123,
        "count": 123,
        "quantity": 123,
        "countByProduct": {}
      },
      "date": "2023-12-25"
    }
  ],
  "nextPage": "SSBzb2xlbW5seSBzd2VhciB0aGF0IEkgYW0gdXAgdG8gbm8gZ29vZAo="
}

Autorizações

Authorization
string
header
obrigatório

A valid API key generated in Topsort's UI.

Parâmetros de caminho

campaign-id
string<uuid>
obrigatório

The ID of the campaign.

Parâmetros de consulta

limit
integer
padrão:100

The pagination limit.

Intervalo necessário: 0 <= x <= 100
next_page
string | null

Pagination cursor as provided in an earlier response. If provided will fetch the next page of results.

start_date
string<date>
obrigatório

The start date for which reports will be generated.

end_date
string<date>
obrigatório

The end date for which reports will be generated.

purchase_count_by_product
boolean
padrão:false

Whether to include the purchase count by product inside purchases. Defaults to False.

Resposta

Successful Response

Response for daily aggregation reports

hasMore
boolean
obrigatório

Flag that indicates whether more results are available. true indicates there is a next page of results. false indicates this response contains the last page of results.

reports
DailyReportData · object[]
obrigatório

A list with report data aggregated by day.

nextPage
string | null

Pagination cursor. Provide this value as a next_page query parameter in a new request to retrieve the next page of results.

Minimum string length: 1
Exemplo:

"SSBzb2xlbW5seSBzd2VhciB0aGF0IEkgYW0gdXAgdG8gbm8gZ29vZAo="