Miscellaneous Inventory APIs

List position types

GET /v1/inventory/position-type

Lists all available position types for the account.

Response - 200

[
    {
        "id": 1,
        "name": "",
        "templateFile": "",
        "thirdPartyQuotum": 0
    },
    {
        "id": 13,
        "name": "newsletter img tag",
        "templateFile": "",
        "thirdPartyQuotum": 0
    },
    {
        "id": 10,
        "name": "normal javascript",
        "templateFile": "",
        "thirdPartyQuotum": 0
    },
    {
        "id": 12,
        "name": "normal javascript / no empty",
        "templateFile": "",
        "thirdPartyQuotum": 0
    }
]

Response codes

List location channel options

GET /v1/inventory/location-channel-option

Lists all location channel options (such as normal position and available group levels).

Response - 200

[
    {
        "code": 0,
        "name": "normal position (no group)"
    },
    {
        "code": 1,
        "name": "group level 1"
    },
    {
        "code": 2,
        "name": "group level 2"
    },
    {
        "code": 3,
        "name": "group level 3"
    },
    {
        "code": 4,
        "name": "group level 4"
    },
    {
        "code": 5,
        "name": "group level 5"
    }
]

Response codes

List available formats

GET /v1/inventory/format

Retrieves all available ad formats (templates) that can be assigned to positions.

Response - 200

[
    {
        "id": 4,
        "name": "Billboard",
        "width": 970,
        "height": 250,
        "active": true,
        "comment": "",
        "templateFile": "",
        "allTogetherOrder": 0,
        "hasCompletionRateEvents": 0,
        "codeTag": "billboard",
        "codeBook": "billboard"
    },
    {
        "id": 1,
        "name": "Halfpage",
        "width": 300,
        "height": 600,
        "active": true,
        "comment": "",
        "templateFile": "",
        "allTogetherOrder": 0,
        "hasCompletionRateEvents": 0,
        "codeTag": "halfpage",
        "codeBook": "halfpage"
    },
    {
        "id": 6,
        "name": "Landscape Screen",
        "width": 16,
        "height": 9,
        "active": true,
        "comment": "",
        "templateFile": "",
        "allTogetherOrder": 0,
        "hasCompletionRateEvents": 0,
        "codeTag": "landscape",
        "codeBook": "landscape"
    },
    {
        "id": 5,
        "name": "Leaderboard",
        "width": 728,
        "height": 90,
        "active": true,
        "comment": "",
        "templateFile": "",
        "allTogetherOrder": 0,
        "hasCompletionRateEvents": 0,
        "codeTag": "leaderboard",
        "codeBook": "leaderboard"
    },
    {
        "id": 2,
        "name": "Medium Rectangle",
        "width": 300,
        "height": 250,
        "active": true,
        "comment": "",
        "templateFile": "",
        "allTogetherOrder": 0,
        "hasCompletionRateEvents": 0,
        "codeTag": "imu",
        "codeBook": "imu;halfpage"
    },
    {
        "id": 7,
        "name": "Portrait Screen",
        "width": 9,
        "height": 16,
        "active": true,
        "comment": "",
        "templateFile": "",
        "allTogetherOrder": 0,
        "hasCompletionRateEvents": 0,
        "codeTag": "portrait",
        "codeBook": "portrait"
    },
    {
        "id": 3,
        "name": "Wide Skyscraper",
        "width": 160,
        "height": 600,
        "active": true,
        "comment": "",
        "templateFile": "",
        "allTogetherOrder": 0,
        "hasCompletionRateEvents": 0,
        "codeTag": "skyscraper",
        "codeBook": "skyscraper"
    }
]

Response codes