Documentation Powered by ReDoc

Advertising statistics REST API (latest)

URL: https://github.com/allegro/allegro-api/issues

Documented API allows advertising agencies to obtain statistics about their advertising campaigns.

Authentication

bearerTokenForUser

To obtain an API access token, please follow the steps described in Authorization Code flow docs: https://developer.allegro.pl/tutorials/authentication-and-authorization-m09BlVyo7iY#authorization-code-flow

Security Scheme Type OAuth2
authorizationCode OAuth Flow
Authorization URL: https://allegro.pl/auth/oauth/authorize
Token URL: https://allegro.pl/auth/oauth/token
Scopes:

    Statistics

    Get statistics on agency client campaign

    path Parameters
    id
    required
    string

    Agency client ID.

    query Parameters
    types
    Array of strings unique
    Items Enum: "SPONSORED_OFFER" "GRAPHIC_AD"

    Campaign types with items.

    statistics.gte
    required
    string <date>

    The lower bound of date time range from which statistics will be collected. Date cannot be older than 2 years. Format (ISO 8601) - yyyy-MM-dd.

    statistics.lte
    required
    string <date>

    The upper bound of date time range from which statistics will be collected. Date cannot be younger than yesterday (ISO 8601) - yyyy-MM-dd.

    Responses

    Response samples

    Content type
    application/vnd.allegro.public.v1+json
    {
    • "sponsoredOffers": [
      ],
    • "graphicAds": [
      ]
    }

    Get agency clients

    Responses

    Response samples

    Content type
    application/vnd.allegro.public.v1+json
    {
    • "clients": [
      ]
    }