API GDE 2.0

• Introduction
• Error messages
• Users
• Campaign
• Placements
• Media Plan
• Creatives
• Creative Templates
• Creative Codes
• Creative Events
• File Upload
• Tracking Scripts
• Landing Pages
• gT for gDE
• Gemius Traffic
• Indicators
• Basic Stats
• Cost Stats
• Outer Stats
• Progress Stats
• SingleSource
• Filtered Reports
• Systems
• Tech
• Geo
• Campaign Tag1
• Campaign Tag2
• Placement Tag1
• Placement Tag2
• Creative Tag1
• Creative Tag2
• Session

Progress Stats

• GetProgressStats

GetProgressStats [finished]

Overlays:

Activation:

GetProgressStats.php ? sessionID = ... & dimensionIDs = ... & indicatorIDs = ... & campaignIDs = ...    
    [ & placementIDs = ... ]
        
    [ & orderIDs = ... ]
        
    [ & withPlacementRoots = ... ]
        
    [ & placementPrintMode = ... ]
        
    [ & timeDivision = ... ]
        
    [ & recursiveGoals = ... ]
        
    [ & timeUnits = ... ]
        
    [ & showNames = ... ]
        
    [ & humanDates = ... ]
        
    [ & indicatorNames = ... ]
        
    [ & sortIndicatorIDs = ... & indicatorSortOrders = ... ]
        
    [ & limit = ... ]
        
    [ & offset = ... ]

Description:

    Returns progress and goal statistics for given campaigns.

    Output format may vary depending on the input parameters.

    Available dimension intersections are:
        - campaign,
        - placement,
        - order,
        - placement × order.
    See Indicators->GetIndicatorDimensionsList.

    Indicators from groups progress, basicGeneral and basicNonGeneral
    are available for this command. See Indicators->GetIndicatorsList.

    - *Progress - percentage, non negative real number, 1.0 means 100%.
    - *Goal - set for placement, order or campaign

    Publishers do not see statistics for placement nodes.

Parameters:

• sessionID: string(16)
• dimensionIDs: uint list - list of indicator dimensions to intersect, they will appear in output
• indicatorIDs: uint list - list of indicators (only progress, goal and basic indicators are allowed)
• campaignIDs: uint list - max 40 campaigns
• placementIDs: uint list - filter for specific placements
• orderIDs: uint list - filter for specific orders
• withPlacementRoots: enum('Y',N') default 'Y' - show records for campaign root placements
• placementPrintMode: enum('all','nodes','leaves') default 'all' - whether to show placements, folders or either placements and folders in output
• timeDivision: enum('General', 'Month', 'Week', 'Day', 'Hour') - name of a time period for which statistics will be displayed
• recursiveGoals: enum('Y','N') - for objects with no goals defined, compute them recursively, enabled by default
• timeUnits: timeunit list
• showNames: enum('Y','N') default 'N' - if enabled, names of objects in the result will be printed
• humanDates: enum('Y','N') default 'N'
• indicatorNames: enum('Y','N') default 'Y' - if enabled, statistic value will be surrounded by XML tag containing indicator name. Otherwise, tag will be named using indicator id (e.g. <indicatorID_3>34</indicatorID_3>).
• sortIndicatorIDs: uint list - list of indicators, that will be used to sort records, must be subset of indicatorIDs
• indicatorSortOrders: enum('asc','desc') list - orders of indicator sorting, list must have the same length as sortIndicatorIDs
• limit: uint - limits result to given number of records
• offset: uint - skips given number of records

Results:

<GetProgressStats>
    <status>OK</status>
    <statisticsNumber>23</statisticsNumber> : uint - all records number (if there were no limit and offset)
    <statistics>
        <statisticsRecord>
            <campaignID>14771</campaignID> : uint
            <orderID>11258</orderID> : uint
            <placementID>4005331</placementID> : uint
            <periodName>General</periodName> : string
            <clicks>10634</clicks> : nullable float - statistic value
            <actionsProgress>0.000333</actionsProgress> : nullable float - statistic value
        </statisticsRecord>
    </statistics>
</GetProgressStats>

Throw Errors: