Saltar al contenido principal
GET
/
public
/
v1
/
offsite-ads
/
reporting
/
campaigns
/
{campaign-id}
/
daily
Get Campaign Daily Report
curl --request GET \
  --url https://api.topsort.com/public/v1/offsite-ads/reporting/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="
}

Autorizaciones

Authorization
string
header
requerido

A valid API key generated in Topsort's UI.

Parámetros de ruta

campaign-id
string<uuid>
requerido

The ID of the campaign to get the daily report for.

Parámetros de consulta

vendor_id
string
requerido

The ID of the vendor to get the daily report for.

start_date
string<date>
requerido

The start date for which reports will be generated.

end_date
string<date>
requerido

The end date for which reports will be generated.

limit
integer
predeterminado:100

The pagination limit.

Rango requerido: 0 <= x <= 365
next_page
string | null

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

Respuesta

Successful Response

hasMore
boolean
requerido

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
PublicDailyReportData · object[]
requerido

The daily report for the campaign

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
Ejemplo:

"SSBzb2xlbW5seSBzd2VhciB0aGF0IEkgYW0gdXAgdG8gbm8gZ29vZAo="