Contents x
    Get Campaign Data for Publisher Report
    • 16 Jul 2024
    • Dark
      Light
    Contents

    Get Campaign Data for Publisher Report

    • Updated on 16 Jul 2024
    • Dark
      Light
    Article summary

    Get
    /publishers/{publisherId}/reports/campaign

    GET reports aggregated by campaign

    The campaign report aggregates clicks and transactions by campaign and advertiser.

    For all clicks and transactions within the selected time frame within a specific timezone, the result can be listed in intervals of days, months or years. The user can see the aggregation across multiple data points such as the number of clicks, number of transactions, commission and total sale amount. All transaction data are aggregated by commission status, such as pending or approved.


    Who can use it 

    Users who have a publisher account and use the parameter "&campaign=" for clicks. Please see our page about Campaign Tracking and Reporting for further details. 

    Header parameters
    Authorization
    string

    accessToken

    Path parameters
    publisherId
    integer (int64) Required

    publisher id

    Query parameters
    accessToken
    stringRequired

    access token

    advertiserIds
    array of integer

    advertiserIds

    campaign
    string
    endDate
    string (date) Required

    end date

    Default"2021-03-15"
    includeNumbersWithoutCampaign
    boolean

    also show data without campaign id?

    Default"False"
    interval
    string
    region
    stringRequired

    region

    Valid values[ "\"AT\"", "\"AU\"", "\"BE\"", "\"BR\"", "\"BU\"", "\"CA\"", "\"CH\"", "\"DE\"", "\"DK\"", "\"ES\"", "\"FI\"", "\"FR\"", "\"GB\"", "\"IE\"", "\"IT\"", "\"NL\"", "\"NO\"", "\"PL\"", "\"SE\"", "\"US\"" ]
    set
    boolean
    startDate
    string (date) Required

    start date

    Default"2021-01-01"
    timezone
    string

    time zone in short or default format

    Default"UTC"

    Further details on query parameter

    parameterformatmandatory/optionaldescription
    startDatestring,
    ISO Date,
    YYYY-MM-YY    		mandatoryThe given date is incl., greater than or equal.
    endDatestring,
    ISO Date,
    YYYY-MM-YY    		mandatoryThe given date is incl., greater than or equal
    The max period between startDate and endDate is 400 days
    regioncurrently supported:
    AE
    AR
    AT
    AU
    BE
    BG
    BR(Brazil programs running in BRL)
    BU(Brazil programs running in BRU)
    CA
    CH
    CL
    CN
    CO
    CZ
    DE
    DK
    ES
    FI
    FR
    GB
    GR
    HR
    HU
    IE
    IN
    IT
    JP
    LT
    LV
    MX
    NL
    NO
    NZ
    PE
    PL
    PT
    RO
    RU
    SE
    SG
    SI
    SK
    TR
    UA
    US
    ZA
    		mandatoryPlease choose one region of the advertiser account.
    campaignstringoptionalThe value which was used in &campaign=.
    The value needs to have at least 3 characters. Max number of characters is 128.
    Returns a result based on a prefix search.
    If empty on NA, aggregation goes over all data having a value in &campaign=.
    timezoneAmerica/Sao_Paulo
    Australia/Sydney
    Europe/Berlin
    Europe/Dublin
    Europe/Helsinki
    Europe/London
    Europe/Paris
    Canada/Central
    Canada/Eastern
    Canada/Mountain
    Canada/Pacific
    US/Central
    US/Eastern
    US/Mountain
    US/Pacific
    UTC    		optionaldefault UTC
    advertiserIdsinteger array
    comma separated list    		optionalOne or more advertiser IDs.
    The resultset will show you just the advertiser accounts of your selection.
    All advertisers must be from your chosen "region=".
    includeNumbersWithoutCampaignboolean (true, false)optionalDefault (false). By default, the API just delivers numbers in case a campaign is associated with the click or the transactions.
    If set to "true" the result will also incl. numbers from clicks and transactions without campaign parameters.
    The parameter will be ignored (default "false") once the parameter "campaign=" contains a valid value.
    intervalstring (day, month, year)optionalIf set, numbers will be reported in sums per interval (day, month, year).


    Responses
    200

    OK

    Expand All
    object
    body
    object
    statusCode
    string
    Valid values[ "\"100 CONTINUE\"", "\"101 SWITCHING_PROTOCOLS\"", "\"102 PROCESSING\"", "\"103 CHECKPOINT\"", "\"200 OK\"", "\"201 CREATED\"", "\"202 ACCEPTED\"", "\"203 NON_AUTHORITATIVE_INFORMATION\"", "\"204 NO_CONTENT\"", "\"205 RESET_CONTENT\"", "\"206 PARTIAL_CONTENT\"", "\"207 MULTI_STATUS\"", "\"208 ALREADY_REPORTED\"", "\"226 IM_USED\"", "\"300 MULTIPLE_CHOICES\"", "\"301 MOVED_PERMANENTLY\"", "\"302 FOUND\"", "\"302 MOVED_TEMPORARILY\"", "\"303 SEE_OTHER\"", "\"304 NOT_MODIFIED\"", "\"305 USE_PROXY\"", "\"307 TEMPORARY_REDIRECT\"", "\"308 PERMANENT_REDIRECT\"", "\"400 BAD_REQUEST\"", "\"401 UNAUTHORIZED\"", "\"402 PAYMENT_REQUIRED\"", "\"403 FORBIDDEN\"", "\"404 NOT_FOUND\"", "\"405 METHOD_NOT_ALLOWED\"", "\"406 NOT_ACCEPTABLE\"", "\"407 PROXY_AUTHENTICATION_REQUIRED\"", "\"408 REQUEST_TIMEOUT\"", "\"409 CONFLICT\"", "\"410 GONE\"", "\"411 LENGTH_REQUIRED\"", "\"412 PRECONDITION_FAILED\"", "\"413 PAYLOAD_TOO_LARGE\"", "\"413 REQUEST_ENTITY_TOO_LARGE\"", "\"414 URI_TOO_LONG\"", "\"414 REQUEST_URI_TOO_LONG\"", "\"415 UNSUPPORTED_MEDIA_TYPE\"", "\"416 REQUESTED_RANGE_NOT_SATISFIABLE\"", "\"417 EXPECTATION_FAILED\"", "\"418 I_AM_A_TEAPOT\"", "\"419 INSUFFICIENT_SPACE_ON_RESOURCE\"", "\"420 METHOD_FAILURE\"", "\"421 DESTINATION_LOCKED\"", "\"422 UNPROCESSABLE_ENTITY\"", "\"423 LOCKED\"", "\"424 FAILED_DEPENDENCY\"", "\"425 TOO_EARLY\"", "\"426 UPGRADE_REQUIRED\"", "\"428 PRECONDITION_REQUIRED\"", "\"429 TOO_MANY_REQUESTS\"", "\"431 REQUEST_HEADER_FIELDS_TOO_LARGE\"", "\"451 UNAVAILABLE_FOR_LEGAL_REASONS\"", "\"500 INTERNAL_SERVER_ERROR\"", "\"501 NOT_IMPLEMENTED\"", "\"502 BAD_GATEWAY\"", "\"503 SERVICE_UNAVAILABLE\"", "\"504 GATEWAY_TIMEOUT\"", "\"505 HTTP_VERSION_NOT_SUPPORTED\"", "\"506 VARIANT_ALSO_NEGOTIATES\"", "\"507 INSUFFICIENT_STORAGE\"", "\"508 LOOP_DETECTED\"", "\"509 BANDWIDTH_LIMIT_EXCEEDED\"", "\"510 NOT_EXTENDED\"", "\"511 NETWORK_AUTHENTICATION_REQUIRED\"" ]
    statusCodeValue
    integer (int32)

    Which data fields do we provide

    field namedescription
    datefield represents either the day, the month or the year, according to selected timeframe and interval
    advertiserIdID of the advertiser / corresponding with advertiserName
    advertiserNameName of the advertiser / corresponding with advertiserID
    campaignValue of campaign by which the result is aggregated
    quantityNumber of transactions by commission status and clicks, "total" sums up approved, pending and bonus transactions
    saleAmountValue of the transactions by commssion satus, "total" sums up approved, pending and bonus transactions
    commissionAmountCommissions of the transactions by commssion satus, "total" sums up approved, pending and bonus transactions 
    Was this article helpful?
    What's Next

    © 2024, AWIN Ltd. All rights reserved. Awin is part of Axel Springer Group. No part of this publication may be reproduced, translated, stored in a retrieval system, or transmitted in any form or by any means, electronic, mechanical, photocopying, recording or otherwise, without the prior permission of the copyright owner.