Reporting API
- Jon Link (Unlicensed)
Overview
Our API requires POST requests to be made with all fields as POST data. Fields with multiple values should be passed as JSON arrays (eg. [“value1”, “value2”]).
Responses can be in either JSON or CSV format.
Reporting
The report method can be used to view delivery and earnings data across a specific publisher's placement groups and placements. You can choose what data you want to see. Note that the data will be grouped on, and the metrics aggregated by, the dimensions that you specify.
The API endpoint is:
Request Parameters
Field | Required | Default | Description |
|---|---|---|---|
key | Yes | n/a | Found in your account settings |
format | No | json | “json” or “csv” |
start_date | No | (yesterday) | YYYY-MM-DD format |
end_date | No | (yesterday) | YYYY-MM-DD format |
dimensions | No | ["date", "order_id", "order_name"] | JSON array of dimensions |
metrics | No | ["mobilefuse_clicks", "mobilefuse_imps", "mobilefuse_video_starts", "mobilefuse_video_completes", "billable_clicks", "billable_imps", "billable_video_starts", "billable_video_completes"] | JSON array of metrics |
filters | No | {} | JSON object of filters (note any of the supplied ids can match), eg. {"placement_id": ["first_id”, “second_id"]} |
Available Dimensions
Dimension | Type | Example | Description |
|---|---|---|---|
date | date | 2022-07-01 | YYYY-MM-DD format |
hour | datetime | 2022-07-31 02:00:00 | YYYY-MM-DD HH:00:00 format |
week | date | 2022-07-03 | YYYY-MM-DD format of the first Sunday in that week |
month | string | 2022-07 | YYYY-MM format |
year | int | 2022 | YYYY format |
creative_id | int | 700000 | ID of the creative |
creative_name | string | 300x250Mindset | Name of the creative |
line_item_id | int | 300000 | ID of the line item, also referred to as a placement. It is a grouping of creatives |
line_item_name | string | ABC2022JanMindset | Name of the line item, also referred to as a placement. It is a grouping of creatives |
order_id | int | 100000 | ID of the order, encompassing all stats for a campaign |
order_name | string | ABC2022 | Name of the order, encompassing all stats for a campaign |
Available Metrics
Metric | Type | Example | Description |
|---|---|---|---|
mobilefuse_clicks | int | 500 | MobileFuse’s recorded number of ad clicks |
mobilefuse_conversions | int | 30 | MobileFuse’s recorded number of conversions |
mobilefuse_ctr | double | 1.25 | Click Through Rate based on mobilefuse_imps and mobilefuse_clicks, expressed as a decimal |
mobilefuse_imps | int | 25000 | MobileFuse’s recorded number of impressions |
mobilefuse_installs | int | 150 | MobileFuse’s recorded number of installs |
mobilefuse_vcr | double | 0.254 | Video Completion Rate based on mobilefuse_video_starts and mobilefuse_video_completes, expressed as a decimal |
mobilefuse_video_starts | int | 50 | MobileFuse’s recorded number of video starts |
mobilefuse_video_first_quartiles | int | 50 | MobileFuse’s recorded number of first quartile events (25% completion) |
mobilefuse_video_midpoints | int | 50 | MobileFuse’s recorded number of midpoint events (50% completion) |
mobilefuse_video_billable_quartiles | int | 50 | MobileFuse’s recorded number of third quartile events (75% completion) |
mobilefuse_video_completes | int | 50 | MobileFuse’s recorded number of video completion events (100% completion) |
billable_clicks | int | 500 | Billable number of ad clicks |
billable_conversions | int | 30 | Billable number of conversions |
billable_ctr | double | 1.25 | Click Through Rate based on billable_imps and billable_clicks, expressed as a decimal |
billable_imps | int | 25000 | Billable number of impressions |
billable_installs | int | 150 | Billable number of installs |
billable_vcr | double | 0.254 | Video Completion Rate based on billable_video_starts and billable_video_completes, expressed as a decimal |
billable_video_starts | int | 50 | Billable number of video starts |
billable_video_first_quartiles | int | 50 | Billable number of first quartile events (25% completion) |
billable_video_midpoints | int | 50 | Billable number of midpoint events (50% completion) |
billable_video_billable_quartiles | int | 50 | Billable number of third quartile events (75% completion) |
billable_partner_video_completes | int | 50 | Billable number of video completion events (100% completion) |
Available Filters
Dimension | Type | Example | Description |
|---|---|---|---|
creative_id | int | 600000 | ID of the creative |
line_item_id | int | 600000 | ID of the line item, also referred to as a placement. It is a grouping of creatives |
order_id | int | 600000 | ID of the order, encompassing all stats for a campaign |
Example JSON Response
Given the following request:
curl -X POST -H "Content-Type: multipart/form-data;" -F "key=[INSERT_KEY_HERE]" -F "format=json" -F "start_date=2022-08-01" -F "end_date=2022-08-02" -F "dimensions=[\"date\"]" -F "metrics=[\"mobilefuse_imps\", \"mobilefuse_clicks\", \"mobilefuse_video_starts\", \"mobilefuse_video_completes\"]" "https://dashboard.mobilefuse.com/api/v2/report"Or the following request, if you want to query for a specific placement:
curl -X POST -H "Content-Type: multipart/form-data;" -F "key=[INSERT_KEY_HERE]" -F "format=json" -F "start_date=2022-08-01" -F "end_date=2022-08-02" -F "dimensions=[\"date\"]" -F "metrics=[\"mobilefuse_imps\", \"mobilefuse_clicks\", \"mobilefuse_video_starts\", \"mobilefuse_video_completes\"]" -F "filters={\"order_id\": [100000]}" "https://dashboard.mobilefuse.com/api/v2/report"You will receive a response similar to the following (note for errors, “status” will be “error” and there will be a description in the “message” field):
{
"status": "success",
"data": [
{
"date": "2022-06-01",
"mobilefuse_imps": "1000",
"mobilefuse_clicks": "10",
"mobilefuse_video_starts": "1000",
"mobilefuse_video_completes": "900"
},
{
"date": "2022-06-02",
"mobilefuse_imps": "1000",
"mobilefuse_clicks": "10",
"mobilefuse_video_starts": "1000",
"mobilefuse_video_completes": "900"
}
]
}Example CSV Response
Given the following request:
You will receive a response similar to the following (not for errors, the output will start with “Error:” followed by a description of the error.:
Note: All strings are enclosed in “double quotes”.
Get a List of Orders
The orders method can be used to retrieve a list of all active orders.
The API endpoint is:
https://dashboard.mobilefuse.com/api/v2/orders
Request Parameters
Field | Required | Default | Description |
|---|---|---|---|
key | Yes | n/a | Found in your account settings |
format | No | json | “json” or “csv” |
Example JSON Response
Given the following request:
You will receive a response similar to the following:
Example CSV Response
Given the following request:
You will receive a response similar to the following:
Note: All strings are enclosed in “double quotes”.
Get a List of Line Items
The orders method can be used to retrieve a list of all active line items.
The API endpoint is:
https://dashboard.mobilefuse.com/api/v2/line-items
Request Parameters
Field | Required | Default | Description |
|---|---|---|---|
key | Yes | n/a | Found in your account settings |
format | No | json | “json” or “csv” |
Example JSON Response
Given the following request:
You will receive a response similar to the following:
Get a List of Creatives
The orders method can be used to retrieve a list of all creatives.
The API endpoint is:
https://dashboard.mobilefuse.com/api/v2/creatives
Request Parameters
Field | Required | Default | Description |
|---|---|---|---|
key | Yes | n/a | Found in your account settings |
format | No | json | “json” or “csv” |
Example JSON Response
Given the following request:
You will receive a response similar to the following: