Skip to main content

Get Campaign statistics

GET 
/v1/campaigns/:campaignId/stats

Get Campaign statistics

Request​

Path Parameters

    campaignId stringrequired

    The Campaign identifier to get statistics for

Responses​

OK

Schema

    campaignId stringrequired

    The Campaign identifier to that statistics relate to

    name stringrequired

    The name of the Campaign

    bidAmount

    object

    required

    Represents an amount of money with its currency type.

    currencyCode stringrequired
    units int64required

    The whole units of the amount. For example if currencyCode is "USD", then 1 unit is one US dollar.

    nanos int32required

    Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If units is positive, nanos must be positive or zero. If units is zero, nanos can be positive, zero, or negative. If units is negative, nanos must be negative or zero. For example $-1.75 is represented as units=-1 and nanos=-750,000,000.

    status CampaignStatus (string)required

    The status of a Campaign.

    Possible values: [RUNNING, STOPPED]

    created date-timerequired

    A date time representing when the Campaign was created

    totalBids int32required

    The total number of bids made by the Campaign

    winningBids int32required

    The total number of winning bids made by the Campaign

    totalSpent

    object

    required

    Represents an amount of money with its currency type.

    currencyCode stringrequired
    units int64required

    The whole units of the amount. For example if currencyCode is "USD", then 1 unit is one US dollar.

    nanos int32required

    Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If units is positive, nanos must be positive or zero. If units is zero, nanos can be positive, zero, or negative. If units is negative, nanos must be negative or zero. For example $-1.75 is represented as units=-1 and nanos=-750,000,000.

    meanBidAmount

    object

    required

    Represents an amount of money with its currency type.

    currencyCode stringrequired
    units int64required

    The whole units of the amount. For example if currencyCode is "USD", then 1 unit is one US dollar.

    nanos int32required

    Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If units is positive, nanos must be positive or zero. If units is zero, nanos can be positive, zero, or negative. If units is negative, nanos must be negative or zero. For example $-1.75 is represented as units=-1 and nanos=-750,000,000.

Loading...