Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
65 changes: 63 additions & 2 deletions docs/_partials/planner-api/hcp.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -828,6 +828,34 @@ Get Healthcare proposal Planner details by ID.
}
```

<details className="objectPropertiesDetails" style={{ maxWidth: "100%", padding: "1rem" }}>
<summary style={{fontSize: "16px"}}>More responses</summary>

```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"
}
]
}
```

</details>

</div></div>

---
Expand All @@ -848,7 +876,7 @@ A plan <var>id</var> can be used in the [HCP Planner details by ID](#hcp-planner
| `pageNo` <br /><span class="type-text">integer</span> | Page number of retrieved data, default: <var>1</var>. |
| `noOfEntries` <br /><span class="type-text">integer</span> | Number of entries returned per page, default: <var>50</var>. |
| `searchField` <br /><span class="type-text">string</span> | Filter results by search field: account name. |
| `sortBy` <br /><span class="type-text">string</span> | Sorts by ascending (<var>+</var>) or descending (<var>-</var>). <br />Supported values: <var>id</var>, <var>name</var>, <var>createdBy</var>, <var>createdOn</var>, <var>startDate</var>, <var>reach</var>, <var>impression</var>, <var>budget</var>. |
| `sortBy` <br /><span class="type-text">string</span> | Sorts by ascending (<var>+</var>) or descending (<var>-</var>), default: <var>-id</var>. <br />Supported values: <var>id</var>, <var>name</var>, <var>createdBy</var>, <var>createdOn</var>, <var>startDate</var>, <var>endDate</var>, <var>reach</var>, <var>impressions</var>, <var>budget</var>, <var>duration</var>. |
| `statusIds` <br /><span class="type-text">string</span> | Comma separated status IDs. |
| `budgetTypeIds` <br /><span class="type-text">string</span> | Comma separated budget type IDs: budget(<var>1</var>) or impression(<var>2</var>). |
| `startDate` <br /><span class="type-text">integer</span> | Epoch time in milliseconds. |
Expand Down Expand Up @@ -890,6 +918,10 @@ A plan <var>id</var> can be used in the [HCP Planner details by ID](#hcp-planner
<td>`endDate` <br /><span class="type-text">integer</span></td>
<td>Unix epoch end date, in milliseconds.</td>
</tr>
<tr>
<td>`timezoneId` <br /><span class="type-text">integer</span></td>
<td>[Timezone ID](/guidelines/master-api#get-timezones) of the plan.</td>
</tr>
<tr>
<td>`reach` <br /><span class="type-text">integer</span></td>
<td>Reach.</td>
Expand Down Expand Up @@ -938,6 +970,7 @@ A plan <var>id</var> 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,
Expand Down Expand Up @@ -1333,6 +1366,34 @@ Update an existing Healthcare proposal Planner by ID. See resource properties fo
}
```

<details className="objectPropertiesDetails" style={{ maxWidth: "100%", padding: "1rem" }}>
<summary style={{fontSize: "16px"}}>More responses</summary>

```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"
}
]
}
```

</details>

</div></div>

---
Expand Down Expand Up @@ -1427,7 +1488,7 @@ Check if a Healthcare proposal Planner name is available for use within the Orga

### Get targeting graphs

<CopyUrl method="POST" url="https://api.iqm.com/api/v3/plan-targeting-graphs" operationId="getTargetingGraphs" />
<CopyUrl method="POST" url="https://api.iqm.com/api/v3/plan/hcp/plan-targeting-graphs" operationId="getTargetingGraphs" />

<div class="endpoint-container">
<div class="child1">
Expand Down
48 changes: 44 additions & 4 deletions docs/_partials/planner-api/political.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -249,11 +249,11 @@ import { deviceType } from '@site/src/data/enums/deviceType';
</td></tr>
<tr>
<td>`whitelistedAudiences` <br /><span class="type-text">array of integers</span></td>
<td>Whitelisted [audience IDs](/guidelines/audience-api/#audience-details-list).</td>
<td>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 (<var>objectiveId: 3</var>).</td>
</tr>
<tr>
<td>`blacklistedAudiences` <br /><span class="type-text">array of integers</span></td>
<td>Blacklisted [audience IDs](/guidelines/audience-api/#audience-details-list).</td>
<td>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 (<var>objectiveId: 3</var>).</td>
</tr>
<tr>
<td>`prebidSegments` <br /><span class="type-text">array of integers</span></td>
Expand Down Expand Up @@ -768,7 +768,7 @@ A plan <var>id</var> can be used in the [Get plan details by ID](#get-plan-detai
| `pageNo` <br /><span class="type-text">integer</span> | Page number of retrieved data, default: <var>1</var>. |
| `noOfEntries` <br /><span class="type-text">integer</span> | Number of entries returned per page, default: <var>50</var>. |
| `searchField` <br /><span class="type-text">string</span> | Search by plan name, ID, or created by user name. |
| `sortBy` <br /><span class="type-text">string</span> | Sorts by ascending (<var>+</var>) or descending (<var>-</var>), default: <var>-id</var>. <br />Supported values: <var>id</var>, <var>name</var>, <var>createdOn</var>, <var>createdBy</var>, <var>startDate</var>, <var>endDate</var>, <var>objectiveId</var>, <var>linkedProposals</var>. |
| `sortBy` <br /><span class="type-text">string</span> | Sorts by ascending (<var>+</var>) or descending (<var>-</var>), default: <var>-id</var>. <br />Supported values: <var>id</var>, <var>name</var>, <var>createdOn</var>, <var>createdBy</var>, <var>startDate</var>, <var>endDate</var>, <var>objectiveId</var>, <var>totalProposals</var>, <var>duration</var>. |
| `statusIds` <br /><span class="type-text">string</span> | Comma-separated [status IDs](#get-plan-statuses). <br /><EnumWidget values={planStatus} /> |
| `objectiveIds` <br /><span class="type-text">string</span> | Comma-separated [objective IDs](#get-plan-objectives). <br /><EnumWidget values={planObjectives} /> |

Expand Down Expand Up @@ -884,7 +884,7 @@ Get a paginated list of Political proposals with comprehensive metadata includin
| `pageNo` <br /><span class="type-text">integer</span> | Page number of retrieved data, default: <var>1</var>. |
| `noOfEntries` <br /><span class="type-text">integer</span> | Number of entries returned per page, default: <var>50</var>. |
| `searchField` <br /><span class="type-text">string</span> | Search by proposal name, ID, or created by user name. |
| `sortBy` <br /><span class="type-text">string</span> | Sorts by ascending (<var>+</var>) or descending (<var>-</var>), default: <var>-id</var>. <br />Supported values: <var>id</var>, <var>name</var>, <var>createdOn</var>, <var>createdBy</var>, <var>startDate</var>, <var>endDate</var>, <var>reach</var>, <var>impressions</var>, <var>cpm</var>, <var>budget</var>. |
| `sortBy` <br /><span class="type-text">string</span> | Sorts by ascending (<var>+</var>) or descending (<var>-</var>), default: <var>-id</var>. <br />Supported values: <var>id</var>, <var>name</var>, <var>createdOn</var>, <var>createdBy</var>, <var>startDate</var>, <var>endDate</var>, <var>reach</var>, <var>impressions</var>, <var>cpm</var>, <var>budget</var>, <var>frequency</var>. |
| `statusIds` <br /><span class="type-text">string</span> | Comma-separated [status IDs](/guidelines/planner-api/#proposal-status-list). <br /><EnumWidget values={proposalStatus} /> |
| `planId` <br /><span class="type-text">integer</span> | Filter proposals by [plan ID](#get-list-of-political-plans). |

Expand Down Expand Up @@ -928,6 +928,10 @@ Get a paginated list of Political proposals with comprehensive metadata includin
<td>`endDate` <br /><span class="type-text">integer</span></td>
<td>Unix epoch end date, in milliseconds.</td>
</tr>
<tr>
<td>`timezoneId` <br /><span class="type-text">integer</span></td>
<td>[Timezone ID](/guidelines/master-api#get-timezones) of the proposal.</td>
</tr>
<tr>
<td>`reach` <br /><span class="type-text">integer</span></td>
<td>Estimated reach.</td>
Expand Down Expand Up @@ -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,
Expand All @@ -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,
Expand Down Expand Up @@ -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,
Expand All @@ -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,
Expand Down Expand Up @@ -1725,6 +1733,22 @@ See resource properties for request schema.
}
```

<details className="objectPropertiesDetails" style={{ maxWidth: "100%", padding: "1rem" }}>
<summary style={{fontSize: "16px"}}>More responses</summary>

```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]"
}
]
}
```

</details>

</div></div>

---
Expand Down Expand Up @@ -1759,6 +1783,22 @@ See resource properties for request schema.
}
```

<details className="objectPropertiesDetails" style={{ maxWidth: "100%", padding: "1rem" }}>
<summary style={{fontSize: "16px"}}>More responses</summary>

```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]"
}
]
}
```

</details>

</div></div>

---
Expand Down
Loading
Loading