Publisher

• publishers
• placements
• reports
• Lookup Tables

Resource Overview

publishers

publishers commands are used to view (GET), add (POST), update (PUT) and DELETE Publishers.

Example POST request: https://oiapi.com/v1/publishers/

{ 
    "name": "Some Name",  
    "status_id": 1,
    "category_id": 1010
}
	

Example GET response: https://oiapi.com/v1/publishers/

{ 
    "id": 59,  
    "name": "Some Name",
    "create_date": "2014-11-17T12:30:30Z", 
    "modify_date": "2014-11-17T14:56:10Z",  
    "status_id": 1, 
    "category_id": 1010,
    "key": ""
}
	

Example PUT request: https://oiapi.com/v1/publishers/59

{ 
    "status_id": 2 
}
	

The examples above create an Publisher named "Some Name" in the Retail & E-commerce category. In the final PUT request we modify the status_id to "2", thus making the Publisher inactive.

placements

placements commands are used to view (GET), add (POST), and update (PUT) Placements.

Example POST request: https://oiapi.com/v1/placements/

{ 
    "publisher_id": 59, 
    "name": "My Website Placement 1",
    "status_id": 9,
    "category_id": 1010,
    "layout_id": 1,
    "offer_format_id": 2607,
    "max_offers": 4,
    "parameter_share": true
}
	

This command would create a Placement called My Website Placement 1. Users would only be shown Offers 2 times within a 7 day period. Once created, a success response is returned:

{
    "status": "Save Successful",
    "message": "Placement successfully saved",
    "id": 98987676
}
	

Example GET response: https://oiapi.com/v1/placements/98987676/

{ 
    "publisher_id": 59, 
    "id": "98987676",
    "name": "My Website Placement 1",
    "status_id": 9,
    "category_id": 1010,
    "create_date": "2014-11-17T12:30:30Z", 
    "modify_date": "2014-11-17T14:56:10Z",  
    "layout_id": 1,
    "offer_format_id": 2607,
    "max_offers": 4,
    "parameter_share": true
}
	

reports

reports/publishers commands are used to view (GET) statistics for a Placement or group of Placements.

Summary mode

Calling reports/publishers/ straight-away will return stats in Summary mode. The stats above will be nested as a list sub-field under today, yesterday and mtd (month to date).

Example GET response: https://oiapi.com/v1/reports/publishers/

{
    "status": "ok",
    "data": {
        "today": [
            {
                "IMPRESSIONS": 300,
                "RPM": 33.33,
                "REVENUE": 10
            }
        ],
        "yesterday": [
            {
                "IMPRESSIONS": 400,
                "RPM": 50,
                "REVENUE": 20
            }
        ],
        "mtd": [
            {
                "IMPRESSIONS": 1500,
                "RPM": 60,
                "REVENUE": 90
            }
        ]
    }
}
	

Custom mode

Calling reports with an added parameter start will return stats in Custom mode. The max range for a Custom mode return is 2000 rows. In order to view the rest of the data for a custom report, you will have to pass in additional pagination parameters.

Example GET response: https://oiapi.com/v1/reports/publishers/?start=2014-11-01

{
{
    "status": "ok",
    "data": {
        "custom": [
            {
                "IMPRESSIONS": 4056,
                "RPM": 3.2,
                "REVENUE": 13.01
            }
        ]
    }
}
	

An additional parameter, end will allow for a snapshot for specific period. Both start and end dates are inclusive. Remember there is still a 2000 row limit for data returned. In order to view the rest of the data for a custom report, you will have to pass in additional pagination parameters.

Additional features

The following features can be utilized both in Summary and Custom modes.

The id-type parameter enables stats filtering by Placement or by Publisher. An additional field, ids, must also be present, representing the Placement(s) or Publishers(s) to filter by.

https://oiapi.com/v1/reports/publishers/?start=2014-11-01&end=2014-11-05&id-type=publisher&ids=123

{
    "status": "ok", 
    "data": {
        "custom": [
            {
                "IMPRESSIONS": 3000,
                "RPM": 5.00,
                "REVENUE": 15.00
            }
        ]
    }
}
	

https://oiapi.com/v1/reports/advertisers/?start=2014-11-01&end=2014-11-05&id-type=placement&ids=98987676

{
    "status": "ok", 
    "data": {
        "custom": [
            {
                "IMPRESSIONS": 2000,
                "RPM": 6.00,
                "REVENUE": 12.00
            }
        ]
    }
}
	

The fields parameter will limit the stats returned to only those fields listed. Acceptable values for this parameter are rpm, revenue, and impressions. You are able to pass in multiple values by using a comma separated list.

The example below will show the RPM for all Placements rolled into one data set.

{
    "status": "ok",
    "data": {
        "custom": [
            {
                "PUB_ID": 98765,
                "RPM": 7,
                "PUB": "Some Publisher Name"
            }
        ]
    }
}
	

The groupby parameter enables a stats roll-up by Placement, Publisher, and Sub-Affiliate ID. Acceptable values for this parameter are placement, publisher, subid, and subid2. You are able to pass multiiple values by using a comma separated list.

Changing the groupby parameter will display a data set for each Offer.

{
    "status": "ok",
    "data": {
        "custom": [
            {
                "PUB_ID": 98765,
                "PLACEMENT_ID": 87654321,
                "RPM": 10,
                "PUB": "Some Publisher Name",
                "PLACEMENT": "Some Placement Name [1]"
            },
            {
                "PUB_ID": 98765,
                "PLACEMENT_ID": 12345678,
                "RPM": 5,
                "PUB": "Some Publisher Name",
                "PLACEMENT": "Some Placement Name [2]"
            }
        ]
    }
}
	

The row_start and row_limit parameters allow you to view the rest of your data if the report exceeds 2000 rows, or to limit how many rows are returned. The values for row_start and row_limit must both be whole numbers. The default row limit is 100 and the default starting row is 1.