diff --git a/docs/_partials/planner-api/hcp.mdx b/docs/_partials/planner-api/hcp.mdx index 056e15a8..28ff697f 100644 --- a/docs/_partials/planner-api/hcp.mdx +++ b/docs/_partials/planner-api/hcp.mdx @@ -828,6 +828,34 @@ Get Healthcare proposal Planner details by ID. } ``` +
+More responses + +```json title="Response 403" +{ + "success": false, + "errorObjects": [ + { + "error": "Plan with plan id 3104 does not exist" + } + ] +} +``` + +```json title="Response 422" +{ + "success": false, + "errorObjects": [ + { + "error": "Invalid Plan Id", + "field": "planId" + } + ] +} +``` + +
+ --- @@ -848,7 +876,7 @@ A plan id can be used in the [HCP Planner details by ID](#hcp-planner | `pageNo`
integer | Page number of retrieved data, default: 1. | | `noOfEntries`
integer | Number of entries returned per page, default: 50. | | `searchField`
string | Filter results by search field: account name. | -| `sortBy`
string | Sorts by ascending (+) or descending (-).
Supported values: id, name, createdBy, createdOn, startDate, reach, impression, budget. | +| `sortBy`
string | Sorts by ascending (+) or descending (-), default: -id.
Supported values: id, name, createdBy, createdOn, startDate, endDate, reach, impressions, budget, duration. | | `statusIds`
string | Comma separated status IDs. | | `budgetTypeIds`
string | Comma separated budget type IDs: budget(1) or impression(2). | | `startDate`
integer | Epoch time in milliseconds. | @@ -890,6 +918,10 @@ A plan id can be used in the [HCP Planner details by ID](#hcp-planner `endDate`
integer Unix epoch end date, in milliseconds. + + `timezoneId`
integer + [Timezone ID](/guidelines/master-api#get-timezones) of the plan. + `reach`
integer Reach. @@ -938,6 +970,7 @@ A plan id can be used in the [HCP Planner details by ID](#hcp-planner "userAvatarUrl": "https://iqm-web-assets-c92d6b6cbde1-stage.s3.amazonaws.com/avatar/HB.png", "startDate": 1752838419000, "endDate": 1753934400000, + "timezoneId": 29, "reach": 206567705, "impression": 37182186900, "budget": 334639683, @@ -1333,6 +1366,34 @@ Update an existing Healthcare proposal Planner by ID. See resource properties fo } ``` +
+More responses + +```json title="Response 403" +{ + "success": false, + "errorObjects": [ + { + "error": "Plan with plan id 3104 does not exist" + } + ] +} +``` + +```json title="Response 422" +{ + "success": false, + "errorObjects": [ + { + "error": "Invalid Plan Id", + "field": "planId" + } + ] +} +``` + +
+ --- @@ -1427,7 +1488,7 @@ Check if a Healthcare proposal Planner name is available for use within the Orga ### Get targeting graphs - +
diff --git a/docs/_partials/planner-api/political.mdx b/docs/_partials/planner-api/political.mdx index b5b0b3fd..e7010fef 100644 --- a/docs/_partials/planner-api/political.mdx +++ b/docs/_partials/planner-api/political.mdx @@ -249,11 +249,11 @@ import { deviceType } from '@site/src/data/enums/deviceType'; `whitelistedAudiences`
array of integers - Whitelisted [audience IDs](/guidelines/audience-api/#audience-details-list). + Whitelisted [audience IDs](/guidelines/audience-api/#audience-details-list). [Power Segment audiences](/political-vertical/audience-segments/#power-segment-audience-details) are supported, except for Voter TV+ plans (objectiveId: 3). `blacklistedAudiences`
array of integers - Blacklisted [audience IDs](/guidelines/audience-api/#audience-details-list). + Blacklisted [audience IDs](/guidelines/audience-api/#audience-details-list). [Power Segment audiences](/political-vertical/audience-segments/#power-segment-audience-details) are supported, except for Voter TV+ plans (objectiveId: 3). `prebidSegments`
array of integers @@ -768,7 +768,7 @@ A plan id can be used in the [Get plan details by ID](#get-plan-detai | `pageNo`
integer | Page number of retrieved data, default: 1. | | `noOfEntries`
integer | Number of entries returned per page, default: 50. | | `searchField`
string | Search by plan name, ID, or created by user name. | -| `sortBy`
string | Sorts by ascending (+) or descending (-), default: -id.
Supported values: id, name, createdOn, createdBy, startDate, endDate, objectiveId, linkedProposals. | +| `sortBy`
string | Sorts by ascending (+) or descending (-), default: -id.
Supported values: id, name, createdOn, createdBy, startDate, endDate, objectiveId, totalProposals, duration. | | `statusIds`
string | Comma-separated [status IDs](#get-plan-statuses).
| | `objectiveIds`
string | Comma-separated [objective IDs](#get-plan-objectives).
| @@ -884,7 +884,7 @@ Get a paginated list of Political proposals with comprehensive metadata includin | `pageNo`
integer | Page number of retrieved data, default: 1. | | `noOfEntries`
integer | Number of entries returned per page, default: 50. | | `searchField`
string | Search by proposal name, ID, or created by user name. | -| `sortBy`
string | Sorts by ascending (+) or descending (-), default: -id.
Supported values: id, name, createdOn, createdBy, startDate, endDate, reach, impressions, cpm, budget. | +| `sortBy`
string | Sorts by ascending (+) or descending (-), default: -id.
Supported values: id, name, createdOn, createdBy, startDate, endDate, reach, impressions, cpm, budget, frequency. | | `statusIds`
string | Comma-separated [status IDs](/guidelines/planner-api/#proposal-status-list).
| | `planId`
integer | Filter proposals by [plan ID](#get-list-of-political-plans). | @@ -928,6 +928,10 @@ Get a paginated list of Political proposals with comprehensive metadata includin `endDate`
integer Unix epoch end date, in milliseconds. + + `timezoneId`
integer + [Timezone ID](/guidelines/master-api#get-timezones) of the proposal. + `reach`
integer Estimated reach. @@ -989,6 +993,7 @@ Get a paginated list of Political proposals with comprehensive metadata includin "userAvatarUrl": "https://example.com/avatars/john-smith.png", "startDate": 1709654400000, "endDate": 1717430400000, + "timezoneId": 29, "reach": 500000, "impressions": 2000000, "cpm": 15.50, @@ -1010,6 +1015,7 @@ Get a paginated list of Political proposals with comprehensive metadata includin "userAvatarUrl": "https://example.com/avatars/jane-doe.png", "startDate": 1710259200000, "endDate": 1718640000000, + "timezoneId": 5, "reach": 750000, "impressions": 3000000, "cpm": 12.75, @@ -1049,6 +1055,7 @@ Get a paginated list of Political proposals with comprehensive metadata includin "userAvatarUrl": "https://example.com/avatars/john-smith.png", "startDate": 1709654400000, "endDate": 1717430400000, + "timezoneId": 29, "reach": 500000, "impressions": 2000000, "cpm": 15.50, @@ -1070,6 +1077,7 @@ Get a paginated list of Political proposals with comprehensive metadata includin "userAvatarUrl": "https://example.com/avatars/jane-doe.png", "startDate": 1710259200000, "endDate": 1718640000000, + "timezoneId": 5, "reach": 750000, "impressions": 3000000, "cpm": 12.75, @@ -1725,6 +1733,22 @@ See resource properties for request schema. } ``` +
+More responses + +```json title="Response 422" +{ + "success": false, + "errorObjects": [ + { + "error": "Power Segment audiences are not supported for Voter TV+. Remove the unsupported audience to proceed. Audience IDs: [1160231]" + } + ] +} +``` + +
+
--- @@ -1759,6 +1783,22 @@ See resource properties for request schema. } ``` +
+More responses + +```json title="Response 422" +{ + "success": false, + "errorObjects": [ + { + "error": "Power Segment audiences are not supported for Voter TV+. Remove the unsupported audience to proceed. Audience IDs: [1160231]" + } + ] +} +``` + +
+ --- diff --git a/docs/guidelines/planner-api.mdx b/docs/guidelines/planner-api.mdx index c397f723..2ae08e00 100644 --- a/docs/guidelines/planner-api.mdx +++ b/docs/guidelines/planner-api.mdx @@ -1162,6 +1162,33 @@ Get summary of maximum reach and impressions for different targeting parameters } ``` +
+More responses + +```json title="Response 403" +{ + "success": false, + "errorObjects": [ + { + "error": "Requested Proposal details is not accessible to logged-in user" + } + ] +} +``` + +```json title="Response 422" +{ + "success": false, + "errorObjects": [ + { + "error": "Proposal not found", + "field": "proposalId" + } + ] +} +``` +
+ @@ -1552,6 +1579,33 @@ Get summary of impressions distribution for different device types targeted in a } ``` +
+More responses + +```json title="Response 403" +{ + "success": false, + "errorObjects": [ + { + "error": "Requested Proposal details is not accessible to logged-in user" + } + ] +} +``` + +```json title="Response 422" +{ + "success": false, + "errorObjects": [ + { + "error": "Proposal not found", + "field": "proposalId" + } + ] +} +``` +
+ @@ -1945,6 +1999,33 @@ Get summary of impressions distribution for different channel types targeted in } ``` +
+More responses + +```json title="Response 403" +{ + "success": false, + "errorObjects": [ + { + "error": "Requested Proposal details is not accessible to logged-in user" + } + ] +} +``` + +```json title="Response 422" +{ + "success": false, + "errorObjects": [ + { + "error": "Proposal not found", + "field": "proposalId" + } + ] +} +``` +
+ @@ -2347,6 +2428,33 @@ Get summary of impressions distribution for different bid landscapes targeted in } ``` +
+More responses + +```json title="Response 403" +{ + "success": false, + "errorObjects": [ + { + "error": "Requested Proposal details is not accessible to logged-in user" + } + ] +} +``` + +```json title="Response 422" +{ + "success": false, + "errorObjects": [ + { + "error": "Proposal not found", + "field": "proposalId" + } + ] +} +``` +
+ @@ -3561,6 +3669,33 @@ Update proposal details. The target proposal must currently be in ready +More responses + +```json title="Response 403" +{ + "success": false, + "errorObjects": [ + { + "error": "Requested Proposal details is not accessible to logged-in user" + } + ] +} +``` + +```json title="Response 422" +{ + "success": false, + "errorObjects": [ + { + "error": "Proposal not found", + "field": "proposalId" + } + ] +} +``` + + @@ -4034,6 +4169,33 @@ Update draft proposal details. } ``` +
+More responses + +```json title="Response 403" +{ + "success": false, + "errorObjects": [ + { + "error": "Requested Proposal details is not accessible to logged-in user" + } + ] +} +``` + +```json title="Response 422" +{ + "success": false, + "errorObjects": [ + { + "error": "Proposal not found", + "field": "proposalId" + } + ] +} +``` +
+ @@ -4170,6 +4332,32 @@ Convert a proposal into an insertion order with draft campaigns. The proposal st } ``` +
+More responses + +```json title="Response 403" +{ + "success": false, + "errorObjects": [ + { + "error": "Requested Proposal details is not accessible to logged-in user" + } + ] +} +``` + +```json title="Response 422" +{ + "success": false, + "errorObjects": [ + { + "error": "Proposal not found" + } + ] +} +``` +
+ @@ -4269,6 +4457,21 @@ Restore expired proposals back to ready status by recalcul } ``` +
+More responses + +```json title="Response 403" +{ + "success": false, + "errorObjects": [ + { + "error": "Requested Proposal details is not accessible to logged-in user" + } + ] +} +``` +
+