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
26 changes: 13 additions & 13 deletions docs/_partials/audience-api/cva-audience.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,14 @@ import ExternalLink from '@site/static/img/external-link2.svg';
import CodeDropdown, { CodeOption } from '@site/src/components/CodeDropdown';
import { audienceStatuses } from '@site/src/data/enums/audienceStatuses';

### Get Custom Voter Audience details
### Get Custom Voter audience details

<CopyUrl method="GET" url="https://api.iqm.com/api/v3/audience/cva/{audienceId}" operationId="getCustomVoterAudienceDetailsByAudienceId" />

<div class="endpoint-container">
<div class="child1">

Get Custom Voter Audience details by ID.
Get Custom Voter audience details by ID.

| Path parameter | |
| --- | --- |
Expand Down Expand Up @@ -174,14 +174,14 @@ Get Custom Voter Audience details by ID.

---

### Get available states for Custom Voter Audiences
### Get available states for Custom Voter audiences

<CopyUrl method="GET" url="https://api.iqm.com/api/v3/audience/cva/states" operationId="getStates" />

<div class="endpoint-container">
<div class="child1">

Get list of available states for Custom Voter Audiences. (Note: This endpoint only returns states in the United States.)
Get list of available states for Custom Voter audiences. (Note: This endpoint only returns states in the United States.)

<details className="objectPropertiesDetails" style={{ maxWidth: "800px", padding: "1rem" }}>
<summary style={{ fontSize: "16px" }}>Response properties</summary>
Expand Down Expand Up @@ -241,14 +241,14 @@ Get list of available states for Custom Voter Audiences. (Note: This endpoint on

---

### Get Custom Voter Audience segment details
### Get Custom Voter audience segment details

<CopyUrl method="POST" url="https://api.iqm.com/api/v3/audience/cva/segments" operationId="getSegmentDetails" />

<div class="endpoint-container">
<div class="child1">

Browse the Custom Voter Audience segment catalogue to find segments to reference in a CVA <var>equation</var> (see [Create CVA Details](/political-vertical/planner/#create-cva-details)).
Browse the Custom Voter audience segment catalogue to find segments to reference in a CVA <var>equation</var> (see [Create CVA Details](/political-vertical/planner/#create-cva-details)).

The catalogue is a tree. Only leaf segments (<var>isLeaf: true</var>) carry a real, non-zero reach and are valid to reference in an equation. Category/grouping nodes (states, topic groupings, etc.) always report <var>reach: 0</var> and exist only to organize the tree. A leaf segment's <var>taxonomyId</var> (e.g. <var>IQMCVACA041742</var>) is the exact token to use inside an equation string.

Expand Down Expand Up @@ -675,14 +675,14 @@ This endpoint fetches the segments based on the search parameters provided:

---

### Create Custom Voter Audience
### Create Custom Voter audience

<CopyUrl method="POST" url="https://api.iqm.com/api/v3/audience/cva" operationId="createCustomVoterAudience" />

<div class="endpoint-container">
<div class="child1">

Create a Custom Voter Audience by providing audience details in the request body. The response includes the created audience ID which can be used to retrieve audience details and apply the audience to campaigns.
Create a Custom Voter audience by providing audience details in the request body. The response includes the created audience ID which can be used to retrieve audience details and apply the audience to campaigns.

Using segment IDs (from the [Master API](/guidelines/master-api)), you can build an audience with the <var>equation</var> field. Segment IDs in parentheses, separated by a vertical bar (|), will be in an 'or' relationship, which will combine the sets of segments; groups of segments in parentheses, separated by an ampersand (&), will be in an 'and' relationship, which will build an audience based on the intersection of those groups.

Expand Down Expand Up @@ -753,7 +753,7 @@ You can see an example of this format in the "Request sample" code block on the
"success": true,
"data": {
"id": 1143140,
"message": "Custom Voter Audience created successfully"
"message": "Custom Voter audience created successfully"
}
}
```
Expand All @@ -769,9 +769,9 @@ You can see an example of this format in the "Request sample" code block on the
<div class="endpoint-container">
<div class="child1">

Get reach data for a Custom Voter Audience.
Get reach data for a Custom Voter audience.

See the [Create Custom Voter Audience](#create-custom-voter-audience) endpoint for details on the <var>equation</var> parameter.
See the [Create Custom Voter audience](#create-custom-voter-audience) endpoint for details on the <var>equation</var> parameter.

| Request schema | |
| ---- | --- |
Expand Down Expand Up @@ -848,9 +848,9 @@ See the [Create Custom Voter Audience](#create-custom-voter-audience) endpoint f
<div class="endpoint-container">
<div class="child1">

Get Insights data for a Custom Voter Audience, including demographic breakdowns for party registration, gender, urbanicity, age, and ethnicity.
Get Insights data for a Custom Voter audience, including demographic breakdowns for party registration, gender, urbanicity, age, and ethnicity.

See the [Create Custom Voter Audience](#create-custom-voter-audience) endpoint for details on the <var>equation</var> parameter.
See the [Create Custom Voter audience](#create-custom-voter-audience) endpoint for details on the <var>equation</var> parameter.

| Request schema | |
| ---- | --- |
Expand Down
18 changes: 9 additions & 9 deletions docs/_partials/mcp/audience-index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -408,31 +408,31 @@
</tr>
</table>

### Custom Voter Audiences (CVA)
### Custom Voter audiences (CVA)

<table className="toolsIndex">
<th>Tool name</th>
<th>Description</th>
<th>Documentation</th>
<tr>
<td><code>createCustomVoterAudience</code></td>
<td>Create a new Custom Voter Audience</td>
<td>[Create Custom Voter Audience](/political-vertical/audience-segments/#create-custom-voter-audience)</td>
<td>Create a new Custom Voter audience</td>
<td>[Create Custom Voter audience](/political-vertical/audience-segments/#create-custom-voter-audience)</td>
</tr>
<tr>
<td><code>getCustomVoterAudienceDetailsByAudienceId</code></td>
<td>Get Custom Voter Audience details by ID</td>
<td>[Get Custom Voter Audience details](/political-vertical/audience-segments/#get-custom-voter-audience-details)</td>
<td>Get Custom Voter audience details by ID</td>
<td>[Get Custom Voter audience details](/political-vertical/audience-segments/#get-custom-voter-audience-details)</td>
</tr>
<tr>
<td><code>getSegmentDetails</code></td>
<td>Get segment details from the Custom Voter Audience segment catalogue</td>
<td>[Get Custom Voter Audience segment details](/political-vertical/audience-segments/#get-custom-voter-audience-segment-details)</td>
<td>Get segment details from the Custom Voter audience segment catalogue</td>
<td>[Get Custom Voter audience segment details](/political-vertical/audience-segments/#get-custom-voter-audience-segment-details)</td>
</tr>
<tr>
<td><code>getStates</code></td>
<td>Get the list of states available for Custom Voter Audiences</td>
<td>[Get available states for Custom Voter Audiences](/political-vertical/audience-segments/#get-available-states-for-custom-voter-audiences)</td>
<td>Get the list of states available for Custom Voter audiences</td>
<td>[Get available states for Custom Voter audiences](/political-vertical/audience-segments/#get-available-states-for-custom-voter-audiences)</td>
</tr>
</table>

Expand Down
4 changes: 2 additions & 2 deletions docs/_partials/mcp/planner-index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -284,12 +284,12 @@
</tr>
<tr>
<td><code>createCvaDetails</code></td>
<td>Create Custom Voter Audience (CVA) details</td>
<td>Create Custom Voter audience (CVA) details</td>
<td>[Create CVA details](/political-vertical/planner/#create-cva-details)</td>
</tr>
<tr>
<td><code>updateCvaDetails</code></td>
<td>Update Custom Voter Audience (CVA) details</td>
<td>Update Custom Voter audience (CVA) details</td>
<td>[Update CVA details](/political-vertical/planner/#update-cva-details)</td>
</tr>
</table>
Expand Down
Loading
Loading