Skip to content

Update mcp-planner.json #355

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
conor-iqm merged 1 commit into from
Oct 12, 2026
Merged

Update mcp-planner.json #355

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
34 changes: 24 additions & 10 deletions static/openapi/mcp-planner.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"openapi": "3.0.1",
"info": {
"title": "MCP Planner API Specification",
"version": "1.0.0",
"version": "1.0.1",
"description": "MCP Planner API Specification",
"contact": {
"name": "IQM Support",
Expand Down Expand Up @@ -2446,7 +2446,7 @@
{
"name": "sortBy",
"in": "query",
"description": "Sort the result set by specific field. For ascending use plus(+) sign(ascii value '%2B') and for descending use minus(-) sign. Allowed values - id, name, createdOn, createdBy, startDate, endDate, reach, impressions, cpm, budget",
"description": "Sort the result set by specific field. For ascending use plus(+) sign(ascii value '%2B') and for descending use minus(-) sign. Allowed values - id, name, createdOn, createdBy, startDate, endDate, reach, impressions, cpm, budget, frequency",
"required": false,
"schema": {
"type": "string",
Expand Down Expand Up @@ -3168,7 +3168,7 @@
"MCP"
],
"summary": "API to create a political plan (ready)",
"description": "Creates a new political plan in ready status. Name, details, and targeting are required. The\nprovided targeting.creative/targeting.device selection is sent to an external strategy-generation\nservice (DSI), which computes viable strategies from real-time inventory/forecast data -- there is\nno fixed, enumerable list of valid creative/device combinations within this API itself. If DSI\nfinds no viable strategy for the given combination (even one where every individual ID is valid),\nthe request is rejected with \"No strategies meet your criteria. Edit the plan to explore more\noptions.\" rather than a field-specific validation error.\n",
"description": "Creates a new political plan in ready status. Name, details, and targeting are required. The\nprovided targeting.creative/targeting.device selection is sent to an external strategy-generation\nservice (DSI), which computes viable strategies from real-time inventory/forecast data -- there is\nno fixed, enumerable list of valid creative/device combinations within this API itself. If DSI\nfinds no viable strategy for the given combination (even one where every individual ID is valid),\nthe request is rejected with \"No strategies meet your criteria. Edit the plan to explore more\noptions.\" rather than a field-specific validation error.",
"operationId": "createReadyPlan",
"parameters": [
{
Expand Down Expand Up @@ -5397,7 +5397,7 @@
"success": false,
"errorObjects": [
{
"error": "This file’s NPI(s) contain non-numeric characters. Update the file and try again, or choose another file.",
"error": "This file\u2019s NPI(s) contain non-numeric characters. Update the file and try again, or choose another file.",
"field": "npi"
}
]
Expand Down Expand Up @@ -8316,7 +8316,7 @@
{
"name": "sortBy",
"in": "query",
"description": "Sort the result set by specific field. For ascending use plus(+) sign(ascii value '%2B') and for descending use minus(-) sign. Allowed values - id, Name, createdBy, createdOn, startDate, endDate, reach, impressions, budget",
"description": "Sort the result set by specific field. For ascending use plus(+) sign(ascii value '%2B') and for descending use minus(-) sign. Allowed values - id, name, createdBy, createdOn, startDate, endDate, reach, impression, budget",
"required": false,
"schema": {
"type": "string",
Expand Down Expand Up @@ -9938,7 +9938,7 @@
{
"name": "sortBy",
"in": "query",
"description": "Sort the result set by specific field. For ascending use plus(+) sign(ascii value '%2B') and for descending use minus(-) sign. Allowed values - id, name, createdOn, createdBy, startDate, endDate, objectiveId, linkedProposals",
"description": "Sort the result set by specific field. For ascending use plus(+) sign(ascii value '%2B') and for descending use minus(-) sign. Allowed values - id, name, createdOn, createdBy, startDate, endDate, objectiveId, totalProposals, duration",
"required": false,
"schema": {
"type": "string",
Expand Down Expand Up @@ -11461,7 +11461,7 @@
{
"name": "sortBy",
"in": "query",
"description": "Sort the result set by specific field. For ascending use plus(+) sign(ascii value '%2B') and for descending use minus(-) sign. Allowed values - id, name, createdBy, createdOn, startDate, reach, impression, budget",
"description": "Sort the result set by specific field. For ascending use plus(+) sign(ascii value '%2B') and for descending use minus(-) sign. Allowed values - id, name, createdBy, createdOn, startDate, endDate, reach, impressions, budget, duration",
"required": false,
"schema": {
"type": "string",
Expand Down Expand Up @@ -11545,6 +11545,7 @@
"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 @@ -11860,7 +11861,7 @@
"campaigns": [
{
"id": 1,
"name": "Filter‑Block1•Device1•Creative1",
"name": "Filter\u2011Block1\u2022Device1\u2022Creative1",
"startDate": 1732707706666,
"endDate": 1733312506666,
"budget": 16000,
Expand Down Expand Up @@ -13417,7 +13418,7 @@
"whitelistedAudiences": {
"uniqueItems": true,
"type": "array",
"description": "Whitelisted audience targeting criteria for the campaign plan",
"description": "Whitelisted audience targeting criteria for the campaign plan. Power Segment audiences (audienceTypeId 12) are supported, except when objectiveId is 3 (Voter TV+).",
"items": {
"type": "integer",
"description": "Whitelisted audience targeting criteria for the campaign plan",
Expand All @@ -13427,7 +13428,7 @@
"blacklistedAudiences": {
"uniqueItems": true,
"type": "array",
"description": "Blacklisted audience targeting criteria for the campaign plan",
"description": "Blacklisted audience targeting criteria for the campaign plan. Power Segment audiences (audienceTypeId 12) are supported, except when objectiveId is 3 (Voter TV+).",
"items": {
"type": "integer",
"description": "Blacklisted audience targeting criteria for the campaign plan",
Expand Down Expand Up @@ -17562,6 +17563,13 @@
"format": "int64",
"example": 1625337600000
},
"timezoneId": {
"type": "integer",
"format": "int32",
"nullable": true,
"description": "Timezone ID of the proposal. May be null; not currently populated by this endpoint.",
"example": 29
},
"reach": {
"type": "integer",
"description": "Reach of the proposal",
Expand Down Expand Up @@ -19055,6 +19063,12 @@
"format": "int64",
"example": 1625337600000
},
"timezoneId": {
"type": "integer",
"format": "int32",
"description": "Timezone ID of the plan. See the timezone list in the Master API.",
"example": 29
},
"reach": {
"type": "integer",
"description": "Reach of the proposal",
Expand Down
Loading