Insight Report Definition Requests

This page provides examples for the following requests:

List All Insight Report Definitions

Method GET
URL https://api.videoplaza.com/api/2.0/report-definition
Header Authentication header (x-o-api-key)
Content type application/json
URL params -
Query params -
Body -
Success response

HTTP status: 200 OK

Header: -

Body: A list of all the default and custom report templates:

[
    {
        "id": "<string>",
        "name": "<string>",
        "created": "<string>,
        "type": "<default|custom>",
        "filters": [
            {
                "type": "<string>",
                "id": "<string>"
            }
        ]
    },
    {
        "id": "<string>",
        "name": "<string>",
        "created": "<string>,
        "type": "<default|custom>",
        "filters": [
            {
                "type": "<string>",
                "id": "<string>"
            }
        ]
    }
]

Example:

Request header:

GET /api/2.0/report-definition HTTP/1.1
Host: api.videoplaza.com
Content-type: application/json
x-o-api-key="<your key>"

Request body: NA

Success response:

HTTP status:
    200 (OK)  

Body:
[
    {
        "id": "56de9277498e2bd57afc71ef",
        "name": "Category performance by campaign",
        "created": null,
        "type": "default",
        "filters": [
            {
                "type": "CATEGORY",
                "id": null
            },
            {
                "type": "TIME_PERIOD"
            }
        ]
    },
    {
        "id": "56de9277498e6096ecfa2aa9",
        "name": "Campaign performance by day",
        "created": null,
        "type": "default",
        "filters": [
            {
                "type": "CAMPAIGN",
                "id": null
            }
        ]
    },
    {
        "id": "57ea11af498e68b049d346cb",
        "name": "Campaign performance by Audience segments",
        "created": null,
        "type": "default",
        "filters": [
            {
                "type": "CAMPAIGN",
                "id": null
            }
        ]
    },
    {
        "id": "56de9277498ed663342784cb",
        "name": "Agency performance by creative and day",
        "created": null,
        "type": "default",
        "filters": [
            {
                "type": "AGENCY",
                "id": null
            },
            {
                "type": "TIME_PERIOD"
            }
        ]
    },
    {
        "id": "56de9277498e31479f896d8b",
        "name": "Brand performance by creative and day",
        "created": null,
        "type": "default",
        "filters": [
            {
                "type": "BRAND",
                "id": null
            },
            {
                "type": "TIME_PERIOD"
            }
        ]
    },
    {
        "id": "56de9277498e6096ecfa2aad",
        "name": "Advertiser performance by creative and day",
        "created": null,
        "type": "default",
        "filters": [
            {
                "type": "ADVERTISER",
                "id": null
            },
            {
                "type": "TIME_PERIOD"
            }
        ]
    },
    {
        "id": "56de9277498e2bd57afc71f1",
        "name": "Account performance by device group",
        "created": null,
        "type": "default",
        "filters": [
            {
                "type": "TIME_PERIOD"
            }
        ]
    },
    {
        "id": "56de9277498e6096ecfa2aab",
        "name": "Campaign performance by content partner",
        "created": null,
        "type": "default",
        "filters": [
            {
                "type": "CAMPAIGN",
                "id": null
            }
        ]
    },
    {
        "id": "56de9277498ed663342784c9",
        "name": "Category performance by day",
        "created": null,
        "type": "default",
        "filters": [
            {
                "type": "TIME_PERIOD"
            },
            {
                "type": "CATEGORY",
                "id": null
            }
        ]
    },
    {
        "id": "582c232a498e3da80f61c348",
        "name": "Campaign performance report by goal and ad",
        "created": "2016-11-16T09:13:14.990+0000",
        "type": "custom",
        "filters": [
            {
                "type": "CAMPAIGN",
                "id": "12e7c137-d421-40b0-a03d-ffc1c1704699"
            }
        ]
    },
    {
        "id": "56decaae498ed66334278dfb",
        "name": "Campaign performance report by format type and date",
        "created": "2016-03-08T12:50:54.097+0000",
        "type": "custom",
        "filters": [
            {
                "type": "CAMPAIGN",
                "id": "1cc9f23e-6b18-494b-a638-4f1fd5b45e09"
            }
        ]
    },
    {
        "id": "56de9277498e31479f896d89",
        "name": "Category performance by subcategory",
        "created": null,
        "type": "default",
        "filters": [
            {
                "type": "CATEGORY",
                "id": null
            },
            {
                "type": "TIME_PERIOD"
            }
        ]
    },
    {
        "id": "57ea11af498ea7ee77f29bf5",
        "name": "Category performance by Audience segments",
        "created": null,
        "type": "default",
        "filters": [
            {
                "type": "CATEGORY",
                "id": null
            }
        ]
    },
    {
        "id": "583307ea498ed7d288d02bea",
        "name": "Format type performance report by campaign",
        "created": "2016-11-21T14:42:50.566+0000",
        "type": "custom",
        "filters": [
            {
                "type": "CATEGORY",
                "id": "e7b9ce18-2d78-4fc7-a3a6-ca4bff0a26da"
            },
            {
                "type": "FORMAT_TYPE",
                "formatType": "preroll"
            }
        ]
    },
    {
        "id": "56de9277498ed663342784c7",
        "name": "Campaign performance by creative",
        "created": null,
        "type": "default",
        "filters": [
            {
                "type": "CAMPAIGN",
                "id": null
            }
        ]
    },
    {
        "id": "56de9277498e31479f896d87",
        "name": "Campaign performance by category",
        "created": null,
        "type": "default",
        "filters": [
            {
                "type": "CATEGORY",
                "id": null
            },
            {
                "type": "CAMPAIGN",
                "id": null
            }
        ]
    },
    {
        "id": "56de9277498e2bd57afc71ed",
        "name": "Campaign performance by device group",
        "created": null,
        "type": "default",
        "filters": [
            {
                "type": "CAMPAIGN",
                "id": null
            }
        ]
    }
]

Fetch an Insight Report Definition by ID

Method GET
URL https://api.videoplaza.com/api/2.0/report-definition/{id}
Header Authentication header (x-o-api-key)
Content type application/json
URL params ID of the report definition
Query params -
Body -
Success response

HTTP status: 200 OK

Header: -

Body: Specific report template:

[
    {
        "id": "<string>",
        "name": "<string>",
        "created": "<string>,
        "type": "<default|custom>",
        "filters": [
            {
                "type": "<string>",
                "id": "<string>"
            }
        ]
    }
]

Example:

Request header:

GET /api/2.0/report-definition/56de9277498ed663342784c7 HTTP/1.1
Host: api.videoplaza.com
Content-type: application/json
x-o-api-key="<your key>"

Request body: NA

Success response:

HTTP status:
    200 (OK)    

Body:
{
    "id": "56de9277498ed663342784c7",
    "name": "Campaign performance by creative",
    "created": null,
    "type": "default",
    "filters": [
        {
            "type": "CAMPAIGN",
            "id": null
        }
    ]
}

해당 내용이 도움 되었습니까?