You are here: Developers > OpenX Platform API > Platform API reference > report object

report object

Last updated on June 23, 2017

 

The report object provides the following calls:

 

Call Description
GET /report/available_fields List the available fields to create or update a report. Open report example 1.
GET /report/get_reportlist List all reports available for your account. Open report example 4.
GET /report/get_report_inputs?report=report_code

Return the inputs for the specified report code, such as report=adunit_size_sum.

You can retrieve the available report codes using the GET /report/get_reportlist call. Open report example 3.

GET /report/run

Run the report specified in the report parameter.

Parameter

Description

report

The report code, such as report=adunit_size_sum. You can retrieve the available report codes using the GET /report/get_reportlist call.

start_date

A specific date in yyyy-mm-dd HH:MM:SS format or an integer for the days backward from today. For example, 7 means "seven days ago" and 0 means "starting today" (inclusive).

end_date

A specific date in yyyy-mm-dd HH:MM:SS format or a negative integer for the days from now. For example, -7 means "until seven days from now" and 0 means "before today" (exclusive).

do_break The breakout parameters being used in the request. These parameters vary by report.
report_format

The format of the report data to download, such as report_format=csv. Size limitations include:

csv

No limitations

json

Maximum of 1000 rows

pdf

No limitations

xls

Maximum of 65,000 rows

(variable_parameters)

(Optional) Depending on the report code, the response from GET /report/get_report_inputs provides additional parameters.

Open report example 5.
GET /report/download/report_ID

Download a report. You can get a report's ID from the response to the GET /report/run call.

Sample request:

curl http://openx_server_name/ox/4.0/report/download/3bcbd450-750a-45e6-b828-5cb448a2e374 
--cookie "openx3_access_token=token_string"
GET /report/list_accounts_with_segments List accounts that have at least one audience segmentA group of users with similar traits or characteristics..
GET /report/get_report_columns?report=report_code

Return the columns for the specified report code. Open report example 2.

GET /report/report_ID Read the specified report.
GET /report/traffic_lineitem_alerts

Return traffic line itemThe primary unit of execution for an order, which represents a specific inventory purchase and the required conditions for ad delivery. alerts.

Parameter

Description

start_date

A specific date in yyyy-mm-dd HH:MM:SS format or an integer for the days backward from today. For example, 7 means "seven days ago" and 0 means "starting today" (inclusive).

end_date

A specific date in yyyy-mm-dd HH:MM:SS format or a negative integer for the days from now. For example, -7 means "until seven days from now" and 0 means "before today" (exclusive).

GET /report/traffic_by_account_time

Return traffic-by-account-time data.

Parameter

Description

start_date

A specific date in yyyy-mm-dd HH:MM:SS format or an integer for the days backward from today. For example, 7 means "seven days ago" and 0 means "starting today" (inclusive).

end_date

A specific date in yyyy-mm-dd HH:MM:SS format or a negative integer for the days from now. For example, -7 means "until seven days from now" and 0 means "before today" (exclusive).

GET /report/traffic_by_order Return traffic-by-order data.

Parameter

Description

start_date

A specific date in yyyy-mm-dd HH:MM:SS format or an integer for the days backward from today. For example, 7 means "seven days ago" and 0 means "starting today" (inclusive).

end_date

A specific date in yyyy-mm-dd HH:MM:SS format or a negative integer for the days from now. For example, -7 means "until seven days from now" and 0 means "before today" (exclusive).

GET /report/video_ad_type_options Return a list of video ad type IDs used to filter the Video Events By AdvertiserIn OpenX, an account type that represents a business that runs advertising campaigns to display ads on websites. report (video_perf).

Response

[
	{
	"id": "3rd Party Linear Video", 
	"name": "3rd Party Linear Video"
	}, 
	{
	"id": "3rd Party Non-Linear Video", 
	"name": "3rd Party Non-Linear Video"
	}, 
	{
	"id": "Linear Video", 
	"name": "Linear Video"
	}, 
	{
	"id": "Non-Linear Video", 
	"name": "Non-Linear Video"
	}
]
POST /report/revenue_impact_by_floors

Return total revenue impact for the specified brand floors.

Parameter

Description

floor_uids

A comma-separated list of brand floorThe minimum price a publisher is willing to accept for a given impression. UIDs.

start_date

A specific date in yyyy-mm-dd HH:MM:SS format or an integer for the days backward from today. For example, 7 means "seven days ago" and 0 means "starting today" (inclusive).

end_date

A specific date in yyyy-mm-dd HH:MM:SS format or a negative integer for the days from now. For example, -7 means "until seven days from now" and 0 means "before today" (exclusive).

See also

Feedback form