{ "openapi": "3.0.0", "info": { "title": "Documentation for Internal", "version": "1.0.0" }, "paths": { "/api/v3/internal/audience/insights/update-status": { "put": { "tags": [ "Audience API" ], "summary": "This api used to update insight status for audience.", "description": "This api update status of insight for audience in the master audience table", "operationId": "updateAudienceInsightStatus", "requestBody": { "description": "\n**Request Body Details:**\n\n| **Field** | **Type** | **Description** |\n| --- | --- | --- |\n| id | Integer | The ID of the source which insight status need to update. |\n| owId | Integer | The ID of the organization work space associated with the insights. |\n| status | Integer | The new status of the insights update to source. Allowed values are `ready`, `failed`. |\n", "content": { "application/json": { "schema": { "required": [ "status" ], "type": "object", "properties": { "id": { "minimum": 1, "type": "integer", "format": "int32" }, "owId": { "minimum": 1, "type": "integer", "format": "int32" }, "status": { "pattern": "ready|failed", "type": "string" } } }, "examples": { "Update insight status": { "description": "Update insight status", "value": { "id": 123, "owId": 100384, "status": "ready" } }, "Invalid insight status": { "description": "Invalid insight status", "value": { "id": 123, "owId": 100384, "status": "success" } } } } }, "required": true }, "responses": { "200": { "description": "Successful update of insight status.", "content": { "application/json": { "examples": { "Update insight status": { "description": "Update insight status", "value": { "success": true, "data": { "message": "Insights status updated successfully." } } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/internal/audience/campaign/cost/update": { "put": { "tags": [ "Audience API" ], "summary": "Update campaign audience data cost (cpm)", "description": "This API is primarily used to update data cost (cpm) for campaign audiences created from provided\ncampaignId. Whenever new segment audience or campaign audience is attached to campaign, data cost\n(cpm) for all the campaign audiences which are created from provided campaignId will be updated.\nAs this is Internal API, there are no strict validations performed for the input parameters.\n", "operationId": "updateCampaignAudienceCost", "parameters": [ { "name": "campaignId", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "audienceIds", "in": "query", "required": true, "schema": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } } }, { "name": "uowId", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successful update of campaign audience cost", "content": { "application/json": { "example": { "success": true, "data": "Campaign audience cost(s) updated successfully." } } } } } } }, "/api/v3/audience/segmented/{audienceId}": { "get": { "tags": [ "Audience API" ], "summary": "Get the segment audience details.", "description": "Get the segment audience details by the audience id.", "operationId": "getSegmentedAudience", "parameters": [ { "name": "audienceId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Segment audience detail": { "description": "Segment audience detail", "value": { "success": true, "data": { "audienceId": 1076846, "audienceName": "Test kishan 19,04:50", "audienceStatusId": 3, "createdAt": 1718796428, "uniques": 0, "cpm": 1.5, "editAccess": true, "segmentPartnerName": "LiveRamp", "segmentPartnerId": 1, "segmentPartnerLogo": "https://s3.amazonaws.com/advp0had0vuj7rad3niaw1eus2/data_partner/liveramp.png", "equation": "((5586112|6450431)&(14005))", "segmentsList": [ { "segmentId": 14005, "taxonomyId": "1000143856", "taxonomyValue": "Western Samoa", "description": null, "pathKey": "LiveRamp \u003E L2 Political \u003E L2 Voter Data \u003E Individual Demographics \u003E Ethnicity \u003E Ethnic Description \u003E Western Samoa", "cpm": 1.5, "modifiedAt": "2021-06-08 08:45:50.979634", "totalReach": 0, "reachMetadata": null, "dataAvailable": false, "leafNode": true }, { "segmentId": 5586112, "taxonomyId": "1007595031", "taxonomyValue": "South Dakota-13", "description": "30 day full data refresh: Individuals living in the South Dakota-13 state senate district. For political use only.", "pathKey": "LiveRamp \u003E 123Push \u003E Optimized for CTV \u003E Voters \u003E State Senate District \u003E South Dakota-13", "cpm": 0.75, "modifiedAt": "2021-06-08 08:45:50.979634", "totalReach": 14800, "reachMetadata": null, "dataAvailable": false, "leafNode": true }, { "segmentId": 6450431, "taxonomyId": "1000037244", "taxonomyValue": "Voted In the 2004 Primary Election", "description": "This segment contains users who voted in the General Election of this election year", "pathKey": "LiveRamp \u003E Porch Group Media (fka V12) \u003E V12 \u003E NEW VOTER & INCOME \u003E Voted In the 2004 Primary Election", "cpm": 0.5, "modifiedAt": "2024-05-07 09:52:51.191186", "totalReach": 5100000, "reachMetadata": { "iosDevicesReach": 2200000, "androidDevicesReach": 2900000, "cookiesReach": 0 }, "dataAvailable": false, "leafNode": true } ] } } } } } } }, "403": { "description": "Forbidden Exception", "content": { "application/json": { "examples": { "Audience Not Accessible": { "description": "Audience Not Accessible", "value": { "success": false, "errorObjects": [ { "error": "Audience is not accessible for the given user." } ] } } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "examples": { "Invalid Audience Id": { "description": "Invalid Audience Id", "value": { "success": false, "errorObjects": [ { "error": "No active audience found with the given Id.", "field": "audienceId" } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } }, "put": { "tags": [ "Audience API" ], "summary": "Updates an existing segmented audience.", "description": "This API updates an existing segmented audience based on the provided request parameters. It allows modifying the details of an existing segmented audience i.e. name and segments.\n\n**Request Body Details:**\n\n| **Field** | **Type** | **Description** |\n| --- | --- | --- |\n| equation `[required]` | String | The equation representing the segment ID groups in AND/OR relationship. It should be a valid equation string. |\n| audienceName `[required]` | String | The name of the segmented audience to be updated. Maximum allowed length is 255. |\n", "operationId": "updateSegmentedAudience", "parameters": [ { "name": "audienceId", "in": "path", "description": "The ID of the segmented audience to be updated.", "required": true, "schema": { "type": "integer", "format": "int32" }, "example": 1140623 }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" } ], "requestBody": { "description": "Request body containing details for updating a segmented audience.", "content": { "application/json": { "schema": { "required": [ "audienceName", "equation" ], "type": "object", "properties": { "audienceName": { "maxLength": 255, "minLength": 0, "type": "string" }, "equation": { "type": "string" }, "campaignId": { "type": "integer", "format": "int32" } } }, "examples": { "Update Segmented Audience Request": { "description": "Update Segmented Audience Request", "value": { "equation": "((6192796|6192797)&(6177921|6177917))", "audienceName": "Updated Audience Name" } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Successful update of segmented audience": { "description": "Successful update of segmented audience", "value": { "success": true, "data": { "audienceId": 1140623, "message": "\u003CAudience Name\u003E audience updated successfully" } } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "examples": { "Missing equation": { "description": "Missing equation", "value": { "success": false, "errorObjects": [ { "error": "Segment group equation is required and can not be empty.", "field": "equation" } ] } }, "Audience name exceeds limit": { "description": "Audience name exceeds limit", "value": { "success": false, "errorObjects": [ { "error": "Audience name must be between 1 and 255 characters.", "field": "audienceName" } ] } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden !" } ] } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "examples": { "Invalid audience ID provided": { "description": "Invalid audience ID provided", "value": { "success": false, "errorObjects": [ { "error": "No audience found with the given Id" } ] } }, "Number of segment group exceeds limit": { "description": "Number of segment group exceeds limit", "value": { "success": false, "errorObjects": [ { "error": "Segment group count cannot be more than 5." } ] } }, "Number of segments in a group exceeds limit": { "description": "Number of segments in a group exceeds limit", "value": { "success": false, "errorObjects": [ { "error": "Maximum number of segments in a group cannot be more than 100." } ] } }, "Invalid segment IDs in equation": { "description": "Invalid segment IDs in equation", "value": { "success": false, "errorObjects": [ { "error": "No segments found for the provided segment IDs. Please provide valid segment IDs." } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/audience/matched/{audienceId}/rematch": { "put": { "tags": [ "Audience API" ], "summary": "Rematch/Refresh matched audience", "description": "This API is used to rematch/refresh an existing matched audience data.\nThe audience must be eligible for rematch based on its status, last rematch time and other criteria.\nThis API internally calls the data team API to initiate the rematch process.\n", "operationId": "rematchMatchedAudience", "parameters": [ { "name": "audienceId", "in": "path", "description": "Audience id of the matched audience to be rematched.", "required": true, "schema": { "type": "integer", "format": "int32" }, "example": 1234 }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "Matched audience rematched successfully", "content": { "application/json": { "examples": { "Successful audience rematch": { "description": "Response when matched audience is successfully rematched", "value": { "success": true, "data": { "audienceId": 1119083, "message": "Test audience rematched successfully via Re-Match" } } } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "examples": { "Invalid Audience Id": { "description": "Invalid Audience Id", "value": { "success": false, "errorObjects": [ { "error": "No active audience found with the given Id.", "field": "audienceId" } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/internal/audience/ua/customer/default-segments/add": { "post": { "tags": [ "Audience API" ], "summary": "To set default partner-provider access for provided workspace or advertiser owId", "description": "This API will assign default partner-provider access to workspace or workspace's access to advertiser owId.\n\n**Request Body Details:**\n\n| **Field** | **Type** | **Description** |\n| --- | --- | --- |\n| advertiserOwId | int | The owId of the advertiser organization. |\n| workspaceOwId | int | The owId of the workspace organization. |\n| isWorkspaceRequest | boolean | The flag to indicate if the request is for adding details for workspace |\n| organizationName | String | The name of the organization. |\n| logoUrl | String | The URL of the organization's logo. |\n", "operationId": "setDefaultPartnerAccessForCustomer", "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "required": [ "logoUrl", "workspaceOwId" ], "type": "object", "properties": { "advertiserOwId": { "type": "integer", "format": "int32" }, "workspaceOwId": { "type": "integer", "format": "int32" }, "workspaceRequest": { "type": "boolean" }, "organizationName": { "type": "string" }, "logoUrl": { "type": "string" } } } }, "examples": { "Advertiser request": { "description": "Advertiser request", "value": [ { "advertiserOwId": 202544, "workspaceOwId": 202316, "isWorkspaceRequest": false, "organizationName": "Advertiser Org", "logoUrl": "https://example.com/logo.png" }, { "advertiserOwId": 202545, "workspaceOwId": 202316, "isWorkspaceRequest": false, "organizationName": "Advertiser Org", "logoUrl": "https://example.com/logo.png" } ] }, "Workspace request": { "description": "Workspace request", "value": [ { "workspaceOwId": 202316, "isWorkspaceRequest": true } ] } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "success": true, "data": "Default partner-provider access added successfully." } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "examples": { "Invalid workspaceOwId Parameter": { "description": "Invalid workspaceOwId Parameter", "value": { "success": false, "errorObjects": [ { "error": "Required request body parameter workspaceOwId is not provided.", "field": "workspaceOwId" } ] } }, "Invalid advertiserOwId Parameter": { "description": "Invalid advertiserOwId Parameter", "value": { "success": false, "errorObjects": [ { "error": "Required request body parameter advertiserOwId is not provided.", "field": "advertiserOwId" } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/internal/audience/send-email/{audienceId}/data-fetch-completed": { "post": { "tags": [ "Audience API" ], "summary": "Notify users when audience data processing is completed and ready for data-partner selection", "description": "This API triggers an email after the completion of audience data fetching. Email would be sent to the\nuser who created the audience and the advertised owner. The notification includes information about\navailable data-partners and their associated performance metrics for targeting optimization.\n", "operationId": "sendEmailForAudienceDataFetchCompleted", "parameters": [ { "name": "audienceId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successful email dispatch", "content": { "application/json": { "example": { "success": true, "data": { "message": "e-mail sent successfully" } } } } }, "422": { "description": "When audience id entered is not valid", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Invalid Audience Id/s provided.", "field": "audienceId" } ] } } } } } } }, "/api/v3/internal/audience/segmented/campaign-wise/bulk": { "post": { "tags": [ "Audience API" ], "summary": "Creates bulk segmented audience per campaign.", "description": "This API creates bulk segmented audiences for given campaigns based on the provided request parameters. \n**Request Body Details:**\n\n| **Field** | **Type** | **Description** |\n| --- | --- | --- |\n| proposalId `[required]` | Number | The unique ID of proposal for which the audience is to be created. |\n| owId `[required]` | Number | The Organization Workspace mapping ID representing the organization for which the audiences are to be created. |\n| uowId `[required]` | Number | The User Workspace mapping ID representing the user who is creating the audiences. |\n| audienceDetails `[required]` | JSON | JSON containing campaign ID, valid audience name and equation for creating the audiences. |\n", "operationId": "createBulkSegmentedAudience", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "required": true, "schema": { "type": "string" }, "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" } ], "requestBody": { "description": "Request body containing details for creating a segmented audience.", "content": { "application/json": { "schema": { "type": "object", "properties": { "proposalId": { "type": "integer", "format": "int32" }, "owId": { "type": "integer", "format": "int32" }, "uowId": { "type": "integer", "format": "int32" }, "audienceDetails": { "type": "array", "items": { "required": [ "audienceName", "equation" ], "type": "object", "properties": { "audienceName": { "maxLength": 255, "minLength": 0, "type": "string" }, "equation": { "type": "string" }, "campaignId": { "type": "integer", "format": "int32" } } } } } }, "examples": { "Create Bulk Segmented Audience Request": { "description": "Create Bulk Segmented Audience Request", "value": { "proposalId": 12345, "owId": 12345, "uowId": 12345, "audienceDetails": [ { "campaignId": 12345, "audienceName": "Audience 1", "equation": "((6192796|6192797)&(6177921|6177917))" }, { "campaignId": 12345, "audienceName": "Audience 2", "equation": "((6192796|6192797)&(6177921|6177917))" } ] } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Successful creation of bulk segmented audience": { "description": "Successful creation of bulk segmented audience", "value": { "success": true, "data": [ { "audienceId": 1142249, "campaignId": 565028 }, { "audienceId": 1142250, "campaignId": 565028 }, { "audienceId": 1142250, "campaignId": 565029 }, { "audienceId": 1142251, "campaignId": 565029 } ] } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "examples": { "Missing equation": { "description": "Missing equation", "value": { "success": false, "errorObjects": [ { "error": "Segment group equation is required and can not be empty.", "field": "equation" } ] } }, "Audience name exceeds limit": { "description": "Audience name exceeds limit", "value": { "success": false, "errorObjects": [ { "error": "Audience name must be between 1 and 255 characters.", "field": "audienceName" } ] } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden !" } ] } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "examples": { "Number of segment group exceeds limit": { "description": "Number of segment group exceeds limit", "value": { "success": false, "errorObjects": [ { "error": "Segment group count cannot be more than 5." } ] } }, "Number of segments in a group exceeds limit": { "description": "Number of segments in a group exceeds limit", "value": { "success": false, "errorObjects": [ { "error": "Maximum number of segments in a group cannot be more than 100." } ] } }, "Invalid segment IDs in equation": { "description": "Invalid segment IDs in equation", "value": { "success": false, "errorObjects": [ { "error": "No segments found for the provided segment IDs. Please provide valid segment IDs." } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/internal/audience/segmented/basic-list": { "post": { "tags": [ "Audience API" ], "summary": "Fetches basic details of segments based on provided segment IDs.", "description": "This API retrieves basic information about segments based on the provided segment IDs in the request. \n**Request Body Details:**\n\n| **Field** | **Type** | **Description** |\n| --- | --- | --- |\n| segmentIds `[required]` | Array of Numbers | List of segment IDs for which basic details are to be fetched. |\n| owId `[required]` | Number | The Organization Workspace mapping ID representing the organization for which the segments are to be fetched. |\n", "operationId": "getSegmentBasicList", "requestBody": { "description": "Request body containing segment IDs and organization workspace ID.", "content": { "application/json": { "schema": { "required": [ "segmentIds" ], "type": "object", "properties": { "segmentIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int64" } }, "owId": { "type": "integer", "format": "int32" } } }, "examples": { "Segment Basic List Request": { "description": "Segment Basic List Request", "value": { "segmentIds": [5658712, 5659156], "owId": 12345 } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Successful retrieval of segment basic details": { "description": "Successful retrieval of segment basic details", "value": { "success": true, "data": [ { "segmentId": 5658712, "taxonomyId": "1000984279", "partnerId": 1, "iqmSegment": true }, { "segmentId": 5659156, "taxonomyId": "1000996239", "partnerId": 1, "iqmSegment": true } ] } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "examples": { "Empty segment IDs list": { "description": "Empty segment IDs list", "value": { "success": false, "errorObjects": [ { "error": "Segment Ids are required cannot be null or empty.", "field": "segmentIds" } ] } }, "Missing owId": { "description": "Missing owId", "value": { "success": false, "errorObjects": [ { "error": "OW ID cannot be null or empty.", "field": "owId" } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/internal/audience/matched": { "post": { "tags": [ "Audience API" ], "summary": "Create matched audience - unified endpoint for all verticals and subtypes", "description": " Unified API endpoint for creating matched audiences across all verticals and subtypes.\n Supports Political, Specialization, and Healthcare (Patient, HCP, Nurse, Generic) verticals.\n The appropriate processing strategy is selected based on verticalId and subtypeId.\n", "operationId": "createMatchedAudience", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "description": "Multipart form data with audienceRequest and XLSX/CSV file. Please see the structure of audienceRequest below:", "content": { "multipart/form-data": { "schema": { "required": [ "audienceRequest", "file" ], "type": "object", "properties": { "audienceRequest": { "required": [ "audienceName", "columnMappings" ], "type": "object", "properties": { "audienceName": { "maxLength": 255, "minLength": 0, "type": "string" }, "columnMappings": { "type": "array", "items": { "required": [ "columnId", "fileColumnName" ], "type": "object", "properties": { "columnId": { "type": "integer", "format": "int32" }, "fileColumnName": { "type": "string" }, "dataFormatId": { "type": "integer", "format": "int32" } } } }, "fileRowCount": { "type": "integer", "format": "int32" }, "fileColumnCount": { "type": "integer", "format": "int32" }, "dataPartnerId": { "type": "integer", "format": "int32" }, "columnCombinationId": { "type": "integer", "format": "int32" }, "audienceSubtypeId": { "type": "integer", "format": "int32" }, "consentGiven": { "type": "boolean" }, "advertiserOwId": { "type": "integer", "format": "int32" } } }, "file": { "type": "string", "format": "binary" } } }, "examples": { "Sample audienceRequest object for political Matched Audience Creation": { "description": "Sample audienceRequest object for political Matched Audience Creation", "value": { "advertiserOwId": 1001, "audienceName": "matched-audience-example-fs", "fileRowCount": 5, "fileColumnCount": 10, "columnMappings": [ { "columnId": 5, "fileColumnName": "l2-voter-id", "dataFormatId": null }, { "columnId": 6, "fileColumnName": "email", "dataFormatId": 1 } ], "dataPartnerId": 2, "columnCombinationId": 11 } }, "Sample audienceRequest object for Healthcare Patient Matched Audience Creation": { "description": "Sample audienceRequest object for Healthcare Patient Matched Audience Creation", "value": { "audienceName": "Revamped Healthcare Matched Audience 02", "dataPartnerId": 7, "audienceSubtypeId": 3, "columnMappings": [ { "columnId": 18, "fileColumnName": "NPI_ID" } ], "fileRowCount": 19, "fileColumnCount": 1, "columnCombinationId": 14, "consentGiven": true } } } } }, "required": true }, "responses": { "200": { "description": "Matched audience created successfully", "content": { "application/json": { "examples": { "Successful creation": { "description": "Successful creation", "value": { "success": true, "data": { "matchedAudienceId": 12345, "message": "Matched audience created successfully" } } } } } } }, "400": { "description": "Bad Request - When mandatory parameters are missing or invalid", "content": { "application/json": { "examples": { "Column combination id not provided": { "description": "Column combination id not provided", "value": { "success": false, "errorObjects": [ { "error": "Column combination ID must be positive", "field": "columnCombinationId" } ] } } } } } }, "422": { "description": "Unprocessable Entity - Validation failed", "content": { "application/json": { "examples": { "Invalid vertical": { "description": "Invalid vertical", "value": { "success": false, "errorObjects": [ { "error": "Invalid vertical 99 and subtype null", "field": "verticalId" } ] } }, "Missing required columns": { "description": "Missing required columns", "value": { "success": false, "errorObjects": [ { "error": "Required column 'npi-id' is missing from column mappings", "field": "columns" } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/internal/audience/matched/send-email/{audienceId}/rematch-completed": { "post": { "tags": [ "Audience API" ], "summary": "Notify users when matched audience rematch is completed successfully", "description": "This API triggers an email after the completion of matched audience rematch(refresh). Email would be sent to the\nuser who triggered the audience rematch process. The notification includes information about\nthe updated audience details and associated campaigns.\n", "operationId": "sendEmailForMatchedAudienceRematchCompleted", "parameters": [ { "name": "audienceId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successful email dispatch", "content": { "application/json": { "example": { "success": true, "data": { "message": "e-mail sent successfully" } } } } }, "422": { "description": "Invalid audience status error", "content": { "application/json": { "examples": { "When audience status is not 'Ready' or 'Failed'": { "description": "When audience status is not 'Ready' or 'Failed'", "value": { "success": false, "errorObjects": [ { "error": "Invalid audience status. Audience status must be 'Ready' or 'Failed'." } ] } }, "When audienceId provided does not exist": { "description": "When audienceId provided does not exist", "value": { "success": false, "errorObjects": [ { "error": "Invalid Audience Id/s provided.", "field": "audienceId" } ] } } } } } } } } }, "/api/v3/internal/audience/ict/{audienceId}/send-email/processing-completed": { "post": { "tags": [ "Audience API" ], "summary": "Internal API that sends an email after the processing of ICT audience is completed.", "description": "This API triggers an email after the completion of ICT audience processing. Email would be sent for both the cases of Ready and Failed audience.In case of failure, we either send generic failure reason or a reason with specific failure cause if available.", "operationId": "sendEmailOnICTAudienceProcessingCompletion", "parameters": [ { "name": "audienceId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successful email dispatch", "content": { "application/json": { "example": { "success": true, "data": { "message": "e-mail sent successfully" } } } } }, "422": { "description": "Unprocessable Entity - Invalid audience ID", "content": { "application/json": { } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/internal/audience/abm/{audienceId}/send-email": { "post": { "tags": [ "Audience API" ], "summary": "Internal API that sends an email after the processing of ABM audience is completed.", "description": "This API triggers an email after the completion of ABM audience processing. Email would be sent for both the cases of Ready and Failed audience.", "operationId": "sendEmailOnAccountBasedAudienceProcessingCompletion", "parameters": [ { "name": "audienceId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successful email dispatch", "content": { "application/json": { "example": { "success": true, "data": { "message": "e-mail sent successfully" } } } } } } } }, "/api/v3/internal/audience/abm/bulk": { "post": { "tags": [ "Audience API" ], "summary": "This method creates bulk ABM audiences.", "description": "This method creates an ABM Audience with mapping of health care data and store the calculated statistics of an ABM Audience.", "operationId": "createBulkABMAudiences", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "content": { "application/json": { "schema": { "required": [ "audiences" ], "type": "object", "properties": { "audiences": { "type": "array", "items": { "required": [ "audienceName", "filters" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "audienceName": { "type": "string" }, "filters": { "type": "object", "properties": { "sortCriteriaMap": { "type": "object", "additionalProperties": { "type": "string" } }, "selectAll": { "type": "boolean" }, "ids": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "dataProviderIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "healthCareSystemIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "accountIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int64" } }, "accountTypeIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "accountSubTypeIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "titleIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "specialityIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "countryIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "stateIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "cityIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "pageNo": { "type": "integer", "format": "int32" }, "noOfEntries": { "type": "integer", "format": "int32" }, "sortBy": { "type": "string" }, "searchField": { "type": "string" }, "order": { "type": "string", "enum": [ "SortOrderEnum[id=1, name='asc', symbol='+']", "SortOrderEnum[id=2, name='desc', symbol='-']" ] } } }, "dataProviderId": { "type": "integer", "format": "int32" } } } }, "owId": { "type": "integer", "format": "int32" }, "uowId": { "type": "integer", "format": "int32" } } }, "example": { "owId": 1001, "uowId": 1023, "audiences": [ { "id": 1, "audienceName": "HealthCare Innovators", "filters": { "dataProviderIds": [1], "healthCareSystemIds": [40100004, 40100007], "accountIds": [40208104, 40628423], "accountTypeIds": [40300003], "accountSubTypeIds": [40400001, 40400010], "countryIds": [30100001], "stateIds": [30200028, 30200043], "cityIds": [30430356, 30447825, 30447952, 30448122], "titleIds": [40500099], "specialityIds": [40500014, 40500086], "ids": [1, 2, 3], "pageNo": 1, "noOfEntries": 2 } }, { "id": 1, "audienceName": "HealthCare Innovators", "filters": { "dataProviderIds": [1], "healthCareSystemIds": [40100004, 40100007], "accountIds": [40208104, 40628423], "accountTypeIds": [40300003], "accountSubTypeIds": [40400001, 40400010], "countryIds": [30100001], "stateIds": [30200028, 30200043], "cityIds": [30430356, 30447825, 30447952, 30448122], "titleIds": [40500099], "specialityIds": [40500014, 40500086], "ids": [1, 2, 3], "pageNo": 1, "noOfEntries": 2 } } ] } } }, "required": true }, "responses": { "200": { "description": "Successful Creation of ABM Audience", "content": { "application/json": { "examples": { "Response containing message": { "description": "Response containing message", "value": { "success": true, "data": { "1": 123, "2": 124 } } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/audience/segmented": { "post": { "tags": [ "Audience API" ], "summary": "Creates a segmented audience.", "description": "This API creates a segmented audience based on the provided request parameters. It allows creating a new segmented audience with the specified details.\n\n**Request Body Details:**\n\n| **Field** | **Type** | **Description** |\n| --- | --- | --- |\n| equation `[required]` | String | The equation representing the segment ID groups in AND/OR relationship. It should be a valid equation string. |\n| audienceName `[required]` | String | The name of the segmented audience to be created. Maximum allowed length is 255. |\n", "operationId": "createSegmentedAudience", "parameters": [ { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" } ], "requestBody": { "description": "Request body containing details for creating a segmented audience.", "content": { "application/json": { "schema": { "required": [ "audienceName", "equation" ], "type": "object", "properties": { "audienceName": { "maxLength": 255, "minLength": 0, "type": "string" }, "equation": { "type": "string" }, "campaignId": { "type": "integer", "format": "int32" } } }, "examples": { "Create Segmented Audience Request": { "description": "Create Segmented Audience Request", "value": { "equation": "((6192796|6192797)&(6177921|6177917))", "audienceName": "Test Audience" } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Successful creation of segmented audience": { "description": "Successful creation of segmented audience", "value": { "success": true, "data": { "audienceId": 1140623, "message": "\u003CAudience Name\u003E audience created successfully" } } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "examples": { "Missing equation": { "description": "Missing equation", "value": { "success": false, "errorObjects": [ { "error": "Segment group equation is required and can not be empty.", "field": "equation" } ] } }, "Audience name exceeds limit": { "description": "Audience name exceeds limit", "value": { "success": false, "errorObjects": [ { "error": "Audience name must be between 1 and 255 characters.", "field": "audienceName" } ] } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden !" } ] } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "examples": { "Number of segment group exceeds limit": { "description": "Number of segment group exceeds limit", "value": { "success": false, "errorObjects": [ { "error": "Segment group count cannot be more than 5." } ] } }, "Number of segments in a group exceeds limit": { "description": "Number of segments in a group exceeds limit", "value": { "success": false, "errorObjects": [ { "error": "Maximum number of segments in a group cannot be more than 100." } ] } }, "Invalid segment IDs in equation": { "description": "Invalid segment IDs in equation", "value": { "success": false, "errorObjects": [ { "error": "INo segments found for the provided segment IDs. Please provide valid segment IDs." } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/audience/segmented/search/list": { "post": { "tags": [ "Audience API" ], "summary": "Fetches the segments search list.", "description": "This API retrieves the segments search list based on the provided request parameters. It allows filtering segments based on various criteria such as search fields, segment ids, provider, price range, and more.\n\n**Request Body Details:**\n\n| **Field** | **Type** | **Description** |\n| --- | --- | --- |\n| pageNo `[optional]` | Number | Page number for the required data. The default value is 1. \n| noOfEntries `[optional]` | Number | The maximum number of returned results per page. The default value is 100. |\n| sortBy `[optional]` | String | Sort the result set by specific field. For ascending use plus(+) sign(ascii value '%2B') and for descending use minus(-) sign. \n| searchKeywordSet `[required if segmentIds not given]` | List of Number | Search keywords to be searched on the 'pathKey' and 'description' of the segments with encoded special characters. |\n| segmentIds `[required if searchField not given]` | List of Number | List of segment ids upon which segment data is to be filtered. |\n| verticalIds `[optional]` | List of Number | List of vertical ids upon which segment data is to be filtered. |\n| partnerIds `[optional]` | List of Number | List of partner ids upon which segment data is to be filtered. |\n| providerIds `[optional]` | List of Number | List of provider ids upon which segment data is to be filtered. |\n| priceRangeIds `[optional]` | List of Number | List of price range ids upon which segment data is to be filtered. |\n| reachRangeIds `[optional]` | List of Number | List of reach range ids upon which segment data is to be filtered. |\n| showOnlyReadySegments `[optional]` | Boolean | Flag to filter segments that are ready. Default is false. |\n| showOnlyNonZeroSegments `[optional]` | Boolean | Flag to filter segments that have non-zero reach. Default is false. |\n", "operationId": "getSegmentsSearchList", "parameters": [ { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" } ], "requestBody": { "description": "Request body containing search criteria for segments.", "content": { "application/json": { "schema": { "type": "object", "properties": { "sortCriteriaMap": { "type": "object", "additionalProperties": { "type": "string" } }, "verticalIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "partnerIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "providerIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "segmentIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int64" } }, "priceRangeIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "reachRangeIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "showOnlyNonZeroSegments": { "type": "boolean" }, "showOnlyReadySegments": { "type": "boolean" }, "searchKeywordSet": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "pageNo": { "type": "integer", "format": "int32" }, "noOfEntries": { "type": "integer", "format": "int32" }, "sortBy": { "type": "string" }, "searchField": { "type": "string" }, "order": { "type": "string", "enum": [ "SortOrderEnum[id=1, name='asc', symbol='+']", "SortOrderEnum[id=2, name='desc', symbol='-']" ] } } }, "examples": { "Segment Search List Request": { "description": "Segment Search List Request", "value": { "pageNo": 1, "noOfEntries": 20, "searchKeywordSet": [ "sample 1", "sample 2" ], "sortBy": "-reach", "verticalIds": [1, 2, 3], "partnerIds": [1, 2, 3], "providerIds": [1, 2, 3], "priceRangeIds": [1, 2, 3], "reachRangeIds": [1, 2, 3], "segmentIds": [1, 2, 3], "showOnlyReadySegments": true, "showOnlyNonZeroSegments": true } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Successful fetching of segments search list": { "description": "Successful fetching of segments search list", "value": { "success": true, "data": { "filteredRecords": 45, "segmentsList": [ { "segmentId": 5830140, "taxonomyValue": "Thriller/Horror", "description": "This audience contains people that are likely to watch Thriller/Horror TV content & are CBD purchasers. Data leverages Comscore's deterministic, single-source cross-platform dataset derived from set-top box (STB) data from households exposed to the target viewing criteria & is cultivated from industry-leading endemic companies (Point of Sale systems, eCommerce platforms, Delivery services, and Loyalty/CRM platforms).", "pathKey": "LiveRamp \u003E Fyllo \u003E Fyllo \u003E Infused \u003E Comscore \u003E TV \u003E Genre \u003E Thriller/Horror", "cpm": 1.5, "modifiedAt": "2021-07-04T10:48:42.29600:00", "totalReach": 6000000, "providerId": 140, "partnerId": 1, "dataAvailable": true, "reachMetadata": { "iosDevicesReach": 120, "androidDevicesReach": 120, "cookiesReach": 120 }, "logoUrl": "https://www.sample-domain.com/liveramp.png" }, { "segmentId": 6164189, "taxonomyValue": "Thriller Crime & Mystery Films", "description": "ShareThis collects data from its network of 600 million publisher pages capturing site visitors' pageviews, clicks, shares, and searches. ShareThis processes these signals and uses associated keywords and topics to build out its audience. ShareThis CTV targeting allows you to leverage this online behavioral data for CTV campaigns, merging the performance of online interest data with the impact and engagement of TV.", "pathKey": "LiveRamp \u003E ShareThis \u003E ShareThis \u003E ShareThis for TV \u003E Arts & Entertainment \u003E Movies \u003E Thriller Crime & Mystery Films", "cpm": 2, "modifiedAt": "2021-12-03T11:19:19.76300:00", "totalReach": 8600000, "providerId": 21, "partnerId": 1, "dataAvailable": true, "reachMetadata": { "iosDevicesReach": 120, "androidDevicesReach": 120, "cookiesReach": 120 }, "logoUrl": "https://www.sample-domain.com/liveramp.png" } ] } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden !" } ] } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "examples": { "Both searchField and segmentIds are not provided": { "description": "Both searchField and segmentIds are not provided", "value": { "success": false, "errorObjects": [ { "error": "Either searchField or segmentIds must be provided." } ] } }, "Search keywords provided are more than allowed limit": { "description": "Search keywords provided are more than allowed limit", "value": { "success": false, "errorObjects": [ { "error": "Search keywords cannot be more than 10." } ] } }, "Invalid sortBy provided": { "description": "Invalid sortBy provided", "value": { "success": false, "errorObjects": [ { "error": "Invalid sortBy value provided in the request." } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/audience/segmented/search/list/download": { "post": { "tags": [ "Audience API" ], "summary": "Downloads the segments search list.", "description": "This API provides a link to download the segments search list based on the provided request parameters. It allows filtering segments based on various criteria such as search fields, segment ids, provider, price range, and more.\n\n**Request Body Details:**\n\n| **Field** | **Type** | **Description** |\n| --- | --- | --- |\n| sortBy `[optional]` | String | Sort the result set by specific field. For ascending use plus(+) sign(ascii value '%2B') and for descending use minus(-) sign. \n| searchKeywordSet `[required if segmentIds not given]` | List of Number | Search keywords to be searched on the 'pathKey' and 'description' of the segments with encoded special characters. |\n| segmentIds `[required if searchField not given]` | List of Number | List of segment ids upon which segment data is to be filtered. |\n| verticalIds `[optional]` | List of Number | List of vertical ids upon which segment data is to be filtered. |\n| partnerIds `[optional]` | List of Number | List of partner ids upon which segment data is to be filtered. |\n| providerIds `[optional]` | List of Number | List of provider ids upon which segment data is to be filtered. |\n| priceRangeIds `[optional]` | List of Number | List of price range ids upon which segment data is to be filtered. |\n| reachRangeIds `[optional]` | List of Number | List of reach range ids upon which segment data is to be filtered. |\n| showOnlyReadySegments `[optional]` | Boolean | Flag to filter segments that are ready. Default is false. |\n| showOnlyNonZeroSegments `[optional]` | Boolean | Flag to filter segments that have non-zero reach. Default is false. |\n", "operationId": "downloadSegmentsSearchList", "parameters": [ { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" } ], "requestBody": { "description": "Request body containing search criteria for segments.", "content": { "application/json": { "schema": { "type": "object", "properties": { "sortCriteriaMap": { "type": "object", "additionalProperties": { "type": "string" } }, "verticalIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "partnerIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "providerIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "segmentIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int64" } }, "priceRangeIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "reachRangeIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "showOnlyNonZeroSegments": { "type": "boolean" }, "showOnlyReadySegments": { "type": "boolean" }, "searchKeywordSet": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "pageNo": { "type": "integer", "format": "int32" }, "noOfEntries": { "type": "integer", "format": "int32" }, "sortBy": { "type": "string" }, "searchField": { "type": "string" }, "order": { "type": "string", "enum": [ "SortOrderEnum[id=1, name='asc', symbol='+']", "SortOrderEnum[id=2, name='desc', symbol='-']" ] } } }, "examples": { "Segment Search List Request": { "description": "Segment Search List Request", "value": { "searchKeywordSet": [ "sample 1", "sample 2" ], "sortBy": "-reach", "verticalIds": [1, 2, 3], "partnerIds": [1, 2, 3], "providerIds": [1, 2, 3], "priceRangeIds": [1, 2, 3], "reachRangeIds": [1, 2, 3], "segmentIds": [1, 2, 3], "showOnlyReadySegments": true, "showOnlyNonZeroSegments": true } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Successful fetching of download link for segments search list": { "description": "Successful fetching of download link for segments search list", "value": { "success": true, "data": { "fileUrl": "https://sampledomain/\u003CsearchKeys\u003E_segments_1719309819439.csv" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden !" } ] } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "examples": { "Both searchField and segmentIds are not provided": { "description": "Both searchField and segmentIds are not provided", "value": { "success": false, "errorObjects": [ { "error": "Either searchField or segmentIds must be provided." } ] } }, "Search keywords provided are more than allowed limit": { "description": "Search keywords provided are more than allowed limit", "value": { "success": false, "errorObjects": [ { "error": "Search keywords cannot be more than 10." } ] } }, "Invalid sortBy provided": { "description": "Invalid sortBy provided", "value": { "success": false, "errorObjects": [ { "error": "Invalid sortBy value provided in the request." } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/audience/retargeted": { "post": { "tags": [ "Audience API" ], "summary": "Create a new Retargeted audience", "description": "Creates a new Retargeted audience with the provided audience details in the request.\n \n**Request Body Details:**\n\n| **Field** | **Type** | **Description** |\n| --- | --- | --- |\n| audienceName `[required]` | String | Name of the retargeted audience |\n| dataCollectionBy `[required]` | String | Valid data collection method either 'month' or 'date_range' |\n| dataCollectionPeriod `[optional]`| Integer | Represents number of months for data collection period |\n| startDate `[optional]` | Integer | Represents start date in epoch millis for data collection |\n| endDate `[optional]` | Integer | Represents end date in epoch millis for data collection |\n", "operationId": "createRetargetedAudience", "parameters": [ { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" } ], "requestBody": { "content": { "application/json": { "schema": { "required": [ "audienceName", "dataCollectionBy" ], "type": "object", "properties": { "audienceName": { "maxLength": 255, "minLength": 0, "type": "string" }, "dataCollectionBy": { "type": "string" }, "startDate": { "type": "integer", "format": "int64" }, "endDate": { "type": "integer", "format": "int64" }, "dataCollectionPeriod": { "maximum": 12, "type": "integer", "format": "int32" } } }, "examples": { "Request body for audience creation with 'month' mode": { "description": "Request body for audience creation with 'month' mode", "value": { "audienceName": "Test audience by month", "dataCollectionBy": "month", "dataCollectionPeriod": 1 } }, "Request body for audience creation with 'date_range' mode": { "description": "Request body for audience creation with 'date_range' mode", "value": { "audienceName": "Test audience by date_range", "dataCollectionBy": "date_range", "startDate": 1753262493020, "endDate": 1753900200000 } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Successful creation of Retargeted Audience": { "description": "Successful creation of Retargeted Audience", "value": { "success": true, "data": { "tag_script": "\u003Cscript src='https://pxl.stage.iqm.com/c/4c90b124-bfbe-4af1-b780-d2a1d3cb93c1' async\u003E\u003C/script\u003E", "audienceId": 1140586, "message": "Test audience by month audience created successfully" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "examples": { "Non Advertiser user accessing the API": { "description": "Non Advertiser user accessing the API", "value": { "success": false, "errorObjects": [ { "error": "User is not allowed to access this API. Only Advertiser users can access this API." } ] } } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "examples": { "When dataCollectionPeriod is sent for 'date_range' mode": { "description": "When dataCollectionPeriod is sent for 'date_range' mode", "value": { "success": false, "errorObjects": [ { "error": "Data Collection period should not be specified for data collection by 'date_range' mode.", "field": "dataCollectionPeriod" } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/audience/retargeted/{audienceId}/email-notification": { "post": { "tags": [ "Audience API" ], "summary": "Email pixel code to recipients.", "description": "This API can be used to send email with retargeted audience pixel code to the provided recipient emails.\n \n**Request Body Details:**\n\n| **Field** | **Type** | **Description** |\n| --- | --- | --- |\n| recipientEmails `[required]` | List of String | List of recipient emails |\n", "operationId": "sendRetargetedPixelCodeEmail", "parameters": [ { "name": "audienceId", "in": "path", "description": "master audience id of the retargeted audience.", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" } ], "requestBody": { "content": { "application/json": { "schema": { "required": [ "recipientEmails" ], "type": "object", "properties": { "recipientEmails": { "maxItems": 2147483647, "minItems": 1, "type": "array", "items": { "type": "string" } } } }, "examples": { "Request body with recipient emails": { "description": "Request body with recipient emails", "value": { "recipientEmails": [ "test.s@gmail.com" ] } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Pixel code emailed successfully": { "description": "Pixel code emailed successfully", "value": { "success": true, "data": { "message": "Pixel Code emailed successfully" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "examples": { "Non Advertiser user accessing the API": { "description": "Non Advertiser user accessing the API", "value": { "success": false, "errorObjects": [ { "error": "User is not allowed to access this API. Only Advertiser users can access this API." } ] } } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "examples": { "Invalid Audience Id": { "description": "Invalid Audience Id", "value": { "success": false, "errorObjects": [ { "error": "No active audience found with the given Id.", "field": "audienceId" } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/audience/prebid": { "post": { "tags": [ "Audience API" ], "summary": "Create a new Prebid audience", "description": "Creates a new Prebid audience with the provided audience details in the request.\n \n**Request Body Details:**\n\n| **Field** | **Type** | **Description** |\n| --- | --- | --- |\n| audienceName | String | Name of the prebid audience |\n| prebidSegmentIds | List of Integer | List of valid and accessible prebid segment IDs. |\n| prebidProviderId | Integer | Id of prebid segments provider |\n", "operationId": "createPrebidAudience", "parameters": [ { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" } ], "requestBody": { "content": { "application/json": { "schema": { "required": [ "audienceName", "prebidProviderId", "prebidSegmentIds" ], "type": "object", "properties": { "audienceName": { "maxLength": 255, "minLength": 0, "type": "string" }, "prebidSegmentIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "prebidProviderId": { "minimum": 1, "type": "integer", "format": "int32" } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Successful creation of Prebid Audience": { "description": "Successful creation of Prebid Audience", "value": { "success": true, "data": { "audienceId": 1026631, "message": "Test Audience audience created successfully" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "examples": { "Non Advertiser user accessing the API": { "description": "Non Advertiser user accessing the API", "value": { "success": false, "errorObjects": [ { "error": "User is not allowed to access this API. Only Advertiser users can access this API." } ] } } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "examples": { "Invalid segmentIds or Invalid prebid providers passed": { "description": "Invalid segmentIds or Invalid prebid providers passed", "value": { "success": false, "errorObjects": [ { "error": "Invalid Prebid Segment Ids or Multiple Providers found for the provided segments." } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/audience/prebid/segments/search/list": { "post": { "tags": [ "Audience API" ], "summary": "It API fetches the prebid segment details according to the search text or provided prebid segment ids.", "description": "This API will fetch the details of prebid segments based on the given prebid segment ids or search field. Providing any one of the field is mandatory. This API can be used by all the type of customers. Its mandatory to pass customerOwId for non advertiser users.\n\n**Request Body Details:**\n\n| **Field** | **Type** | **Description** |\n| --- | --- | --- |\n| searchField `[optional]` | String | Search the result by provided keyword in the searchField. |\n| prebidSegmentIds `[optional]` | Array of Integer | The list includes prebid audience segment IDs. |\n| customerOwId `[optional]` | Integer | Used to fetch the data of customer by workspace/super user |\n| showInActiveSegments `[optional]` | Boolean | Used to fetch inactive segments specifically to view data of deprecated segments which are already attached. default value is false. |\n", "operationId": "getPrebidSegmentDetailsBySearch", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "audienceIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "prebidSegmentIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "searchField": { "type": "string" }, "customerOwId": { "type": "integer", "format": "int32" }, "showInActiveSegments": { "type": "boolean" } } }, "examples": { "Request body for advertiser": { "description": "Request body for advertiser", "value": { "prebidSegmentIds": [156, 157], "searchField": "risk", "showInActiveSegments": true } }, "Request body for non-advertiser": { "description": "Request body for non-advertiser", "value": { "prebidSegmentIds": [156, 157], "searchField": "risk", "customerOwId": 201332 } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Successful retrieval of prebid segment details": { "description": "Successful retrieval of prebid segment details", "value": { "success": true, "data": [ { "prebidSegmentId": 158, "prebidSegmentName": "Avoid High and Moderate risk Alcohol content pages", "description": "Avoid High and Moderate risk Alcohol content pages", "parentPathKey": "Brand Safety \u003E Display", "cpm": 0.05, "isLeaf": true, "creativeTypeIds": [11, 14], "prebidRootId": 1, "providerId": 1 }, { "prebidSegmentId": 156, "prebidSegmentName": "Avoid High and Moderate risk Adult content pages", "description": "Avoid High and Moderate risk Adult content pages", "parentPathKey": "Brand Safety \u003E Display", "cpm": 0.05, "isLeaf": true, "creativeTypeIds": [11, 14], "prebidRootId": 1, "providerId": 1 } ] } }, "422_UNPROCESSABLE_ENTITY": { "description": "422_UNPROCESSABLE_ENTITY", "value": { "success": false, "errorObjects": [ { "error": "Invalid input. Please provide either a search field, prebid segment IDs or audience IDs to search." } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/audience/matched": { "post": { "tags": [ "Audience API" ], "summary": "Create matched audience - unified endpoint for all verticals and subtypes", "description": " Unified API endpoint for creating matched audiences across all verticals and subtypes.\n Supports Political, Specialization, and Healthcare (Patient, HCP, Nurse, Non NPI Nurse, Generic) verticals.\n The appropriate processing strategy is selected based on verticalId and subtypeId. audienceRequest\n and file is sent as binary multipart/form-data.\n\n**Request Body Details:**\n\n| **Field** | **Type** | **Description** |\n| --- | --- | --- |\n | audienceName `[required]` | String | Name of the matched audience to be created. Max length 255. |\n | dataPartnerId `[required for few verticals and few subtypes]` | Integer | ID of the data partner associated with the audience. |\n | audienceSubtypeId `[required for subtype specific audience]` | Integer | Subtype ID for Healthcare audiences (e.g., 3 for HCP, 4 for Nurse, 5 for Non NPI Nurse and 6 for Patient). |\n | columnMappings `[required]` | List of Objects | Mappings of file columns to expected data formats. Each object contains `columnId`, `fileColumnName`, and optional `dataFormatId`. |\n | fileRowCount `[required]` | Integer | Number of rows in the uploaded file. |\n | fileColumnCount `[required]` | Integer | Number of columns in the uploaded file. |\n | columnCombinationId `[required]` | Integer | ID representing the combination of columns used for matching. This represents the mandatory columns that should be provided for audience creation. |\n | consentGiven `[required for Healthcare Patient subtype]` | Boolean | Indicates if consent has been given for patient data usage. |\n", "operationId": "createMatchedAudience_1", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "description": "Multipart form data with audienceRequest and XLSX/CSV file. Please see the structure of audienceRequest below:", "content": { "multipart/form-data": { "schema": { "type": "object", "description": "Multipart payload containing `audienceRequest` JSON and a binary `file` part." }, "examples": { "Sample audienceRequest object for Political Matched Audience Creation": { "description": "Sample audienceRequest object for Political Matched Audience Creation", "value": { "audienceRequest": { "audienceName": "matched-audience-example-fs", "fileRowCount": 5, "fileColumnCount": 10, "columnMappings": [ { "columnId": 5, "fileColumnName": "l2-voter-id", "dataFormatId": null }, { "columnId": 6, "fileColumnName": "email", "dataFormatId": 1 } ], "dataPartnerId": 2, "columnCombinationId": 11 }, "file": "BINARY FILE" } }, "Sample audienceRequest object for Healthcare Patient Matched Audience Creation": { "description": "Sample audienceRequest object for Healthcare Patient Matched Audience Creation", "value": { "audienceRequest": { "audienceName": "Revamped Healthcare Matched Audience 02", "dataPartnerId": 7, "audienceSubtypeId": 3, "columnMappings": [ { "columnId": 18, "fileColumnName": "NPI_ID" } ], "fileRowCount": 19, "fileColumnCount": 1, "columnCombinationId": 14, "consentGiven": true }, "file": "BINARY FILE" } } }, "encoding": { "audienceRequest": { "contentType": "application/json" }, "file": { "contentType": "application/octet-stream" } } } }, "required": true }, "responses": { "200": { "description": "Matched audience created successfully", "content": { "application/json": { "examples": { "Successful creation": { "description": "Successful creation", "value": { "success": true, "data": { "matchedAudienceId": 12345, "message": "Matched audience created successfully" } } } } } } }, "400": { "description": "Bad Request - When mandatory parameters are missing or invalid", "content": { "application/json": { "examples": { "Column combination id not provided": { "description": "Column combination id not provided", "value": { "success": false, "errorObjects": [ { "error": "Column combination ID must be positive", "field": "columnCombinationId" } ] } } } } } }, "422": { "description": "Unprocessable Entity - Validation failed", "content": { "application/json": { "examples": { "Invalid vertical": { "description": "Invalid vertical", "value": { "success": false, "errorObjects": [ { "error": "Invalid vertical 99 and subtype null", "field": "verticalId" } ] } }, "Missing required columns": { "description": "Missing required columns", "value": { "success": false, "errorObjects": [ { "error": "Required column 'npi-id' is missing from column mappings", "field": "columns" } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/audience/lookalike": { "post": { "tags": [ "Audience API" ], "summary": "Create a new Lookalike audience", "description": "Creates a new Lookalike audience with the provided source audience IDs, geo-location details, and audience size.\n \n**Request Body Details:**\n\n| **Field** | **Type** | **Description** |\n| --- | --- | --- |\n| audienceName `[required]` | String | Name of the retargeted audience |\n| sourceAudienceIds `[required]` | String | Comma-separated string of source audience IDs used to create the lookalike audience |\n| geoLocationDetails `[required]` | JSON Object | Geographical targeting information for the lookalike. |\n| audienceSize `[required]` | Integer | Size of the lookalike audience ranging from 1 to 10. This will be inversely proportional to similarity levels |\n", "operationId": "createLookalikeAudience", "parameters": [ { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" } ], "requestBody": { "content": { "application/json": { "schema": { "required": [ "audienceName", "geoLocationDetails", "sourceAudienceIds" ], "type": "object", "properties": { "audienceName": { "maxLength": 255, "minLength": 0, "type": "string" }, "sourceAudienceIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "audienceSize": { "type": "integer", "format": "int32" }, "geoLocationDetails": { "required": [ "countryIds", "stateIds" ], "type": "object", "properties": { "countryIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "stateIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "cityIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "countyIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "senateDistrictIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "houseDistrictIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "congressionalDistrictIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } } } } } }, "examples": { "Request body for lookalike audience with minimal location related fields": { "description": "Request body for lookalike audience with minimal location related fields", "value": { "audienceName": "Test Lookalike Audience", "sourceAudienceIds": "12345,67890", "audienceSize": 5, "countryIds": "1", "stateIds": "10,20,30" } }, "Request body for lookalike audience with all location related fields": { "description": "Request body for lookalike audience with all location related fields", "value": { "audienceName": "Test Lookalike Audience with Full Geo", "sourceAudienceIds": "12345", "audienceSize": 3, "countryIds": "1", "stateIds": "10,20", "cityIds": "100,200,300", "countyIds": "50,60", "senateDistrictIds": "1,2,3", "houseDistrictIds": "10,20", "congressionalDistrictIds": "5,6,7" } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Successful creation of Lookalike Audience": { "description": "Successful creation of Lookalike Audience", "value": { "success": true, "data": { "audienceId": 1140586, "message": "Test Lookalike Audience audience created successfully" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "examples": { "Non Advertiser user accessing the API": { "description": "Non Advertiser user accessing the API", "value": { "success": false, "errorObjects": [ { "error": "User is not allowed to access this API. Only Advertiser users can access this API." } ] } } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "examples": { "When source audience IDs are invalid (not matched audiences)": { "description": "When source audience IDs are invalid (not matched audiences)", "value": { "success": false, "errorObjects": [ { "error": "Please provide valid matched audience ids." } ] } }, "When country IDs are invalid": { "description": "When country IDs are invalid", "value": { "success": false, "errorObjects": [ { "error": "Please provide valid country ids." } ] } }, "When state IDs are invalid": { "description": "When state IDs are invalid", "value": { "success": false, "errorObjects": [ { "error": "Please provide valid state ids." } ] } }, "When congressional district IDs are invalid": { "description": "When congressional district IDs are invalid", "value": { "success": false, "errorObjects": [ { "error": "Please provide valid congressional district ids." } ] } }, "When City IDs are invalid": { "description": "When City IDs are invalid", "value": { "success": false, "errorObjects": [ { "error": "Please provide valid city ids." } ] } }, "When house district IDs are invalid": { "description": "When house district IDs are invalid", "value": { "success": false, "errorObjects": [ { "error": "Please provide valid house district ids." } ] } }, "When senate district IDs are invalid": { "description": "When senate district IDs are invalid", "value": { "success": false, "errorObjects": [ { "error": "Please provide valid senate district ids." } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/audience/list": { "post": { "tags": [ "Audience API" ], "summary": "This API gives the detailed list of audiences and insights details.", "description": "This API provides the detailed list of audiences based on the search request parameters. It supports filtering by audience IDs, audience type IDs, audience subtype IDs, OW IDs, and status IDs. The response includes pagination and sorting options.", "operationId": "getAudienceList", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "description": "Search request containing filters and pagination parameters for audience listing", "content": { "application/json": { "schema": { "type": "object", "properties": { "sortCriteriaMap": { "type": "object", "additionalProperties": { "type": "string" } }, "audienceIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "audienceTypeIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "audienceSubtypeIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "dataPartnerIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "owIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "audienceStatusIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "searchFields": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "includeGenericAudience": { "type": "boolean" }, "audienceTypeIdsWithAllSubtypes": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "pageNo": { "type": "integer", "format": "int32" }, "noOfEntries": { "type": "integer", "format": "int32" }, "sortBy": { "type": "string" }, "searchField": { "type": "string" }, "order": { "type": "string", "enum": [ "SortOrderEnum[id=1, name='asc', symbol='+']", "SortOrderEnum[id=2, name='desc', symbol='-']" ] } } }, "examples": { "Basic audience search request": { "description": "Example request with common search parameters", "value": "{\n \"audienceIds\": [1003879, 1003880],\n \"audienceTypeIds\": [1, 2],\n \"audienceSubtypeIds\": [3, 4],\n \"owIds\": [12345, 67890],\n \"audienceStatusIds\": [1, 2],\n \"includeGenericAudience\": true,\n \"audienceTypeIdsWithAllSubtypes\": [9]\n \"pageNo\": 1,\n \"noOfEntries\": 20,\n \"sortBy\": \"audienceName\",\n \"searchFields\": [\"test audience\", 123456]\n}\n" }, "Minimal search request": { "description": "Example request with no filters, only pagination", "value": { "pageNumber": 1, "pageSize": 20 } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "audienceId": { "type": "integer", "format": "int32" }, "audienceName": { "type": "string" }, "audienceTypeId": { "type": "integer", "format": "int32" }, "audienceSubtypeId": { "type": "integer", "format": "int32" }, "audienceStatusId": { "type": "integer", "format": "int32" }, "cpm": { "type": "number", "format": "double" }, "owId": { "type": "integer", "format": "int32" }, "createdByUowId": { "type": "integer", "format": "int32" }, "createdAt": { "type": "integer", "format": "int64" }, "reach": { "type": "integer", "format": "int32" }, "verticalId": { "type": "integer", "description": "Vertical identifier (optional)", "format": "int32", "example": 1 }, "organizationName": { "type": "string", "description": "Name of the organization owning the audience", "example": "devaldhealthcare" }, "rejectionReason": { "type": "string", "description": "Reason for rejection if applicable", "example": "reason" }, "includedCampaignList": { "uniqueItems": true, "type": "array", "description": "List of campaigns where this audience is included", "example": [101, 102, 103], "items": { "type": "integer", "description": "List of campaigns where this audience is included", "format": "int32" } }, "excludedCampaignList": { "uniqueItems": true, "type": "array", "description": "List of campaigns where this audience is excluded", "example": [201, 202], "items": { "type": "integer", "description": "List of campaigns where this audience is excluded", "format": "int32" } }, "runningCampaignCount": { "type": "integer", "description": "Number of running campaigns for this audience", "format": "int32", "example": 3 }, "pendingCampaignCount": { "type": "integer", "description": "Number of pending campaigns for this audience", "format": "int32", "example": 1 }, "pausedCampaignCount": { "type": "integer", "description": "Number of paused campaigns for this audience", "format": "int32", "example": 0 }, "expiredCampaignCount": { "type": "integer", "description": "Number of expired campaigns for this audience", "format": "int32", "example": 0 }, "matchRate": { "type": "number", "description": "Match rate percentage (only for matched and ICT audiences)", "format": "double", "example": 59.17 }, "fileTotalCount": { "type": "integer", "description": "Total file count uploaded for matching (only for matched and ICT audiences)", "format": "int32", "example": 10000 }, "s3FileName": { "type": "string", "description": "S3 filename for uploaded audience data (only for matched and ICT audiences)", "example": "1751006475705_Sample_File.csv" }, "insightId": { "type": "integer", "description": "Insight identifier (only for matched audiences)", "format": "int32", "example": 1585 }, "insightStatusId": { "type": "integer", "description": "Insight status identifier (only for matched audiences)", "format": "int32", "example": 2 }, "parentAudienceId": { "type": "integer", "description": "Parent audience ID (only for ICT audiences)", "format": "int32", "example": 1234 }, "scriptTag": { "type": "string", "description": "Script Tag for retargeted audiences (only for retargeted audiences)", "example": "tag_12345" }, "tagUniqueCount": { "type": "integer", "description": "Unique count of tag IDs (only for retargeted audiences)", "format": "int64", "example": 75000 }, "dataCollectionPeriod": { "type": "integer", "description": "Data collection period in days (only for retargeted audiences)", "format": "int32", "example": 30 }, "dataCollectionBy": { "type": "string", "description": "Data collection source (only for retargeted audiences)", "example": "pixel_tracking" }, "startDate": { "type": "integer", "description": "Start date (epoch millis) (only for geofarmed and retargeted)", "format": "int64", "example": 1640995200000 }, "endDate": { "type": "integer", "description": "End date (epoch millis) (only for geofarmed and retargeted)", "format": "int64", "example": 1643673600000 }, "timezone": { "type": "integer", "description": "Timezone offset for geo farmed audiences (only for geofarmed)", "format": "int32", "example": -5 }, "failureReason": { "type": "string", "description": "Failure reason if processing failed (only for geofarmed and contextual)", "example": "Insufficient data points" }, "regeneratedCount": { "type": "integer", "description": "Number of regenerations attempted (only for geofarmed and contextual)", "format": "int32", "example": 2 }, "dataPartnerId": { "type": "integer", "description": "Data partner identifier (only for geofarmed, contextual and matched)", "format": "int32", "example": 1 }, "prebidAudienceProviderId": { "type": "integer", "description": "Prebid audience provider identifier (only for prebid)", "format": "int32" }, "audienceRematchEligible": { "type": "boolean", "description": "Boolean flag representing if the audience is eligible for rematch or not. Unavailability of flag represents this field is not applicable for particular audience type.", "example": true }, "lastRematchStatusId": { "type": "integer", "description": "Represents status id of last rematch of the audience. Eg: Processing, Ready or Failed. It can be null if audience is not rematched yet.", "format": "int32", "example": 2 }, "approvalAccess": { "type": "boolean" }, "editAccess": { "type": "boolean" } }, "description": "Detailed audience response containing attributes and campaign insights. Fields may be optional depending on audienceTypeId." }, "examples": { "AudienceResponseExample": { "description": "AudienceResponseExample", "value": { "audienceId": 1142057, "audienceName": "asdf", "audienceStatusId": 3, "createdAt": 1755598239000, "uniques": 0, "cpm": 0.07, "audienceTypeId": 1, "audienceSubtypeId": 2, "verticalId": 10, "organizationName": "devaldhealthcare", "isEditAccess": true, "isApprovalAccess": false, "rejectionReason": "Invalid data format", "includedCampaignList": [101, 102, 103], "excludedCampaignList": [201, 202], "runningCampaignCount": 3, "pendingCampaignCount": 1, "pausedCampaignCount": 0, "expiredCampaignCount": 0, "matchRate": 59.17, "fileTotalCount": 10000, "s3FileName": "1751006475705_Sample_File.csv", "insightId": 1585, "insightStatusId": 2, "dataPartnerId": 1 } } } } } }, "422": { "description": "Unprocessable Entity - Request validation failed", "content": { "application/json": { "examples": { "Invalid pagination parameters": { "description": "Error when page size is negative or page number is invalid", "value": { "success": false, "error": { "message": "Invalid page size" } } }, "Invalid status ID": { "description": "Error when provided status ID is not in the allowed status list", "value": { "success": false, "error": { "message": "Invalid status ID: 99", "field": "statusIds" } } }, "Invalid audience type ID": { "description": "Error when provided audience type ID is not in the allowed audience type list", "value": { "success": false, "error": { "message": "Invalid audience type ID: 15", "field": "audienceTypeIds" } } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/audience/insights/add": { "post": { "tags": [ "Audience API" ], "summary": "This API generate insights for the given audience id(s)", "description": "This API generate insights for match audience. The audience IDs are provided in the request body.", "operationId": "generateInsightsForMatchedAudience", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "description": "Request body containing audience IDs for insights generation", "content": { "application/json": { "schema": { "required": [ "audienceIds" ], "type": "object", "properties": { "audienceIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } } } }, "examples": { "Generate Insights Request": { "description": "Generate Insights Request", "value": { "audienceIds": [12345, 54321, 1233] } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Successful Insights creation": { "description": "Successful Insights creation", "value": { "success": true, "data": { "invalidSourceIds": [1233], "insightsData": [ { "id": 1003, "typeId": 1, "statusId": 1, "sourceName": "Audience - 1", "name": "Audience - 1_insights", "sourceId": 12345, "createdAt": 1689155409179 }, { "id": 1100, "typeId": 1, "statusId": 1, "sourceName": "audience 2", "name": "audience 2_insights", "sourceId": 54321, "createdAt": 1689155409179 } ] } } } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "examples": { "Unprocessable Entity422 error message": { "description": "Unprocessable Entity422 error message", "value": { "success": false, "errorObjects": [ { "error": "No Audience ids provided" } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/audience/ict": { "post": { "tags": [ "Audience API" ], "summary": "Create ICT audience with optional extended audiences", "description": "API endpoint for creating ICT (Integrated Care Team) audiences.\nCreates a primary ICT audience and optionally creates extended audiences\nbased on different audience subtypes. The audienceRequest and file are sent\nas binary multipart/form-data.\n\n**Request Body Details:**\n\n| **Field** | **Type** | **Description** |\n| --- | --- | --- |\n | audienceName `[required]` | String | Name of the ICT audience to be created. Max length 255. |\n | dataPartnerId `[required]` | Integer | ID of the data partner associated with the audience. |\n | audienceSubtypeId `[required]` | Short | Primary audience subtype ID for ICT audience (e.g., 3 for HCP, 4 for Nurse). |\n | extensionAudienceSubtypeIds `[required]` | List of Short | List of subtype IDs for creating extended audiences. |\n | columnMappings `[required]` | List of Objects | Mappings of file columns to expected data formats. Each object contains `columnId`, `fileColumnName`, and optional `dataFormatId`. |\n | fileRowCount `[required]` | Integer | Number of rows in the uploaded file. |\n | fileColumnCount `[required]` | Integer | Number of columns in the uploaded file. |\n | columnCombinationId `[required]` | Integer | ID representing the combination of columns used for matching. |\n", "operationId": "createICTAudience", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "description": "Multipart form data with audienceRequest and XLSX/CSV file. Please see the structure of audienceRequest below:", "content": { "multipart/form-data": { "schema": { "type": "object", "description": "Multipart payload containing `audienceRequest` JSON and a binary `file` part." }, "examples": { "Sample audienceRequest object for ICT Audience Creation": { "description": "Sample audienceRequest object for ICT Audience Creation", "value": { "audienceRequest": { "audienceName": "Sample xyz", "fileRowCount": 5, "fileColumnCount": 10, "columnMappings": [ { "columnId": 18, "fileColumnName": "npi-id", "dataFormatId": null }, { "columnId": 2, "fileColumnName": "email", "dataFormatId": 1 }, { "columnId": 3, "fileColumnName": "phone-sha256", "dataFormatId": 4 } ], "dataPartnerId": 7, "columnCombinationId": 32, "audienceSubtypeId": 3, "extensionAudienceSubtypeIds": [4, 5] }, "file": "BINARY FILE" } } }, "encoding": { "audienceRequest": { "contentType": "application/json" }, "file": { "contentType": "application/octet-stream" } } } }, "required": true }, "responses": { "200": { "description": "ICT audience created successfully", "content": { "application/json": { "examples": { "Successful creation": { "description": "Successful creation", "value": { "success": true, "data": { "audienceId": 12345, "extensionAudienceIds": [12346, 12347], "message": "Sample xyz and 2 extended audiences created successfully" } } } } } } }, "400": { "description": "Bad Request - When mandatory parameters are missing or invalid", "content": { "application/json": { "examples": { "Missing audience subtype ID": { "description": "Missing audience subtype ID", "value": { "success": false, "errorObjects": [ { "error": "Audience subtype ID is required", "field": "audienceSubtypeId" } ] } }, "Missing data partner ID": { "description": "Missing data partner ID", "value": { "success": false, "errorObjects": [ { "error": "Data partner ID is required", "field": "dataPartnerId" } ] } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "examples": { "Non Advertiser user accessing the API": { "description": "Non Advertiser user accessing the API", "value": { "success": false, "errorObjects": [ { "error": "User is not allowed to access this API. Only Advertiser users can access this API." } ] } } } } } }, "422": { "description": "Unprocessable Entity - Validation failed", "content": { "application/json": { "examples": { "Invalid column mappings": { "description": "Invalid column mappings", "value": { "success": false, "errorObjects": [ { "error": "Required column 'npi-id' is missing from column mappings", "field": "columns" } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/audience/ict/count-by-data-partner": { "post": { "tags": [ "Audience API" ], "summary": "This API fetches the data partner ids and their respective audience count.", "description": "This API gets the data partner ids and the count of audiences created for each data partner. The audience count is filtered based on the logged in OW ID and returns only data partners with non-zero counts.", "operationId": "getAudienceCountByDataPartner", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "sortCriteriaMap": { "type": "object", "additionalProperties": { "type": "string" } }, "audienceIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "audienceTypeIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "audienceSubtypeIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "dataPartnerIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "owIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "audienceStatusIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "searchFields": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "includeGenericAudience": { "type": "boolean" }, "audienceTypeIdsWithAllSubtypes": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "pageNo": { "type": "integer", "format": "int32" }, "noOfEntries": { "type": "integer", "format": "int32" }, "sortBy": { "type": "string" }, "searchField": { "type": "string" }, "order": { "type": "string", "enum": [ "SortOrderEnum[id=1, name='asc', symbol='+']", "SortOrderEnum[id=2, name='desc', symbol='-']" ] } } }, "examples": { "Get Audience Count by Data Partner for Super/Workspace User": { "description": "Get Audience Count by Data Partner for Super/Workspace User", "value": { "audienceTypeIds": [2, 4], "owIds": [201427, 201865], "searchField": "DP" } }, "Get Audience Count by Data Partner for Advertiser User": { "description": "Get Audience Count by Data Partner for Advertiser User", "value": { "audienceTypeIds": [2, 4], "searchField": "DP" } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Successful fetching of data partners with their audience counts": { "description": "Successful fetching of data partners with their audience counts", "value": { "success": true, "data": [ { "dataPartnerId": 1, "audienceCount": 111 }, { "dataPartnerId": 2, "audienceCount": 222 } ] } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "examples": { "When incorrect owIds are provided in the request": { "description": "When incorrect owIds are provided in the request", "value": { "success": false, "errorObjects": [ { "error": "Failed to filter result as per provided owIds" } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } }, "deprecated": true } }, "/api/v3/audience/geo-farmed": { "post": { "tags": [ "Audience API" ], "summary": "This method creates GeoFarmed audience.", "description": "This method creates a GeoFarmed Audience with location-based targeting and scheduling options", "operationId": "createGeoFarmedAudience", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "content": { "application/json": { "schema": { "required": [ "audienceName" ], "type": "object", "properties": { "audienceName": { "maxLength": 255, "minLength": 0, "type": "string" }, "frequency": { "maximum": 10, "minimum": 1, "type": "integer", "format": "int32" }, "frequencyTypeId": { "maximum": 3, "minimum": 1, "type": "integer", "format": "int32" }, "startDate": { "type": "integer", "format": "int64" }, "endDate": { "type": "integer", "format": "int64" }, "timezoneId": { "type": "integer", "format": "int32" }, "timeRange": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "array", "items": { "type": "string" } } } }, "timeRangeWithTimezone": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "array", "items": { "type": "string" } } } } }, "audienceSubtypeIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "locations": { "type": "object", "properties": { "included": { "type": "object", "properties": { "zipCodes": { "type": "array", "items": { "type": "string" } }, "customAreas": { "type": "array", "items": { "type": "object", "properties": { "latitude": { "type": "number", "format": "double" }, "longitude": { "type": "number", "format": "double" }, "radius": { "type": "number", "format": "double" }, "address": { "type": "string" }, "stateShortName": { "type": "string" }, "countryShortName": { "type": "string" }, "locationId": { "type": "integer", "format": "int32" }, "rejectionReason": { "type": "string" }, "polypath": { "type": "object" }, "placemarkName": { "type": "string" }, "cid": { "type": "string" }, "sid": { "type": "string" }, "type": { "type": "string" }, "unit": { "type": "string" }, "cdId": { "type": "integer", "format": "int32" }, "sdId": { "type": "integer", "format": "int32" }, "hdId": { "type": "integer", "format": "int32" }, "isIncluded": { "type": "boolean" } } } }, "locationIds": { "type": "array", "items": { "type": "integer", "format": "int32" } } } }, "excluded": { "type": "object", "properties": { "zipCodes": { "type": "array", "items": { "type": "string" } }, "customAreas": { "type": "array", "items": { "type": "object", "properties": { "latitude": { "type": "number", "format": "double" }, "longitude": { "type": "number", "format": "double" }, "radius": { "type": "number", "format": "double" }, "address": { "type": "string" }, "stateShortName": { "type": "string" }, "countryShortName": { "type": "string" }, "locationId": { "type": "integer", "format": "int32" }, "rejectionReason": { "type": "string" }, "polypath": { "type": "object" }, "placemarkName": { "type": "string" }, "cid": { "type": "string" }, "sid": { "type": "string" }, "type": { "type": "string" }, "unit": { "type": "string" }, "cdId": { "type": "integer", "format": "int32" }, "sdId": { "type": "integer", "format": "int32" }, "hdId": { "type": "integer", "format": "int32" }, "isIncluded": { "type": "boolean" } } } }, "locationIds": { "type": "array", "items": { "type": "integer", "format": "int32" } } } }, "locationFileIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "country": { "type": "integer", "format": "int32" } } }, "removedLocationsIds": { "type": "array", "items": { "type": "integer", "format": "int32" } } } }, "example": { "audienceName": "Healthcare Professionals NYC", "frequency": 5, "frequencyTypeId": 2, "startDate": 1697040000, "endDate": 1699641600, "timezoneId": 1, "audienceSubtypeIds": [3, 4], "timeRange": { "0": [ [ "09:00:00", "17:00:00" ] ], "1": [ [ "10:00:00", "18:00:00" ] ] }, "locations": { "country": 1, "included": { "zipCodes": [ "10001", "10002", "10003" ], "customAreas": [ { "type": "circle", "latitude": 40.7128, "longitude": -74.006, "radius": 5, "unit": "mile" } ] }, "locationFileIds": [123] } } } }, "required": true }, "responses": { "200": { "description": "Successful Creation of GeoFarmed Audience", "content": { "application/json": { "examples": { "Adding single geofarmed Audience": { "description": "Adding single geofarmed Audience", "value": { "success": true, "data": { "audienceIds": [1142280], "message": "Test_aud audience created successfully" } } }, "Adding multiple geofarmed Audiences": { "description": "Adding multiple geofarmed Audiences", "value": { "success": true, "data": { "message": "2 audiences created successfully", "audienceIds": [1142284, 114228] } } } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "examples": { "Invalid Date Range": { "description": "Invalid Date Range", "value": { "success": false, "errorObjects": [ { "error": "End Date can not be less than Start Date", "field": "endDate" } ] } }, "Invalid Location Data": { "description": "Invalid Location Data", "value": { "success": false, "errorObjects": [ { "error": "At least one targeting either from zip codes or custom areas is required." } ] } }, "Invalid Audience Subtype": { "description": "Invalid Audience Subtype", "value": { "success": false, "errorObjects": [ { "error": "Invalid audience subtype provided: 99" } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/audience/count-by-status": { "post": { "tags": [ "Audience API" ], "summary": "This API fetches the audience status ids and their respective count.", "description": "This API gets the audience status ids and the count of audiences created for each status. The audience count is filtered based on the logged in OW ID and return's only audience statuses with non-zero counts.", "operationId": "getAudienceCountByStatus", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "sortCriteriaMap": { "type": "object", "additionalProperties": { "type": "string" } }, "audienceIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "audienceTypeIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "audienceSubtypeIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "dataPartnerIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "owIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "audienceStatusIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "searchFields": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "includeGenericAudience": { "type": "boolean" }, "audienceTypeIdsWithAllSubtypes": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "pageNo": { "type": "integer", "format": "int32" }, "noOfEntries": { "type": "integer", "format": "int32" }, "sortBy": { "type": "string" }, "searchField": { "type": "string" }, "order": { "type": "string", "enum": [ "SortOrderEnum[id=1, name='asc', symbol='+']", "SortOrderEnum[id=2, name='desc', symbol='-']" ] } } }, "examples": { "Get Audience Count by Status for Super/Workspace User": { "description": "Get Audience Count by Status for Super/Workspace User", "value": { "searchFields": [ "hi", "bye" ], "audienceTypeIds": [2, 4], "owIds": [201427, 201865] } }, "Get Audience Count by Status for Advertiser User": { "description": "Get Audience Count by Status for Advertiser User", "value": { "searchFields": [ "hi", "bye" ], "audienceTypeIds": [2, 4] } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Successful fetching of Audience status with their counts": { "description": "Successful fetching of Audience status with their counts", "value": { "success": true, "data": [ { "audienceStatusId": 8, "audienceCount": 296 }, { "audienceStatusId": 7, "audienceCount": 125 } ] } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "examples": { "When incorrect owIds are provided in the request": { "description": "When incorrect owIds are provided in the request", "value": { "success": false, "errorObjects": [ { "error": "Failed to filter result as per provided owIds" } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/audience/count-by-data-partner": { "post": { "tags": [ "Audience API" ], "summary": "This API fetches the data partner ids and their respective audience count.", "description": "This API gets the data partner ids and the count of audiences created for each data partner. The audience count is filtered based on the logged in OW ID and returns only data partners with non-zero counts.", "operationId": "getAudienceCountByDataPartner_1", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "sortCriteriaMap": { "type": "object", "additionalProperties": { "type": "string" } }, "audienceIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "audienceTypeIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "audienceSubtypeIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "dataPartnerIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "owIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "audienceStatusIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "searchFields": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "includeGenericAudience": { "type": "boolean" }, "audienceTypeIdsWithAllSubtypes": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "pageNo": { "type": "integer", "format": "int32" }, "noOfEntries": { "type": "integer", "format": "int32" }, "sortBy": { "type": "string" }, "searchField": { "type": "string" }, "order": { "type": "string", "enum": [ "SortOrderEnum[id=1, name='asc', symbol='+']", "SortOrderEnum[id=2, name='desc', symbol='-']" ] } } }, "examples": { "Get Audience Count by Data Partner for Super/Workspace User": { "description": "Get Audience Count by Data Partner for Super/Workspace User", "value": { "audienceTypeIds": [2, 4], "owIds": [201427, 201865] } }, "Get Audience Count by Data Partner for Advertiser User": { "description": "Get Audience Count by Data Partner for Advertiser User", "value": { "audienceTypeIds": [2, 4] } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Successful fetching of data partners with their audience counts": { "description": "Successful fetching of data partners with their audience counts", "value": { "success": true, "data": [ { "dataPartnerId": 1, "audienceCount": 111 }, { "dataPartnerId": 2, "audienceCount": 222 } ] } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "examples": { "When incorrect owIds are provided in the request": { "description": "When incorrect owIds are provided in the request", "value": { "success": false, "errorObjects": [ { "error": "Failed to filter result as per provided owIds" } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/audience/contextual": { "post": { "tags": [ "Audience API" ], "summary": "Add contextual Audience", "operationId": "createContextualAudiences", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "content": { "application/json": { "schema": { "required": [ "audienceName", "dataCollectionMethodId" ], "type": "object", "properties": { "audienceName": { "maxLength": 255, "minLength": 0, "type": "string" }, "keywords": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "urls": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "frequency": { "maximum": 10, "minimum": 1, "type": "integer", "format": "int32" }, "startDate": { "type": "integer", "format": "int64" }, "endDate": { "type": "integer", "format": "int64" }, "timezoneId": { "type": "integer", "format": "int32" }, "dataCollectionMethodId": { "type": "integer", "format": "int32" }, "dataCollectionDays": { "maximum": 60, "minimum": 1, "type": "integer", "format": "int32" }, "audienceSubtypes": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } } } }, "examples": { "Adding contextual Audience with static data collection method": { "description": "Adding contextual Audience with static data collection method", "value": { "audienceName": "Test_aud", "frequency": 5, "startDate": 1750737600000, "endDate": 1753329599000, "keywords": [ "Test" ], "urls": [ "http://iqm.com" ], "timezoneId": 29, "dataCollectionMethodId": 1, "audienceSubtypes": [2, 3] } }, "Adding contextual Audience with dynamic data collection method": { "description": "Adding contextual Audience with dynamic data collection method", "value": { "audienceName": "Test_aud", "frequency": 10, "keywords": [ "Test" ], "urls": [ "http://iqm.com" ], "timezoneId": 29, "dataCollectionMethodId": 2, "dataCollectionDays": 20, "audienceSubtypes": [2, 3] } } } } }, "required": true }, "responses": { "200": { "description": "Successfully created contextual Audience(s)", "content": { "application/json": { "examples": { "Adding single contextual Audience": { "description": "Adding single contextual Audience", "value": { "success": true, "data": { "audienceIds": [1142280], "message": "Test_aud audience created successfully" } } }, "Adding multiple contextual Audiences": { "description": "Adding multiple contextual Audiences", "value": { "success": true, "data": { "message": "2 audiences created successfully", "audienceIds": [1142284, 1142285] } } } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "examples": { "Invalid data difference": { "description": "Invalid data difference", "value": { "success": false, "errorObjects": [ { "error": "The period between start date and end date cannot exceed 60 days.", "field": "endDate" } ] } }, "Invalid frequency": { "description": "Invalid frequency", "value": { "success": false, "errorObjects": [ { "error": "Frequency must be between 1 and 10." } ] } }, "Dates not within 180 days or more than 90 days in future": { "description": "Dates not within 180 days or more than 90 days in future", "value": { "success": false, "errorObjects": [ { "error": "Start date must be within the last 180 days or up to 90 days in the future." } ] } }, "Invalid Timezone id provided": { "description": "Invalid Timezone id provided", "value": { "success": false, "errorObjects": [ { "error": "Invalid value provided", "field": "timezoneId" } ] } }, "Invalid data collection method provided": { "description": "Invalid data collection method provided", "value": { "success": false, "errorObjects": [ { "error": "Invalid data collection method provided" } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/audience/contextual/validate-programmatic-urls": { "post": { "tags": [ "Audience API" ], "summary": "Validate Programmatic URLs for contextual audience targeting", "description": "This API validates the given URL to be targeted in the contextual audience. It checks if\nthe URL is part of programmatic universe. if the any URL is mapped to 'true' that means the URL is valid,\nif 'false' then that means that the URL is invalid, and if 'null' that means it's unable to validate the URL\n(if URL is taking longer time to be validated, it sets NULL as the result for such URL).\n", "operationId": "validateProgrammaticUrls", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "description": "Request body must have the list of the URLs which is to be validated.", "content": { "application/json": { "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "examples": { "URLs to validate": { "description": "URLs to validate", "value": [ "https://sample-url-1.com", "https://sample-url-2.com", "https://sample-url-3.com" ] } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Validating all valid URIs": { "description": "Validating all valid URIs", "value": { "success": true, "data": { "https://sample-url-1.com": false, "https://sample-url-2.me": true, "https://sample-url-3.com": null } } } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Invalid sortBy value." } ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/audience/campaigns/audience-history": { "post": { "tags": [ "Audience API" ], "summary": "Fetch attached audience history for specified campaigns", "description": "Return the history of audiences attached to specified campaigns.\nThe request should include campaign IDs, audience type IDs, sub-type IDs, and pagination details\nto filter and retrieve the relevant audience history data.\nResult includes only whitelisted audience types.\nFetch current and historical audience data based on historicalData flag.\n1. If historicalData is true, fetch historical audience data.\n2. If historicalData is false, fetch current audience data.\n", "operationId": "getAttachedAudienceHistory", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "content": { "application/json": { "schema": { "required": [ "campaignIds" ], "type": "object", "properties": { "sortCriteriaMap": { "type": "object", "additionalProperties": { "type": "string" } }, "campaignIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "historicalData": { "type": "boolean" }, "subTypeIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "typeIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "pageNo": { "type": "integer", "format": "int32" }, "noOfEntries": { "type": "integer", "format": "int32" }, "sortBy": { "type": "string" }, "searchField": { "type": "string" }, "order": { "type": "string", "enum": [ "SortOrderEnum[id=1, name='asc', symbol='+']", "SortOrderEnum[id=2, name='desc', symbol='-']" ] } } }, "examples": { "Sample request": { "description": "Sample request", "value": { "campaignId": [540050], "subTypeIds": [], "historicalData": false, "typeIds": [], "noOfEntries": 2, "pageNo": 1 } } } } }, "required": true }, "responses": { "200": { "description": "Successfully fetched attached audience history", "content": { "application/json": { "examples": { "Success response": { "description": "Success response", "value": { "success": true, "data": { "totalRecords": 12, "filteredRecords": 12, "audienceDetails": [ { "id": 1023234, "campaignIds": [540050], "name": "MA-1 voter id", "audienceSubTypeId": null, "typeId": 1 }, { "id": 1054138, "campaignIds": [540050], "name": "MA With 90 K Records And 8 Columns NYSD 3 Digital Universe Csv", "audienceSubTypeId": null, "typeId": 1 } ] } } } } } } }, "400": { "description": "Bad Request - Invalid parameters", "content": { "application/json": { "examples": { "Campaign ids empty error": { "description": "Campaign ids empty error", "value": { "success": false, "errorObjects": [ { "error": "must not be empty", "field": "campaignIds" } ] } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "examples": { "Non Advertiser user accessing the API": { "description": "Non Advertiser user accessing the API", "value": { "success": false, "errorObjects": [ { "error": "User is not allowed to access this API. Only Advertiser users can access this API." } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/audience/campaign": { "post": { "tags": [ "Audience API" ], "summary": "Create a new Campaign Audience", "description": "Creates a new Campaign Audience with the provided campaign details in the request.\n \n**Request Body Details:**\n\n| **Field** | **Type** | **Description** |\n| --- | --- | --- |\n| audienceName `[required]` | String | Name of the retargeted audience |\n| campaignDetails `[required]` | Map\u003CString, List\u003CInteger\u003E\u003E | Map of campaign tracking type('impression'/'clicks'/'conversions') with values as list of campaignIds |\n| startDate `[required]` | Long | Start date in epoch millis to consider for campaign serving |\n| endDate `[required]` | Long | End date in epoch millis to consider for campaign serving |\n", "operationId": "createCampaignAudience", "parameters": [ { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" } ], "requestBody": { "content": { "application/json": { "schema": { "required": [ "audienceName", "campaignDetails", "endDate", "startDate" ], "type": "object", "properties": { "audienceName": { "maxLength": 255, "minLength": 0, "type": "string" }, "campaignDetails": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "integer", "format": "int32" } } }, "startDate": { "type": "integer", "format": "int64" }, "endDate": { "type": "integer", "format": "int64" } } }, "examples": { "Request body for audience creation": { "description": "Request body for audience creation", "value": { "audienceName": "Sample audience name", "campaignDetails": { "impressions": [1, 2], "clicks": [3], "conversions": [4] }, "startDate": 1638316800, "endDate": 1640085173 } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Successful creation of Campaign Audience": { "description": "Successful creation of Campaign Audience", "value": { "success": true, "data": { "audienceId": 1140606, "message": "Test campaign audience audience created successfully" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "examples": { "Non Advertiser user accessing the API": { "description": "Non Advertiser user accessing the API", "value": { "success": false, "errorObjects": [ { "error": "User is not allowed to access this API. Only Advertiser users can access this API." } ] } } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "examples": { "When startDate is older than 1 year": { "description": "When startDate is older than 1 year", "value": { "success": false, "errorObjects": [ { "error": "Start Date can not be older than 1 year", "field": "startDate" } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/audience/basic/list": { "post": { "tags": [ "Audience API" ], "summary": "This API gives the basic list of audiences.", "description": "This API provides the basic list of audiences based on the search request parameters.\nIt supports filtering by audience IDs, type IDs, subtype IDs, OW IDs, and status IDs.\nThe request includes pagination and sorting options.\n", "operationId": "getAudienceBasicList", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "description": "Search request containing filters and pagination parameters for audience listing", "content": { "application/json": { "schema": { "type": "object", "properties": { "sortCriteriaMap": { "type": "object", "additionalProperties": { "type": "string" } }, "audienceIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "audienceTypeIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "audienceSubtypeIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "dataPartnerIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "owIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "audienceStatusIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "searchFields": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "includeGenericAudience": { "type": "boolean" }, "audienceTypeIdsWithAllSubtypes": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "pageNo": { "type": "integer", "format": "int32" }, "noOfEntries": { "type": "integer", "format": "int32" }, "sortBy": { "type": "string" }, "searchField": { "type": "string" }, "order": { "type": "string", "enum": [ "SortOrderEnum[id=1, name='asc', symbol='+']", "SortOrderEnum[id=2, name='desc', symbol='-']" ] } } }, "examples": { "Basic audience search request": { "description": "Example request with common search parameters", "value": { "audienceIds": [1003879, 1003880], "audienceTypeIds": [1, 2], "audienceSubtypeIds": [3, 4], "owIds": [12345, 67890], "audienceStatusIds": [1, 2], "includeGenericAudience": true, "pageNo": 1, "noOfEntries": 20, "sortBy": "audienceName", "searchFields": [ "test audience", 123456] } }, "Minimal search request": { "description": "Example request with no filters, only pagination", "value": { "pageNumber": 1, "pageSize": 20 } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "audienceId": { "type": "integer", "format": "int32" }, "audienceName": { "type": "string" }, "audienceTypeId": { "type": "integer", "format": "int32" }, "audienceSubtypeId": { "type": "integer", "format": "int32" }, "audienceStatusId": { "type": "integer", "format": "int32" }, "cpm": { "type": "number", "format": "double" }, "owId": { "type": "integer", "format": "int32" }, "createdByUowId": { "type": "integer", "format": "int32" }, "createdAt": { "type": "integer", "format": "int64" }, "reach": { "type": "integer", "format": "int32" }, "verticalId": { "type": "integer", "description": "Vertical identifier (optional)", "format": "int32", "example": 1 }, "organizationName": { "type": "string", "description": "Name of the organization owning the audience", "example": "devaldhealthcare" }, "rejectionReason": { "type": "string", "description": "Reason for rejection if applicable", "example": "reason" }, "includedCampaignList": { "uniqueItems": true, "type": "array", "description": "List of campaigns where this audience is included", "example": [101, 102, 103], "items": { "type": "integer", "description": "List of campaigns where this audience is included", "format": "int32" } }, "excludedCampaignList": { "uniqueItems": true, "type": "array", "description": "List of campaigns where this audience is excluded", "example": [201, 202], "items": { "type": "integer", "description": "List of campaigns where this audience is excluded", "format": "int32" } }, "runningCampaignCount": { "type": "integer", "description": "Number of running campaigns for this audience", "format": "int32", "example": 3 }, "pendingCampaignCount": { "type": "integer", "description": "Number of pending campaigns for this audience", "format": "int32", "example": 1 }, "pausedCampaignCount": { "type": "integer", "description": "Number of paused campaigns for this audience", "format": "int32", "example": 0 }, "expiredCampaignCount": { "type": "integer", "description": "Number of expired campaigns for this audience", "format": "int32", "example": 0 }, "matchRate": { "type": "number", "description": "Match rate percentage (only for matched and ICT audiences)", "format": "double", "example": 59.17 }, "fileTotalCount": { "type": "integer", "description": "Total file count uploaded for matching (only for matched and ICT audiences)", "format": "int32", "example": 10000 }, "s3FileName": { "type": "string", "description": "S3 filename for uploaded audience data (only for matched and ICT audiences)", "example": "1751006475705_Sample_File.csv" }, "insightId": { "type": "integer", "description": "Insight identifier (only for matched audiences)", "format": "int32", "example": 1585 }, "insightStatusId": { "type": "integer", "description": "Insight status identifier (only for matched audiences)", "format": "int32", "example": 2 }, "parentAudienceId": { "type": "integer", "description": "Parent audience ID (only for ICT audiences)", "format": "int32", "example": 1234 }, "scriptTag": { "type": "string", "description": "Script Tag for retargeted audiences (only for retargeted audiences)", "example": "tag_12345" }, "tagUniqueCount": { "type": "integer", "description": "Unique count of tag IDs (only for retargeted audiences)", "format": "int64", "example": 75000 }, "dataCollectionPeriod": { "type": "integer", "description": "Data collection period in days (only for retargeted audiences)", "format": "int32", "example": 30 }, "dataCollectionBy": { "type": "string", "description": "Data collection source (only for retargeted audiences)", "example": "pixel_tracking" }, "startDate": { "type": "integer", "description": "Start date (epoch millis) (only for geofarmed and retargeted)", "format": "int64", "example": 1640995200000 }, "endDate": { "type": "integer", "description": "End date (epoch millis) (only for geofarmed and retargeted)", "format": "int64", "example": 1643673600000 }, "timezone": { "type": "integer", "description": "Timezone offset for geo farmed audiences (only for geofarmed)", "format": "int32", "example": -5 }, "failureReason": { "type": "string", "description": "Failure reason if processing failed (only for geofarmed and contextual)", "example": "Insufficient data points" }, "regeneratedCount": { "type": "integer", "description": "Number of regenerations attempted (only for geofarmed and contextual)", "format": "int32", "example": 2 }, "dataPartnerId": { "type": "integer", "description": "Data partner identifier (only for geofarmed, contextual and matched)", "format": "int32", "example": 1 }, "prebidAudienceProviderId": { "type": "integer", "description": "Prebid audience provider identifier (only for prebid)", "format": "int32" }, "audienceRematchEligible": { "type": "boolean", "description": "Boolean flag representing if the audience is eligible for rematch or not. Unavailability of flag represents this field is not applicable for particular audience type.", "example": true }, "lastRematchStatusId": { "type": "integer", "description": "Represents status id of last rematch of the audience. Eg: Processing, Ready or Failed. It can be null if audience is not rematched yet.", "format": "int32", "example": 2 }, "approvalAccess": { "type": "boolean" }, "editAccess": { "type": "boolean" } }, "description": "Detailed audience response containing attributes and campaign insights. Fields may be optional depending on audienceTypeId." }, "examples": { "Basic response": { "description": "Basic response", "value": " {\n \"success\": true,\n \"data\": {\n \"totalRecords\": 874,\n \"filteredRecords\": 874\n \"audienceBasicList\": [\n {\n \"audienceId\": 1,\n \"audienceName\": \"Sample audinece name 1\",\n \"audienceTypeId\": 1,\n \"audienceSubtypeId\": 1,\n \"isIqmIdTargeted\": true,\n \"audienceStatusId\": 1,\n \"createdOn\": 1653510068,\n \"cpm\": 1.5,\n \"reach\": 18850783\n }\n ]\n }\n }\n" }, "Basic response for ICTM audience type": { "description": "Basic response for ICTM audience type", "value": { "success": true, "data": { "totalRecords": 874, "filteredRecords": 2, "audienceBasicList": [ { "audienceId": 1, "audienceName": "Sample audinece name 1", "audienceTypeId": 1, "audienceSubtypeId": 1, "isIqmIdTargeted": true, "audienceStatusId": 1, "createdOn": 1653510068, "cpm": 1.5, "reach": 18850783, "dataPartnerId": 123, "parentAudienceId": 1 }, { "audienceId": 2, "audienceName": "Sample audinece name 1_Ext_NPI_Nurse", "audienceTypeId": 1, "audienceSubtypeId": 2, "isIqmIdTargeted": true, "audienceStatusId": 1, "createdOn": 1653510068, "cpm": 1.5, "reach": 18850783, "dataPartnerId": 456, "parentAudienceId": 1 } ] } } } } } } }, "422": { "description": "Unprocessable Entity - Request validation failed", "content": { "application/json": { "examples": { "Invalid pagination parameters": { "description": "Error when page size is negative or page number is invalid", "value": { "success": false, "error": { "message": "Invalid page size" } } }, "Invalid status ID": { "description": "Error when provided status ID is not in the allowed status list", "value": { "success": false, "error": { "message": "Invalid status ID: 99", "field": "statusIds" } } }, "Invalid audience type ID": { "description": "Error when provided audience type ID is not in the allowed audience type list", "value": { "success": false, "error": { "message": "Invalid audience type ID: 15", "field": "audienceTypeIds" } } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/audience/attach-data-partner": { "post": { "tags": [ "Audience API" ], "summary": "This API attaches a data partner to a audience.", "description": "This API attaches a data partner to a audience based on the provided audience ID and data partner ID.", "operationId": "attachDataPartnerToAudience", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "audienceId": { "type": "integer", "format": "int32" }, "dataPartnerId": { "type": "integer", "format": "int32" } } }, "examples": { "Request to attach a data partner to a audience": { "description": "Request to attach a data partner to a audience", "value": { "audienceId": 124, "dataPartnerId": 7 } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Successful attaching of data partner to audience": { "description": "Successful attaching of data partner to audience", "value": { "success": true, "data": { "message": "Data partner attached successfully." } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "examples": { "Non Advertiser user accessing the API": { "description": "Non Advertiser user accessing the API", "value": { "success": false, "errorObjects": [ { "error": "User is not allowed to access this API. Only Advertiser users can access this API." } ] } } } } } }, "422": { "description": "Unprocessable Entity - Request validation failed", "content": { "application/json": { "examples": { "Incorrect audience type for data partner attachment": { "description": "Incorrect audience type for data partner attachment", "value": { "success": false, "errorObjects": [ { "error": "Only Geo-farmed and Contextual audiences support this operation." } ] } }, "Invalid audience status for data partner attachment": { "description": "Invalid audience status for data partner attachment", "value": { "success": false, "errorObjects": [ { "error": "Invalid audience status. Audience status must be 'Data Fetched' to attach a data partner." } ] } }, "Insufficient data partner reach for attachment": { "description": "Insufficient data partner reach for attachment", "value": { "success": false, "errorObjects": [ { "error": "Data partner reach is below the minimum required threshold." } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/audience/abm": { "post": { "tags": [ "Audience API" ], "summary": "This method creates ABM audience.", "description": "This method creates an ABM Audience with mapping of health care data ", "operationId": "createAbmAudience", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "content": { "application/json": { "schema": { "required": [ "audienceName" ], "type": "object", "properties": { "audienceName": { "maxLength": 255, "minLength": 0, "type": "string" }, "healthCareDataMappingIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "filters": { "type": "object", "properties": { "sortCriteriaMap": { "type": "object", "additionalProperties": { "type": "string" } }, "selectAll": { "type": "boolean" }, "ids": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "dataProviderIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "healthCareSystemIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "accountIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int64" } }, "accountTypeIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "accountSubTypeIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "titleIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "specialityIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "countryIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "stateIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "cityIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "pageNo": { "type": "integer", "format": "int32" }, "noOfEntries": { "type": "integer", "format": "int32" }, "sortBy": { "type": "string" }, "searchField": { "type": "string" }, "order": { "type": "string", "enum": [ "SortOrderEnum[id=1, name='asc', symbol='+']", "SortOrderEnum[id=2, name='desc', symbol='-']" ] } } }, "dataProviderId": { "type": "integer", "format": "int32" } } }, "example": { "audienceName": "HealthCare Innovators", "healthCareDataMappingIds": [1, 2, 3], "dataProviderId": 1, "filters": { "selectAll": false, "healthCareSystemIds": [40100004, 40100007], "accountIds": [40208104, 40628423], "accountTypeIds": [40300003], "accountSubTypeIds": [40400001, 40400010], "countryIds": [30100001], "stateIds": [30200028, 30200043], "cityIds": [30430356, 30447825, 30447952, 30448122], "titleIds": [40500099], "specialityIds": [40500014, 40500086] } } } }, "required": true }, "responses": { "200": { "description": "Successful Creation of ABM Audience", "content": { "application/json": { "examples": { "Response containing message": { "description": "Response containing message", "value": { "success": true, "data": { "audienceId": 1026631, "message": "HealthCare Innovators audience created successfully" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "examples": { "Non Advertiser user accessing the API": { "description": "Non Advertiser user accessing the API", "value": { "success": false, "errorObjects": [ { "error": "User is not allowed to access this API. Only Advertiser users can access this API." } ] } } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "examples": { "Invalid Data Provider IDs": { "description": "Invalid Data Provider IDs", "value": { "success": false, "errorObjects": [ { "error": "Invalid data provider ID/s given. Please pass valid data provider ID/s." } ] } }, "Invalid Mapping": { "description": "Invalid Mapping", "value": { "success": false, "errorObjects": [ { "error": "Invalid request as health care mapping Ids are not matching." } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/audience/abm/healthcare-data/statistics": { "post": { "tags": [ "Audience API" ], "summary": "This API fetches statistics based on the filters passed", "description": "This API fetches different statistics like number of health care systems, accounts, account-types, specialities and total npi reach based on the filters passed \n\n**Request Body Details:**\n\n| **Field** | **Type** | **Description** |\n| --- | --- | --- |\n| selectAll `[optional]` | Boolean | Flag to indicate whether to select all records or apply filters. Default is true. |\n| dataProviderIds `[required]` | List of Integer | The list includes data provider IDs such as HealthLink, etc. to filter data. |\n| healthcareSystemIds `[optional]` | List of Integer | The list includes healthcare system IDs to filter data. |\n| accountIds `[optional]` | List of Integer | The list includes account IDs to filter data. |\n| accountTypeIds `[optional]` | List of Integer | The list includes account type IDs to filter data. |\n| accountSubTypeIds `[optional]` | List of Integer | The list includes account sub type IDs to filter data. |\n| countryIds `[optional]` | List of Integer | The list includes country IDs to filter data. |\n| stateIds `[optional]` | List of Integer | The list includes state IDs to filter data. |\n| cityIds `[optional]` | List of Integer | The list includes city IDs to filter data. |\n| titleIds `[optional]` | List of Integer | The list includes title IDs to filter data. |\n| specialtyIds `[optional]` | List of Integer | The list includes specialty IDs to filter data. |\n| ids `[optional]` | Array of Integer | The list includes health care data mapping Ids to filter data. |\n", "operationId": "getHealthcareDataStatistics", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "sortCriteriaMap": { "type": "object", "additionalProperties": { "type": "string" } }, "selectAll": { "type": "boolean" }, "ids": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "dataProviderIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "healthCareSystemIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "accountIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int64" } }, "accountTypeIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "accountSubTypeIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "titleIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "specialityIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "countryIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "stateIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "cityIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "pageNo": { "type": "integer", "format": "int32" }, "noOfEntries": { "type": "integer", "format": "int32" }, "sortBy": { "type": "string" }, "searchField": { "type": "string" }, "order": { "type": "string", "enum": [ "SortOrderEnum[id=1, name='asc', symbol='+']", "SortOrderEnum[id=2, name='desc', symbol='-']" ] } } }, "examples": { "Request Body containing all the filters": { "description": "Request Body containing all the filters", "value": { "selectAll": true, "dataProviderIds": [1], "healthCareSystemIds": [40100004, 40100007], "accountIds": [40208104, 40628423], "accountTypeIds": [40300003], "accountSubTypeIds": [40400001, 40400010], "countryIds": [30100001], "stateIds": [30200028, 30200043], "cityIds": [30430356, 30447825, 30447952, 30448122], "titleIds": [40500099], "specialityIds": [40500014, 40500086], "ids": [1, 2, 3], "pageNo": 1, "noOfEntries": 2 } } } } }, "required": true }, "responses": { "200": { "description": "Successful retrieval of ABM Audience statistics", "content": { "application/json": { "examples": { "Response containing statistics of an ABM Audience": { "description": "Response containing statistics of an ABM Audience", "value": { "success": true, "data": { "healthSystem": 2, "account": 4, "accountType": 8, "npiReach": 25513, "speciality": 3 } } } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "examples": { "Invalid Data Provider IDs": { "description": "Invalid Data Provider IDs", "value": { "success": false, "errorObjects": [ { "error": "Invalid data provider ID/s given. Please pass valid data provider ID/s." } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/audience/abm/healthcare-data/list": { "post": { "tags": [ "Audience API" ], "summary": "List of health care data based on filters passed", "description": "This API fetches the healthcare data list, filtered record count, and total record count based on the provided filters.\n\n**Request Body Details:**\n\n| **Field** | **Type** | **Description** |\n| --- | --- | --- |\n| pageNo `[optional]` | Number | Page number for the required data. The default value is 1. Setting the page number to -1 will disable pagination and return all data in a single page. |\n| noOfEntries `[optional]` | Number | The maximum number of returned results per page. The default value is 50. |\n| selectAll `[optional]` | Boolean | Flag to indicate whether to select all records or apply filters. Default is true. |\n| dataProviderIds `[required]` | List of Integer | The list includes data provider IDs such as HealthLink, etc. to filter data. |\n| healthcareSystemIds `[optional]` | List of Integer | The list includes healthcare system IDs to filter data. |\n| accountIds `[optional]` | List of Integer | The list includes account IDs to filter data. |\n| accountTypeIds `[optional]` | List of Integer | The list includes account type IDs to filter data. |\n| accountSubTypeIds `[optional]` | List of Integer | The list includes account sub type IDs to filter data. |\n| countryIds `[optional]` | List of Integer | The list includes country IDs to filter data. |\n| stateIds `[optional]` | List of Integer | The list includes state IDs to filter data. |\n| cityIds `[optional]` | List of Integer | The list includes city IDs to filter data. |\n| titleIds `[optional]` | List of Integer | The list includes title IDs to filter data. |\n| specialtyIds `[optional]` | List of Integer | The list includes specialty IDs to filter data. |\n| ids `[optional]` | Array of Integer | The list includes health care data mapping Ids to filter data. |\n", "operationId": "getHealthcareData", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "sortCriteriaMap": { "type": "object", "additionalProperties": { "type": "string" } }, "selectAll": { "type": "boolean" }, "ids": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "dataProviderIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "healthCareSystemIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "accountIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int64" } }, "accountTypeIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "accountSubTypeIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "titleIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "specialityIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "countryIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "stateIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "cityIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "pageNo": { "type": "integer", "format": "int32" }, "noOfEntries": { "type": "integer", "format": "int32" }, "sortBy": { "type": "string" }, "searchField": { "type": "string" }, "order": { "type": "string", "enum": [ "SortOrderEnum[id=1, name='asc', symbol='+']", "SortOrderEnum[id=2, name='desc', symbol='-']" ] } } }, "examples": { "Request Body containing all the filters": { "description": "Request Body containing all the filters", "value": { "selectAll": true, "dataProviderIds": [1], "healthCareSystemIds": [40100004, 40100007], "accountIds": [40208104, 40628423], "accountTypeIds": [40300003], "accountSubTypeIds": [40400001, 40400010], "countryIds": [30100001], "stateIds": [30200028, 30200043], "cityIds": [30430356, 30447825, 30447952, 30448122], "titleIds": [40500099], "specialityIds": [40500014, 40500086], "ids": [1, 2, 3], "pageNo": 1, "noOfEntries": 2 } } } } }, "required": true }, "responses": { "200": { "description": "Successful information retrieval", "content": { "application/json": { "examples": { "HealthCare Data having all the values": { "description": "HealthCare Data having all the values", "value": { "success": true, "data": { "totalRecords": 52265, "filteredRecords": 5, "healthCareData": [ { "id": 1, "cost": 10, "reach": 1, "healthCareSystemId": 40100004, "healthCareSystemName": "ABCD PEDIATRICS", "accountId": 40628423, "accountName": "Stepping Stone Pediatrics PA", "accountTypeId": 40300003, "accountTypeName": "Group Practice", "accountSubTypeId": 40400010, "accountSubTypeName": "Telephone/E-Mail Order Pharmacy", "titleId": 40500099, "titleName": "MD", "specialityId": 40500086, "specialityName": "Gastroenterology", "countryId": 30100001, "countryName": "United States", "stateId": 30200043, "stateName": "Tennessee", "cityId": 30447952, "cityName": "Franklin, TN", "dataProviderId": 1, "dataProviderName": "HealthCarelink" }, { "id": 2, "cost": 10, "reach": 1, "healthCareSystemId": 40100004, "healthCareSystemName": "ABCD PEDIATRICS", "accountId": 40628423, "accountName": "Stepping Stone Pediatrics PA", "accountTypeId": 40300003, "accountTypeName": "Group Practice", "accountSubTypeId": 40400010, "accountSubTypeName": "Telephone/E-Mail Order Pharmacy", "titleId": 40500099, "titleName": "MD", "specialityId": 40500086, "specialityName": "Gastroenterology", "countryId": 30100001, "countryName": "United States", "stateId": 30200043, "stateName": "Tennessee", "cityId": 30447825, "cityName": "Brentwood, TN", "dataProviderId": 1, "dataProviderName": "HealthCarelink" } ] } } } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "examples": { "Invalid Data Provider IDs": { "description": "Invalid Data Provider IDs", "value": { "success": false, "errorObjects": [ { "error": "Invalid data provider ID/s given. Please pass valid data provider ID/s." } ] } }, "Invalid Page Number": { "description": "Invalid Page Number", "value": { "success": false, "errorObjects": [ { "error": "Invalid page number. Page number must be -1 or greater than 0." } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/audience/abm/healthcare-data/filter-file": { "post": { "tags": [ "Audience API" ], "summary": "The API extracts ABM filters from the uploaded file.", "description": "This API provides the ABM audiences Health Care Data filters on the provided file and columns by fetching the data from the uploaded file.", "operationId": "getHealthcareDataFiltersFromFile", "parameters": [ { "name": "fileType", "in": "query", "description": "Type of the file being uploaded. 1 for CSV, 2 for Excel.", "required": true, "schema": { "type": "integer", "enum": [ "1", "2" ] } }, { "name": "columns", "in": "query", "description": "Serialised mapping of the header of the file with the column IDs to search the data from the filters", "required": true, "schema": { "type": "string" }, "example": { "Title-name": 26, "Account-type-name": 24, "Account-Sub-Type-Name": 25, "Health-System-Name": 22, "Account-Name": 23, "Speciality-Name": 27, "City-Name": 11, "State-Name": 8 } }, { "name": "abmFilterFile", "in": "query", "description": "The file containing the ABM audience data to be filtered.", "required": true }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "content": { "application/json": { "schema": { "required": [ "abmFilterFile" ], "type": "object", "properties": { "abmFilterFile": { "type": "string", "format": "binary" } } } } } }, "responses": { "200": { "description": "Successful retrieval of ABM audience data based on the provided file and columns.", "content": { "application/json": { "examples": { "Response containing filtered ABM audience data": { "description": "Response containing filtered ABM audience data", "value": "{\n \"success\": true,\n \"data\": {\n {\n \"success\": true,\n \"data\":\n {\n \"healthCareFilterData\":\n {\n \"healthcareSystemIds\":[1,2,3],\n \"healthcareAccountIds\":[1,2,3],\n \"accountTypeIds\":[1,2,3],\n \"accountSubTypeIds\":[1,2,3],\n \"titleIds\":[1,2,3],\n \"specialityIds\":[1,2,3],\n \"stateIds\":[1,2,3],\n \"cityIds\":[1,2,3]\n },\n \"matchingRate\": 95\n }\n }\n }\n}\n" } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "examples": { "Invalid Data Provider IDs": { "description": "Invalid Data Provider IDs", "value": { "success": false, "errorObjects": [ { "error": "Invalid System column provided." } ] } }, "Invalid Page Number": { "description": "Invalid Page Number", "value": { "success": false, "errorObjects": [ { "error": "This file does not contain any information." } ] } }, "Invalid File Type": { "description": "Invalid File Type", "value": { "success": false, "errorObjects": [ { "error": "Invalid file type." } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/audience/abm/healthcare-data/account-types": { "post": { "tags": [ "Audience API" ], "summary": "Retrieves a list of account types based on the provided filters.", "description": "This API fetches the account type list, filtered record count, and total record count based on the provided filters.\n\n**Request Body Details:**\n\n| **Field** | **Type** | **Description** |\n| --- | --- | --- |\n| pageNo `[optional]` | Number | Page number for the required data. The default value is 1. Setting the page number to -1 will disable pagination and return all data in a single page. |\n| noOfEntries `[optional]` | Number | The maximum number of returned results per page. The default value is 50. |\n| searchField `[optional]` | String | Search the result by provided keyword in the searchField. |\n| dataProviderIds `[required]` | List of Integer | The list includes data provider IDs such as HealthLink, etc. to filter data. |\n| healthcareSystemIds `[optional]` | List of Integer | The list includes healthcare system IDs to filter data. |\n| accountIds `[optional]` | List of Integer | The list includes account IDs to filter data. |\n| accountTypeIds `[optional]` | List of Integer | The list includes account type IDs to filter data. |\n", "operationId": "getAccountTypeList", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "sortCriteriaMap": { "type": "object", "additionalProperties": { "type": "string" } }, "dataProviderIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "healthcareSystemIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "accountIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int64" } }, "accountTypeIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "accountSubTypeIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "specialityIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "titleIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "audienceTypeId": { "type": "integer", "format": "int32" }, "pageNo": { "type": "integer", "format": "int32" }, "noOfEntries": { "type": "integer", "format": "int32" }, "sortBy": { "type": "string" }, "searchField": { "type": "string" }, "order": { "type": "string", "enum": [ "SortOrderEnum[id=1, name='asc', symbol='+']", "SortOrderEnum[id=2, name='desc', symbol='-']" ] } } }, "example": { "pageNo": 1, "noOfEntries": 20, "searchField": "Sample text", "dataProviderIds": [1], "healthcareSystemIds": [1, 2, 3], "accountIds": [4, 5, 6], "accountTypeIds": [7, 8, 9] } } }, "required": true }, "responses": { "200": { "description": "Successful information retrieval", "content": { "application/json": { "example": { "success": true, "data": { "accountTypeList": [ { "id": 1, "displayName": "Account Type 1", "displayOrder": 1, "reach": 12345 }, { "id": 2, "displayName": "Account Type 2", "displayOrder": 20, "reach": 54321 } ], "filteredRecords": 5, "totalRecords": 3294 } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "examples": { "Invalid Data Provider IDs": { "description": "Invalid Data Provider IDs", "value": { "success": false, "errorObjects": [ { "error": "Invalid data provider ID/s given. Please pass valid data provider ID/s." } ] } }, "Invalid Page Number": { "description": "Invalid Page Number", "value": { "success": false, "errorObjects": [ { "error": "Invalid page number. Page number must be -1 or greater than 0." } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/audience/abm/healthcare-data/account-subtypes": { "post": { "tags": [ "Audience API" ], "summary": "Retrieves a list of account subtypes based on the provided filters.", "description": "This API fetches the account subtype list, filtered record count, and total record count based on the provided filters.\n\n**Request Body Details:**\n\n| **Field** | **Type** | **Description** |\n| --- | --- | --- |\n| pageNo `[optional]` | Number | Page number for the required data. The default value is 1. Setting the page number to -1 will disable pagination and return all data in a single page. |\n| noOfEntries `[optional]` | Number | The maximum number of returned results per page. The default value is 50. |\n| searchField `[optional]` | String | Search the result by provided keyword in the searchField. |\n| dataProviderIds `[required]` | List of Integer | The list includes data provider IDs such as HealthLink, etc. to filter data. |\n| healthcareSystemIds `[optional]` | List of Integer | The list includes healthcare system IDs to filter data. |\n| accountIds `[optional]` | List of Integer | The list includes account IDs to filter data. |\n| accountTypeIds `[optional]` | List of Integer | The list includes account type IDs to filter data. |\n| accountSubTypeIds `[optional]` | List of Integer | The list includes account sub type IDs to filter data. |\n", "operationId": "getAccountSubTypeList", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "sortCriteriaMap": { "type": "object", "additionalProperties": { "type": "string" } }, "dataProviderIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "healthcareSystemIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "accountIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int64" } }, "accountTypeIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "accountSubTypeIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "specialityIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "titleIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "audienceTypeId": { "type": "integer", "format": "int32" }, "pageNo": { "type": "integer", "format": "int32" }, "noOfEntries": { "type": "integer", "format": "int32" }, "sortBy": { "type": "string" }, "searchField": { "type": "string" }, "order": { "type": "string", "enum": [ "SortOrderEnum[id=1, name='asc', symbol='+']", "SortOrderEnum[id=2, name='desc', symbol='-']" ] } } }, "example": { "pageNo": 1, "noOfEntries": 20, "searchField": "Sample text", "dataProviderIds": [1], "healthcareSystemIds": [1, 2, 3], "accountIds": [4, 5, 6], "accountTypeIds": [7, 8, 9], "accountSubTypeIds": [10, 11, 12] } } }, "required": true }, "responses": { "200": { "description": "Successful information retrieval", "content": { "application/json": { "example": { "success": true, "data": { "accountSubTypeList": [ { "id": 1, "displayName": "Account Subtype 1", "displayOrder": 1 }, { "id": 2, "displayName": "Account Subtype 2", "displayOrder": 2 } ], "filteredRecords": 5, "totalRecords": 3294 } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "examples": { "Invalid Data Provider IDs": { "description": "Invalid Data Provider IDs", "value": { "success": false, "errorObjects": [ { "error": "Invalid data provider ID/s given. Please pass valid data provider ID/s." } ] } }, "Invalid Page Number": { "description": "Invalid Page Number", "value": { "success": false, "errorObjects": [ { "error": "Invalid page number. Page number must be -1 or greater than 0." } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/audience/abm/healthcare-data/account-names": { "post": { "tags": [ "Audience API" ], "summary": "Retrieves a list of account names based on the provided filters.", "description": "This API fetches the account name list, filtered record count, and total record count based on the provided filters.\n\n**Request Body Details:**\n\n| **Field** | **Type** | **Description** |\n| --- | --- | --- |\n| pageNo `[optional]` | Number | Page number for the required data. The default value is 1. Setting the page number to -1 will disable pagination and return all data in a single page. |\n| noOfEntries `[optional]` | Number | The maximum number of returned results per page. The default value is 50. |\n| searchField `[optional]` | String | Search the result by provided keyword in the searchField. |\n| dataProviderIds `[required]` | List of Integer | The list includes data provider IDs such as HealthLink, etc. to filter data. |\n| healthcareSystemIds `[optional]` | List of Integer | The list includes healthcare system IDs to filter data. |\n| accountIds `[optional]` | List of Integer | The list includes account IDs to filter data. |\n", "operationId": "getAccountNameList", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "sortCriteriaMap": { "type": "object", "additionalProperties": { "type": "string" } }, "dataProviderIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "healthcareSystemIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "accountIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int64" } }, "accountTypeIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "accountSubTypeIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "specialityIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "titleIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "audienceTypeId": { "type": "integer", "format": "int32" }, "pageNo": { "type": "integer", "format": "int32" }, "noOfEntries": { "type": "integer", "format": "int32" }, "sortBy": { "type": "string" }, "searchField": { "type": "string" }, "order": { "type": "string", "enum": [ "SortOrderEnum[id=1, name='asc', symbol='+']", "SortOrderEnum[id=2, name='desc', symbol='-']" ] } } }, "example": { "pageNo": 1, "noOfEntries": 20, "searchField": "Sample text", "dataProviderIds": [1], "healthcareSystemIds": [1, 2, 3], "accountIds": [4, 5, 6] } } }, "required": true }, "responses": { "200": { "description": "Successful information retrieval", "content": { "application/json": { "example": { "success": true, "data": { "accountNameList": [ { "id": 1, "displayName": "Account Name 1", "displayOrder": 1, "reach": 12345 }, { "id": 2, "displayName": "Account Name 2", "displayOrder": 20, "reach": 54321 } ], "filteredRecords": 5, "totalRecords": 3294 } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "examples": { "Invalid Data Provider IDs": { "description": "Invalid Data Provider IDs", "value": { "success": false, "errorObjects": [ { "error": "Invalid data provider ID/s given. Please pass valid data provider ID/s." } ] } }, "Invalid Page Number": { "description": "Invalid Page Number", "value": { "success": false, "errorObjects": [ { "error": "Invalid page number. Page number must be -1 or greater than 0." } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/internal/audience/ua/update-partner-details": { "patch": { "tags": [ "Audience API" ], "summary": "To update partner details on organization details update", "description": "This internal API will update partner details on organization profile details update.\n\n**Request Body Details:**\n\n| **Field** | **Type** | **Description** |\n| --- | --- | --- |\n| owId | int | | The owId of the advertiser organization. |\n| organizationName | String | | The organization name to be updated. |\n| logoUrl | String | | The organization logo url to be updated |\n", "operationId": "updatePartnerDetails", "requestBody": { "content": { "application/json": { "schema": { "required": [ "logoUrl", "owId" ], "type": "object", "properties": { "owId": { "type": "integer", "format": "int32" }, "organizationName": { "type": "string" }, "logoUrl": { "type": "string" } } }, "example": { "owId": 123, "organizationName": "Advertiser - 1", "logoUrl": "https://s3.amazonaws.com/sample/path/logo.png" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "success": true, "data": "Partner Details updated successfully." } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "examples": { "Invalid owId for updating details": { "description": "Invalid owId for updating details", "value": { "success": false, "errorObjects": [ { "error": "No partner found with the provided owId" } ] } }, "At least one field is required": { "description": "At least one field is required", "value": { "success": false, "errorObjects": [ { "error": "Both organizationName and logoUrl cannot be null." } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/internal/audience/contextual/{audienceId}": { "get": { "tags": [ "Audience API" ], "summary": "Get contextual Audience backend values", "description": "This API will fetch the backend column values of contextual audience based on the given audience id. This id refers to the master audience id.", "operationId": "getContextualAudienceBackendValues", "parameters": [ { "name": "audienceId", "in": "path", "description": "Audience ID", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Successful response with static data collection method": { "description": "Successful response with static data collection method", "value": { "success": true, "data": { "audienceId": 914547, "keywords": [ "macys near me", "thrift store" ], "urls": [ "www.big-basket.com", "www.amazon.in" ], "dataCollectionMethodId": 1, "startDate": 1724697000000, "endDate": 1724869799000, "frequency": 2, "frequencyType": 2 } } }, "Successful response with dynamic data collection method": { "description": "Successful response with dynamic data collection method", "value": { "success": true, "data": { "audienceId": 1137961, "keywords": [ "Test", "dynamic" ], "urls": [ "http://test.com", "http://iqm.com" ], "dataCollectionMethodId": 2, "dataCollectionDays": 12, "frequency": 2, "frequencyType": 1 } } } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "examples": { "Invalid Audience Id": { "description": "Invalid Audience Id", "value": { "success": false, "errorObjects": [ { "error": "No active audience found with the given Id.", "field": "audienceId" } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } }, "patch": { "tags": [ "Audience API" ], "summary": "It will add or update contextual audience backend column values.", "description": "This API will add or update contextual audience backend column values based on the given audience id.\nThis id refers to the master audience id.\nIf replaceValues is true, it will replace the existing keywords and urls with the new values\nprovided in the request. If replaceValues is false or not provided, it will append the new values\nto the existing keywords and urls.\nFor other fields like frequency, frequencyType, startDate, endDate and dataCollectionDays,\nit will update the values if provided in the request.\n", "operationId": "updateContextualAudienceBackendValues", "parameters": [ { "name": "audienceId", "in": "path", "description": "Contextual Audience Id", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "keywords": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "urls": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "frequency": { "type": "integer", "format": "int32" }, "frequencyType": { "type": "integer", "format": "int32" }, "startDate": { "type": "integer", "format": "int64" }, "endDate": { "type": "integer", "format": "int64" }, "dataCollectionDays": { "type": "integer", "format": "int32" }, "replaceValues": { "type": "boolean" } } }, "examples": { "Append values for static data collection method": { "description": "Append values for static data collection method", "value": { "keywords": [ "Test" ], "urls": [ "http://iqm.com" ], "frequency": 10, "frequencyType": 2, "startDate": 1751342400000, "endDate": 1753934399000 } }, "Append values for dynamic data collection method": { "description": "Append values for dynamic data collection method", "value": { "keywords": [ "Test" ], "urls": [ "http://iqm.com" ], "frequency": 10, "frequencyType": 2, "dataCollectionDays": 20 } }, "Replace values - Replaces existing keywords and urls with new values": { "description": "Replace values - Replaces existing keywords and urls with new values", "value": { "keywords": [ "Test" ], "urls": [ "http://iqm.com" ], "frequency": 10, "frequencyType": 2, "dataCollectionDays": 20, "replaceValues": true } }, "Empty values - Used to clear any field and set null": { "description": "Empty values - Used to clear any field and set null", "value": { "keywords": null, "urls": null, "frequency": null, "frequencyType": null, "dataCollectionDays": null } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Success Response": { "description": "Success Response", "value": { "success": true, "data": { "audienceId": 1141504, "message": "Changes saved successfully" } } } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "examples": { "When empty request body is sent": { "description": "When empty request body is sent", "value": { "success": false, "errorObjects": [ { "error": "Please provide at least one valid field for update operation" } ] } }, "When frequency and frequencyType are not provided together": { "description": "When frequency and frequencyType are not provided together", "value": { "success": false, "errorObjects": [ { "error": "Provide both the frequency and frequency type together." } ] } }, "When Invalid frequencyType is provided": { "description": "When Invalid frequencyType is provided", "value": { "success": false, "errorObjects": [ { "error": "FrequencyType should be 1 (total), 2 (weekly) or 3 (monthly)", "field": "frequencyType" } ] } }, "When start or end date is passed for dynamic data collection method": { "description": "When start or end date is passed for dynamic data collection method", "value": { "success": false, "errorObjects": [ { "error": "Start date and end date are not allowed for this data collection method" } ] } }, "When dataCollectionDays is passed for static data collection method": { "description": "When dataCollectionDays is passed for static data collection method", "value": { "success": false, "errorObjects": [ { "error": "data collection days are not allowed for this data collection method", "field": "dataCollectionDays" } ] } }, "endDate is there but startDate is missing": { "description": "endDate is there but startDate is missing", "value": { "success": false, "errorObjects": [ { "error": "For endDate, there should be a valid startDate." } ] } }, "startDate is greater than endDate": { "description": "startDate is greater than endDate", "value": { "success": false, "errorObjects": [ { "error": "startDate cannot be greater than endDate." } ] } }, "When endDate provided is not after the existing startDate present in database": { "description": "When endDate provided is not after the existing startDate present in database", "value": { "success": false, "errorObjects": [ { "error": "Provided end date should be after the existing start date.", "field": "endDate" } ] } }, "When startDate provided is not before the existing endDate present in database": { "description": "When startDate provided is not before the existing endDate present in database", "value": { "success": false, "errorObjects": [ { "error": "Provided start date should be before existing end date.", "field": "startDate" } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/audience/{audienceId}/update-name": { "patch": { "tags": [ "Audience API" ], "summary": "Update audience name", "description": "Updates the name of an existing audience. The audience name must be between 1 and 255 characters long. Only the advertiser who created the audience can update the audience.", "operationId": "updateAudienceName", "parameters": [ { "name": "audienceId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "description": "The new name for the audience. Must be between 1 and 255 characters.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } }, "examples": { "Valid audience name": { "description": "Example of a valid audience name update", "value": { "audienceName": "Sample Audience" } }, "Single character name": { "description": "Example of minimum valid audience name length", "value": { "audienceName": "1" } }, "Invalid empty name": { "description": "Example of an invalid audience name that is empty", "value": { "audienceName": " " } }, "Invalid too long name": { "description": "Example of an invalid audience name that exceeds 255 characters", "value": { "audienceName": "This audience name is way too long .............................................................................................................................................................................................................................................................." } } } } }, "required": true }, "responses": { "200": { "description": "Audience name updated successfully", "content": { "application/json": { "examples": { "Successful audience name update": { "description": "Response when audience name is successfully updated", "value": { "success": true, "data": { "message": "Changes saved successfully" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "examples": { "Non Advertiser user accessing the API": { "description": "Non Advertiser user accessing the API", "value": { "success": false, "errorObjects": [ { "error": "User is not allowed to access this API. Only Advertiser users can access this API." } ] } } } } } }, "422": { "description": "Unprocessable Entity - Validation errors", "content": { "application/json": { "examples": { "Audience name size error": { "description": "Error when audience name is empty, null, or exceeds 255 characters", "value": { "success": false, "errorObjects": [ { "error": "Audience name must be between 1 and 255 characters." } ] } }, "Audience not found or not accessible": { "description": "Error when audience ID does not exist or user doesn't have access to it", "value": { "success": false, "errorObjects": [ { "error": "No active audience found with the provided ID or the audience is not accessible" } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/audience/{audienceId}/regenerate": { "patch": { "tags": [ "Audience API" ], "summary": "This API regenerates a failed audience", "description": "This API lets the user regenerate a failed audience based on the provided audience ID.", "operationId": "regenerateAudience", "parameters": [ { "name": "audienceId", "in": "path", "description": "The ID of the audience to regenerate", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Successful regeneration of audience": { "description": "Successful regeneration of audience", "value": { "success": true, "data": { "message": "Audience regenerated successfully." } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "examples": { "Non Advertiser user accessing the API": { "description": "Non Advertiser user accessing the API", "value": { "success": false, "errorObjects": [ { "error": "User is not allowed to access this API. Only Advertiser users can access this API." } ] } } } } } }, "422": { "description": "Unprocessable Entity - Request validation failed", "content": { "application/json": { "examples": { "Incorrect audience type for audience regeneration": { "description": "Incorrect audience type for audience regeneration", "value": { "success": false, "errorObjects": [ { "error": "Only Geo-farmed and Contextual audiences support this operation." } ] } }, "Invalid audience status for audience regeneration": { "description": "Invalid audience status for audience regeneration", "value": { "success": false, "errorObjects": [ { "error": "Invalid audience status. Audience status must be 'Failed'." } ] } }, "Maximum regeneration attempts reached": { "description": "Maximum regeneration attempts reached", "value": { "success": false, "errorObjects": [ { "error": "You have reached the maximum limit for audience regeneration attempts." } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/audience/retargeted/{audienceId}": { "patch": { "tags": [ "Audience API" ], "summary": "Updates existing Retargeted audience", "description": "Updates an existing Retargeted audience with the provided audience details in the request.\n \n**Request Body Details:**\n\n| **Field** | **Type** | **Description** |\n| --- | --- | --- |\n| audienceName `[required]` | String | Name of the retargeted audience |\n| dataCollectionBy `[required]` | String | Valid data collection method either 'month' or 'date_range' |\n| dataCollectionPeriod `[optional]`| Integer | Represents number of months for data collection period |\n| startDate `[optional]` | Integer | Represents start date in epoch millis for data collection |\n| endDate `[optional]` | Integer | Represents end date in epoch millis for data collection |\n", "operationId": "updateRetargetedAudience", "parameters": [ { "name": "audienceId", "in": "path", "description": "master audience id of the retargeted audience to be updated.", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "audienceName": { "maxLength": 255, "minLength": 0, "type": "string" }, "dataCollectionBy": { "type": "string" }, "startDate": { "type": "integer", "format": "int64" }, "endDate": { "type": "integer", "format": "int64" }, "dataCollectionPeriod": { "maximum": 12, "type": "integer", "format": "int32" } } }, "examples": { "Request body for audience update with 'month' monde": { "description": "Request body for audience update with 'month' monde", "value": { "audienceName": "Test audience by month", "dataCollectionBy": "month", "dataCollectionPeriod": 1 } }, "Request body for audience update with 'date_range' mode": { "description": "Request body for audience update with 'date_range' mode", "value": { "audienceName": "Test audience by date_range", "dataCollectionBy": "date_range", "startDate": 1753262493020, "endDate": 1753900200000 } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Successful update of Retargeted Audience": { "description": "Successful update of Retargeted Audience", "value": { "success": true, "data": { "tag_script": "\u003Cscript src='https://pxl.stage.iqm.com/c/34248612-0744-4a92-8ba9-8a05b10a424b' async\u003E\u003C/script\u003E", "message": "Changes saved successfully" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "examples": { "Non Advertiser user accessing the API": { "description": "Non Advertiser user accessing the API", "value": { "success": false, "errorObjects": [ { "error": "User is not allowed to access this API. Only Advertiser users can access this API." } ] } } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "examples": { "When startDate is sent for 'month' mode": { "description": "When startDate is sent for 'month' mode", "value": { "success": false, "errorObjects": [ { "error": "Start date and End date should not be specified for data collection by 'month' mode.", "field": "startDate, endDate" } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/audience/prebid/{audienceId}": { "get": { "tags": [ "Audience API" ], "summary": "It will retrieve the prebid audience details.", "description": "This API will fetch the details of prebid audience based on the given prebid audience id. This id refers to the master audience id.", "operationId": "getPrebidAudienceDetails", "parameters": [ { "name": "audienceId", "in": "path", "description": "master audience id of the prebid audience to be fetched.", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Successful information retrieval": { "description": "Successful information retrieval", "value": { "success": true, "data": { "audienceId": 1139208, "audienceName": "test", "cpm": 0.325, "owId": 201427, "createdByUowId": 9480, "createdAt": 1750866960, "prebidSegmentDetails": [ { "prebidSegmentId": 247, "prebidSegmentName": "Impressions with Insufficient IAB Viewability Data", "description": "Impressions where DV does not have sufficient viewability performance statistics for the URL or URL can not be targeted (e.g., blinded).", "parentPathKey": "Viewability \u003E Video", "prebidRootId": 159, "cpm": 0.2, "creativeTypeIds": [14, 15], "leaf": false, "providerId": 2, "providerLogoUrl": "https://d2v0lj9tfbnmhu.cloudfront.net/assets/dist/audience/prebid-providers/DV-logo.svg" }, { "prebidSegmentId": 248, "prebidSegmentName": "80% or Higher Viewability Rate", "description": "For video, this is a rate-based segment used to target the URLs that have historically achieved a 80% or higher viewability rate based on the IAB standard.", "parentPathKey": "Viewability \u003E Video", "prebidRootId": 159, "cpm": 0.2, "creativeTypeIds": [14, 15], "leaf": false, "providerId": 2, "providerLogoUrl": "https://d2v0lj9tfbnmhu.cloudfront.net/assets/dist/audience/prebid-providers/DV-logo.svg" } ] } } } } } } }, "403": { "description": "Forbidden Exception", "content": { "application/json": { "examples": { "Audience Not Accessible": { "description": "Audience Not Accessible", "value": { "success": false, "errorObjects": [ { "error": "Audience is not accessible for the given user." } ] } } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "examples": { "Invalid Audience Id": { "description": "Invalid Audience Id", "value": { "success": false, "errorObjects": [ { "error": "No active audience found with the given Id.", "field": "audienceId" } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } }, "patch": { "tags": [ "Audience API" ], "summary": "Update existing Prebid audience", "description": "This API will update the details of prebid audience including its name, segments and provider id.\n\n**Request Body Details:**\n\n| **Field** | **Type** | **Description** |\n| --- | --- | --- |\n| audienceName | String | Name of the prebid audience to be updated |\n| prebidSegmentIds | List of Integer | List of valid and accessible prebid segment IDs. |\n| prebidProviderId | Integer | Id of prebid segments provider |\n", "operationId": "updatePrebidAudience", "parameters": [ { "name": "audienceId", "in": "path", "description": "master audience id of the prebid audience to be updated.", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "content": { "application/json": { "schema": { "required": [ "audienceName", "prebidProviderId", "prebidSegmentIds" ], "type": "object", "properties": { "audienceName": { "maxLength": 255, "minLength": 0, "type": "string" }, "prebidSegmentIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "prebidProviderId": { "minimum": 1, "type": "integer", "format": "int32" } } }, "example": { "audienceName": "Test 2", "prebidSegmentIds": [163, 164], "prebidProviderId": 2 } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Prebid Audience updated successfully": { "description": "Prebid Audience updated successfully", "value": { "success": true, "data": { "audienceId": 1140257, "message": "Changes saved successfully" } } } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "examples": { "Invalid prebid Audience Id": { "description": "Invalid prebid Audience Id", "value": { "success": false, "errorObjects": [ { "error": "Invalid prebid Audience Id" } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/audience/matched/{audienceId}": { "get": { "tags": [ "Audience API" ], "summary": "Get matched audience details.", "description": "This API returns details of the matched audience. It also supports returning campaign targeting details\n(whitelisted and blacklisted campaign IDs) based on the `campaignTargetingRequired` query parameter.\n1. If `campaignTargetingRequired` is true, the response will include campaign targeting details.\n2. If `campaignTargetingRequired` is false or not provided, campaign targeting details will be omitted from the response.\n3. This allows clients to optimize data transfer by only requesting campaign targeting information when needed.\n", "operationId": "getMatchedAudienceById", "parameters": [ { "name": "audienceId", "in": "path", "description": "Audience id of the audience to be fetched.", "required": true, "schema": { "type": "integer", "format": "int32" }, "example": 1234 }, { "name": "campaignTargetingRequired", "in": "query", "description": "Flag to indicate whether campaign whitelist/blacklist ids are required in response or not.", "required": false, "schema": { "type": "boolean", "default": false }, "example": false }, { "name": "userDetailsRequired", "in": "query", "description": "Flag to indicate whether user details like approvedBy, rejectedBy are required in response or not.", "required": false, "schema": { "type": "boolean", "default": false }, "example": false }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Get Matched Audience by Id - with both flags false": { "description": "Get Matched Audience by Id - with both flags false", "value": { "success": true, "data": { "audienceId": 1143824, "audienceName": "Download - Impression _NPI Nurse_iqvia_Filtered", "audienceSubtypeId": 4, "audienceStatusId": 3, "cpm": 25, "owId": 20489, "createdByUowId": 0, "createdAt": 1762502664000, "reach": 242, "s3FileName": "17_iltered9644451186956185605.csv", "s3Url": "s3://test-Client=204389/Audience=1143824/1762502664252_3524Download___Impression__NPI_Nurse_iqvia_Filtered9644451186956185605.csv", "fileRowCount": 1829, "matchRate": 13.23, "dataPartnerId": 5, "modifiedAt": "2025-11-07T02:42:33.000+00:00", "approvalAccess": false, "editAccess": true } } }, "Get Matched Audience by Id - With both flags true": { "description": "Get Matched Audience by Id - With both flags true", "value": { "success": true, "data": { "audienceId": 1143824, "audienceName": "Download - Impression _NPI Nurse_iqvia_Filtered", "audienceSubtypeId": 4, "audienceStatusId": 3, "cpm": 25, "owId": 20489, "createdByUowId": 0, "createdAt": 1762502664000, "reach": 242, "s3FileName": "17_ssion__NPI_Nurse_iqvia_Filtered9644451186956185605.csv", "s3Url": "s3://test/UPLOAD/NPI_NURSE/Client=204389/Audience=1143824/1762502664252_3524Download___Impression__NPI_Nurse_iqvia_Filtered9644451186956185605.csv", "fileRowCount": 1829, "matchRate": 13.23, "dataPartnerId": 5, "modifiedAt": "2025-11-07T02:42:33.000+00:00", "organizationName": "IQM Zydus Healthcare", "approvedOrRejectedByUserName": "Harsh Modi", "approvalAccess": false, "editAccess": true, "whitelistedCampaignIds": [573312, 573313], "blacklistedCampaignIds": [57332, 53313] } } } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "examples": { "when Invalid/Inaccessible audience id is passed": { "description": "when Invalid/Inaccessible audience id is passed", "value": { "success": false, "errorObjects": [ { "error": "No active audience found with the given Id.", "field": "audienceId" } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } }, "patch": { "tags": [ "Audience API" ], "summary": "Update audience details", "description": "This API is used to update the details of an existing audience.\nThis includes approving/rejecting the audience hence changing its status,\nas well as updating other audience attributes like data cost.\n", "operationId": "updateMatchedAudience", "parameters": [ { "name": "audienceId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "description": "The details to update for the audience.", "content": { "application/json": { "schema": { "type": "object", "properties": { "dataCost": { "type": "number", "format": "double" }, "audienceStatusId": { "type": "integer", "format": "int32" }, "rejectionReason": { "type": "string" } } }, "examples": { "Valid update request": { "description": "Example of a valid audience update request", "value": { "dataCost": 10, "audienceStatusId": 4, "rejectionReason": "Insufficient data quality." } } } } }, "required": true }, "responses": { "200": { "description": "Audience details updated successfully", "content": { "application/json": { "examples": { "Successful audience update": { "description": "Response when audience details are successfully updated", "value": { "success": true, "data": { "message": "Changes saved successfully" } } } } } } }, "422": { "description": "Unprocessable Entity - Validation errors", "content": { "application/json": { "examples": { "Audience not found or not accessible": { "description": "Invalid audience ID provided", "value": { "success": false, "errorObjects": [ { "error": "Invalid Audience Id/s provided." } ] } }, "Only matched audiences can be edited": { "description": "Only matched audiences can be edited", "value": { "success": false, "errorObjects": [ { "error": "Only matched audiences can be edited." } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/internal/audience/segmented/vertical/audience-segments": { "get": { "tags": [ "Audience API" ], "summary": "Fetches audience and segment partner IDs based on provided owIds and verticalId.", "description": "This API retrieves audience and segment partner IDs for the specified organization workspace IDs (owIds) and vertical ID.", "operationId": "getAudienceAndSegmentData", "parameters": [ { "name": "owIds", "in": "query", "description": "Set of Organization Workspace mapping IDs representing the organizations for which the data is to be fetched.", "required": true, "schema": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "example": "12345,67890" }, { "name": "verticalId", "in": "query", "description": "The vertical ID for which the audience and segment partner data is to be fetched.", "required": true, "schema": { "type": "integer", "format": "int32" }, "example": 1 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Successful retrieval of audience and segment partner data": { "description": "Successful retrieval of audience and segment partner data", "value": { "success": true, "data": [ { "owId": 12345, "partnerIds": [1, 6, 16], "audienceIds": [123456, 234567, 345678] } ] } } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "examples": { "Invalid verticalId": { "description": "Invalid verticalId", "value": { "success": false, "errorObjects": [ { "error": "Invalid vertical ID provided." } ] } }, "OW IDs not present in the input": { "description": "OW IDs not present in the input", "value": { "success": false, "errorObjects": [ { "error": "OW IDs cannot be null/empty." } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/internal/audience/insights/list": { "get": { "tags": [ "Audience API" ], "summary": "It will provide list of eligible audience which has 10k uniques(minimum) and type should be matched audience with approved status.", "description": "This API will provide list of eligible audience which has 10k uniques(minimum) and type should be matched audience with approved status.\n#### Response body Detail\n| **Field** | **Type** | **Description** |\n| --- | --- | --- |\n| id | int | **Id** of audience.|\n| audienceName | String | Name of the audience.|\n| matchRate | double | match rate of audience.|\n| uniques | int | uniques of audience.|\n| insightsStatus | int | Status of the insights for audience (it should be ready, processing or failed).|\n", "operationId": "getMatchedAudienceListForInsights", "parameters": [ { "name": "searchField", "in": "query", "description": "Search the result by provided keyword in the searchField. Search audience by audience name and id.", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "pageSize", "in": "query", "description": "The maximum number of returned results per page. ", "required": false, "schema": { "type": "integer", "format": "int32", "default": 20 } }, { "name": "pageNo", "in": "query", "description": "Page number for the required data. ", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "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(name of audience), matchRate, uniques", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "owId", "in": "query", "description": "Organization workspace id associated with the insights.", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "excludeInsightsAudienceIds", "in": "query", "description": "Comma separated insights audience ids which need to be excluded from the response.", "required": false, "schema": { "type": "string" } }, { "name": "includeInsightsAudienceIds", "in": "query", "description": "Comma separated insights audience ids which need to be included in the response.", "required": false, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "success": true, "data": { "totalRecords": 5, "filteredRecords": 1, "insightsData": [ { "id": 1234, "audienceName": "Audience 1", "matchRate": 82.78, "uniques": 12345, "insightsStatus": 3 } ] } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Invalid sortBy value." } ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/audience/{audienceId}/insights": { "get": { "tags": [ "Audience API" ], "summary": "This API is used to get the insights of audience.", "description": "This API fetches the insights of an audience from the data science API based on the\nprovided audienceId. The insights include age, gender, devices and geographical distribution of the audience.\n", "operationId": "getAudienceInsights", "parameters": [ { "name": "audienceId", "in": "path", "description": "The ID of the audience to get the insight", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Successful retrieval of audience insights": { "description": "Successful retrieval of audience insights", "value": "{\n \"success\": true,\n \"data\": {\n \"audience_id\": \"1139300\",\n \"audience_name\": \"new hcp 1\",\n \"audience_date\": \"2025-06-27\",\n \"vertical_id\": \"2\",\n \"vertical\": \"Healthcare\",\n \"widgets\": [\n {\n \"title\": \"Audience Summary\",\n \"type\": \"table\",\n \"data\": [\n {\n \"Sr no.\": 1,\n \"Key\": \"Total Healthcare Facilities\",\n \"Audience Value\": \"14,219\"\n },\n {\n \"Sr no.\": 2,\n \"Key\": \"Total People\",\n \"Audience Value\": \"5,917\"\n },\n {\n \"Sr no.\": 3,\n \"Key\": \"Total Phones\",\n \"Audience Value\": \"4,833\"\n },\n {\n \"Sr no.\": 4,\n \"Key\": \"Total Emails\",\n \"Audience Value\": \"3,010\"\n }\n ]\n },\n" } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "examples": { "User not having access to the audience": { "description": "User not having access to the audience", "value": { "success": false, "errorObjects": [ { "error": "Audience is not accessible for the given user." } ] } } } } } }, "422": { "description": "Unprocessable Entity - Request validation failed", "content": { "application/json": { "examples": { "Incorrect audience type for audience regeneration": { "description": "Incorrect audience type for audience regeneration", "value": { "success": false, "errorObjects": [ { "error": "Invalid Audience Id/s provided." } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/audience/{audienceId}/file-url": { "get": { "tags": [ "Audience API" ], "summary": "Get audience file download presigned URL.", "description": "This API returns the presigned S3 URL to download the matched or ICT audience file for the given audience ID.\nThe presigned URL allows secure, temporary access to the file stored in S3.\n", "operationId": "getAudienceFileUrl", "parameters": [ { "name": "audienceId", "in": "path", "description": "Audience id of the audience to be fetched.", "required": true, "schema": { "type": "integer", "format": "int32" }, "example": 1234 }, { "name": "verticalId", "in": "query", "description": "Vertical ID to be used for resolving applicable columns. Required for workspace/super users. Inferred for advertisers.", "required": false, "schema": { "type": "integer", "format": "int32" }, "example": 2 }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Get Audience File URL by Id": { "description": "Get Audience File URL by Id", "value": { "success": true, "data": { "audienceFileUrl": "https://sampleurl.com/file123.csv?AWSAccessKeyId=abc&Expires=111&Signature=encoded-signature" } } } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "examples": { "when Invalid/Inaccessible audience id is passed": { "description": "when Invalid/Inaccessible audience id is passed", "value": { "success": false, "errorObjects": [ { "error": "No active audience found with the given Id.", "field": "audienceId" } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/audience/static/frequency-types": { "get": { "tags": [ "Audience API" ], "summary": "This API fetches the static list of active frequency types.", "description": "This API fetches the static list supported and don't have support for any filters.", "operationId": "getFrequencyTypes", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "Successful retrieval of Frequency types", "content": { "application/json": { "examples": { "Response containing list of frequency types": { "description": "Response containing list of frequency types", "value": { "success": true, "data": [ { "id": 1, "name": "total", "order": 1, "displayName": "Total" }, { "id": 2, "name": "weekly", "order": 2, "displayName": "Weekly" } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/audience/static/data-partners": { "get": { "tags": [ "Audience API" ], "summary": "Get matched audience data partners based on vertical and subtype", "description": "Returns a list of data partners relevant for audience based on vertical and optional subtype.\n- For advertiser users, vertical is derived from the logged-in user's OWID.\n- For workspace/super users, a vertical ID should be passed explicitly.\n- type id is mandatory to fetch data partners.\n- If comma separated set of subtype IDs are passed, those must be valid for the vertical.\n- Data partners shown are based on active configurations.\n", "operationId": "getAudienceDataPartners", "parameters": [ { "name": "audienceTypeId", "in": "query", "description": "audience type ID for which the applicable data partners are resolved", "required": true, "schema": { "type": "integer", "format": "int32" }, "example": 2 }, { "name": "audienceSubtypeIds", "in": "query", "description": "Optional comma separated subtype IDs used to further refine data partners (e.g., HCP or Patient under Healthcare vertical)", "required": false, "schema": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "example": "2,3" }, { "name": "verticalId", "in": "query", "description": "Vertical ID based on which data partners are fetched.", "required": false, "schema": { "type": "integer", "format": "int32" }, "example": 2 }, { "name": "active", "in": "query", "description": "Flag to filter data partners by active status. If true, only active data partners will be returned; if false, only inactive data partners will be returned; if not provided, all data partners will be returned.", "required": false, "schema": { "type": "boolean" }, "example": true }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "Audience data partners retrieved successfully", "content": { "application/json": { "examples": { "Response with data partners": { "description": "Response with data partners", "value": { "success": true, "data": [ { "id": 7, "name": "hl_npi_id", "order": 6, "displayName": "Healthlink ID", "cpm": 10, "logoUrl": "https://cdn.com/data_partner/hld.png" }, { "id": 8, "name": "data360_npi_id", "order": 7, "displayName": "Data360 ID", "cpm": 15, "logoUrl": "https://cdn.com/data_partner/D360.png" } ] } }, "Response with empty data partners list": { "description": "Response with empty data partners list", "value": { "success": true, "data": [] } } } } } }, "422": { "description": "Invalid combination of subtype with type and vertical. Thrown especially when subtype is passed in request.", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Data Partner doesn't exist for provided/customer vertical and audienceType" } ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/audience/static/data-formats": { "get": { "tags": [ "Audience API" ], "summary": "This API fetches the static list of supported data formats.", "description": "This API fetches the static list of data formats also known as hashed data formats which is used to get encryption information of column in matched audience uploaded file.", "operationId": "getDataFormats", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "Successful retrieval of data formats", "content": { "application/json": { "examples": { "Sample response containing list of data formats": { "description": "Sample response containing list of data formats", "value": { "success": true, "data": [ { "id": 1, "name": "Raw", "order": 1, "displayName": "Raw" }, { "id": 2, "name": "MD5", "order": 2, "displayName": "Hashed (MD5)" } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/audience/static/column-list": { "get": { "tags": [ "Audience API" ], "summary": "Get audience columns based on audience type, vertical and subtype and data partner", "description": "Returns a list of audience columns along with its supported data format ids based on audience type, vertical\n and optional audience subtype and optional data partner.\n- For advertiser users, vertical is inferred from the logged-in user's owId.\n- For workspace/super users, vertical ID should be passed explicitly.\n- If both passed and inferred vertical IDs conflict, the request will be rejected.\n- If a subtype is provided, it must belong to the specified vertical.\nNote: if there is no column combination found, it will return empty list.\n", "operationId": "getAudienceColumnWithDataFormats", "parameters": [ { "name": "audienceTypeId", "in": "query", "description": "Audience type ID to be used for resolving applicable columns.", "required": true, "schema": { "type": "integer", "format": "int32" }, "example": 2 }, { "name": "verticalId", "in": "query", "description": "Vertical ID to be used for resolving applicable columns. Required for workspace/super users. Inferred for advertisers.", "required": false, "schema": { "type": "integer", "format": "int32" }, "example": 2 }, { "name": "audienceSubtypeId", "in": "query", "description": "Optional subtype ID used to further refine audience columns (e.g., HCP or Patient under Healthcare vertical)", "required": false, "schema": { "type": "integer", "format": "int32" }, "example": 1 }, { "name": "dataPartnerId", "in": "query", "description": "Optional data partner ID to further filter columns based on data partner specific configurations (e.g., Healthlink, RevOptimal, etc.)", "required": false, "schema": { "type": "integer", "format": "int32" }, "example": 7 }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "List of audience columns with data formats retrieved successfully", "content": { "application/json": { "example": { "success": true, "data": [ { "id": 1, "name": "Voters_ID", "order": 1, "displayName": "Voter ID" }, { "id": 2, "name": "Email", "order": 3, "displayName": "Email", "dataFormatIds": [1, 2, 3, 4, 5, 6] }, { "id": 3, "name": "Phone", "order": 4, "displayName": "Phone", "dataFormatIds": [1, 2, 3, 4, 5, 6] } ] } } } }, "422": { "description": "Invalid combination of subtype with vertical. Thrown especially when subtype is passed in request.", "content": { "application/json": { "examples": { "Invalid Subtype for Vertical": { "description": "Invalid combination of subtype with vertical. Thrown especially when subtype is passed in request.", "value": { "success": false, "errorObjects": [ { "error": "Invalid audienceSubtypeId 7 for verticalId 2" } ] } }, "Invalid Audience Type ID": { "description": "When audience type ID is invalid", "value": { "success": false, "errorObjects": [ { "error": "Invalid audience type ID provided." } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/audience/static/column-combinations": { "get": { "tags": [ "Audience API" ], "summary": "Get valid audience column combinations based on audience type, vertical and subtype", "description": "Returns a list of audience column combinations based on type, vertical\n and optional audience subtype.\n- For advertiser users, vertical is inferred from the logged-in user's owId.\n- For workspace/super users, vertical ID should be passed explicitly.\n- If both passed and inferred vertical IDs conflict, the request will be rejected.\n- If a subtype is provided, it must belong to the specified vertical.\n", "operationId": "getAudienceColumnCombinations", "parameters": [ { "name": "audienceTypeId", "in": "query", "description": "Audience type ID to be used for resolving applicable column combinations.", "required": true, "schema": { "type": "integer", "format": "int32" }, "example": 2 }, { "name": "verticalId", "in": "query", "description": "Vertical ID to be used for resolving applicable column combinations.Required for workspace/super users. Inferred for advertisers.", "required": false, "schema": { "type": "integer", "format": "int32" }, "example": 2 }, { "name": "audienceSubtypeId", "in": "query", "description": "Optional subtype ID used to further refine audience column combinations.(e.g., HCP or Patient under Healthcare vertical)", "required": false, "schema": { "type": "integer", "format": "int32" }, "example": 1 }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "List of audience columns with data formats retrieved successfully", "content": { "application/json": { "example": { "success": true, "data": [ { "id": 1, "columnIds": [1, 2, 3, 4], "order": 1 }, { "id": 3, "columnIds": [3, 4, 8, 9], "order": 4 }, { "id": 5, "columnIds": [7, 8, 4, 9], "order": 6 } ] } } } }, "422": { "description": "Unprocessable request.", "content": { "application/json": { "examples": { "Invalid Subtype for Vertical": { "description": "Invalid combination of subtype with vertical. Thrown especially when subtype is passed in request.", "value": { "success": false, "errorObjects": [ { "error": "Invalid audienceSubtypeId 7 for verticalId 2" } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/audience/static/audience-types": { "get": { "tags": [ "Audience API" ], "summary": "This API fetches the list of audience types for the logged in OW ID.", "description": "This API fetches the list of audience types for the logged in OW ID. The audience types are filtered based on the vertical type of the logged in OW ID.", "operationId": "getAudienceTypes", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "Successful retrieval of Audience types", "content": { "application/json": { "examples": { "Response containing list of Audience types": { "description": "Response containing list of Audience types", "value": { "success": true, "data": [ { "id": 1, "name": "Matched Audience", "order": 1, "displayName": "Matched Audience" }, { "id": 2, "name": "Segmented Audience", "order": 2, "displayName": "Segmented Audience" }, { "id": 3, "name": "Retargeted Audience", "order": 3, "displayName": "Retargeted Audience" } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/audience/static/audience-subtypes": { "get": { "tags": [ "Audience API" ], "summary": "This API fetches the static list of audience subtypes", "description": "This API fetches the static list of audience subtypes for given audience type id and vertical id.\nIf for a particular audience type id, there are no audience subtypes,\nor no subtype of the given vertical, response will contain an empty list.\n", "operationId": "getAudienceSubtypes", "parameters": [ { "name": "verticalId", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "audienceTypeIds", "in": "query", "required": false, "schema": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "Successful retrieval of audience subtypes", "content": { "application/json": { "examples": { "Response containing list of audience subtypes along with number of filtered records and total records when audience type ID is not provided and vertical is healthcare": { "description": "Response containing list of audience subtypes along with number of filtered records and total records when audience type ID is not provided and vertical is healthcare", "value": { "success": true, "data": { "audienceSubtypes": [ { "id": 3, "name": "hcp", "order": 3, "displayName": "HCP" }, { "id": 4, "name": "npi_nurse", "order": 4, "displayName": "Nurse" }, { "id": 5, "name": "non_npi_nurse", "order": 5, "displayName": "Non-NPI Nurse" }, { "id": 6, "name": "patient", "order": 6, "displayName": "Patient" } ], "totalRecords": 4, "filteredRecords": 4 } } }, "Response containing list of audience subtypes along with\nnumber of filtered records\nand total records when audience type ID is provided.\n": { "description": "Response containing list of audience subtypes along with\nnumber of filtered records\nand total records when audience type ID is provided.\n", "value": { "success": true, "data": { "audienceSubtypes": [ { "id": 3, "name": "hcp", "order": 3, "displayName": "HCP" }, { "id": 6, "name": "patient", "order": 6, "displayName": "Patient" } ], "totalRecords": 4, "filteredRecords": 2 } } } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "examples": { "Missing Vertical ID": { "description": "When no vertical ID is provided and user's vertical is not defined", "value": { "success": false, "errorObjects": [ { "error": "No vertical ID provided, please provide a valid vertical ID" } ] } }, "Forbidden Vertical ID": { "description": "When the provided vertical ID does not match the user's vertical ID", "value": { "success": false, "errorObjects": [ { "error": "Request for resource with forbidden vertical ID." } ] } }, "Invalid Vertical ID": { "description": "When the provided vertical ID is not valid", "value": { "success": false, "errorObjects": [ { "error": "Invalid vertical ID provided." } ] } }, "Invalid Audience Type ID": { "description": "When one or more audience type IDs are invalid", "value": { "success": false, "errorObjects": [ { "error": "Invalid audience type ID provided." } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/audience/static/audience-status": { "get": { "tags": [ "Audience API" ], "summary": "This API fetches the list of audience statuses.", "description": "This API fetches the list of audience statuses.It also supports audienceTypeIds parameter to fetch audience statuses applicable for the given audience types.", "operationId": "getAudienceStatuses", "parameters": [ { "name": "audienceTypeIds", "in": "query", "description": "Set of audience Type Ids to fetch their applicable audience statuses. If not provided, audience statuses for all audience types will be fetched.", "required": false, "schema": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } } }, { "name": "verticalIds", "in": "query", "description": "Set of vertical IDs to filter audience statuses. If not provided, all verticals are considered.", "required": false, "schema": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } } }, { "name": "deletedStatusRequired", "in": "query", "description": "Flag to indicate whether to include 'Deleted' status in the response.\nIf true, 'Deleted' status will be included; if false or not provided, it will be excluded.\n", "required": false, "schema": { "type": "boolean" } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "Successful retrieval of Audience Statuses", "content": { "application/json": { "examples": { "Sample response containing list of Audience statuses": { "description": "Sample response containing list of Audience statuses", "value": { "success": true, "data": [ { "id": 2, "name": "pending", "order": 1, "displayName": "Pending" }, { "id": 1, "name": "processing", "order": 2, "displayName": "Processing" } ] } }, "Sample response containing list of Audience statuses when deletedStatusRequired flag is true": { "description": "Sample response containing list of Audience statuses when deletedStatusRequired flag is true", "value": { "success": true, "data": [ { "id": 2, "name": "pending", "order": 1, "displayName": "Pending" }, { "id": 5, "name": "deleted", "order": 8, "displayName": "Deleted" } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/audience/segmented/static/reach-range": { "get": { "tags": [ "Audience API" ], "summary": "Fetches the segment reach range list.", "description": "This API retrieves the list of segment reach ranges that are active. The response includes the ID, name, display name, and order of each reach range.", "operationId": "getSegmentReachRange", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Successful fetching of segment reach range list": { "description": "Successful fetching of segment reach range list", "value": { "success": true, "data": [ { "id": 1, "name": "Unknown", "order": 1, "displayName": "Unknown" }, { "id": 2, "name": "\u003C10K", "order": 2, "displayName": "\u003C10K" }, { "id": 3, "name": "10K to 100K", "order": 3, "displayName": "10K to 100K" }, { "id": 4, "name": "100K to 1M", "order": 4, "displayName": "100K to 1M" }, { "id": 5, "name": "1M+", "order": 5, "displayName": "1M+" } ] } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden !" } ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/audience/segmented/static/price-range": { "get": { "tags": [ "Audience API" ], "summary": "Fetches the segment price range list.", "description": "This API retrieves the list of segment price ranges that are active. The response includes the ID, name, display name, and order of each price range.", "operationId": "getSegmentPriceRange", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Successful fetching of segment price range list": { "description": "Successful fetching of segment price range list", "value": { "success": true, "data": [ { "id": 1, "name": "$0 to $1", "order": 1, "displayName": "$0 to $1" }, { "id": 2, "name": "$1 to $2", "order": 2, "displayName": "$1 to $2" }, { "id": 3, "name": "$2 to $5", "order": 3, "displayName": "$2 to $5" }, { "id": 4, "name": "$5 to $10", "order": 4, "displayName": "$5 to $10" }, { "id": 5, "name": "$10+", "order": 5, "displayName": "$10+" } ] } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden !" } ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/audience/segmented/segments/children": { "get": { "tags": [ "Audience API" ], "summary": "Fetches the segments list by parent or provider ID.", "description": "This API retrieves the list of segments based on the provided parent ID or provider ID. That means either parent ID or provider ID needs to be provided in the request.It allows filtering segments based on whether they have non-zero reach and whether they are ready.", "operationId": "getSegmentsListByParentOrProvider", "parameters": [ { "name": "parentId", "in": "query", "description": "The parent ID to filter segments by.", "required": false, "schema": { "type": "integer", "format": "int32" }, "example": 12345 }, { "name": "providerId", "in": "query", "description": "The provider ID to filter segments by.", "required": false, "schema": { "type": "integer", "format": "int32" }, "example": 67890 }, { "name": "showOnlyNonZeroSegments", "in": "query", "description": "Optional Flag to show only segments with non-zero reach.", "required": false, "schema": { "type": "boolean", "default": false }, "example": true }, { "name": "showOnlyReadySegments", "in": "query", "description": "Optional Flag to show only segments that are ready.", "required": false, "schema": { "type": "boolean", "default": false }, "example": false }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Successful fetching of segments list by parent or provider ID": { "description": "Successful fetching of segments list by parent or provider ID", "value": { "success": true, "data": [ { "segmentId": 6192803, "taxonomyValue": "Giving And Investment", "description": "Sample description", "pathKey": "LiveRamp \u003E i360 \u003E i360 \u003E Demographics \u003E Giving And Investment", "cpm": 10, "modifiedAt": "2021-06-08T03:15:50.979+00:00", "totalReach": 360, "dataAvailable": true, "reachMetadata": { "iosDevicesReach": 120, "androidDevicesReach": 120, "cookiesReach": 120 }, "leaf": false }, { "segmentId": 6192796, "taxonomyValue": "Ages 18 To 29", "description": "Individuals Ages 18 And 29.", "pathKey": "LiveRamp \u003E i360 \u003E i360 \u003E Demographics \u003E Ages 18 To 29", "cpm": 1, "modifiedAt": "2021-06-08T03:15:50.979+00:00", "totalReach": 360, "reachMetadata": { "iosDevicesReach": 120, "androidDevicesReach": 120, "cookiesReach": 120 }, "leaf": true } ] } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden !" } ] } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "examples": { "Both parentId or providerId are not provided": { "description": "Both parentId or providerId are not provided", "value": { "success": false, "errorObjects": [ { "error": "Both providerId and parentId cannot be null. Please provide at least one of them" } ] } }, "Invalid providerId provided": { "description": "Invalid providerId provided", "value": { "success": false, "errorObjects": [ { "error": "Invalid providerId provided. Please provide a valid providerId" } ] } }, "Invalid parentId provided": { "description": "Invalid parentId provided", "value": { "success": false, "errorObjects": [ { "error": "Invalid parentId provided. Please provide a valid parentId" } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/audience/segmented/partner-provider/list": { "get": { "tags": [ "Audience API" ], "summary": "Fetches the list of segment partner providers.", "description": "This API retrieves the list of segment partner and their providers for the organization workspace. ", "operationId": "getSegmentPartnerProviderList", "parameters": [ { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Successful fetching of segment partner provider list": { "description": "Successful fetching of segment partner provider list", "value": { "success": true, "data": [ { "partnerId": 6, "partnerName": "IQM Political", "partnerLogoUrl": "https://www.sample-domain/data_partner/iqm-political-provider.svg", "description": "IQM Political", "verticalIds": [1], "displayOrder": 2, "providers": [ { "providerId": 76, "providerName": "AdMavin", "providerLogoUrl": "https://www.sample-domain.com/iqm-political-provider.svg", "description": "AdMavin", "verticalIds": [1] }, { "providerId": 279, "providerName": "Aristotle", "providerLogoUrl": "https://www.sample-domain.com/iqm-political-provider.svg", "description": "Aristotle", "verticalIds": [1] } ], "isCustomPartner": false, "isPartnerPublic": false }, { "partnerId": 13033, "partnerName": "OL's Healthcare", "partnerLogoUrl": "https://www.sample-domain.com/avatar/OH.png", "description": "Seat ID: 203775", "seatId": 203775, "displayOrder": 0, "isCustomPartner": true, "isPartnerPublic": false } ] } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden !" } ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/audience/prebid/static/providers/child-segments": { "get": { "tags": [ "Audience API" ], "summary": "This API retrieves the prebid provider and its immediate child details.", "description": "This API will fetch the details of provider and the details of its immediate child segments", "operationId": "getProviderDetailsWithChildSegments", "parameters": [ { "name": "showInActiveSegments", "in": "query", "description": "Used to fetch deprecated/InActive segments. Default value is false.", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Successfully fetching the prebid provider and its immediate child segments": { "description": "Successfully fetching the prebid provider and its immediate child segments", "value": { "success": true, "data": [ { "providerId": 1, "providerName": "Integral Ad Science", "description": "Segments for Brand Safety, Viewability, Fraud & IVT", "providerLogoUrl": "http://logoUrl.com", "childSegments": [ { "prebidSegmentId": 2, "prebidSegmentName": "Fraud & IVT", "description": "prebidSegmentDescription", "parentPathKey": "prebid \u003E IAS", "cpm": 0, "creativeTypeIdList": [11, 14], "leaf": false }, { "prebidSegmentId": 1, "prebidSegmentName": "Brand Safety", "description": "prebidSegmentDescription", "parentPathKey": "prebid \u003E IAS", "cpm": 0, "creativeTypeIdList": [11, 14], "leaf": false } ] } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/audience/prebid/segments/children": { "get": { "tags": [ "Audience API" ], "summary": "This API provides the prebid audience child segment details.", "description": "This API will fetch the details of child prebid audience segments based on the given parent prebid segment id", "operationId": "getPrebidChildSegmentDetailsByParentId", "parameters": [ { "name": "prebidParentSegmentId", "in": "query", "description": "The prebid audience segment for which the details are to be fetched", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Successful retrieval of prebid child segments": { "description": "Successful retrieval of prebid child segments", "value": { "success": true, "data": [ { "prebidSegmentId": 4, "prebidSegmentName": "Display", "description": null, "parentPathKey": "IAS \u003E Brand Safety", "cpm": 0, "creativeTypeIds": [11, 14], "leaf": false }, { "prebidSegmentId": 5, "prebidSegmentName": "Video", "description": null, "parentPathKey": "IAS \u003E Brand Safety", "cpm": 0, "creativeTypeIds": [11, 14], "leaf": false } ] } }, "Invalid Prebid Segment Id or When no child segments are present": { "description": "Invalid Prebid Segment Id or When no child segments are present", "value": { "success": false, "errorObjects": [ { "error": "Invalid Prebid Segment Id or No further Segments in the hierarchy." } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/audience/prebid/dv-ivt/free-segments": { "get": { "tags": [ "Audience API" ], "summary": "This API fetches the prebid segment details which are free for advertiser.", "description": "This endpoint will fetch the prebid segments which are made available for free by Super Admin. As of now, DV (DoubleVerify) Fraud and IVT(Invalid Traffic) segments are made available for free as per users", "operationId": "getDvIvtFreePrebidSegments", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "When advertiser has access to free segments": { "description": "When advertiser has access to free segments", "value": "{\n \"success\": true,\n \"data\": {\n [\n {\n \"prebidSegmentId\": 234,\n \"providerId\": 2\n \"defaultSelected\": true\n },\n {\n \"prebidSegmentId\": 235,\n \"providerId\": 2\n \"defaultSelected\": true\n },\n {\n \"prebidSegmentId\": 236\n \"providerId\": 2\n \"defaultSelected\": true\n }\n ]\n }\n}\n" }, "When advertiser does not have access to any free segments": { "description": "When advertiser does not have access to any free segments", "value": "{\n \"success\": true,\n \"data\": {\n []\n }\n}\n" } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/audience/platform-config": { "get": { "tags": [ "Audience API" ], "summary": "Get properties for audiences", "description": "Fetches the default properties and configuration details for the audiences.\nThis API is used to retrieve property definitions for all audiences.\n", "operationId": "getAudienceProperties", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "Successfully fetched audience properties", "content": { "application/json": { "examples": { "Success response": { "description": "Success response", "value": { "success": true, "data": { "audienceCvaMaxAllowedSegmentGroups": 5, "audienceCvaMaxSegmentsAllowedInGroup": 100, "audienceCvaMinReachCriteria": 100, "audienceNonPatientRematchFromDurationInDays": "90", "audiencePatientRematchTillDurationInDays": "21" } } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/audience/lookalike/{audienceId}": { "get": { "tags": [ "Audience API" ], "summary": "Get the lookalike audience details.", "description": "Get the lookalike audience details by the audience id. The API also support an optional flag of isTargetingInfoRequired as parameter.If the flag is true, API also gives the targeted campaigns details", "operationId": "getLookalikeAudienceById", "parameters": [ { "name": "isTargetingInfoRequired", "in": "query", "description": "Flag to indicate whether targeting information is required in the response. Default is false.If the flag is true, we will also send the targeted campaigns details along with type of targeting and attached campaign status ", "required": false, "schema": { "type": "boolean" }, "example": true }, { "name": "audienceId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Lookalike audience detail": { "description": "Lookalike audience detail", "value": "{\n \"success\": true,\n \"data\": {\n \"audienceId\": 1141499,\n \"audienceName\": \"Test lookalike Audience - 90K\",\n \"audienceStatusId\": 3,\n \"createdAt\": 1753882035,\n \"organizationName\": \"Political Advertiser - Audience Bidder\",\n \"owId\": 204472,\n \"createdByUowId\": 267663,\n \"createdByUser\": \"Political Advertiser - Audience Bidder\",\n \"createdByUserEmail\": null,\n \"reach\": 2000,\n \"cpm\": 1.5,\n \"sourceAudienceIds\": [123456, 123457],\n \"geoLocationDetails\": {\n \"countryIds\": [30100001],\n \"stateIds\": [30200001, 30200002, 30200003, 30200004],\n \"cityIds\": [30400001, 30400002]\n \"countyIds\": [30300001, 30300003],\n \"senateDistrictIds\": [687, 688],\n \"houseDistrictIds\": [5098, 5121],\n \"congressionalDistrictIds\": [350, 78]\n },\n \"audienceSize\": 10,\n \"targetedCampaignList\": [\n {\n \"campaignName\": \"Audience - LookAlike Audience with IP Based\",\n \"campaignId\": 565213,\n \"targetingTypeId\": 1, // Whitelist\n \"campaignStatus\": \"Running\"\n },\n {\n \"campaignName\": \"Audience - LookAlike Audience with Device Based - Blacklisted\",\n \"campaignId\": 565262,\n \"targetingTypeId\": 2, // Blacklist\n \"campaignStatus\": \"Paused\"\n }\n ],\n \"approvedRejectedByUserName\": null,\n \"rejectionReason\": null,\n \"isApprovalAccess\": true\n }\n }\n" } } } } }, "403": { "description": "Forbidden Exception", "content": { "application/json": { "examples": { "Audience Not Accessible": { "description": "Audience Not Accessible", "value": { "success": false, "errorObjects": [ { "error": "Audience is not accessible for the given user." } ] } } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "examples": { "Invalid Audience Id": { "description": "Invalid Audience Id", "value": { "success": false, "errorObjects": [ { "error": "No active audience found with the given Id.", "field": "audienceId" } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/audience/geo-farmed/{audienceId}": { "get": { "tags": [ "Audience API" ], "summary": "Get the geofarmed audience details.", "description": "Get the geofarmed audience details by the audience id.", "operationId": "getGeofarmedAudience", "parameters": [ { "name": "audienceId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Geofarmed audience detail": { "description": "Geofarmed audience detail", "value": { "success": true, "data": { "audienceId": 1141873, "audienceName": "my geo check 3", "audienceStatusId": 1, "createdAt": 1754997589, "reach": 14300, "cpm": 10, "audienceSubtypeId": 3, "dataPartnerId": 7, "dataPartnerMetrics": [ { "id": 7, "reach": 14300 }, { "id": 10, "reach": 14142 }, { "id": 8, "reach": 4989 } ], "frequency": 1, "frequencyTypeId": 1, "startDate": 1752465600, "endDate": 1752552000, "timezoneId": 29, "timeRange": null, "locations": { "included": { "zipCodes": [ "03060" ], "customAreas": [ { "latitude": 36.0326439664845, "longitude": -119.880242625793, "radius": 0.5, "address": "24M9+3W Kettleman City, CA, USA", "locationId": 0, "cid": "US", "sid": "CA", "type": "circle", "unit": "mile", "cdId": 0, "sdId": 0, "hdId": 0, "isIncluded": true }, { "latitude": 36.0300478976465, "longitude": -119.85904244574, "radius": 0.5, "address": "24JR+29 Kettleman City, CA, USA", "locationId": 0, "cid": "US", "sid": "CA", "type": "circle", "unit": "mile", "cdId": 0, "sdId": 0, "hdId": 0, "isIncluded": true }, { "latitude": 36.0310726879797, "longitude": -79.3626645007933, "radius": 31.99, "address": "Graham, NC 27253, USA", "locationId": 0, "polypath": [ { "lat": 36.387219031078, "lng": -79.6263363757933 }, { "lat": 35.5335466824209, "lng": -79.9778988757933 }, { "lat": 35.6764655344158, "lng": -78.8353207507933 }, { "lat": 36.5285986935384, "lng": -78.7474301257933 } ], "cid": "US", "sid": "NC", "type": "custom", "unit": "mile", "cdId": 0, "sdId": 0, "hdId": 0, "isIncluded": true }, { "latitude": 34.4534306784404, "longitude": -80.7249691882933, "radius": 20.21, "address": "Camden, SC 29020, USA", "locationId": 0, "polypath": [ { "lat": 34.5983771861123, "lng": -80.4173520007933 }, { "lat": 34.5983771861123, "lng": -81.0325863757933 }, { "lat": 34.3084841707685, "lng": -81.0325863757933 }, { "lat": 34.3084841707685, "lng": -80.4173520007933 } ], "cid": "US", "sid": "SC", "type": "square", "unit": "mile", "cdId": 0, "sdId": 0, "hdId": 0, "isIncluded": true } ], "locationIds": [1252824, 1252825] }, "excluded": { "zipCodes": [], "customAreas": [], "locationIds": [] }, "locationFileIds": [17063], "country": 30100001 }, "bulkLocationDetails": { "17063": { "fileName": "bulk-location-example.csv", "fileType": "location", "validLocations": [ { "latitude": 40.7128, "longitude": -74.006, "radius": 0.5, "address": "230 Broadway, New York, NY 10007, USA", "locationId": 1252824, "cid": "US", "sid": "NY", "cdId": 0, "sdId": 0, "hdId": 0, "isIncluded": true }, { "latitude": 36.7783, "longitude": -119.4179, "radius": 1, "address": "2630 Croydon Drive, Sanger, CA 93657, USA", "locationId": 1252825, "cid": "US", "sid": "CA", "cdId": 0, "sdId": 0, "hdId": 0, "isIncluded": true } ], "invalidLocations": null, "locationRejectionReasons": null, "campaignId": null, "id": 17063, "rowCount": null, "invalidLocationsCount": null, "duplicateLocationsCount": null } } } } } } } } }, "403": { "description": "Forbidden Exception", "content": { "application/json": { "examples": { "Audience Not Accessible": { "description": "Audience Not Accessible", "value": { "success": false, "errorObjects": [ { "error": "Audience is not accessible for the given user." } ] } } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "examples": { "Invalid Audience Id": { "description": "Invalid Audience Id", "value": { "success": false, "errorObjects": [ { "error": "No active audience found with the given Id.", "field": "audienceId" } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/audience/count-by-type": { "get": { "tags": [ "Audience API" ], "summary": "This API fetches the types of audience ids and their respective count.", "description": "This API gets the audience type ids and the count of audiences created for each type. The audience count is filtered based on the logged in OW ID and the vertical type of the OW ID. This API return's only non-zero counts of audiences.", "operationId": "getAudienceCountByType", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Successful fetching of Audience types with their counts": { "description": "Successful fetching of Audience types with their counts", "value": { "success": true, "data": [ { "audienceTypeId": 1, "audienceCount": 10 }, { "audienceTypeId": 2, "audienceCount": 25 } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/audience/contextual/{audienceId}": { "get": { "tags": [ "Audience API" ], "summary": "Get contextual Audience", "description": "This API will fetch the details of contextual audience based on the given audience id. This id refers to the master audience id.", "operationId": "getContextualAudienceDetails", "parameters": [ { "name": "audienceId", "in": "path", "description": "Audience ID", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "Successfully fetched contextual audience details", "content": { "application/json": { "examples": { "Get contextual audience with static data collection method by healthcare customer": { "description": "Get contextual audience with static data collection method by healthcare customer", "value": { "success": true, "data": { "audienceId": 114224, "audienceName": "Test_aud", "audienceStatusId": 7, "createdAt": 1756469053153, "reach": 0, "audienceSubtypeId": 3, "keywords": [ "Test", "healthcare", "Nurse", "profession" ], "urls": [ "http://iqm.com" ], "dataCollectionMethodId": 1, "startDate": 1753934400000, "endDate": 1756526399000, "frequency": 5 } } }, "Get contextual audience with dynamic data collection method by Non-healthcare customer": { "description": "Get contextual audience with dynamic data collection method by Non-healthcare customer", "value": { "success": true, "data": { "audienceId": 1141259, "audienceName": "Test_aud_contextual", "audienceStatusId": 8, "cpm": 1.5, "reach": 0, "createdAt": 1753773402000, "keywords": [ "Test" ], "urls": [ "http://iqm.com" ], "dataCollectionMethodId": 2, "dataCollectionDays": 10, "frequency": 5, "dataPartnerId": 1, "dataPartnerMetrics": [ { "id": 1, "reach": 1000 }, { "id": 2, "reach": 1000 } ] } } } } } } }, "403": { "description": "Forbidden Exception", "content": { "application/json": { "examples": { "Audience Not Accessible": { "description": "Audience Not Accessible", "value": { "success": false, "errorObjects": [ { "error": "Audience is not accessible for the given user." } ] } } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "examples": { "Invalid Audience Id": { "description": "Invalid Audience Id", "value": { "success": false, "errorObjects": [ { "error": "No active audience found with the given Id.", "field": "audienceId" } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/audience/campaign/{audienceId}": { "get": { "tags": [ "Audience API" ], "summary": "This API fetches the details of an Campaign Audience", "description": "This API fetches the details of an Campaign audience from the database based on the provided audienceId and logged in user. The details include audience Id, name and campaign audience specific details ", "operationId": "getCampaignAudience", "parameters": [ { "name": "audienceId", "in": "path", "description": "Master audience Id of the campaign audience", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "Successful retrieval of Campaign Audience details", "content": { "application/json": { "examples": { "Campaign Audience Success Response": { "description": "Campaign Audience Success Response", "value": { "success": true, "data": { "audienceId": 119431, "audienceName": "asdf", "audienceStatusId": 1, "cpm": 2.5, "uniques": 56590, "createdAt": 1740876000000, "campaignDetails": { "clicks": [], "conversions": [], "impressions": [56590] }, "startDate": 1740816000000, "endDate": 1753167600000 } } } } } } }, "403": { "description": "Forbidden Exception", "content": { "application/json": { "examples": { "Audience Not Accessible": { "description": "Audience Not Accessible", "value": { "success": false, "errorObjects": [ { "error": "Audience is not accessible for the given user." } ] } } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "examples": { "Invalid Audience Id": { "description": "Invalid Audience Id", "value": { "success": false, "errorObjects": [ { "error": "No active audience found with the given Id.", "field": "audienceId" } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/audience/abm/{audienceId}": { "get": { "tags": [ "Audience API" ], "summary": "This API fetches the details of an ABM Audience", "description": "This API fetches the details of an Account-Based (ABM) audience from the database based on the provided audienceId. The details include audience ID, name, status, type, creation timestamp, data cost, healthcare data mappings, healthcare filters, and reach.", "operationId": "getAccountBasedAudienceDetailsByAudienceId", "parameters": [ { "name": "audienceId", "in": "path", "description": "Unique Identifier for ABM Audience", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "Successful retrieval of ABM Audience details", "content": { "application/json": { "examples": { "Response containing details of an ABM Audience": { "description": "Response containing details of an ABM Audience", "value": { "success": true, "data": { "audienceId": 1124243, "audienceName": "Test ABM audience", "audienceStatusId": 3, "createdAt": 1739261114, "partnerName": "Healthlink", "partnerLogoUrl": "www.sample.com", "reach": 1000, "cpm": 10, "healthCareDataMappingIds": [13572, 13575, 32777], "filters": { "ids": [13572, 13575, 32777], "dataProviderIds": [1], "healthCareSystemIds": [1, 2, 3], "accountIds": [1, 2, 3], "accountTypeIds": [1, 2, 3], "accountSubTypeIds": [1, 2, 3], "titleIds": [1, 2, 3], "specialityIds": [1, 2, 3], "countryIds": [30100001], "stateIds": [1, 2, 3], "cityIds": [1, 2, 3], "pageNo": 1, "noOfEntries": 10000 } } } } } } } }, "403": { "description": "Forbidden Exception", "content": { "application/json": { "examples": { "Audience Not Accessible": { "description": "Audience Not Accessible", "value": { "success": false, "errorObjects": [ { "error": "Audience is not accessible for the given user." } ] } } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "examples": { "Invalid Audience Id": { "description": "Invalid Audience Id", "value": { "success": false, "errorObjects": [ { "error": "No active audience found with the given Id.", "field": "audienceId" } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/audience/abm/healthcare-data/titles": { "get": { "tags": [ "Audience API" ], "summary": "Retrieves a list of healthcare titles based on the provided filters.", "description": "This API fetches the healthcare title list, filtered record count, and total record count based on the provided filters.", "operationId": "getHealthcareTitleList", "parameters": [ { "name": "titleIds", "in": "query", "description": "Set of healthcare title IDs to filter the healthcare titles. Comma-separated String of IDs is also allowed.", "required": false, "schema": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } } }, { "name": "dataProviderIds", "in": "query", "description": "List of data provider IDs to filter the healthcare data. Comma-separated String of IDs is also allowed.", "required": false, "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } }, { "name": "pageNo", "in": "query", "description": "[optional] Page number for the required data. The default value is 1. ", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 }, "example": 1 }, { "name": "noOfEntries", "in": "query", "description": " [optional] The maximum number of returned results per page. The default value is 20 and the maximum value is 500.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 50 }, "example": 20 }, { "name": "searchField", "in": "query", "description": "Search the result by provided keyword in the searchField.", "required": false, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "Successful information retrieval", "content": { "application/json": { "example": { "success": true, "data": { "titleList": [ { "id": 1, "displayName": "Healthcare Title 1", "displayOrder": 1 }, { "id": 2, "displayName": "Healthcare Title 2", "displayOrder": 2 } ], "filteredRecords": 5, "totalRecords": 3294 } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "examples": { "Invalid Data Provider IDs": { "description": "Invalid Data Provider IDs", "value": { "success": false, "errorObjects": [ { "error": "Invalid data provider ID/s given. Please pass valid data provider ID/s." } ] } }, "Invalid Page Number": { "description": "Invalid Page Number", "value": { "success": false, "errorObjects": [ { "error": "Invalid page number. Page number must be -1 or greater than 0." } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/audience/abm/healthcare-data/specialities": { "get": { "tags": [ "Audience API" ], "summary": "Retrieves a list of healthcare specialities based on the provided filters.", "description": "This API fetches the healthcare speciality list, filtered record count, and total record count based on the provided filters.", "operationId": "getHealthcareSpecialityList", "parameters": [ { "name": "specialityIds", "in": "query", "description": "Set of healthcare speciality IDs to filter the healthcare specialities. Comma-separated String of IDs is also allowed.", "required": false, "schema": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } } }, { "name": "audienceTypeId", "in": "query", "description": "Audience type ID to filter the healthcare specialities. It is required when dataProviderIds are passed.", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "dataProviderIds", "in": "query", "description": "List of data provider IDs to filter the healthcare data. Comma-separated String of IDs is also allowed.", "required": false, "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } }, { "name": "pageNo", "in": "query", "description": "[optional] Page number for the required data. The default value is 1. ", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 }, "example": 1 }, { "name": "noOfEntries", "in": "query", "description": " [optional] The maximum number of returned results per page. The default value is 20 and the maximum value is 500.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 50 }, "example": 20 }, { "name": "searchField", "in": "query", "description": "Search the result by provided keyword in the searchField.", "required": false, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "Successful information retrieval", "content": { "application/json": { "example": { "success": true, "data": { "specialityList": [ { "id": 1, "displayName": "Healthcare Speciality 1", "displayOrder": 1 }, { "id": 2, "displayName": "Healthcare Speciality 2", "displayOrder": 2 } ], "filteredRecords": 5, "totalRecords": 3294 } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Invalid input parameters" } ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/audience/abm/healthcare-data/healthcare-systems": { "get": { "tags": [ "Audience API" ], "summary": "Retrieves a list of healthcare systems based on the provided filters.", "description": "This API fetches the healthcare system list, filtered record count, and total record count based on the provided filters.", "operationId": "getHealthcareSystemList", "parameters": [ { "name": "healthcareSystemIds", "in": "query", "description": "List of healthcare system IDs to filter the healthcare systems. Comma-separated String of IDs is also allowed.", "required": false, "schema": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } } }, { "name": "dataProviderIds", "in": "query", "description": "List of data provider IDs to filter the healthcare data. Comma-separated String of IDs is also allowed.", "required": false, "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } }, { "name": "pageNo", "in": "query", "description": "[optional] Page number for the required data. The default value is 1. ", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 }, "example": 1 }, { "name": "noOfEntries", "in": "query", "description": " [optional] The maximum number of returned results per page. The default value is 20 and the maximum value is 500.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 50 }, "example": 20 }, { "name": "searchField", "in": "query", "description": "Search the result by provided keyword in the searchField.", "required": false, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "Successful information retrieval", "content": { "application/json": { "example": { "success": true, "data": { "healthcareSystemList": [ { "id": 1, "displayName": "Healthcare System 1", "displayOrder": 1 }, { "id": 2, "displayName": "Healthcare System 2", "displayOrder": 20 } ], "filteredRecords": 5, "totalRecords": 3294 } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "examples": { "Invalid Data Provider IDs": { "description": "Invalid Data Provider IDs", "value": { "success": false, "errorObjects": [ { "error": "Invalid data provider ID/s given. Please pass valid data provider ID/s." } ] } }, "Invalid Page Number": { "description": "Invalid Page Number", "value": { "success": false, "errorObjects": [ { "error": "Invalid page number. Page number must be -1 or greater than 0." } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/internal/audience/segmented/vertical/partners-access": { "delete": { "tags": [ "Audience API" ], "summary": "Deletes segment partner mappings for specified owIds and verticalId.", "description": "This API deletes segment partner mappings for the given organization workspace IDs (owIds) and vertical ID.\nThis API is a part of updating the vertical of a customer.\nWhen a customer is moved to a different vertical, the vertical specific segmented-partner access given to them for the previous vertical needs to be deleted.\nThe request should contain a list of owIds and the verticalId for which the segmented-partner access needs to be deleted.\nThe response will indicate whether the deletion was successful.\n", "operationId": "deleteVerticalSpecificPartnerMapping", "parameters": [ { "name": "owIds", "in": "query", "description": "Set of Organization Workspace mapping IDs representing the organizations for which the segment partner mappings are to be deleted.", "required": true, "schema": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "example": "12345,67890" }, { "name": "verticalId", "in": "query", "description": "The vertical ID for which the segment partner mappings are to be deleted.", "required": true, "schema": { "type": "integer", "format": "int32" }, "example": 1 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Successful deletion of segment partner mappings": { "description": "Successful deletion of segment partner mappings", "value": { "success": true, "data": "Segment partner access deleted successfully." } } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "examples": { "Invalid verticalId": { "description": "Invalid verticalId", "value": { "success": false, "errorObjects": [ { "error": "Invalid vertical ID provided." } ] } }, "OW IDs not present in the input": { "description": "OW IDs not present in the input", "value": { "success": false, "errorObjects": [ { "error": "OW IDs cannot be null/empty." } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/internal/audience/abm/clear-cache": { "delete": { "tags": [ "Audience API" ], "summary": "Clear caches for health care data", "description": "This internal API will clear caches available for health care data", "operationId": "evictCaches", "responses": { "200": { "description": "Cache eviction was successful.", "content": { "application/json": { "example": { "success": true, "data": "cache evicted: [healthCareDataStatistics, healthCareDataStatistics], cache does not exists: []" } } } } } } }, "/api/v3/audience": { "delete": { "tags": [ "Audience API" ], "summary": "Delete multiple audiences by their IDs", "description": "This API allows deletion of multiple audiences by providing their IDs as query parameters. The API processes each audience ID individually and returns the list of successfully deleted and failed audience IDs. Users can only delete audiences they have appropriate permissions for.", "operationId": "deleteAudiences", "parameters": [ { "name": "audienceIds", "in": "query", "required": true, "schema": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "Audiences deletion completed successfully", "content": { "application/json": { "examples": { "Successful deletion of all audiences": { "description": "All provided audience IDs were successfully deleted", "value": { "success": true, "data": { "successfulAudienceIds": [123456, 123457], "failedAudienceIds": [] } } }, "Partial deletion success": { "description": "Some audiences were deleted successfully while others failed", "value": { "success": true, "data": { "successfulAudienceIds": [123456], "failedAudienceIds": [123457, 123458] } } }, "No audiences deleted": { "description": "All audience deletion attempts failed", "value": { "success": true, "data": { "successfulAudienceIds": [], "failedAudienceIds": [123456, 123457, 123458] } } } } } } }, "400": { "description": "Bad Request - Invalid request parameters", "content": { "application/json": { "examples": { "Missing audience IDs": { "description": "No audience IDs provided in the request", "value": { "success": false, "errorObjects": [ { "error": "Missing required parameter: 'audienceIds'. Type: Set", "field": "audienceIds" } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v2/validate/bulkLocations": { "post": { "tags": [ "Campaign API" ], "summary": "Validate and Save Bulk Locations", "operationId": "ValidateandSaveBulkLocations", "parameters": [], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { }, "schema": { "required": [ "countryShortName", "stateShortNames", "locationFile", "campaignId", "fileType" ], "type": "object", "properties": { "countryShortName": { "type": "string", "description": "Country code", "example": "US" }, "stateShortNames": { "type": "string", "description": "Optional Comma separated State codes", "example": "NC" }, "locationFile": { "type": "string" }, "campaignId": { "type": "string", "description": "Optional campaign ID in edit campaign request" }, "fileType": { "type": "string", "description": "Optional fileType param, Allowed values : location, address and kml. default value - location", "example": "location" } } } } }, "required": false }, "responses": { "201": { "description": "Created", "headers": { }, "content": { "application/json": { "schema": { "title": "201Created", "required": [ "statusCode", "responseObject" ], "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "responseObject": { "title": "ResponseObject2", "required": [ "data", "message" ], "type": "object", "properties": { "data": { "title": "Data", "required": [ "validLocations", "fileId" ], "type": "object", "properties": { "validLocations": { "type": "array", "items": { "title": "ValidLocation", "required": [ "latitude", "longitude", "radius", "address", "stateShortName", "countryShortName", "locationId", "rejectionReason", "polypath", "placemarkName" ], "type": "object", "properties": { "latitude": { "type": "number" }, "longitude": { "type": "number" }, "radius": { "oneOf": [ { "type": "integer", "format": "int32" }, { "type": "number" } ] }, "address": { "type": "string" }, "stateShortName": { "type": "string" }, "countryShortName": { "type": "string" }, "locationId": { "type": "integer", "format": "int32" }, "rejectionReason": { "type": "string", "nullable": true }, "polypath": { "type": "string", "nullable": true }, "placemarkName": { "type": "string", "nullable": true } } }, "description": "" }, "fileId": { "type": "integer", "format": "int32" } } }, "message": { "type": "string" } } } } } } } }, "400": { "description": "Bad Request", "headers": { }, "content": { "application/json": { "schema": { "title": "400Badrequest1", "required": [ "statusCode", "responseObject" ], "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "responseObject": { "title": "ResponseObject", "required": [ "errorMsg", "errorCode" ], "type": "object", "properties": { "errorMsg": { "type": "string" }, "errorCode": { "type": "integer", "format": "int32" } }, "example": { "errorMsg": "CSV file is not in proper format, Please attach a file having latitude, longitude and radius columns", "errorCode": 400 } } }, "example": { "statusCode": 400, "responseObject": { "errorMsg": "CSV file is not in proper format, Please attach a file having latitude, longitude and radius columns", "errorCode": 400 } } }, "example": { "statusCode": 400, "responseObject": { "errorMsg": "CSV file is not in proper format, Please attach a file having latitude, longitude and radius columns", "errorCode": 400 } } } } } }, "deprecated": false, "servers": [ { "url": "http://example.com/api", "variables": { } } ] } }, "/api/v2/cmp/invalidLocations/{fileId}/dismiss": { "delete": { "tags": [ "Campaign API" ], "summary": "Dismiss Invalid location from location file", "operationId": "DismissInvalidlocationfromlocationfile", "parameters": [ { "name": "x-iaa-api-token", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "{{advertiser_api_token}}" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string", "example": "application/json" } }, { "name": "fileId", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": { }, "content": { "application/json": { "schema": { "title": "200OK", "required": [ "statusCode", "responseObject" ], "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "responseObject": { "title": "ResponseObject3", "required": [ "message" ], "type": "object", "properties": { "message": { "type": "string" } }, "example": { "message": "Invalid locations dismissed successfully" } } }, "example": { "statusCode": 200, "responseObject": { "message": "Invalid locations dismissed successfully" } } }, "example": { "statusCode": 200, "responseObject": { "message": "Invalid locations dismissed successfully" } } } } } }, "deprecated": false, "servers": [ { "url": "http://example.com/api", "variables": { } } ] } }, "/api/v2/cmp/invalidLocations/{fileId}/download": { "get": { "tags": [ "Campaign API" ], "summary": "Download Invalid location from location file", "operationId": "DownloadInvalidlocationfromlocationfile", "parameters": [ { "name": "x-iaa-api-token", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "{{advertiser_api_token}}" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string", "example": "application/json" } }, { "name": "fileId", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": { }, "content": { "text/plain": { "schema": { "type": "string", "example": "latitude,longitude,radius,rejection reason\n35.3535,-78.7878,0.0,Invalid Radius\n34.0265,-78.2897,1.0,Address is non existent\n23.030357,72.517845,1.5,Country or State is Invalid" }, "example": "latitude,longitude,radius,rejection reason\n35.3535,-78.7878,0.0,Invalid Radius\n34.0265,-78.2897,1.0,Address is non existent\n23.030357,72.517845,1.5,Country or State is Invalid" } } } }, "deprecated": false, "servers": [ { "url": "http://example.com/api", "variables": { } } ] } }, "/api/v2/cmp/campaigns/data": { "get": { "tags": [ "Campaign API" ], "summary": "Get campaign data", "description": "This API returns list of campaigns based on provided filters. If conversionId provided in request then it will return targeted campaign on top in list", "operationId": "Getcampaigndata", "parameters": [ { "name": "searchField", "in": "query", "description": "Search by id/name", "required": true, "style": "form", "explode": true, "schema": { "type": "string", "example": "test" } }, { "name": "pageNo", "in": "query", "description": "page number", "required": true, "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32", "example": 1 } }, { "name": "limit", "in": "query", "description": "no of records in each page", "required": true, "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32", "example": 50 } }, { "name": "sortBy", "in": "query", "description": "Sort by fields. Here minus(-) sign is for order DESC and plus(+) is for order ASC. Value can be from created, name, id, status,modifiedDate default value : -created", "required": true, "style": "form", "explode": true, "schema": { "type": "string", "example": "+name" } }, { "name": "conversionId", "in": "query", "description": "If provided API will return targeted campaign at top", "required": true, "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32", "example": 18 } }, { "name": "status", "in": "query", "description": "Filter by multiple status", "required": true, "style": "form", "explode": true, "schema": { "type": "string", "example": "pending,running" } }, { "name": "owIds", "in": "query", "description": "Filter by ow Ids", "required": true, "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32", "example": 100289 } }, { "name": "X-IAA-OW-ID", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32", "example": 1 } }, { "name": "X-Iaa-Host", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "app.stage.inhousebuying.com" } }, { "name": "authorization", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "{{bearer_token}}" } } ], "responses": { "200": { "description": "OK", "headers": { }, "content": { "application/json": { "schema": { "title": "m200", "required": [ "statusCode", "responseObject" ], "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "responseObject": { "title": "ResponseObject4", "required": [ "totalRecords", "data", "filteredRecords" ], "type": "object", "properties": { "totalRecords": { "type": "integer", "format": "int32" }, "data": { "type": "array", "items": { "title": "Data1", "required": [ "id", "name", "creativeTypeId", "campaignType", "status", "advertiserId", "created", "modifiedDate" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "creativeTypeId": { "type": "integer", "format": "int32" }, "campaignType": { "type": "string" }, "status": { "type": "string" }, "advertiserId": { "type": "integer", "format": "int32" }, "created": { "type": "integer", "format": "int32" }, "modifiedDate": { "type": "integer", "format": "int32" }, "conversionId": { "type": "integer", "format": "int32" } }, "example": { "id": 176881, "name": "Campaign to test duplicate copy", "creativeTypeId": 14, "campaignType": "CPV", "status": "pending", "advertiserId": 100419, "created": 1620024156, "modifiedDate": 1621571575, "conversionId": 18 } }, "description": "" }, "filteredRecords": { "type": "integer", "format": "int32" } }, "example": { "totalRecords": 1498, "data": [ { "id": 176881, "name": "Campaign to test duplicate copy", "creativeTypeId": 14, "campaignType": "CPV", "status": "pending", "advertiserId": 100419, "created": 1620024156, "modifiedDate": 1621571575, "conversionId": 18 }, { "id": 176880, "name": "Campaign to test duplicate update", "creativeTypeId": 14, "campaignType": "CPV", "status": "pending", "advertiserId": 100419, "created": 1620024050, "modifiedDate": 1621571575, "conversionId": 18 }, { "id": 176879, "name": "to test campaign duplication", "creativeTypeId": 11, "campaignType": "CPM", "status": "pending", "advertiserId": 100419, "created": 1620023582, "modifiedDate": 1620024188 }, { "id": 176148, "name": "campaign to test inventory group and all device type", "creativeTypeId": 11, "campaignType": "CPM", "status": "pending", "advertiserId": 100419, "created": 1618990887, "modifiedDate": 1618992828 }, { "id": 173357, "name": "test cb", "creativeTypeId": 11, "campaignType": "CPM", "status": "running", "advertiserId": 100001, "created": 1617170692, "modifiedDate": 1619433624 }, { "id": 173353, "name": "test cb", "creativeTypeId": 11, "campaignType": "CPM", "status": "running", "advertiserId": 100001, "created": 1617163055, "modifiedDate": 1619433624 }, { "id": 173318, "name": "test cb1", "creativeTypeId": 11, "campaignType": "CPM", "status": "running", "advertiserId": 100001, "created": 1617130075, "modifiedDate": 1619433624 }, { "id": 173317, "name": "test cb", "creativeTypeId": 11, "campaignType": "CPM", "status": "running", "advertiserId": 100001, "created": 1617126490, "modifiedDate": 1619433624 }, { "id": 173316, "name": "test old cb", "creativeTypeId": 11, "campaignType": "CPM", "status": "running", "advertiserId": 100001, "created": 1617125771, "modifiedDate": 1619433624 }, { "id": 169459, "name": "test daily", "creativeTypeId": 11, "campaignType": "CPM", "status": "pending", "advertiserId": 100419, "created": 1611734667, "modifiedDate": 1618992828 } ], "filteredRecords": 1039 } } }, "example": { "statusCode": 200, "responseObject": { "totalRecords": 1498, "data": [ { "id": 176881, "name": "Campaign to test duplicate copy", "creativeTypeId": 14, "campaignType": "CPV", "status": "pending", "advertiserId": 100419, "created": 1620024156, "modifiedDate": 1621571575, "conversionId": 18 }, { "id": 176880, "name": "Campaign to test duplicate update", "creativeTypeId": 14, "campaignType": "CPV", "status": "pending", "advertiserId": 100419, "created": 1620024050, "modifiedDate": 1621571575, "conversionId": 18 }, { "id": 176879, "name": "to test campaign duplication", "creativeTypeId": 11, "campaignType": "CPM", "status": "pending", "advertiserId": 100419, "created": 1620023582, "modifiedDate": 1620024188 }, { "id": 176148, "name": "campaign to test inventory group and all device type", "creativeTypeId": 11, "campaignType": "CPM", "status": "pending", "advertiserId": 100419, "created": 1618990887, "modifiedDate": 1618992828 }, { "id": 173357, "name": "test cb", "creativeTypeId": 11, "campaignType": "CPM", "status": "running", "advertiserId": 100001, "created": 1617170692, "modifiedDate": 1619433624 }, { "id": 173353, "name": "test cb", "creativeTypeId": 11, "campaignType": "CPM", "status": "running", "advertiserId": 100001, "created": 1617163055, "modifiedDate": 1619433624 }, { "id": 173318, "name": "test cb1", "creativeTypeId": 11, "campaignType": "CPM", "status": "running", "advertiserId": 100001, "created": 1617130075, "modifiedDate": 1619433624 }, { "id": 173317, "name": "test cb", "creativeTypeId": 11, "campaignType": "CPM", "status": "running", "advertiserId": 100001, "created": 1617126490, "modifiedDate": 1619433624 }, { "id": 173316, "name": "test old cb", "creativeTypeId": 11, "campaignType": "CPM", "status": "running", "advertiserId": 100001, "created": 1617125771, "modifiedDate": 1619433624 }, { "id": 169459, "name": "test daily", "creativeTypeId": 11, "campaignType": "CPM", "status": "pending", "advertiserId": 100419, "created": 1611734667, "modifiedDate": 1618992828 } ], "filteredRecords": 1039 } } }, "example": { "statusCode": 200, "responseObject": { "totalRecords": 1498, "data": [ { "id": 176881, "name": "Campaign to test duplicate copy", "creativeTypeId": 14, "campaignType": "CPV", "status": "pending", "advertiserId": 100419, "created": 1620024156, "modifiedDate": 1621571575, "conversionId": 18 }, { "id": 176880, "name": "Campaign to test duplicate update", "creativeTypeId": 14, "campaignType": "CPV", "status": "pending", "advertiserId": 100419, "created": 1620024050, "modifiedDate": 1621571575, "conversionId": 18 }, { "id": 176879, "name": "to test campaign duplication", "creativeTypeId": 11, "campaignType": "CPM", "status": "pending", "advertiserId": 100419, "created": 1620023582, "modifiedDate": 1620024188 }, { "id": 176148, "name": "campaign to test inventory group and all device type", "creativeTypeId": 11, "campaignType": "CPM", "status": "pending", "advertiserId": 100419, "created": 1618990887, "modifiedDate": 1618992828 }, { "id": 173357, "name": "test cb", "creativeTypeId": 11, "campaignType": "CPM", "status": "running", "advertiserId": 100001, "created": 1617170692, "modifiedDate": 1619433624 }, { "id": 173353, "name": "test cb", "creativeTypeId": 11, "campaignType": "CPM", "status": "running", "advertiserId": 100001, "created": 1617163055, "modifiedDate": 1619433624 }, { "id": 173318, "name": "test cb1", "creativeTypeId": 11, "campaignType": "CPM", "status": "running", "advertiserId": 100001, "created": 1617130075, "modifiedDate": 1619433624 }, { "id": 173317, "name": "test cb", "creativeTypeId": 11, "campaignType": "CPM", "status": "running", "advertiserId": 100001, "created": 1617126490, "modifiedDate": 1619433624 }, { "id": 173316, "name": "test old cb", "creativeTypeId": 11, "campaignType": "CPM", "status": "running", "advertiserId": 100001, "created": 1617125771, "modifiedDate": 1619433624 }, { "id": 169459, "name": "test daily", "creativeTypeId": 11, "campaignType": "CPM", "status": "pending", "advertiserId": 100419, "created": 1611734667, "modifiedDate": 1618992828 } ], "filteredRecords": 1039 } } } } } }, "deprecated": false, "security": [], "servers": [ { "url": "http://example.com/api", "variables": { } } ] } }, "/api/v2/cmp/inventorygroup/{group_id}/includeExclude": { "post": { "tags": [ "Campaign API" ], "summary": "Inventory group targeting", "description": "This API will target inventory group in given campaigns.\n\nisExcluded values indicates\n\n```\n- 0 - whitelisted targeting\n- 1 - blacklisted targeting\n\n```\n\n* * *\n\n#### Request Body Detail\n\n| **Field** | **Type** | **Description** |\n| --- | --- | --- |\n| group_id | Number | group id number which we have to inlude or exlude for serving |\n| campaignIds | String | comma seprated campaign ids |\n| isExcluded | String | 0 - whitelisted targeting , 1 - blacklisted targeting |", "operationId": "Inventorygrouptargeting", "parameters": [ { "name": "X-IAA-OW-ID", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32", "example": 1 } }, { "name": "X-Iaa-Host", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "app.stage.inhousebuying.com" } }, { "name": "authorization", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "{{bearer_token}}" } }, { "name": "group_id", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "title": "InventorygrouptargetingRequest", "required": [ "campaignIds", "isExcluded" ], "type": "object", "properties": { "campaignIds": { "type": "string" }, "isExcluded": { "type": "integer", "format": "int32" } }, "example": { "campaignIds": "172813,177146", "isExcluded": 0 } }, "example": { "campaignIds": "172813,177146", "isExcluded": 0 } } }, "required": true }, "responses": { "200": { "description": "OK", "headers": { "Server": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "nginx" } } }, "Date": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "Thu, 13 May 2021 10:21:40 GMT" } } }, "Transfer-Encoding": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "chunked" } } }, "Connection": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "keep-alive" } } }, "Access-Control-Allow-Origin": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "*" } } }, "Access-Control-Expose-Headers": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "Content-Type,X-IAA-ADMIN-API-TOKEN,x-iaa-admin-api-token,x-iaa-api-token" } } }, "Access-Control-Max-Age": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "5" } } }, "Cache-Control": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "max-age=5" } } } }, "content": { "application/json;charset=UTF-8": { "schema": { "title": "200-OK1", "required": [ "statusCode", "responseObject" ], "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "responseObject": { "title": "ResponseObject3", "required": [ "message" ], "type": "object", "properties": { "message": { "type": "string" } }, "example": { "message": "Invalid locations dismissed successfully" } } }, "example": { "statusCode": 200, "responseObject": { "message": "Inventory Group excluded successfully." } } }, "example": { "statusCode": 200, "responseObject": { "message": "Inventory Group excluded successfully." } } } } } }, "deprecated": false, "security": [], "servers": [ { "url": "http://example.com/api", "variables": { } } ] } }, "/api/v3/cmp/campaign/update-name/{campaign_id}": { "patch": { "tags": [ "Campaign API" ], "summary": "Update Campaign Name", "description": "This API updates only campaign name.\n\n* * *\n\n#### Request Body Detail\n\n| **Field** | **Type** | **Description** |\n| --- | --- | --- |\n| campaignName | String | campaign name |", "operationId": "UpdateCampaignName", "parameters": [ { "name": "Authorization", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "{{bearer_token}}" } }, { "name": "X-Iaa-Host", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "app.stage.inhousebuying.com" } }, { "name": "X-IAA-OW-ID", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32", "example": 200001 } }, { "name": "campaign_id", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "title": "UpdateCampaignNameRequest", "required": [ "campaignName" ], "type": "object", "properties": { "campaignName": { "type": "string" } }, "example": { "campaignName": "Name Edit Test" } }, "example": { "campaignName": "Name Edit Test" } } }, "required": true }, "responses": { "200": { "description": "OK", "headers": { "X-Content-Type-Options": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "nosniff" } } }, "X-XSS-Protection": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "1; mode=block" } } }, "Cache-Control": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "no-cache, no-store, max-age=0, must-revalidate" } } }, "Pragma": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "no-cache" } } }, "Expires": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "0" } } }, "X-Frame-Options": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "DENY" } } }, "Transfer-Encoding": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "chunked" } } }, "Date": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "Tue, 28 Sep 2021 13:48:15 GMT" } } } }, "content": { "application/json;charset=UTF-8": { "schema": { "title": "OK", "required": [ "success", "data" ], "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "title": "Data2", "required": [ "message" ], "type": "object", "properties": { "message": { "type": "string" } }, "example": { "message": "campaignName updated successfully" } } }, "example": { "success": true, "data": { "message": "campaignName updated successfully" } } }, "example": { "success": true, "data": { "message": "campaignName updated successfully" } } } } } }, "deprecated": false, "security": [], "servers": [ { "url": "http://example.com/api", "variables": { } } ] } }, "/api/v2/cmp/campaigns/list": { "get": { "tags": [ "Campaign API" ], "summary": "Get Campaign List", "description": "This API returns paginated list of campaign with its basic details and with total and filtered count.\n\n* * *\n\n### Supported Features:\n\n1. Pagination\n2. Sorting\n3. Search by name or id\n4. Filter by status, creative type, and time of creative creation", "operationId": "GetCampaignList", "parameters": [ { "name": "creative_type_ids", "in": "query", "description": "filter by creative type id", "required": true, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "created_time_of_creative", "in": "query", "description": "greater than creative created time filter", "required": true, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "sort_by", "in": "query", "description": "sorting by column", "required": true, "style": "form", "explode": true, "schema": { "type": "string", "example": "id" } }, { "name": "order", "in": "query", "description": "sorting order `asc` or `desc`", "required": true, "style": "form", "explode": true, "schema": { "type": "string", "example": "desc" } }, { "name": "no_of_entries", "in": "query", "description": "total number of entries", "required": true, "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32", "example": 50 } }, { "name": "pgno", "in": "query", "description": "page number in pagination", "required": true, "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32", "example": 1 } }, { "name": "search_field", "in": "query", "description": "search by id or name", "required": true, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "filtered with campaign status\nCan be from `running`, `pending`, `paused`, `draft`, `rejected`, `expired`", "required": true, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "ow_ids", "in": "query", "description": "comma separated ow Ids", "required": true, "style": "form", "explode": true, "schema": { "type": "string", "example": "1000,1001" } }, { "name": "X-IAA-OW-ID", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32", "example": 200001 } }, { "name": "x-iaa-host", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "app.stage.inhousebuying.com" } }, { "name": "authorization", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "{{bearer_token}}" } } ], "responses": { "default": { "description": "", "headers": { }, "content": { "application/json": { "schema": { "title": "200-OK2", "required": [ "statusCode", "recordsTotal", "pageNumber", "pageSize", "draw", "recordsFiltered", "data" ], "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "recordsTotal": { "type": "integer", "format": "int32" }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "draw": { "type": "integer", "format": "int32" }, "recordsFiltered": { "type": "integer", "format": "int32" }, "data": { "type": "array", "items": { "title": "Data3", "required": [ "id", "name", "status", "owId", "uowId", "advertiser_email", "advertiser_id", "campaign_type", "creative_type", "dsp_id", "start_date", "end_date", "creative_type_id", "total_budget" ], "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "status": { "type": "string" }, "owId": { "type": "integer", "format": "int32" }, "uowId": { "type": "integer", "format": "int32" }, "advertiser_email": { "type": "string", "nullable": true }, "advertiser_id": { "type": "integer", "format": "int32" }, "campaign_type": { "type": "string" }, "creative_type": { "type": "string" }, "dsp_id": { "type": "integer", "format": "int32" }, "start_date": { "type": "integer", "format": "int32" }, "end_date": { "type": "integer", "format": "int32" }, "creative_type_id": { "type": "integer", "format": "int32" }, "total_budget": { "type": "number" } }, "example": { "id": "214269", "name": "Name Edit Test_UI", "status": "pending", "owId": 1000, "uowId": 1, "advertiser_email": null, "advertiser_id": 0, "campaign_type": "CPM", "creative_type": "HTML", "dsp_id": 0, "start_date": 1632873600, "end_date": 1632829200, "creative_type_id": 13, "total_budget": 1000 } }, "description": "" } }, "example": { "statusCode": 200, "recordsTotal": 1, "pageNumber": 1, "pageSize": 50, "draw": 0, "recordsFiltered": 1, "data": [ { "id": "214269", "name": "Name Edit Test_UI", "status": "pending", "owId": 1000, "uowId": 1, "advertiser_email": null, "advertiser_id": 0, "campaign_type": "CPM", "creative_type": "HTML", "dsp_id": 0, "start_date": 1632873600, "end_date": 1632829200, "creative_type_id": 13, "total_budget": 1000 } ] } }, "example": { "statusCode": 200, "recordsTotal": 1, "pageNumber": 1, "pageSize": 50, "draw": 0, "recordsFiltered": 1, "data": [ { "id": "214269", "name": "Name Edit Test_UI", "status": "pending", "owId": 1000, "uowId": 1, "advertiser_email": null, "advertiser_id": 0, "campaign_type": "CPM", "creative_type": "HTML", "dsp_id": 0, "start_date": 1632873600, "end_date": 1632829200, "creative_type_id": 13, "total_budget": 1000 } ] } } } } }, "deprecated": false, "security": [], "servers": [ { "url": "http://example.com/api", "variables": { } } ] } }, "/api/v2/cmp/campaigngroup/remove": { "delete": { "tags": [ "Campaign API" ], "summary": "Remove Campaign group", "description": "This API deleted campaign group and its association with campaign.", "operationId": "RemoveCampaigngroup", "parameters": [ { "name": "ids", "in": "query", "description": "", "required": true, "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32", "example": 107937 } }, { "name": "Authorization", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "{{bearer_token}}" } }, { "name": "X-IAA-OW-ID", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "{{ow_id}}" } } ], "responses": { "200": { "description": "", "headers": { }, "content": { "application/json": { "schema": { "title": "RemoveCampaigngroup", "required": [ "statusCode", "responseObject" ], "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "responseObject": { "title": "ResponseObject3", "required": [ "message" ], "type": "object", "properties": { "message": { "type": "string" } }, "example": { "message": "Invalid locations dismissed successfully" } } }, "example": { "statusCode": 200, "responseObject": { "message": "Campaign group deleted successfully." } } }, "example": { "statusCode": 200, "responseObject": { "message": "Campaign group deleted successfully." } } } } } }, "deprecated": false, "security": [], "servers": [ { "url": "http://example.com/api", "variables": { } } ] } }, "/api/v2/adv/politicalclient/details": { "get": { "tags": [ "Campaign API" ], "summary": "Get Advertiser Details by Id", "operationId": "GetAdvertiserDetailsbyId", "parameters": [ { "name": "advertiserId", "in": "query", "description": "", "required": true, "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32", "example": 1 } }, { "name": "Authorization", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "{{bearer_token}}" } }, { "name": "X-Iaa-Host", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "iqm.stage.inhousebuying.com" } }, { "name": "X-IAA-OW-ID", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32", "example": 200002 } } ], "responses": { "200": { "description": "OK", "headers": { "X-Content-Type-Options": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "nosniff" } } }, "X-XSS-Protection": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "1; mode=block" } } }, "Cache-Control": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "no-cache, no-store, max-age=0, must-revalidate" } } }, "Pragma": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "no-cache" } } }, "Expires": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "0" } } }, "X-Frame-Options": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "DENY" } } }, "Transfer-Encoding": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "chunked" } } }, "Date": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "Wed, 03 Nov 2021 09:48:09 GMT" } } } }, "content": { "application/json;charset=UTF-8": { "schema": { "title": "OK1", "required": [ "statusCode", "responseObject" ], "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "responseObject": { "title": "ResponseObject21", "required": [ "advertiserId", "dspId", "owId", "uowId", "id", "name", "address", "phone", "website", "chiefName", "legalInfo", "isActive", "uuid", "links" ], "type": "object", "properties": { "advertiserId": { "type": "integer", "format": "int32" }, "dspId": { "type": "integer", "format": "int32" }, "owId": { "type": "integer", "format": "int32" }, "uowId": { "type": "integer", "format": "int32" }, "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "address": { "type": "string", "nullable": true }, "phone": { "type": "string" }, "website": { "type": "string" }, "chiefName": { "type": "string" }, "legalInfo": { "type": "string", "nullable": true }, "isActive": { "type": "integer", "format": "int32" }, "uuid": { "type": "string" }, "links": { "type": "string", "nullable": true } }, "example": { "advertiserId": 0, "dspId": 0, "owId": 0, "uowId": 0, "id": 1, "name": "Nikon", "address": null, "phone": "+91 9999999999", "website": "http://nikonindia.com", "chiefName": "Nil Miles", "legalInfo": null, "isActive": 0, "uuid": "40e6215d-b5c6-4896-987c-f30f3678f608", "links": null } } }, "example": { "statusCode": 200, "responseObject": { "advertiserId": 0, "dspId": 0, "owId": 0, "uowId": 0, "id": 1, "name": "Nikon", "address": null, "phone": "+91 9999999999", "website": "http://nikonindia.com", "chiefName": "Nil Miles", "legalInfo": null, "isActive": 0, "uuid": "40e6215d-b5c6-4896-987c-f30f3678f608", "links": null } } }, "example": { "statusCode": 200, "responseObject": { "advertiserId": 0, "dspId": 0, "owId": 0, "uowId": 0, "id": 1, "name": "Nikon", "address": null, "phone": "+91 9999999999", "website": "http://nikonindia.com", "chiefName": "Nil Miles", "legalInfo": null, "isActive": 0, "uuid": "40e6215d-b5c6-4896-987c-f30f3678f608", "links": null } } } } } }, "deprecated": false, "security": [], "servers": [ { "url": "http://example.com/api", "variables": { } } ] } }, "/api/v2/cmp/campaign/listByInventorygroup/{group_id}": { "get": { "tags": [ "Campaign API" ], "summary": "list by inventory group", "description": "List of campaign for inventory group targeting\n\n* * *\n\n### Supported Features:\n\n1. Pagination\n2. Search by name or id\n3. Filter for returning targeted or non targeted campaigns.\n \n\n* * *", "operationId": "listbyinventorygroup", "parameters": [ { "name": "searchField", "in": "query", "description": "search by id or name", "required": true, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "noOfEntries", "in": "query", "description": "number of records required", "required": true, "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32", "example": 10 } }, { "name": "pageNo", "in": "query", "description": "page number", "required": true, "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32", "example": 1 } }, { "name": "provideOnlyTargetedCampaigns", "in": "query", "description": "1- only targeted campaigns list ,0- all campaigns", "required": true, "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32", "example": 0 } }, { "name": "X-IAA-OW-ID", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32", "example": 1 } }, { "name": "X-Iaa-Host", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "app.stage.inhousebuying.com" } }, { "name": "authorization", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "{{bearer_token}}" } }, { "name": "group_id", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": { "Server": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "nginx" } } }, "Date": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "Thu, 13 May 2021 11:01:56 GMT" } } }, "Transfer-Encoding": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "chunked" } } }, "Connection": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "keep-alive" } } }, "Access-Control-Allow-Origin": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "*" } } }, "Access-Control-Expose-Headers": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "Content-Type,X-IAA-ADMIN-API-TOKEN,x-iaa-admin-api-token,x-iaa-api-token" } } }, "Access-Control-Max-Age": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "5" } } }, "Cache-Control": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "max-age=5" } } } }, "content": { "application/json;charset=UTF-8": { "schema": { "title": "200-OK3", "required": [ "statusCode", "responseObject" ], "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "responseObject": { "title": "ResponseObject23", "required": [ "totalRecords", "data", "filteredRecords" ], "type": "object", "properties": { "totalRecords": { "type": "integer", "format": "int32" }, "data": { "type": "array", "items": { "title": "Data4", "required": [ "id", "name", "included", "excluded", "status", "created" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "included": { "type": "integer", "format": "int32" }, "excluded": { "type": "integer", "format": "int32" }, "status": { "type": "string" }, "created": { "type": "integer", "format": "int32" } }, "example": { "id": 68304, "name": "test budget", "included": 0, "excluded": 0, "status": "pending", "created": 1598966720 } }, "description": "" }, "filteredRecords": { "type": "integer", "format": "int32" } }, "example": { "totalRecords": 49, "data": [ { "id": 68304, "name": "test budget", "included": 0, "excluded": 0, "status": "pending", "created": 1598966720 } ], "filteredRecords": 1 } } }, "example": { "statusCode": 200, "responseObject": { "totalRecords": 49, "data": [ { "id": 68304, "name": "test budget", "included": 0, "excluded": 0, "status": "pending", "created": 1598966720 } ], "filteredRecords": 1 } } }, "example": { "statusCode": 200, "responseObject": { "totalRecords": 49, "data": [ { "id": 68304, "name": "test budget", "included": 0, "excluded": 0, "status": "pending", "created": 1598966720 } ], "filteredRecords": 1 } } } } } }, "deprecated": false, "security": [], "servers": [ { "url": "http://example.com/api", "variables": { } } ] } }, "/api/v2/cmp/campaign/budgetInfo": { "get": { "tags": [ "Campaign API" ], "summary": "Campaign Budget Info", "description": "Get campaign budget info and graph details.", "operationId": "CampaignBudgetInfo", "parameters": [ { "name": "budgetTotal", "in": "query", "description": "Campaign total budget \n(**Note** - can be null if fixed daily budget, start time & end time is provided)", "required": true, "style": "form", "explode": true, "schema": { "type": "number", "format": "double", "example": 30000 } }, { "name": "dailyBudget", "in": "query", "description": "Campaign daily budget \n(**Note** - can be null if total budget, start time & end time is provided)", "required": true, "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32", "example": 7000 } }, { "name": "fixedDailyBudget", "in": "query", "description": "Flag to indicate whether daily budget is fixed or not", "required": true, "style": "form", "explode": true, "schema": { "type": "boolean", "example": true } }, { "name": "startTime", "in": "query", "description": "Campaign start time [**Required**]", "required": true, "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32", "example": 1611057600 } }, { "name": "endTime", "in": "query", "description": "Campaign end time \n(**Note** - can be null if total budget, start time & fixed daily budget is provided)", "required": true, "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32", "example": 1611489600 } }, { "name": "timezone", "in": "query", "description": "Campaign timezone id [**Required**]", "required": true, "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32", "example": 371 } }, { "name": "X-IAA-OW-ID", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32", "example": 1 } }, { "name": "X-Iaa-Host", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "app.stage.inhousebuying.com" } }, { "name": "authorization", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "{{bearer_token}}" } } ], "responses": { "200": { "description": "OK", "headers": { }, "content": { "application/json": { "schema": { "title": "CampaignBudgetInfo", "required": [ "statusCode", "responseObject" ], "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "responseObject": { "title": "ResponseObject24", "required": [ "campaignId", "budgetTotal", "actualSpent", "dailyBudget", "fixedDailyBudget", "startTime", "endTime", "timezone", "graphInfo" ], "type": "object", "properties": { "campaignId": { "type": "integer", "format": "int32" }, "budgetTotal": { "type": "number" }, "actualSpent": { "type": "number" }, "dailyBudget": { "type": "number" }, "fixedDailyBudget": { "type": "boolean" }, "startTime": { "type": "integer", "format": "int32" }, "endTime": { "type": "integer", "format": "int32" }, "timezone": { "type": "integer", "format": "int32" }, "graphInfo": { "type": "array", "items": { "title": "GraphInfo", "required": [ "date", "amount", "type" ], "type": "object", "properties": { "date": { "type": "string" }, "amount": { "type": "number" }, "type": { "type": "string" } }, "example": { "date": "2021-01-08T18:30:00.000+0000", "amount": 131.0083085876, "type": "spent" } }, "description": "" } }, "example": { "campaignId": 168930, "budgetTotal": 30000, "actualSpent": 0, "dailyBudget": 5000, "fixedDailyBudget": false, "startTime": 1610211600, "endTime": 1610686800, "timezone": 371, "graphInfo": [ { "date": "2021-01-08T18:30:00.000+0000", "amount": 131.0083085876, "type": "spent" }, { "date": "2021-01-09T18:30:00.000+0000", "amount": 86.1821112588, "type": "spent" }, { "date": "2021-01-10T18:30:00.000+0000", "amount": 127.3163672232, "type": "spent" }, { "date": "2021-01-11T18:30:00.000+0000", "amount": 9885.01, "type": "projected" }, { "date": "2021-01-12T18:30:00.000+0000", "amount": 9885.01, "type": "projected" }, { "date": "2021-01-13T18:30:00.000+0000", "amount": 9885.01, "type": "projected" } ] } } }, "example": { "statusCode": 200, "responseObject": { "campaignId": 168930, "budgetTotal": 30000, "actualSpent": 0, "dailyBudget": 5000, "fixedDailyBudget": false, "startTime": 1610211600, "endTime": 1610686800, "timezone": 371, "graphInfo": [ { "date": "2021-01-08T18:30:00.000+0000", "amount": 131.0083085876, "type": "spent" }, { "date": "2021-01-09T18:30:00.000+0000", "amount": 86.1821112588, "type": "spent" }, { "date": "2021-01-10T18:30:00.000+0000", "amount": 127.3163672232, "type": "spent" }, { "date": "2021-01-11T18:30:00.000+0000", "amount": 9885.01, "type": "projected" }, { "date": "2021-01-12T18:30:00.000+0000", "amount": 9885.01, "type": "projected" }, { "date": "2021-01-13T18:30:00.000+0000", "amount": 9885.01, "type": "projected" } ] } } }, "example": { "statusCode": 200, "responseObject": { "campaignId": 168930, "budgetTotal": 30000, "actualSpent": 0, "dailyBudget": 5000, "fixedDailyBudget": false, "startTime": 1610211600, "endTime": 1610686800, "timezone": 371, "graphInfo": [ { "date": "2021-01-08T18:30:00.000+0000", "amount": 131.0083085876, "type": "spent" }, { "date": "2021-01-09T18:30:00.000+0000", "amount": 86.1821112588, "type": "spent" }, { "date": "2021-01-10T18:30:00.000+0000", "amount": 127.3163672232, "type": "spent" }, { "date": "2021-01-11T18:30:00.000+0000", "amount": 9885.01, "type": "projected" }, { "date": "2021-01-12T18:30:00.000+0000", "amount": 9885.01, "type": "projected" }, { "date": "2021-01-13T18:30:00.000+0000", "amount": 9885.01, "type": "projected" } ] } } } } } }, "deprecated": false, "security": [], "servers": [ { "url": "http://example.com/api", "variables": { } } ] } }, "/api/v2/cmp/campaigns/update-end-date": { "put": { "tags": [ "Campaign API" ], "summary": "Campaign end date update", "description": "This api updates end date of multiple campaign. This can only be accessible by advertiser users as of now.\n\n***\n#### Request Body Detail\n| **Field** | **Type** | **Description** |\n|-----------------------|---------------|---------------------------------------------------| \n|campaignIds |String |Comma separated campaign ids|\n|endDate|Number|end date epoch time in seconds|", "operationId": "Campaignenddateupdate", "parameters": [ { "name": "X-IAA-OW-ID", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32", "example": 1 } }, { "name": "X-Iaa-Host", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "app.stage.inhousebuying.com" } }, { "name": "authorization", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "{{bearer_token}}" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "title": "CampaignenddateupdateRequest", "required": [ "endDate", "campaignIds" ], "type": "object", "properties": { "endDate": { "type": "integer", "format": "int32" }, "campaignIds": { "type": "integer", "format": "int32" } }, "example": { "endDate": 1632132540, "campaignIds": 192476 } }, "example": { "endDate": 1632132540, "campaignIds": 192476 } } }, "required": true }, "responses": { "200": { "description": "OK", "headers": { }, "content": { "application/json": { "schema": { "title": "200-OK4", "required": [ "statusCode", "responseObject" ], "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "responseObject": { "title": "ResponseObject25", "required": [ "status" ], "type": "object", "properties": { "status": { "type": "boolean" } }, "example": { "status": true } } }, "example": { "statusCode": 200, "responseObject": { "status": true } } }, "example": { "statusCode": 200, "responseObject": { "status": true } } } } } }, "deprecated": false, "security": [], "servers": [ { "url": "http://example.com/api", "variables": { } } ] } }, "/api/v2/cmp/campaigns/update-budget": { "put": { "tags": [ "Campaign API" ], "summary": "Campaign budget update", "description": "This api updates total budget, daily budget, max bid of multiple campaigns.\n\n***\n#### Request Body Detail\n| **Field** | **Type** | **Description** |\n|-----------------------|---------------|---------------------------------------------------| \n|campaignIds |String |Comma separated campaign ids|\n|maxBid |Number |max bid of campaign|\n|totalBudget |Number | total budget|\n|dailyBudget |Number | daily budget|\n|totalBudgetUpdateType |String | It is used in case of total budget update. There are three possibilities for this parameter.\u003C/br\u003E `change` : It will replace total budget with given value.\u003C/br\u003E `addition` : It will add budget to the current total budget.\u003C/br\u003E `distribution`: It will distribute given total budget in selected campaigns equally.\u003C/br\u003EDefault value: `change`|", "operationId": "Campaignbudgetupdate", "parameters": [ { "name": "X-IAA-OW-ID", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32", "example": 1 } }, { "name": "X-Iaa-Host", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "app.stage.inhousebuying.com" } }, { "name": "authorization", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "{{bearer_token}}" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "title": "CampaignbudgetupdateRequest", "required": [ "totalBudgetUpdateType", "campaignIds", "dailyBudget" ], "type": "object", "properties": { "totalBudgetUpdateType": { "type": "string" }, "campaignIds": { "type": "integer", "format": "int32" }, "dailyBudget": { "type": "integer", "format": "int32" } }, "example": { "totalBudgetUpdateType": "change", "campaignIds": 192476, "dailyBudget": 1001 } }, "example": { "totalBudgetUpdateType": "change", "campaignIds": 192476, "dailyBudget": 1001 } } }, "required": true }, "responses": { "default": { "description": "", "headers": { }, "content": { "application/json": { "schema": { "title": "200okwithfalsestatus", "required": [ "statusCode", "responseObject" ], "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "responseObject": { "title": "ResponseObject26", "required": [ "reason", "modified_data", "status" ], "type": "object", "properties": { "reason": { "type": "array", "items": { "title": "Reason", "required": [ "errorMessage", "id", "campaignName" ], "type": "object", "properties": { "errorMessage": { "type": "string" }, "id": { "type": "string" }, "campaignName": { "type": "string" } }, "example": { "errorMessage": "max bid cannot be less than minimum bid 3.0", "id": "4120", "campaignName": "test cust aud dev" } }, "description": "" }, "modified_data": { "type": "array", "items": { "title": "ModifiedDatum", "required": [ "campaingId", "maxBid", "totalBudget", "dailyBudget", "endDate" ], "type": "object", "properties": { "campaingId": { "type": "integer", "format": "int32" }, "maxBid": { "type": "integer", "format": "int32" }, "totalBudget": { "type": "integer", "format": "int32" }, "dailyBudget": { "type": "integer", "format": "int32" }, "endDate": { "type": "integer", "format": "int64" } }, "example": { "campaingId": 1, "maxBid": 34, "totalBudget": 35, "dailyBudget": 36, "endDate": 12312312312 } }, "description": "" }, "status": { "type": "boolean" } }, "example": { "reason": [ { "errorMessage": "max bid cannot be less than minimum bid 3.0", "id": "4120", "campaignName": "test cust aud dev" }, { "errorMessage": "For given campaign_type max bid cannot be less than 1.00 or greater than 1000.", "id": "4121", "campaignName": "Vast copy" } ], "modified_data": [ { "campaingId": 1, "maxBid": 34, "totalBudget": 35, "dailyBudget": 36, "endDate": 12312312312 } ], "status": false } } }, "example": { "statusCode": 200, "responseObject": { "reason": [ { "errorMessage": "max bid cannot be less than minimum bid 3.0", "id": "4120", "campaignName": "test cust aud dev" }, { "errorMessage": "For given campaign_type max bid cannot be less than 1.00 or greater than 1000.", "id": "4121", "campaignName": "Vast copy" } ], "modified_data": [ { "campaingId": 1, "maxBid": 34, "totalBudget": 35, "dailyBudget": 36, "endDate": 12312312312 } ], "status": false } } }, "example": { "statusCode": 200, "responseObject": { "reason": [ { "errorMessage": "max bid cannot be less than minimum bid 3.0", "id": "4120", "campaignName": "test cust aud dev" }, { "errorMessage": "For given campaign_type max bid cannot be less than 1.00 or greater than 1000.", "id": "4121", "campaignName": "Vast copy" } ], "modified_data": [ { "campaingId": 1, "maxBid": 34, "totalBudget": 35, "dailyBudget": 36, "endDate": 12312312312 } ], "status": false } } } } } }, "deprecated": false, "security": [], "servers": [ { "url": "http://example.com/api", "variables": { } } ] } }, "/api/v2/cmp/campaigngroup/campaign/list": { "get": { "tags": [ "Campaign API" ], "summary": "Campaign list by campaign group", "description": "Get the list of existing campaign groups with associated campaigns (basic details).", "operationId": "Campaignlistbycampaigngroup", "parameters": [ { "name": "creative_type_ids", "in": "query", "description": "filter with comma seprated creative types", "required": true, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "owIds", "in": "query", "description": "filter with organization workspace ids", "required": true, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "includeChild", "in": "query", "description": "campaign group child include in resposne or not", "required": true, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "filter with comma seprated status", "required": true, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "X-IAA-OW-ID", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32", "example": 1 } }, { "name": "X-Iaa-Host", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "app.stage.inhousebuying.com" } }, { "name": "authorization", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "{{bearer_token}}" } } ], "responses": { "200": { "description": "OK", "headers": { }, "content": { "application/json": { "schema": { "title": "200-OK5", "required": [ "statusCode", "responseObject" ], "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "responseObject": { "type": "array", "items": { "title": "ResponseObject27", "required": [ "id", "name", "created", "uowId", "owId", "lastModified", "rootParentId", "campaignCount", "campaings" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "created": { "type": "integer", "format": "int32" }, "uowId": { "type": "integer", "format": "int32" }, "owId": { "type": "integer", "format": "int32" }, "lastModified": { "type": "integer", "format": "int32" }, "rootParentId": { "type": "string" }, "campaignCount": { "type": "integer", "format": "int32" }, "campaings": { "type": "array", "items": { "title": "Campaing", "required": [ "id", "name", "status", "creativeTypeId" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "status": { "type": "string" }, "creativeTypeId": { "type": "integer", "format": "int32" } }, "example": { "id": 3270, "name": "Test Campaign - 1011", "status": "running", "creativeTypeId": 11 } }, "description": "" } }, "example": { "id": 264, "name": "My group", "created": 1549978603, "uowId": 123, "owId": 456, "lastModified": 1549978603, "rootParentId": "264", "campaignCount": 22, "campaings": [ { "id": 3270, "name": "Test Campaign - 1011", "status": "running", "creativeTypeId": 11 }, { "id": 3303, "name": "Test Campaign - 1011", "status": "pending", "creativeTypeId": 17 } ] } }, "description": "" } }, "example": { "statusCode": 200, "responseObject": [ { "id": 264, "name": "My group", "created": 1549978603, "uowId": 123, "owId": 456, "lastModified": 1549978603, "rootParentId": "264", "campaignCount": 22, "campaings": [ { "id": 3270, "name": "Test Campaign - 1011", "status": "running", "creativeTypeId": 11 }, { "id": 3303, "name": "Test Campaign - 1011", "status": "pending", "creativeTypeId": 17 } ] } ] } }, "example": { "statusCode": 200, "responseObject": [ { "id": 264, "name": "My group", "created": 1549978603, "uowId": 123, "owId": 456, "lastModified": 1549978603, "rootParentId": "264", "campaignCount": 22, "campaings": [ { "id": 3270, "name": "Test Campaign - 1011", "status": "running", "creativeTypeId": 11 }, { "id": 3303, "name": "Test Campaign - 1011", "status": "pending", "creativeTypeId": 17 } ] } ] } } } } }, "deprecated": false, "security": [], "servers": [ { "url": "http://example.com/api", "variables": { } } ] } }, "/api/v2/cmp/campaigns/count": { "get": { "tags": [ "Campaign API" ], "summary": "Campaign Count by creative type", "description": "Fetches status wise count for the given list of owIds", "operationId": "CampaignCountbycreativetype", "parameters": [ { "name": "sortType", "in": "query", "description": "sorting type asceding or descending", "required": true, "style": "form", "explode": true, "schema": { "type": "string", "example": "asc" } }, { "name": "creativeTypeIds", "in": "query", "description": "filter with comma separated creative type ids. \nIt can be from -\n1. 11 (Image)\n2. 13 (Html) \n3. 14 (Video)\n4. 16 (Ticker Banner)\n5. 17 (Audio)\n6. 18 (GOTV)", "required": true, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "searchField", "in": "query", "description": "searching text for filter records", "required": true, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "owIds", "in": "query", "description": "filter with organization workspace ids", "required": true, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "X-IAA-OW-ID", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32", "example": 1 } }, { "name": "X-Iaa-Host", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "app.stage.inhousebuying.com" } }, { "name": "authorization", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "{{bearer_token}}" } } ], "responses": { "200": { "description": "OK", "headers": { }, "content": { "application/json": { "schema": { "title": "200-OK6", "required": [ "statusCode", "responseObject" ], "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "responseObject": { "type": "array", "items": { "title": "ResponseObject28", "required": [ "order", "status_key", "status_label", "status_count" ], "type": "object", "properties": { "order": { "type": "integer", "format": "int32" }, "status_key": { "type": "string" }, "status_label": { "type": "string" }, "status_count": { "type": "integer", "format": "int32" } }, "example": { "order": 0, "status_key": "running", "status_label": "Running", "status_count": 14 } }, "description": "" } }, "example": { "statusCode": 200, "responseObject": [ { "order": 0, "status_key": "running", "status_label": "Running", "status_count": 14 }, { "order": 2, "status_key": "paused", "status_label": "Paused", "status_count": 3 }, { "order": 7, "status_key": "all", "status_label": "ALL", "status_count": 17 } ] } }, "example": { "statusCode": 200, "responseObject": [ { "order": 0, "status_key": "running", "status_label": "Running", "status_count": 14 }, { "order": 2, "status_key": "paused", "status_label": "Paused", "status_count": 3 }, { "order": 7, "status_key": "all", "status_label": "ALL", "status_count": 17 } ] } } } } }, "deprecated": false, "security": [], "servers": [ { "url": "http://example.com/api", "variables": { } } ] } }, "/api/v2/cmp/campaign/{campaign_id}": { "get": { "tags": [ "Campaign API" ], "summary": "Get campaign details", "description": "Get Campaign's basic details and targeting details by id.\n\n* * *\n\n#### Response Body Detail\n\n| **Field** | **Type** | **Description** |\n| --- | --- | --- |\n| id | number | campaign id |\n| campaignName | String | campaign Name |\n| advertiserDomain | String | campaign Advertiser Domain |\n| creativeType | number | creative typ id |\n| totalBudgetPacing | boolean | `false` indicates `off` \u003Cbr\u003E`true` indicates `on` |\n| budgetDay | number | daily budget of campaign |\n| budgetTotal | nuymber | total budget fo campign |\n| maxBid | number | max bid of budget for serving |\n| status | String | status of campaign |\n| dspMargin | number | for dsp margin |\n| platformMargin | number | for platform margin |\n| userDealMargin | number | for user deal margin |\n| spentScale | boolean | spent scale for campaign |\n| conversionType | String | conversion type of campaign |\n| spent | number | campaign spent |\n| bidOptimization | number | bid optimization true/false |\n| bidPacing | boolean | bid pacing on/ off |\n| impressionCapping | number | impressionCapping on/off |\n| exchanges | String | comma seprated exchange-ids |\n| whiteListedDeviceId | strimg | comma seprated whiteListedDeviceId |\n| stateIds | String | comma seprated state-ids |\n| countryId | number | country id |\n| dmaIds | String | comma separated DMA IDs. |\n| whiteListedDmaIds | String | white list comma separated DMA IDs. |\n| blackListedDmaIds | String | comma separated black list DMA IDs. |\n| senateDistrictIds | String | comma separated senate districts Ids. |\n| whiteListedSenateDistrictIds | String | comma separated white list senate district IDs. |\n| blackListedSenateDistrictIds | String | comma separated black list senate districts IDs. |\n| congressionalDistrictIds | String | Congressional districts Ids. |\n| whiteListedCongressionalDistrictIds | String | white list congressional districts Ids. |\n| blackListedCongressionalDistrictIds | String | black list congressional districts Ids. |\n| houseDistrictIds | String | House districts Ids. |\n| whiteListedHouseDistrictIds | String | white list house districts ids. |\n| blackListedHouseDistrictIds | String | black list house districts ids. |\n| geoRadiusDetails | String | custom ares in circle or polygon. Value in form of JSON. |\n| whiteListedGeoRadiusDetails | String | white list custom ares in circle or polygon. Value in form of JSON. |\n| blackListedGeoRadiusDetails | String | black list custom ares in circle or polygon. Value in form of JSON. |\n| zipcodes | String | comma separated zipCode |\n| whiteListedZipcodes | String | white list zipCode Target. Value in form of String of comma separated IDs. |\n| blackListedZipcodes | String | black list zipCode Target. Value in form of String of comma separated IDs. |\n| locationDetails | Json | location by uploaded file with targeting type |\n| whiteListedCityIds | String | white list city Target. |\n| blackListedCityIds | String | black list city Target. |\n| whiteListedCountyIds | String | white list county Target. |\n| blackListedCountyIds | String | black list county Target. |\n| blackListedAudienceSegmentGroupIds | String | comma seprated black listed audience group ids |\n| whiteListedAudienceSegmentGroupIds | String | comma seprated white listed audience group ids |\n| blackListedConversionTagIds | String | comma seprated black listed conversion tag ids |\n| whiteListedConversionTagIds | String | comma seprated white listed conversion tag ids |\n| campaignIabCategoryIds | String | comma seprated campaign iab categories |\n| rejectionReason | String | Reason of rejecting campaign |\n| creativesPlacementMapping | json | ad placement mapping with creatives. (present in case of audio and video campaigns) |\n| organizationName | String | Organization name |\n| userName | String | Name of user |\n| userEmail | String | Email of user |\n| conversionIds | String | comma separated conversions ids. |\n\n* * *\n\n#### Location(By file) details example\n\n```\n\"locationDetails\": {\n \"1010\": {\n \"fileName\": \"bulk-location-example(10)(2).csv\",\n \"fileType\": \"location\",\n \"validLocations\": [\n {\n \"latitude\": 40.7128,\n \"longitude\": -74.006,\n \"radius\": 0.5,\n \"address\": \"1 Murray Street, New York, NY 10007, USA\",\n \"locationId\": 48374,\n \"isIncluded\": true,\n \"cdId\": 0,\n \"sdId\": 0,\n \"hdId\": 0\n },\n {\n \"latitude\": 36.7783,\n \"longitude\": -119.4179,\n \"radius\": 1.0,\n \"address\": \"Center stage, 2630 Croydon Drive, Sanger, CA 93657, USA\",\n \"locationId\": 48375,\n \"isIncluded\": true,\n \"cdId\": 0,\n \"sdId\": 0,\n \"hdId\": 0\n }\n ],\n \"id\": 1010\n },\n \"1011\": {\n \"fileName\": \"bulk-addresses-example (4)(1).csv\",\n \"fileType\": \"address\",\n \"validLocations\": [\n {\n \"latitude\": 35.7831443,\n \"longitude\": -78.6388985,\n \"radius\": 0.5,\n \"address\": \"16 West Jones Street,Raleigh,NC,27601\",\n \"locationId\": 48376,\n \"isIncluded\": false,\n \"cdId\": 0,\n \"sdId\": 0,\n \"hdId\": 0\n },\n {\n \"latitude\": 35.7803163,\n \"longitude\": -78.5326985,\n \"radius\": 1.34,\n \"address\": \"1002 Lyndhurst Falls Ln,Knightdale,NC,27545\",\n \"locationId\": 48377,\n \"isIncluded\": true,\n \"cdId\": 0,\n \"sdId\": 0,\n \"hdId\": 0\n },\n {\n \"latitude\": 35.8440052,\n \"longitude\": -78.6580243,\n \"radius\": 1.2,\n \"address\": \"4604 Gramercy Ct,Raleigh,NC,27609\",\n \"locationId\": 48378,\n \"isIncluded\": true,\n \"cdId\": 0,\n \"sdId\": 0,\n \"hdId\": 0\n },\n {\n \"latitude\": 35.8074803,\n \"longitude\": -78.6582902,\n \"radius\": 1.5,\n \"address\": \"2612 Dover Rd,Raleigh,NC,27608\",\n \"locationId\": 48379,\n \"isIncluded\": true,\n \"cdId\": 0,\n \"sdId\": 0,\n \"hdId\": 0\n },\n {\n \"latitude\": 35.7950389,\n \"longitude\": -78.65665039999999,\n \"radius\": 1.0,\n \"address\": \"820 Graham St ,Raleigh,NC,27605\",\n \"locationId\": 48380,\n \"isIncluded\": true,\n \"cdId\": 0,\n \"sdId\": 0,\n \"hdId\": 0\n }\n ],\n \"id\": 1011\n }\n }\n\n```", "operationId": "Getcampaigndetails", "parameters": [ { "name": "isSpentRequired", "in": "query", "description": "flag to get the campaign spent\nDefault value :- false", "required": true, "style": "form", "explode": true, "schema": { "type": "boolean", "example": false } }, { "name": "X-IAA-OW-ID", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "{{ow_id}}" } }, { "name": "Authorization", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "{{bearer_token}}" } }, { "name": "campaign_id", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": { "Server": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "nginx" } } }, "Date": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fri, 09 Oct 2020 13:40:30 GMT" } } }, "Transfer-Encoding": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "chunked" } } }, "Connection": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "keep-alive" } } }, "Access-Control-Allow-Credentials": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "true" } } }, "Access-Control-Allow-Methods": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "GET, POST, OPTIONS, PUT, DELETE, PATCH" } } }, "Access-Control-Allow-Headers": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "Base-Url,DNT,X-CustomHeader,Keep-Alive,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type,x-iaa-api-token,Cookie" } } }, "Access-Control-Expose-Headers": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "Content-Type,X-IAA-ADMIN-API-TOKEN,x-iaa-admin-api-token,x-iaa-api-token" } } }, "Access-Control-Max-Age": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "5" } } }, "Cache-Control": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "max-age=5" } } } }, "content": { "application/json;charset=UTF-8": { "schema": { "title": "200-OK7", "required": [ "statusCode", "responseObject" ], "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "responseObject": { "title": "ResponseObject29", "required": [ "owId", "parentOrganizationName", "id", "uowId", "campaignName", "advertiserDomain", "creativeType", "campaignType", "totalBudgetPacing", "isTvAd", "budgetDay", "budgetTotal", "maxBid", "timezone", "startTime", "endTime", "status", "dspMargin", "platformMargin", "userDealMargin", "spentScale", "creativeIds", "conversionType", "bidOptimization", "bidPacing", "impressionCapping", "deviceType", "trafficType", "exchanges", "countryId", "locationDetails", "blackListedCustomAudienceIds", "whiteListedCustomAudienceIds", "isCampaignFromNewPlatform", "whiteListedAudienceSegmentGroupIds", "blackListedAudienceSegmentGroupIds", "blackListedConversionTagIds", "whiteListedConversionTagIds", "blackListedAudienceIds", "whiteListedAudienceIds", "organizationName", "userName", "isEditAccess", "isApprovalAccess", "isMarginSet", "isParentInvoiceTemplateSet", "isUnapprovedAudienceTargeted", "isAllAudienceUnapproved" ], "type": "object", "properties": { "owId": { "type": "integer", "format": "int32" }, "parentOrganizationName": { "type": "string" }, "id": { "type": "integer", "format": "int32" }, "uowId": { "type": "integer", "format": "int32" }, "campaignName": { "type": "string" }, "advertiserDomain": { "type": "string" }, "creativeType": { "type": "integer", "format": "int32" }, "campaignType": { "type": "integer", "format": "int32" }, "totalBudgetPacing": { "type": "boolean" }, "isTvAd": { "type": "boolean" }, "budgetDay": { "type": "integer", "format": "int32" }, "budgetTotal": { "type": "integer", "format": "int32" }, "maxBid": { "type": "integer", "format": "int32" }, "timezone": { "type": "integer", "format": "int32" }, "startTime": { "type": "integer", "format": "int32" }, "endTime": { "type": "integer", "format": "int32" }, "status": { "type": "string" }, "dspMargin": { "type": "integer", "format": "int32" }, "platformMargin": { "type": "integer", "format": "int32" }, "userDealMargin": { "type": "integer", "format": "int32" }, "spentScale": { "type": "boolean" }, "creativeIds": { "type": "string" }, "conversionType": { "type": "string" }, "bidOptimization": { "type": "boolean" }, "bidPacing": { "type": "boolean" }, "impressionCapping": { "type": "integer", "format": "int32" }, "deviceType": { "type": "string" }, "trafficType": { "type": "string" }, "exchanges": { "type": "string" }, "countryId": { "type": "string" }, "locationDetails": { "type": "object" }, "blackListedCustomAudienceIds": { "type": "string" }, "whiteListedCustomAudienceIds": { "type": "string" }, "isCampaignFromNewPlatform": { "type": "boolean" }, "whiteListedAudienceSegmentGroupIds": { "type": "string" }, "blackListedAudienceSegmentGroupIds": { "type": "string" }, "blackListedConversionTagIds": { "type": "string" }, "whiteListedConversionTagIds": { "type": "string" }, "blackListedAudienceIds": { "type": "string" }, "whiteListedAudienceIds": { "type": "string" }, "organizationName": { "type": "string" }, "userName": { "type": "string" }, "isEditAccess": { "type": "boolean" }, "isApprovalAccess": { "type": "boolean" }, "isMarginSet": { "type": "boolean" }, "isParentInvoiceTemplateSet": { "type": "boolean" }, "isUnapprovedAudienceTargeted": { "type": "boolean" }, "isAllAudienceUnapproved": { "type": "boolean" } }, "example": { "owId": 100288, "parentOrganizationName": "Local Iqm Dev", "id": 227869, "uowId": 4767, "campaignName": "Create_draft_test_stage", "advertiserDomain": "https://iqm.com", "creativeType": 11, "campaignType": 1, "totalBudgetPacing": false, "isTvAd": false, "budgetDay": 120, "budgetTotal": 1200, "maxBid": 12, "timezone": 11, "startTime": 1640543431, "endTime": 1640629831, "status": "draft", "dspMargin": 0, "platformMargin": 0, "userDealMargin": 0, "spentScale": false, "creativeIds": "394572", "conversionType": "None", "bidOptimization": true, "bidPacing": true, "impressionCapping": 0, "deviceType": "13,15,11,12", "trafficType": "11,14,13,12", "exchanges": "27,21,26,28,29,42,22,17,23,41,30,15,40,39,47,18,1,38,36,31,13,14,19,65,44,45,16,25,12,11,32,37,24,20,52,60,61,62,63,64,51,53,54,55,56,57,58,59,48,50,33,46,34,49,66,43,35", "countryId": "246", "locationDetails": { }, "blackListedCustomAudienceIds": "888981", "whiteListedCustomAudienceIds": "889185", "isCampaignFromNewPlatform": true, "whiteListedAudienceSegmentGroupIds": "900269", "blackListedAudienceSegmentGroupIds": "900254", "blackListedConversionTagIds": "901341", "whiteListedConversionTagIds": "901342", "blackListedAudienceIds": "888981,900254,901341,901537", "whiteListedAudienceIds": "889185,900269,901342,901538", "organizationName": "Company 288", "userName": "Display Name 288", "isEditAccess": false, "isApprovalAccess": true, "isMarginSet": true, "isParentInvoiceTemplateSet": true, "isUnapprovedAudienceTargeted": true, "isAllAudienceUnapproved": false } } }, "example": { "statusCode": 200, "responseObject": { "owId": 100288, "parentOrganizationName": "Local Iqm Dev", "id": 227869, "uowId": 4767, "campaignName": "Create_draft_test_stage", "advertiserDomain": "https://iqm.com", "creativeType": 11, "campaignType": 1, "totalBudgetPacing": false, "isTvAd": false, "budgetDay": 120, "budgetTotal": 1200, "maxBid": 12, "timezone": 11, "startTime": 1640543431, "endTime": 1640629831, "status": "draft", "dspMargin": 0, "platformMargin": 0, "userDealMargin": 0, "spentScale": false, "creativeIds": "394572", "conversionType": "None", "bidOptimization": true, "bidPacing": true, "impressionCapping": 0, "deviceType": "13,15,11,12", "trafficType": "11,14,13,12", "exchanges": "27,21,26,28,29,42,22,17,23,41,30,15,40,39,47,18,1,38,36,31,13,14,19,65,44,45,16,25,12,11,32,37,24,20,52,60,61,62,63,64,51,53,54,55,56,57,58,59,48,50,33,46,34,49,66,43,35", "countryId": "246", "locationDetails": { }, "blackListedCustomAudienceIds": "888981", "whiteListedCustomAudienceIds": "889185", "isCampaignFromNewPlatform": true, "whiteListedAudienceSegmentGroupIds": "900269", "blackListedAudienceSegmentGroupIds": "900254", "blackListedConversionTagIds": "901341", "whiteListedConversionTagIds": "901342", "blackListedAudienceIds": "888981,900254,901341,901537", "whiteListedAudienceIds": "889185,900269,901342,901538", "organizationName": "Company 288", "userName": "Display Name 288", "isEditAccess": false, "isApprovalAccess": true, "isMarginSet": true, "isParentInvoiceTemplateSet": true, "isUnapprovedAudienceTargeted": true, "isAllAudienceUnapproved": false } } }, "example": { "statusCode": 200, "responseObject": { "owId": 100288, "parentOrganizationName": "Local Iqm Dev", "id": 227869, "uowId": 4767, "campaignName": "Create_draft_test_stage", "advertiserDomain": "https://iqm.com", "creativeType": 11, "campaignType": 1, "totalBudgetPacing": false, "isTvAd": false, "budgetDay": 120, "budgetTotal": 1200, "maxBid": 12, "timezone": 11, "startTime": 1640543431, "endTime": 1640629831, "status": "draft", "dspMargin": 0, "platformMargin": 0, "userDealMargin": 0, "spentScale": false, "creativeIds": "394572", "conversionType": "None", "bidOptimization": true, "bidPacing": true, "impressionCapping": 0, "deviceType": "13,15,11,12", "trafficType": "11,14,13,12", "exchanges": "27,21,26,28,29,42,22,17,23,41,30,15,40,39,47,18,1,38,36,31,13,14,19,65,44,45,16,25,12,11,32,37,24,20,52,60,61,62,63,64,51,53,54,55,56,57,58,59,48,50,33,46,34,49,66,43,35", "countryId": "246", "locationDetails": { }, "blackListedCustomAudienceIds": "888981", "whiteListedCustomAudienceIds": "889185", "isCampaignFromNewPlatform": true, "whiteListedAudienceSegmentGroupIds": "900269", "blackListedAudienceSegmentGroupIds": "900254", "blackListedConversionTagIds": "901341", "whiteListedConversionTagIds": "901342", "blackListedAudienceIds": "888981,900254,901341,901537", "whiteListedAudienceIds": "889185,900269,901342,901538", "organizationName": "Company 288", "userName": "Display Name 288", "isEditAccess": false, "isApprovalAccess": true, "isMarginSet": true, "isParentInvoiceTemplateSet": true, "isUnapprovedAudienceTargeted": true, "isAllAudienceUnapproved": false } } }, "application/json": { "schema": { "title": "200OK-getcampaignspent", "required": [ "statusCode", "responseObject" ], "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "responseObject": { "title": "ResponseObject30", "required": [ "owId", "parentOrganizationName", "id", "uowId", "campaignName", "advertiserDomain", "creativeType", "campaignType", "totalBudgetPacing", "isTvAd", "budgetDay", "budgetTotal", "maxBid", "timezone", "startTime", "endTime", "status", "dspMargin", "platformMargin", "userDealMargin", "spentScale", "creativeIds", "spent", "conversionType", "bidOptimization", "bidPacing", "impressionCapping", "deviceType", "trafficType", "exchanges", "countryId", "locationDetails", "blackListedCustomAudienceIds", "whiteListedCustomAudienceIds", "isCampaignFromNewPlatform", "whiteListedAudienceSegmentGroupIds", "blackListedAudienceSegmentGroupIds", "blackListedConversionTagIds", "whiteListedConversionTagIds", "blackListedAudienceIds", "whiteListedAudienceIds", "organizationName", "userName", "isEditAccess", "isApprovalAccess", "isMarginSet", "isParentInvoiceTemplateSet", "isUnapprovedAudienceTargeted", "isAllAudienceUnapproved" ], "type": "object", "properties": { "owId": { "type": "integer", "format": "int32" }, "parentOrganizationName": { "type": "string" }, "id": { "type": "integer", "format": "int32" }, "uowId": { "type": "integer", "format": "int32" }, "campaignName": { "type": "string" }, "advertiserDomain": { "type": "string" }, "creativeType": { "type": "integer", "format": "int32" }, "campaignType": { "type": "integer", "format": "int32" }, "totalBudgetPacing": { "type": "boolean" }, "isTvAd": { "type": "boolean" }, "budgetDay": { "type": "integer", "format": "int32" }, "budgetTotal": { "type": "integer", "format": "int32" }, "maxBid": { "type": "integer", "format": "int32" }, "timezone": { "type": "integer", "format": "int32" }, "startTime": { "type": "integer", "format": "int32" }, "endTime": { "type": "integer", "format": "int32" }, "status": { "type": "string" }, "dspMargin": { "type": "integer", "format": "int32" }, "platformMargin": { "type": "integer", "format": "int32" }, "userDealMargin": { "type": "integer", "format": "int32" }, "spentScale": { "type": "boolean" }, "creativeIds": { "type": "string" }, "spent": { "type": "number" }, "conversionType": { "type": "string" }, "bidOptimization": { "type": "boolean" }, "bidPacing": { "type": "boolean" }, "impressionCapping": { "type": "integer", "format": "int32" }, "deviceType": { "type": "string" }, "trafficType": { "type": "string" }, "exchanges": { "type": "string" }, "countryId": { "type": "string" }, "locationDetails": { "type": "object" }, "blackListedCustomAudienceIds": { "type": "string" }, "whiteListedCustomAudienceIds": { "type": "string" }, "isCampaignFromNewPlatform": { "type": "boolean" }, "whiteListedAudienceSegmentGroupIds": { "type": "string" }, "blackListedAudienceSegmentGroupIds": { "type": "string" }, "blackListedConversionTagIds": { "type": "string" }, "whiteListedConversionTagIds": { "type": "string" }, "blackListedAudienceIds": { "type": "string" }, "whiteListedAudienceIds": { "type": "string" }, "organizationName": { "type": "string" }, "userName": { "type": "string" }, "isEditAccess": { "type": "boolean" }, "isApprovalAccess": { "type": "boolean" }, "isMarginSet": { "type": "boolean" }, "isParentInvoiceTemplateSet": { "type": "boolean" }, "isUnapprovedAudienceTargeted": { "type": "boolean" }, "isAllAudienceUnapproved": { "type": "boolean" } }, "example": { "owId": 100288, "parentOrganizationName": "Local Iqm Dev", "id": 227869, "uowId": 4767, "campaignName": "Create_draft_test_stage", "advertiserDomain": "https://iqm.com", "creativeType": 11, "campaignType": 1, "totalBudgetPacing": false, "isTvAd": false, "budgetDay": 120, "budgetTotal": 1200, "maxBid": 12, "timezone": 11, "startTime": 1640543431, "endTime": 1640629831, "status": "draft", "dspMargin": 0, "platformMargin": 0, "userDealMargin": 0, "spentScale": false, "creativeIds": "394572", "spent": 40, "conversionType": "None", "bidOptimization": true, "bidPacing": true, "impressionCapping": 0, "deviceType": "13,15,11,12", "trafficType": "11,14,13,12", "exchanges": "27,21,26,28,29,42,22,17,23,41,30,15,40,39,47,18,1,38,36,31,13,14,19,65,44,45,16,25,12,11,32,37,24,20,52,60,61,62,63,64,51,53,54,55,56,57,58,59,48,50,33,46,34,49,66,43,35", "countryId": "246", "locationDetails": { }, "blackListedCustomAudienceIds": "888981", "whiteListedCustomAudienceIds": "889185", "isCampaignFromNewPlatform": true, "whiteListedAudienceSegmentGroupIds": "900269", "blackListedAudienceSegmentGroupIds": "900254", "blackListedConversionTagIds": "901341", "whiteListedConversionTagIds": "901342", "blackListedAudienceIds": "888981,900254,901341,901537", "whiteListedAudienceIds": "889185,900269,901342,901538", "organizationName": "Company 288", "userName": "Display Name 288", "isEditAccess": false, "isApprovalAccess": true, "isMarginSet": true, "isParentInvoiceTemplateSet": true, "isUnapprovedAudienceTargeted": true, "isAllAudienceUnapproved": false } } }, "example": { "statusCode": 200, "responseObject": { "owId": 100288, "parentOrganizationName": "Local Iqm Dev", "id": 227869, "uowId": 4767, "campaignName": "Create_draft_test_stage", "advertiserDomain": "https://iqm.com", "creativeType": 11, "campaignType": 1, "totalBudgetPacing": false, "isTvAd": false, "budgetDay": 120, "budgetTotal": 1200, "maxBid": 12, "timezone": 11, "startTime": 1640543431, "endTime": 1640629831, "status": "draft", "dspMargin": 0, "platformMargin": 0, "userDealMargin": 0, "spentScale": false, "creativeIds": "394572", "spent": 40, "conversionType": "None", "bidOptimization": true, "bidPacing": true, "impressionCapping": 0, "deviceType": "13,15,11,12", "trafficType": "11,14,13,12", "exchanges": "27,21,26,28,29,42,22,17,23,41,30,15,40,39,47,18,1,38,36,31,13,14,19,65,44,45,16,25,12,11,32,37,24,20,52,60,61,62,63,64,51,53,54,55,56,57,58,59,48,50,33,46,34,49,66,43,35", "countryId": "246", "locationDetails": { }, "blackListedCustomAudienceIds": "888981", "whiteListedCustomAudienceIds": "889185", "isCampaignFromNewPlatform": true, "whiteListedAudienceSegmentGroupIds": "900269", "blackListedAudienceSegmentGroupIds": "900254", "blackListedConversionTagIds": "901341", "whiteListedConversionTagIds": "901342", "blackListedAudienceIds": "888981,900254,901341,901537", "whiteListedAudienceIds": "889185,900269,901342,901538", "organizationName": "Company 288", "userName": "Display Name 288", "isEditAccess": false, "isApprovalAccess": true, "isMarginSet": true, "isParentInvoiceTemplateSet": true, "isUnapprovedAudienceTargeted": true, "isAllAudienceUnapproved": false } } }, "example": { "statusCode": 200, "responseObject": { "owId": 100288, "parentOrganizationName": "Local Iqm Dev", "id": 227869, "uowId": 4767, "campaignName": "Create_draft_test_stage", "advertiserDomain": "https://iqm.com", "creativeType": 11, "campaignType": 1, "totalBudgetPacing": false, "isTvAd": false, "budgetDay": 120, "budgetTotal": 1200, "maxBid": 12, "timezone": 11, "startTime": 1640543431, "endTime": 1640629831, "status": "draft", "dspMargin": 0, "platformMargin": 0, "userDealMargin": 0, "spentScale": false, "creativeIds": "394572", "spent": 40, "conversionType": "None", "bidOptimization": true, "bidPacing": true, "impressionCapping": 0, "deviceType": "13,15,11,12", "trafficType": "11,14,13,12", "exchanges": "27,21,26,28,29,42,22,17,23,41,30,15,40,39,47,18,1,38,36,31,13,14,19,65,44,45,16,25,12,11,32,37,24,20,52,60,61,62,63,64,51,53,54,55,56,57,58,59,48,50,33,46,34,49,66,43,35", "countryId": "246", "locationDetails": { }, "blackListedCustomAudienceIds": "888981", "whiteListedCustomAudienceIds": "889185", "isCampaignFromNewPlatform": true, "whiteListedAudienceSegmentGroupIds": "900269", "blackListedAudienceSegmentGroupIds": "900254", "blackListedConversionTagIds": "901341", "whiteListedConversionTagIds": "901342", "blackListedAudienceIds": "888981,900254,901341,901537", "whiteListedAudienceIds": "889185,900269,901342,901538", "organizationName": "Company 288", "userName": "Display Name 288", "isEditAccess": false, "isApprovalAccess": true, "isMarginSet": true, "isParentInvoiceTemplateSet": true, "isUnapprovedAudienceTargeted": true, "isAllAudienceUnapproved": false } } } } } }, "deprecated": false, "security": [], "servers": [ { "url": "http://example.com/api", "variables": { } } ] } }, "/api/v2/cmp/campaign/start": { "get": { "tags": [ "Campaign API" ], "summary": "Get campaign start date", "operationId": "Getcampaignstartdate", "parameters": [ { "name": "authorization", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "{{bearer_token}}" } }, { "name": "x-iaa-ow-id", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32", "example": 200001 } }, { "name": "x-iaa-host", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "app.stage.inhousebuying.com" } } ], "responses": { "200": { "description": "OK", "headers": { }, "content": { "application/json": { "schema": { "title": "200-OK8", "required": [ "statusCode", "responseObject" ], "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "responseObject": { "title": "ResponseObject31", "required": [ "start_time" ], "type": "object", "properties": { "start_time": { "type": "integer", "format": "int32" } }, "example": { "start_time": 1632286201 } } }, "example": { "statusCode": 200, "responseObject": { "start_time": 1632286201 } } }, "example": { "statusCode": 200, "responseObject": { "start_time": 1632286201 } } } } } }, "deprecated": false, "security": [], "servers": [ { "url": "http://example.com/api", "variables": { } } ] } }, "/api/v3/custom/cmp/campaigns/targeting": { "get": { "tags": [ "Campaign API" ], "summary": "Campaign Targeting Information", "operationId": "CampaignTargetingInformation", "parameters": [ { "name": "campaignIds", "in": "query", "description": "", "required": true, "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32", "example": 221483 } } ], "responses": { "200": { "description": "OK", "headers": { "Date": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "Sat, 04 Dec 2021 01:30:18 GMT" } } }, "Transfer-Encoding": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "chunked" } } }, "Connection": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "keep-alive" } } }, "X-Content-Type-Options": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "nosniff" } } }, "X-XSS-Protection": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "1; mode=block" } } }, "Cache-Control": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "no-cache, no-store, max-age=0, must-revalidate" } } }, "Pragma": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "no-cache" } } }, "Expires": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "0" } } }, "X-Frame-Options": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "DENY" } } } }, "content": { "application/json": { "schema": { "title": "200-OK9", "required": [ "success", "data" ], "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "additionalProperties": { "type": "integer", "format": "int32" } } }, "example": { "success": true, "data": { "1": 17, "2": 10 } } }, "example": { "success": true, "data": { "1": 17, "2": 10 } } } } } }, "deprecated": false, "servers": [ { "url": "http://campaign-api.stage.iqm/api/v3/custom/cmp/campaigns", "variables": { } } ] } }, "/api/v3/cmp/estimate-reach": { "post": { "tags": [ "Campaign API" ], "summary": "Fetch Estimated reach", "description": "This API is fetching estimated reach based on provided targeting. Currently demographic and geographic segments targeting supported.", "operationId": "FetchEstimatedreach", "parameters": [ { "name": "X-IAA-OW-ID", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "{{ow_id}}" } }, { "name": "Authorization", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "{{bearer_token}}" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "title": "FetchEstimatedreachRequest", "required": [ "whiteListedCityIds", "whiteListedZipcodes", "stateIds", "whiteListedGeoRadiusDetails", "ageRangeIds", "genderIds", "incomeRangeIds", "ethnicityIds" ], "type": "object", "properties": { "whiteListedCityIds": { "type": "string" }, "whiteListedZipcodes": { "type": "string" }, "stateIds": { "type": "string" }, "whiteListedGeoRadiusDetails": { "type": "array", "items": { "title": "WhiteListedGeoRadiusDetail1", "required": [ "radius", "latitude", "longitude" ], "type": "object", "properties": { "radius": { "type": "number" }, "latitude": { "type": "number" }, "longitude": { "type": "number" } }, "example": { "radius": 0.5, "latitude": 65.0573856680273, "longitude": -153.331674515421 } }, "description": "" }, "ageRangeIds": { "type": "string" }, "genderIds": { "type": "string" }, "incomeRangeIds": { "type": "string" }, "ethnicityIds": { "type": "string" } }, "example": { "whiteListedCityIds": "30400001,30400014,30400013", "whiteListedZipcodes": "N3C1W6", "stateIds": "4660,4661,4662", "whiteListedGeoRadiusDetails": [ { "radius": 0.5, "latitude": 65.0573856680273, "longitude": -153.331674515421 } ], "ageRangeIds": "", "genderIds": "", "incomeRangeIds": "", "ethnicityIds": "" } }, "example": { "whiteListedCityIds": "30400001,30400014,30400013", "whiteListedZipcodes": "N3C1W6", "stateIds": "4660,4661,4662", "whiteListedGeoRadiusDetails": [ { "radius": 0.5, "latitude": 65.0573856680273, "longitude": -153.331674515421 } ], "ageRangeIds": "", "genderIds": "", "incomeRangeIds": "", "ethnicityIds": "" } } }, "required": true }, "responses": { "default": { "description": "", "headers": { }, "content": { "application/json": { "schema": { "title": "200-OK10", "required": [ "success", "data" ], "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "title": "Data5", "required": [ "estimated_reach" ], "type": "object", "properties": { "estimated_reach": { "type": "integer", "format": "int32" } }, "example": { "estimated_reach": 123 } } }, "example": { "success": true, "data": { "estimated_reach": 123 } } }, "example": { "success": true, "data": { "estimated_reach": 123 } } } } } }, "deprecated": false, "security": [], "servers": [ { "url": "http://example.com/api", "variables": { } } ] } }, "/api/v3/cmp/campaigns/report/data": { "get": { "tags": [ "Campaign API" ], "summary": "Get Campaign Report Data", "operationId": "GetCampaignReportData", "parameters": [ { "name": "status", "in": "query", "description": "Filter records with status values \u003Cbr/\u003E\n`running`,`paused`,`pending`,`expired`,`draft`", "required": true, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "sortBy", "in": "query", "description": "sortBy sort by (default value `-created`) valid values are `created,name,id,status,modifiedDate. Here minus(-) sign is for order `DESC` and plus(+) is for order `ASC`", "required": true, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "limit of records", "required": true, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "pageNo", "in": "query", "description": "pagination page number", "required": true, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "searchField", "in": "query", "description": "campaign filtered with id or name", "required": true, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "conversionId", "in": "query", "description": "filtered with conversion id", "required": true, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "campaignIds", "in": "query", "description": "filtered with campaign id", "required": true, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "authorization", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "{{bearer_token}}" } }, { "name": "x-iaa-ow-id", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "{{ow_id}}" } } ], "responses": { "200": { "description": "OK", "headers": { "X-Content-Type-Options": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "nosniff" } } }, "X-XSS-Protection": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "1; mode=block" } } }, "Cache-Control": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "no-cache, no-store, max-age=0, must-revalidate" } } }, "Pragma": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "no-cache" } } }, "Expires": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "0" } } }, "X-Frame-Options": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "DENY" } } }, "Transfer-Encoding": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "chunked" } } }, "Date": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "Mon, 27 Dec 2021 09:25:13 GMT" } } } }, "content": { "application/json;charset=UTF-8": { "schema": { "title": "200OK11", "required": [ "success", "data" ], "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "title": "Data6", "required": [ "totalRecords", "data", "filteredRecords" ], "type": "object", "properties": { "totalRecords": { "type": "integer", "format": "int32" }, "data": { "type": "array", "items": { "title": "Data7", "required": [ "id", "name", "status", "clicks", "impression", "conversionCount", "uniqueCount", "creativeType" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "status": { "type": "string" }, "clicks": { "type": "integer", "format": "int32" }, "impression": { "type": "integer", "format": "int32" }, "conversionCount": { "type": "integer", "format": "int32" }, "uniqueCount": { "type": "integer", "format": "int32" }, "creativeType": { "type": "string" } }, "example": { "id": 240946, "name": "Campaign-1", "status": "draft", "clicks": 0, "impression": 0, "conversionCount": 0, "uniqueCount": 0, "creativeType": "VIDEO" } }, "description": "" }, "filteredRecords": { "type": "integer", "format": "int32" } }, "example": { "totalRecords": 290, "data": [ { "id": 240946, "name": "Campaign-1", "status": "draft", "clicks": 0, "impression": 0, "conversionCount": 0, "uniqueCount": 0, "creativeType": "VIDEO" }, { "id": 241058, "name": "Campaign-2", "status": "expired", "clicks": 0, "impression": 0, "conversionCount": 0, "uniqueCount": 0, "creativeType": "IMAGE" } ], "filteredRecords": 290 } } }, "example": { "success": true, "data": { "totalRecords": 290, "data": [ { "id": 240946, "name": "Campaign-1", "status": "draft", "clicks": 0, "impression": 0, "conversionCount": 0, "uniqueCount": 0, "creativeType": "VIDEO" }, { "id": 241058, "name": "Campaign-2", "status": "expired", "clicks": 0, "impression": 0, "conversionCount": 0, "uniqueCount": 0, "creativeType": "IMAGE" } ], "filteredRecords": 290 } } }, "example": { "success": true, "data": { "totalRecords": 290, "data": [ { "id": 240946, "name": "Campaign-1", "status": "draft", "clicks": 0, "impression": 0, "conversionCount": 0, "uniqueCount": 0, "creativeType": "VIDEO" }, { "id": 241058, "name": "Campaign-2", "status": "expired", "clicks": 0, "impression": 0, "conversionCount": 0, "uniqueCount": 0, "creativeType": "IMAGE" } ], "filteredRecords": 290 } } } } } }, "deprecated": false, "security": [], "servers": [ { "url": "http://example.com/api", "variables": { } } ] } }, "/api/v3/cmp/email-reminder/set-margin": { "post": { "tags": [ "Campaign API" ], "summary": "Resend email reminder to set margin", "operationId": "Resendemailremindertosetmargin", "parameters": [ { "name": "Authorization", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "{{bearer_token}}" } }, { "name": "X-IAA-OW-ID", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "{{owId}}" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "title": "ResendemailremindertosetmarginRequest", "required": [ "owId" ], "type": "object", "properties": { "owId": { "type": "integer", "format": "int32" } }, "example": { "owId": 200425 } }, "example": { "owId": 200425 } } }, "required": true }, "responses": { "200": { "description": "OK", "headers": { }, "content": { "application/json": { "schema": { "title": "200OK12", "required": [ "success", "data" ], "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "string" } }, "example": { "success": true, "data": "Email reminder resend successfully to set margin." } }, "example": { "success": true, "data": "Email reminder resend successfully to set margin." } } } } }, "deprecated": false, "security": [], "servers": [ { "url": "http://example.com/api", "variables": { } } ] } }, "/api/v3/cmp/email-reminder/set-invoice-template": { "post": { "tags": [ "Campaign API" ], "summary": "Resend email reminder to set invoice template", "operationId": "Resendemailremindertosetinvoicetemplate", "parameters": [ { "name": "Authorization", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "{{bearer_token}}" } }, { "name": "X-IAA-OW-ID", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "{{owId}}" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "title": "ResendemailremindertosetinvoicetemplateRequest", "required": [ "owId" ], "type": "object", "properties": { "owId": { "type": "integer", "format": "int32" } }, "example": { "owId": 200425 } }, "example": { "owId": 200425 } } }, "required": true }, "responses": { "200": { "description": "OK", "headers": { }, "content": { "application/json": { "schema": { "title": "200OK12", "required": [ "success", "data" ], "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "string" } }, "example": { "success": true, "data": "Email reminder resend successfully to set margin." } }, "example": { "success": true, "data": "Email reminder resend successfully to set invoice template." } } } } }, "deprecated": false, "security": [], "servers": [ { "url": "http://example.com/api", "variables": { } } ] } }, "/api/v2/cmp/campaign/draft/{campaignId}": { "put": { "tags": [ "Campaign API" ], "summary": "Update draft campaign", "description": "This API updates the draft campaign with given targeting.", "operationId": "editDraftCampaign", "parameters": [ { "name": "campaignId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "content": { "application/json": { "schema": { "required": [ "exchanges", "publisherAdCategory" ], "type": "object", "properties": { "advertiserId": { "type": "integer", "format": "int32" }, "dspId": { "type": "integer", "format": "int32" }, "owId": { "type": "integer", "format": "int32" }, "uowId": { "type": "integer", "format": "int32" }, "id": { "type": "integer", "format": "int32" }, "campaignName": { "type": "string" }, "advertiserDomain": { "type": "string" }, "creativeType": { "type": "integer", "format": "int32" }, "campaignType": { "type": "integer", "format": "int32" }, "totalBudgetPacing": { "type": "boolean" }, "budgetDay": { "minimum": 0, "type": "number", "format": "double" }, "budgetTotal": { "minimum": 0, "type": "number", "format": "double" }, "maxBid": { "type": "number", "format": "double" }, "minBid": { "type": "number", "format": "double" }, "allowedMinBid": { "type": "number", "format": "double" }, "timezone": { "type": "integer", "format": "int32" }, "startTime": { "type": "integer", "format": "int64" }, "endTime": { "type": "integer", "format": "int64" }, "status": { "type": "string" }, "created": { "type": "integer", "format": "int32" }, "excludeFromPlatformServing": { "type": "boolean" }, "forTest": { "type": "boolean" }, "modifiedDate": { "type": "string", "format": "date-time" }, "dspMarginJson": { "type": "string" }, "platformMarginJson": { "type": "string" }, "dspMargin": { "type": "integer", "format": "int32" }, "platformMargin": { "type": "integer", "format": "int32" }, "userDealMargin": { "type": "integer", "format": "int32" }, "isAgreementChecked": { "type": "boolean" }, "spentScale": { "type": "boolean" }, "creativeIds": { "type": "string" }, "targetCPI": { "type": "integer", "format": "int64" }, "conversionType": { "type": "string" }, "conversionTypeId": { "type": "integer", "format": "int32" }, "appURL": { "type": "string" }, "bidOptimization": { "type": "boolean" }, "bidPacing": { "type": "boolean" }, "impressionCapping": { "minimum": 0, "type": "integer", "format": "int32" }, "frequencyCapEnabled": { "type": "boolean" }, "frequencyCapping": { "type": "object", "additionalProperties": { "type": "object", "properties": { "frequencyCapDuration": { "type": "integer", "format": "int32" }, "frequencyCapValue": { "type": "integer", "format": "int32" } } } }, "maxDayImpressions": { "minimum": 0, "type": "integer", "format": "int32" }, "maxDayClicks": { "minimum": 0, "type": "integer", "format": "int32" }, "maxDayConversions": { "minimum": 0, "type": "integer", "format": "int32" }, "totalImpressions": { "minimum": 0, "type": "integer", "format": "int32" }, "totalClicks": { "minimum": 0, "type": "integer", "format": "int32" }, "totalConversions": { "minimum": 0, "type": "integer", "format": "int32" }, "bidStrategyFlag": { "type": "boolean" }, "ioId": { "type": "integer", "format": "int32" }, "prebidAudienceSegmentIdList": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "isBidShading": { "type": "boolean" }, "totalCPM": { "minimum": 0, "type": "number", "format": "double" }, "templateId": { "type": "integer", "format": "int32" }, "carriers": { "type": "string" }, "networkType": { "type": "string" }, "deviceType": { "type": "string" }, "trafficType": { "type": "string" }, "manufacturer": { "type": "string" }, "device": { "type": "string" }, "os": { "type": "string" }, "osVersion": { "type": "string" }, "technologyFlag": { "type": "boolean" }, "exchanges": { "type": "string" }, "whiteListedDeviceId": { "type": "string" }, "whiteListedIp": { "type": "string" }, "whiteListedAppId": { "type": "string" }, "whiteListedPackageName": { "type": "string" }, "whiteListedSiteDomain": { "type": "string" }, "blackListedDeviceId": { "type": "string" }, "blackListedIp": { "type": "string" }, "blackListedAppId": { "type": "string" }, "blackListedPackageName": { "type": "string" }, "blackListedSiteDomain": { "type": "string" }, "advancedFlag": { "type": "boolean" }, "userDealId": { "type": "string" }, "groupDealId": { "type": "string" }, "publisherAdCategory": { "type": "string" }, "campaignIabCategoryIds": { "type": "string" }, "stateIds": { "type": "string" }, "whiteListedStateIds": { "type": "string" }, "blackListedStateIds": { "type": "string" }, "countryId": { "type": "integer", "format": "int32" }, "dmaIds": { "type": "string" }, "whiteListedDmaIds": { "type": "string" }, "blackListedDmaIds": { "type": "string" }, "zipcodes": { "type": "string" }, "whiteListedZipcodes": { "type": "string" }, "blackListedZipcodes": { "type": "string" }, "geoRadiusDetails": { "type": "array", "items": { "type": "object", "properties": { "latitude": { "type": "number", "format": "double" }, "longitude": { "type": "number", "format": "double" }, "radius": { "type": "number", "format": "double" }, "address": { "type": "string" }, "stateShortName": { "type": "string" }, "countryShortName": { "type": "string" }, "locationId": { "type": "integer", "format": "int32" }, "rejectionReason": { "type": "string" }, "polypath": { "type": "object" }, "placemarkName": { "type": "string" }, "isIncluded": { "type": "boolean" }, "cid": { "type": "string" }, "sid": { "type": "string" }, "type": { "type": "string" }, "unit": { "type": "string" }, "cdId": { "type": "integer", "format": "int32" }, "sdId": { "type": "integer", "format": "int32" }, "hdId": { "type": "integer", "format": "int32" } } } }, "whiteListedGeoRadiusDetails": { "type": "array", "items": { "type": "object", "properties": { "latitude": { "type": "number", "format": "double" }, "longitude": { "type": "number", "format": "double" }, "radius": { "type": "number", "format": "double" }, "address": { "type": "string" }, "stateShortName": { "type": "string" }, "countryShortName": { "type": "string" }, "locationId": { "type": "integer", "format": "int32" }, "rejectionReason": { "type": "string" }, "polypath": { "type": "object" }, "placemarkName": { "type": "string" }, "isIncluded": { "type": "boolean" }, "cid": { "type": "string" }, "sid": { "type": "string" }, "type": { "type": "string" }, "unit": { "type": "string" }, "cdId": { "type": "integer", "format": "int32" }, "sdId": { "type": "integer", "format": "int32" }, "hdId": { "type": "integer", "format": "int32" } } } }, "blackListedGeoRadiusDetails": { "type": "array", "items": { "type": "object", "properties": { "latitude": { "type": "number", "format": "double" }, "longitude": { "type": "number", "format": "double" }, "radius": { "type": "number", "format": "double" }, "address": { "type": "string" }, "stateShortName": { "type": "string" }, "countryShortName": { "type": "string" }, "locationId": { "type": "integer", "format": "int32" }, "rejectionReason": { "type": "string" }, "polypath": { "type": "object" }, "placemarkName": { "type": "string" }, "isIncluded": { "type": "boolean" }, "cid": { "type": "string" }, "sid": { "type": "string" }, "type": { "type": "string" }, "unit": { "type": "string" }, "cdId": { "type": "integer", "format": "int32" }, "sdId": { "type": "integer", "format": "int32" }, "hdId": { "type": "integer", "format": "int32" } } } }, "gotvLocationId": { "type": "integer", "format": "int32" }, "congressionalDistrictIds": { "type": "string" }, "whiteListedCongressionalDistrictIds": { "type": "string" }, "blackListedCongressionalDistrictIds": { "type": "string" }, "senateDistrictIds": { "type": "string" }, "whiteListedSenateDistrictIds": { "type": "string" }, "blackListedSenateDistrictIds": { "type": "string" }, "houseDistrictIds": { "type": "string" }, "whiteListedHouseDistrictIds": { "type": "string" }, "blackListedHouseDistrictIds": { "type": "string" }, "locationFileIds": { "type": "string" }, "whiteListedLocationIds": { "type": "string" }, "blackListedLocationIds": { "type": "string" }, "radiusUpdatedLocations": { "type": "object", "additionalProperties": { "type": "number", "format": "double" } }, "removedLocationIds": { "type": "string" }, "whiteListedCityIds": { "type": "string" }, "blackListedCityIds": { "type": "string" }, "whiteListedCountyIds": { "type": "string" }, "blackListedCountyIds": { "type": "string" }, "blackListedInventoryGroupIds": { "type": "string" }, "whiteListedInventoryGroupIds": { "type": "string" }, "inventoryKeywords": { "type": "array", "items": { "type": "string" } }, "inventoryUrls": { "type": "array", "items": { "type": "string" } }, "pmpDealIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "blackListedAudienceIds": { "type": "string" }, "whiteListedAudienceIds": { "type": "string" }, "blackListedCustomAudienceIds": { "type": "string" }, "whiteListedCustomAudienceIds": { "type": "string" }, "advertiserType": { "type": "string" }, "politicalAdvertiserClientId": { "type": "integer", "format": "int32" }, "scheduling": { "type": "object", "additionalProperties": { "type": "object" } }, "ageRangeIds": { "type": "string" }, "genderIds": { "type": "string" }, "languageIds": { "type": "string" }, "incomeRangeIds": { "type": "string" }, "ethnicityIds": { "type": "string" }, "interestIds": { "type": "string" }, "demographicTargetingFlag": { "type": "boolean" }, "whiteListedAudienceSegmentGroupIds": { "type": "string" }, "blackListedAudienceSegmentGroupIds": { "type": "string" }, "blackListedConversionTagIds": { "type": "string" }, "whiteListedConversionTagIds": { "type": "string" }, "conversionIds": { "type": "string" }, "creativesPlacementMapping": { "type": "object", "additionalProperties": { "type": "integer", "format": "int32" } }, "isTvAd": { "type": "boolean" }, "creativeAdvanceTargeting": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "integer", "format": "int32" } } }, "budgetTypeId": { "type": "integer", "format": "int32" }, "campaignEstimatorMetaData": { "type": "object", "properties": { "reachMeta": { "type": "object", "additionalProperties": { "type": "object" } }, "landScapeMeta": { "type": "object", "additionalProperties": { "type": "object" } }, "sliderMeta": { "type": "object", "additionalProperties": { "type": "object" } } } }, "campaignOptimization": { "type": "object", "properties": { "aiObjective": { "type": "integer", "format": "int32" }, "aiGoal": { "type": "integer", "format": "int32" }, "aiTargetKpi": { "type": "number", "format": "double" }, "aiConversionId": { "type": "integer", "format": "int32" } } }, "campaignOptimizationType": { "type": "string" }, "modelledDimensionIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "advanceAudioVideoTargeted": { "type": "boolean" }, "customAudienceTargeted": { "type": "boolean" }, "isAdvanceAudioVideoTargeted": { "type": "boolean" } } }, "examples": { "Update draft campaign with all details.": { "description": "Update draft campaign with all details.", "value": { "campaignName": "Sample campaign name ", "isAgreementChecked": true, "advertiserDomain": "https://www.example.com", "creativeType": 14, "budgetTotal": 100, "startTime": 1598427074, "budgetDay": 18, "timezone": 105, "creativeIds": "100027,100028", "maxBid": 10.5, "minBid": 5.5, "bidOptimization": false, "bidPacing": true, "isBidShading": true, "impressionCapping": 2, "frequencyCapEnabled": true, "frequencyCapping": { "1": { "frequencyCapDuration": 6, "frequencyCapValue": 5 }, "2": { "frequencyCapDuration": 3, "frequencyCapValue": 20 }, "3": { "frequencyCapDuration": 3, "frequencyCapValue": 60 }, "4": { "frequencyCapDuration": 0, "frequencyCapValue": 100 } }, "conversionType": "install", "conversionTypeId": 1, "appURL": "https://www.example.com", "totalBudgetPacing": false, "carriers": "293,294", "networkType": "13", "deviceType": "15", "trafficType": "11", "manufacturer": "451,155", "os": "11,14", "osVersion": "11,12,13", "exchanges": "27,21", "prebidAudienceSegmentIdList": [10, 11, 12], "whiteListedIp": "df", "whiteListedPackageName": "sdf", "whiteListedSiteDomain": "example,https://www.example.com", "blackListedDeviceId": "id1,id2", "blackListedIp": "id11,id22", "blackListedAppId": "id1, id2", "blackListedPackageName": "id1,id2", "blackListedSiteDomain": "https://www.example.com", "publisherAdCategory": "112", "userDealId": "1,2,b", "countryId": 246, "politicalAdvertiserClientId": 17, "locationFileIds": "1011,1010", "whiteListedLocationIds": "48377", "blackListedLocationIds": "48376,48363", "whiteListedGeoRadiusDetails": [ { "unit": "mile", "address": "Cimarron, KS 67835, USA", "latitude": 37.8024861214427, "radius": 2, "type": "circle", "longitude": -100.27823091234, "sid": "4678", "cid": "246" }, { "polypath": [ { "lng": -99.3943706177472, "lat": 37.760219677827 }, { "lng": -99.6195903443097, "lat": 37.6385217160143 } ], "unit": "mile", "address": "Greensburg, KS 67054, USA", "latitude": 37.5741000760343, "type": "custom", "radius": 24.1195753931379, "longitude": -99.3311992310285, "sid": "4678", "cid": "246" } ], "blackListedDmaIds": "3,4", "whiteListedDeviceId": "123,jh34,jkd34", "blackListedHouseDistrictIds": "5202,1684,1685", "whiteListedCongressionalDistrictIds": "78,174,222", "stateIds": "30200031,30200032", "whiteListedStateIds": "30200031,30200032", "blackListedStateIds": "30200033,30200035", "blackListedZipcodes": "35007", "whiteListedSenateDistrictIds": "662,665,2303", "whiteListedHouseDistrictIds": "5096,5067,5201", "blackListedSenateDistrictIds": "2308,988,992", "whiteListedDmaIds": "1,2", "whiteListedZipcodes": "35005", "blackListedAudienceIds": "889185,888981", "advertiserType": "political", "whiteListedAudienceIds": "900254,900271", "blackListedCongressionalDistrictIds": "368,53,100", "isAdvanceAudioVideoTargeted": true, "creativeAdvanceTargeting": { "placementType": [20600001], "rollPosition": [20700001], "playerSize": [20800001], "skippability": [20900001], "playbackMethod": [21000001] }, "inventoryKeywords": [ "Clothing", "Education" ], "inventoryUrls": [ "https://www.google.com", "https://www.iqm.com" ] } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Update draft campaign with all details.": { "description": "Update draft campaign with all details.", "value": { "statusCode": 200, "responseObject": { "data": 292664, "message": "Campaign updated successfully.", "status": "draft" } } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "examples": { "Validation error": { "description": "Validation error", "value": { "statusCode": 400, "responseObject": { "errorMsg": "inventoryGroups are modelled, so it can not be removed from this campaign", "errorCode": 400, "errorField": "inventoryGroups" } } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "statusCode": 500, "responseObject": { "errorMsg": "Internal server error", "errorCode": 500 } } } } } } } }, "/api/v3/internal/cmp/io/draft-campaigns/bulk": { "post": { "tags": [ "Campaign API" ], "summary": "Create IO with bulk draft campaigns", "description": "This operation enables the creation of an IO with multiple draft campaigns in bulk", "operationId": "createIOWithDraftCampaigns", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "required": true, "schema": { "type": "string" }, "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" } ], "requestBody": { "description": "Contains IO and bulk draft campaign specifics, including basic info and identifiers for locations, demographics, segment audiences, inventory groups etc., for targeting", "content": { "application/json": { "schema": { "type": "object", "properties": { "ioDetails": { "required": [ "ioName" ], "type": "object", "properties": { "ioId": { "type": "integer", "format": "int32" }, "ioName": { "maxLength": 255, "minLength": 0, "type": "string" }, "owId": { "type": "integer", "format": "int32" }, "createdByUowId": { "type": "integer", "format": "int32" }, "modifiedByUowId": { "type": "integer", "format": "int32" }, "ioStartTime": { "type": "integer", "format": "int64" }, "ioEndTime": { "type": "integer", "format": "int64" }, "ioTotalBudget": { "minimum": 0, "exclusiveMinimum": false, "type": "number", "format": "double" }, "ioTimeZoneId": { "type": "integer", "format": "int32" }, "isAutoSumIoTotalBudget": { "type": "boolean" }, "ioBudgetDistributionMethodId": { "type": "integer", "format": "int32" }, "ioBudgetTypeId": { "type": "integer", "format": "int32" }, "ioTotalImpressions": { "type": "integer", "format": "int64" }, "ioStatusId": { "type": "integer", "format": "int32" }, "ioNextPerformanceCheck": { "type": "integer", "format": "int64" }, "ioLastPriorityShift": { "type": "integer", "format": "int64" }, "ioCurrentPriority": { "type": "integer", "format": "int32" }, "isIoPrioritise": { "type": "boolean" } } }, "campaigns": { "type": "array", "items": { "required": [ "exchanges", "publisherAdCategory" ], "type": "object", "properties": { "advertiserId": { "type": "integer", "format": "int32" }, "dspId": { "type": "integer", "format": "int32" }, "owId": { "type": "integer", "format": "int32" }, "uowId": { "type": "integer", "format": "int32" }, "id": { "type": "integer", "format": "int32" }, "campaignName": { "type": "string" }, "advertiserDomain": { "type": "string" }, "creativeType": { "type": "integer", "format": "int32" }, "campaignType": { "type": "integer", "format": "int32" }, "totalBudgetPacing": { "type": "boolean" }, "budgetDay": { "minimum": 0, "type": "number", "format": "double" }, "budgetTotal": { "minimum": 0, "type": "number", "format": "double" }, "maxBid": { "type": "number", "format": "double" }, "minBid": { "type": "number", "format": "double" }, "allowedMinBid": { "type": "number", "format": "double" }, "timezone": { "type": "integer", "format": "int32" }, "startTime": { "type": "integer", "format": "int64" }, "endTime": { "type": "integer", "format": "int64" }, "status": { "type": "string" }, "created": { "type": "integer", "format": "int32" }, "excludeFromPlatformServing": { "type": "boolean" }, "forTest": { "type": "boolean" }, "modifiedDate": { "type": "string", "format": "date-time" }, "dspMarginJson": { "type": "string" }, "platformMarginJson": { "type": "string" }, "dspMargin": { "type": "integer", "format": "int32" }, "platformMargin": { "type": "integer", "format": "int32" }, "userDealMargin": { "type": "integer", "format": "int32" }, "isAgreementChecked": { "type": "boolean" }, "spentScale": { "type": "boolean" }, "creativeIds": { "type": "string" }, "targetCPI": { "type": "integer", "format": "int64" }, "conversionType": { "type": "string" }, "conversionTypeId": { "type": "integer", "format": "int32" }, "appURL": { "type": "string" }, "bidOptimization": { "type": "boolean" }, "bidPacing": { "type": "boolean" }, "impressionCapping": { "minimum": 0, "type": "integer", "format": "int32" }, "frequencyCapEnabled": { "type": "boolean" }, "frequencyCapping": { "type": "object", "additionalProperties": { "type": "object", "properties": { "frequencyCapDuration": { "type": "integer", "format": "int32" }, "frequencyCapValue": { "type": "integer", "format": "int32" } } } }, "maxDayImpressions": { "minimum": 0, "type": "integer", "format": "int32" }, "maxDayClicks": { "minimum": 0, "type": "integer", "format": "int32" }, "maxDayConversions": { "minimum": 0, "type": "integer", "format": "int32" }, "totalImpressions": { "minimum": 0, "type": "integer", "format": "int32" }, "totalClicks": { "minimum": 0, "type": "integer", "format": "int32" }, "totalConversions": { "minimum": 0, "type": "integer", "format": "int32" }, "bidStrategyFlag": { "type": "boolean" }, "ioId": { "type": "integer", "format": "int32" }, "prebidAudienceSegmentIdList": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "isBidShading": { "type": "boolean" }, "totalCPM": { "minimum": 0, "type": "number", "format": "double" }, "templateId": { "type": "integer", "format": "int32" }, "carriers": { "type": "string" }, "networkType": { "type": "string" }, "deviceType": { "type": "string" }, "trafficType": { "type": "string" }, "manufacturer": { "type": "string" }, "device": { "type": "string" }, "os": { "type": "string" }, "osVersion": { "type": "string" }, "technologyFlag": { "type": "boolean" }, "exchanges": { "type": "string" }, "whiteListedDeviceId": { "type": "string" }, "whiteListedIp": { "type": "string" }, "whiteListedAppId": { "type": "string" }, "whiteListedPackageName": { "type": "string" }, "whiteListedSiteDomain": { "type": "string" }, "blackListedDeviceId": { "type": "string" }, "blackListedIp": { "type": "string" }, "blackListedAppId": { "type": "string" }, "blackListedPackageName": { "type": "string" }, "blackListedSiteDomain": { "type": "string" }, "advancedFlag": { "type": "boolean" }, "userDealId": { "type": "string" }, "groupDealId": { "type": "string" }, "publisherAdCategory": { "type": "string" }, "campaignIabCategoryIds": { "type": "string" }, "stateIds": { "type": "string" }, "whiteListedStateIds": { "type": "string" }, "blackListedStateIds": { "type": "string" }, "countryId": { "type": "integer", "format": "int32" }, "dmaIds": { "type": "string" }, "whiteListedDmaIds": { "type": "string" }, "blackListedDmaIds": { "type": "string" }, "zipcodes": { "type": "string" }, "whiteListedZipcodes": { "type": "string" }, "blackListedZipcodes": { "type": "string" }, "geoRadiusDetails": { "type": "array", "items": { "type": "object", "properties": { "latitude": { "type": "number", "format": "double" }, "longitude": { "type": "number", "format": "double" }, "radius": { "type": "number", "format": "double" }, "address": { "type": "string" }, "stateShortName": { "type": "string" }, "countryShortName": { "type": "string" }, "locationId": { "type": "integer", "format": "int32" }, "rejectionReason": { "type": "string" }, "polypath": { "type": "object" }, "placemarkName": { "type": "string" }, "isIncluded": { "type": "boolean" }, "cid": { "type": "string" }, "sid": { "type": "string" }, "type": { "type": "string" }, "unit": { "type": "string" }, "cdId": { "type": "integer", "format": "int32" }, "sdId": { "type": "integer", "format": "int32" }, "hdId": { "type": "integer", "format": "int32" } } } }, "whiteListedGeoRadiusDetails": { "type": "array", "items": { "type": "object", "properties": { "latitude": { "type": "number", "format": "double" }, "longitude": { "type": "number", "format": "double" }, "radius": { "type": "number", "format": "double" }, "address": { "type": "string" }, "stateShortName": { "type": "string" }, "countryShortName": { "type": "string" }, "locationId": { "type": "integer", "format": "int32" }, "rejectionReason": { "type": "string" }, "polypath": { "type": "object" }, "placemarkName": { "type": "string" }, "isIncluded": { "type": "boolean" }, "cid": { "type": "string" }, "sid": { "type": "string" }, "type": { "type": "string" }, "unit": { "type": "string" }, "cdId": { "type": "integer", "format": "int32" }, "sdId": { "type": "integer", "format": "int32" }, "hdId": { "type": "integer", "format": "int32" } } } }, "blackListedGeoRadiusDetails": { "type": "array", "items": { "type": "object", "properties": { "latitude": { "type": "number", "format": "double" }, "longitude": { "type": "number", "format": "double" }, "radius": { "type": "number", "format": "double" }, "address": { "type": "string" }, "stateShortName": { "type": "string" }, "countryShortName": { "type": "string" }, "locationId": { "type": "integer", "format": "int32" }, "rejectionReason": { "type": "string" }, "polypath": { "type": "object" }, "placemarkName": { "type": "string" }, "isIncluded": { "type": "boolean" }, "cid": { "type": "string" }, "sid": { "type": "string" }, "type": { "type": "string" }, "unit": { "type": "string" }, "cdId": { "type": "integer", "format": "int32" }, "sdId": { "type": "integer", "format": "int32" }, "hdId": { "type": "integer", "format": "int32" } } } }, "gotvLocationId": { "type": "integer", "format": "int32" }, "congressionalDistrictIds": { "type": "string" }, "whiteListedCongressionalDistrictIds": { "type": "string" }, "blackListedCongressionalDistrictIds": { "type": "string" }, "senateDistrictIds": { "type": "string" }, "whiteListedSenateDistrictIds": { "type": "string" }, "blackListedSenateDistrictIds": { "type": "string" }, "houseDistrictIds": { "type": "string" }, "whiteListedHouseDistrictIds": { "type": "string" }, "blackListedHouseDistrictIds": { "type": "string" }, "locationFileIds": { "type": "string" }, "whiteListedLocationIds": { "type": "string" }, "blackListedLocationIds": { "type": "string" }, "radiusUpdatedLocations": { "type": "object", "additionalProperties": { "type": "number", "format": "double" } }, "removedLocationIds": { "type": "string" }, "whiteListedCityIds": { "type": "string" }, "blackListedCityIds": { "type": "string" }, "whiteListedCountyIds": { "type": "string" }, "blackListedCountyIds": { "type": "string" }, "blackListedInventoryGroupIds": { "type": "string" }, "whiteListedInventoryGroupIds": { "type": "string" }, "inventoryKeywords": { "type": "array", "items": { "type": "string" } }, "inventoryUrls": { "type": "array", "items": { "type": "string" } }, "pmpDealIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "blackListedAudienceIds": { "type": "string" }, "whiteListedAudienceIds": { "type": "string" }, "blackListedCustomAudienceIds": { "type": "string" }, "whiteListedCustomAudienceIds": { "type": "string" }, "advertiserType": { "type": "string" }, "politicalAdvertiserClientId": { "type": "integer", "format": "int32" }, "scheduling": { "type": "object", "additionalProperties": { "type": "object" } }, "ageRangeIds": { "type": "string" }, "genderIds": { "type": "string" }, "languageIds": { "type": "string" }, "incomeRangeIds": { "type": "string" }, "ethnicityIds": { "type": "string" }, "interestIds": { "type": "string" }, "demographicTargetingFlag": { "type": "boolean" }, "whiteListedAudienceSegmentGroupIds": { "type": "string" }, "blackListedAudienceSegmentGroupIds": { "type": "string" }, "blackListedConversionTagIds": { "type": "string" }, "whiteListedConversionTagIds": { "type": "string" }, "conversionIds": { "type": "string" }, "creativesPlacementMapping": { "type": "object", "additionalProperties": { "type": "integer", "format": "int32" } }, "isTvAd": { "type": "boolean" }, "creativeAdvanceTargeting": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "integer", "format": "int32" } } }, "budgetTypeId": { "type": "integer", "format": "int32" }, "campaignEstimatorMetaData": { "type": "object", "properties": { "reachMeta": { "type": "object", "additionalProperties": { "type": "object" } }, "landScapeMeta": { "type": "object", "additionalProperties": { "type": "object" } }, "sliderMeta": { "type": "object", "additionalProperties": { "type": "object" } } } }, "campaignOptimization": { "type": "object", "properties": { "aiObjective": { "type": "integer", "format": "int32" }, "aiGoal": { "type": "integer", "format": "int32" }, "aiTargetKpi": { "type": "number", "format": "double" }, "aiConversionId": { "type": "integer", "format": "int32" } } }, "campaignOptimizationType": { "type": "string" }, "modelledDimensionIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "advanceAudioVideoTargeted": { "type": "boolean" }, "customAudienceTargeted": { "type": "boolean" }, "isAdvanceAudioVideoTargeted": { "type": "boolean" } } } }, "userRequestInfo": { "type": "object", "properties": { "token": { "type": "string" }, "referer": { "type": "string" }, "customReferer": { "type": "string" }, "requestId": { "type": "string" }, "host": { "type": "string" }, "owIdStr": { "type": "string" }, "owId": { "type": "integer", "format": "int32" }, "headerMap": { "type": "object", "additionalProperties": { "type": "string" } } } }, "proposalId": { "type": "integer", "format": "int32" } } }, "examples": { "Payload for IO & draft campaigns in bulk": { "description": "Payload for IO & draft campaigns in bulk", "value": { "ioDetails": { "owId": 836215, "createdByUowId": 492867, "modifiedByUowId": 492867, "ioName": "Client Engagement Drive 2025", "ioStartTime": 1746041700000, "ioEndTime": 1747401960000, "ioTotalBudget": 0.18, "ioBudgetTypeId": 1, "isAutoSumIoTotalBudget": false }, "campaigns": [ { "advertiserId": 0, "dspId": 0, "owId": 836215, "uowId": 492867, "id": 0, "campaignName": "client _engagement _drive 2025_campaign1", "advertiserDomain": null, "creativeType": 11, "campaignType": 1, "totalBudgetPacing": false, "budgetDay": 0, "budgetTotal": 0.156, "maxBid": 1.5, "timezone": null, "startTime": 1746041700, "endTime": 1747401960, "status": null, "created": 0, "excludeFromPlatformServing": false, "forTest": false, "modifiedDate": null, "dspMarginJson": null, "platformMarginJson": null, "dspMargin": 0, "platformMargin": 0, "userDealMargin": 0, "isAgreementChecked": false, "spentScale": false, "creativeIds": null, "targetCPI": 0, "conversionType": "None", "conversionTypeId": 0, "appURL": null, "bidOptimization": false, "bidPacing": false, "impressionCapping": 0, "maxDayImpressions": null, "maxDayClicks": null, "maxDayConversions": null, "totalImpressions": 104, "totalClicks": null, "totalConversions": null, "bidStrategyFlag": false, "ioId": null, "prebidAudienceSegmentIdList": null, "isBidShading": null, "carriers": null, "networkType": null, "deviceType": null, "trafficType": null, "manufacturer": null, "device": null, "os": null, "osVersion": null, "technologyFlag": false, "exchanges": null, "whiteListedDeviceId": null, "whiteListedIp": null, "whiteListedAppId": null, "whiteListedPackageName": null, "whiteListedSiteDomain": null, "blackListedDeviceId": null, "blackListedIp": null, "blackListedAppId": null, "blackListedPackageName": null, "blackListedSiteDomain": null, "advancedFlag": true, "userDealId": null, "groupDealId": null, "publisherAdCategory": null, "campaignIabCategoryIds": null, "stateIds": null, "whiteListedStateIds": "30200031", "blackListedStateIds": "30200032", "countryId": 30100001, "dmaIds": null, "whiteListedDmaIds": "30900189", "blackListedDmaIds": "30900033", "zipcodes": null, "whiteListedZipcodes": "90011", "blackListedZipcodes": "20001,20002", "geoRadiusDetails": null, "whiteListedGeoRadiusDetails": null, "blackListedGeoRadiusDetails": null, "gotvLocationId": 0, "congressionalDistrictIds": null, "whiteListedCongressionalDistrictIds": "30615252", "blackListedCongressionalDistrictIds": "30615253", "senateDistrictIds": null, "whiteListedSenateDistrictIds": "30716195", "blackListedSenateDistrictIds": "30716194", "houseDistrictIds": null, "whiteListedHouseDistrictIds": "30803396", "blackListedHouseDistrictIds": "30803397", "locationFileIds": null, "whiteListedLocationIds": null, "blackListedLocationIds": null, "radiusUpdatedLocations": null, "removedLocationIds": null, "whiteListedCityIds": "30435200", "blackListedCityIds": "30435201", "whiteListedCountyIds": "30318981", "blackListedCountyIds": "30318982", "blackListedInventoryGroupIds": null, "whiteListedInventoryGroupIds": "133232,134436", "blackListedAudienceIds": null, "whiteListedAudienceIds": null, "blackListedCustomAudienceIds": null, "whiteListedCustomAudienceIds": null, "politicalAdvertiserClientId": null, "scheduling": null, "ageRangeIds": "10100009,10100003", "genderIds": "10200001,10200002", "languageIds": "10500048,10500056,10500164", "incomeRangeIds": "10300005,10300006", "ethnicityIds": "10700001", "interestIds": null, "demographicTargetingFlag": true, "whiteListedAudienceSegmentGroupIds": "1063406,1063407", "blackListedAudienceSegmentGroupIds": null, "blackListedConversionTagIds": null, "whiteListedConversionTagIds": null, "conversionIds": null, "creativesPlacementMapping": null, "isTvAd": false, "inventoryKeywords": null, "inventoryUrls": null, "creativeAdvanceTargeting": null, "budgetTypeId": 0, "campaignEstimatorMetaData": null, "customAudienceTargeted": false, "advanceAudioVideoTargeted": false, "isAdvanceAudioVideoTargeted": false }, { "advertiserId": 0, "dspId": 0, "owId": 836215, "uowId": 492867, "id": 0, "campaignName": "client _engagement _drive 2025_campaign2", "advertiserDomain": null, "creativeType": 11, "campaignType": 1, "totalBudgetPacing": false, "budgetDay": 0, "budgetTotal": 0.0225, "maxBid": 1.5, "timezone": null, "startTime": 1746041700, "endTime": 1747401960, "status": null, "created": 0, "excludeFromPlatformServing": false, "forTest": false, "modifiedDate": null, "dspMarginJson": null, "platformMarginJson": null, "dspMargin": 0, "platformMargin": 0, "userDealMargin": 0, "isAgreementChecked": false, "spentScale": false, "creativeIds": null, "targetCPI": 0, "conversionType": "None", "conversionTypeId": 0, "appURL": null, "bidOptimization": false, "bidPacing": false, "impressionCapping": 0, "maxDayImpressions": null, "maxDayClicks": null, "maxDayConversions": null, "totalImpressions": 15, "totalClicks": null, "totalConversions": null, "bidStrategyFlag": false, "ioId": null, "prebidAudienceSegmentIdList": null, "isBidShading": null, "carriers": null, "networkType": null, "deviceType": null, "trafficType": null, "manufacturer": null, "device": null, "os": null, "osVersion": null, "technologyFlag": false, "exchanges": null, "whiteListedDeviceId": null, "whiteListedIp": null, "whiteListedAppId": null, "whiteListedPackageName": null, "whiteListedSiteDomain": null, "blackListedDeviceId": null, "blackListedIp": null, "blackListedAppId": null, "blackListedPackageName": null, "blackListedSiteDomain": null, "advancedFlag": true, "userDealId": null, "groupDealId": null, "publisherAdCategory": null, "campaignIabCategoryIds": null, "stateIds": null, "whiteListedStateIds": "30200031", "blackListedStateIds": "30200032", "countryId": 30100001, "dmaIds": null, "whiteListedDmaIds": "30900189", "blackListedDmaIds": "30900033", "zipcodes": null, "whiteListedZipcodes": "10004", "blackListedZipcodes": "20001,20002", "geoRadiusDetails": null, "whiteListedGeoRadiusDetails": null, "blackListedGeoRadiusDetails": null, "gotvLocationId": 0, "congressionalDistrictIds": null, "whiteListedCongressionalDistrictIds": "30615252", "blackListedCongressionalDistrictIds": "30615253", "senateDistrictIds": null, "whiteListedSenateDistrictIds": "30716195", "blackListedSenateDistrictIds": "30716194", "houseDistrictIds": null, "whiteListedHouseDistrictIds": "30803396", "blackListedHouseDistrictIds": "30803397", "locationFileIds": null, "whiteListedLocationIds": null, "blackListedLocationIds": null, "radiusUpdatedLocations": null, "removedLocationIds": null, "whiteListedCityIds": "30435200", "blackListedCityIds": "30435201", "whiteListedCountyIds": "30318981", "blackListedCountyIds": "30318982", "blackListedInventoryGroupIds": null, "whiteListedInventoryGroupIds": "133232,134436", "blackListedAudienceIds": null, "whiteListedAudienceIds": null, "blackListedCustomAudienceIds": null, "whiteListedCustomAudienceIds": null, "politicalAdvertiserClientId": null, "scheduling": null, "ageRangeIds": "10100009,10100003", "genderIds": "10200001,10200002", "languageIds": "10500048,10500056,10500164", "incomeRangeIds": "10300005,10300006", "ethnicityIds": "10700001", "interestIds": null, "demographicTargetingFlag": true, "whiteListedAudienceSegmentGroupIds": "1063406,1063407", "blackListedAudienceSegmentGroupIds": null, "blackListedConversionTagIds": null, "whiteListedConversionTagIds": null, "conversionIds": null, "creativesPlacementMapping": null, "isTvAd": false, "inventoryKeywords": null, "inventoryUrls": null, "creativeAdvanceTargeting": null, "budgetTypeId": 0, "campaignEstimatorMetaData": null, "customAudienceTargeted": false, "advanceAudioVideoTargeted": false, "isAdvanceAudioVideoTargeted": false } ], "userRequestVO": { "token": "Bearer f47ac10b-58cc-4372-a567-0e02b2c3d479", "referer": null, "customReferer": null, "requestId": "6ba7b810-9dad-11d1-80b4-00c04fd430c8", "host": "acme.corp.example.com", "owIdStr": "836215", "owId": 836215, "headerMap": { "Authorization": "Bearer f47ac10b-58cc-4372-a567-0e02b2c3d479", "X-REQ-ID": "6ba7b810-9dad-11d1-80b4-00c04fd430c8", "X-IAA-OW-ID": "836215", "X-Iaa-Host": "acme.corp.example.com" } }, "proposalId": 1 } } } } }, "required": true }, "responses": { "200": { "description": "Success: Request completed", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "errorObjects": { "type": "array", "items": { "type": "object", "properties": { "error": { "type": "string" }, "reason": { "type": "string" }, "field": { "type": "string" } } } }, "data": { "type": "object" } } }, "examples": { "Response containing IO and associated campaigns": { "description": "Response containing IO and associated campaigns", "value": { "success": true, "data": { "ioId": 9939, "campaignIds": [470899, 470900] } } } } } } }, "422": { "description": "Unprocessable Entity: Request data invalid", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "errorObjects": { "type": "array", "items": { "type": "object", "properties": { "error": { "type": "string" }, "reason": { "type": "string" }, "field": { "type": "string" } } } }, "data": { "type": "object" } } }, "examples": { "Missing IO start date": { "description": "Missing IO start date", "value": { "success": false, "errorObjects": [ { "error": "Start date of IO cannot be empty" } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/internal/cmp/insert-device-cookie-audience-data/{campaignId}": { "post": { "tags": [ "Campaign API" ], "summary": "This API will check and insert missing audience data in aerospike for given campaign", "operationId": "insertMissingDeviceCookieAudienceDataForCampaign", "parameters": [ { "name": "campaignId", "in": "path", "description": "Campaign Id", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "servingSets", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": "{\"success\":true,\"data\":\":true\"}}" } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/internal/cmp/conversion/assign-to/campaign": { "post": { "tags": [ "Campaign API" ], "summary": "API for assign conversion to campaign", "description": "This api assigns conversion to campaign while validating the conversionIds as well as the campaignIds.", "operationId": "assignCampaignToConversion", "parameters": [ { "name": "assignConversionToCampaign", "in": "query", "description": "Map containing details list of campaignIds which needs to be added/removed." } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "conversionIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "addCampaignsList": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "removeCampaignsList": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "owId": { "type": "integer", "format": "int32" }, "conversionTypeId": { "type": "integer", "format": "int32" } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Assign to Campaign with Valid CampaignIds and Valid ConversionIds": { "description": "This responses provides message for saved conversionIds and campaignIds.", "value": { "success": true, "data": { "conversionIdsList": [3925], "validAddCampaignIdsList": [262423, 321884], "invalidAddCampaignIdsList": [262428, 259896, 321946], "validRemoveCampaignIdsList": [262428], "invalidRemoveCampaignIdsList": [262423, 259896, 321884, 321946] } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden!" } ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/internal/cmp/campaigns/{campaignId}/toggle-goal-ai": { "post": { "tags": [ "Campaign API" ], "summary": "Toggle Goal AI Campaign Status", "description": "Internal API to enable/disable Goal AI campaigns. When enabling, validates that AI is not already applied from platform and that backend filter config is valid.", "operationId": "toggleGoalAICampaign", "parameters": [ { "name": "enable", "in": "query", "description": "Set to true to enable Goal AI, false to disable", "required": true, "schema": { "type": "boolean" }, "example": true }, { "name": "campaignId", "in": "path", "description": "The ID of the campaign to toggle Goal AI", "required": true, "schema": { "type": "integer", "format": "int32" }, "example": 12345 } ], "responses": { "200": { "description": "Goal AI campaign status toggled successfully", "content": { "application/json": { "examples": { "Success Response": { "description": "Success Response", "value": { "success": true, "data": "Goal AI campaign enabled successfully" } } } } } }, "400": { "description": "Bad Request - Required parameter missing or malformed", "content": { "application/json": { "examples": { "Bad Request Error": { "description": "Bad Request Error", "value": { "success": false, "error": "Required request parameter 'enable' is not present" } } } } } }, "422": { "description": "Unprocessable Entity - Validation failed", "content": { "application/json": { "examples": { "Validation Error": { "description": "Validation Error", "value": { "success": false, "error": "Cannot enable Goal AI: AI is already applied from platform" } } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "examples": { "Server Error": { "description": "Server Error", "value": { "success": false, "error": "An error occurred while processing the request." } } } } } } } } }, "/api/v3/internal/cmp/campaigns/{campaignId}/apply-goal-ai-config": { "post": { "tags": [ "Campaign API" ], "summary": "Apply Goal AI Configuration", "description": "Internal API to apply goal AI configurations post-campaign save. Validates and updates campaign optimization settings from backend. Reuses the same validation logic as campaign edit flow to ensure consistency.", "operationId": "applyGoalAIConfig", "parameters": [ { "name": "campaignId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "Campaign optimization configuration containing AI objective, goal, target KPI, and conversion ID.", "content": { "application/json": { "schema": { "type": "object", "properties": { "aiObjective": { "type": "integer", "format": "int32" }, "aiGoal": { "type": "integer", "format": "int32" }, "aiTargetKpi": { "type": "number", "format": "double" }, "aiConversionId": { "type": "integer", "format": "int32" } } }, "examples": { "Apply Goal AI Configuration Request": { "description": "Apply Goal AI Configuration Request", "value": { "aiObjective": 1, "aiGoal": 2, "aiTargetKpi": 5, "aiConversionId": 456 } } } } }, "required": true }, "responses": { "200": { "description": "Goal AI configuration applied successfully", "content": { "application/json": { "examples": { "Success Response": { "description": "Success Response", "value": { "success": true, "data": "Campaign optimization configuration applied successfully" } } } } } }, "422": { "description": "Unprocessable Entity - Validation failed or invalid parameters", "content": { "application/json": { "examples": { "Validation Error": { "description": "Validation Error", "value": { "success": false, "error": "AI goal is not supported by AI objective" } } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "examples": { "Server Error": { "description": "Server Error", "value": { "success": false, "error": "An error occurred while processing the request." } } } } } } } } }, "/api/v3/internal/cmp/campaigns/reduce-cpm-goal-eligibility": { "post": { "tags": [ "Campaign API" ], "summary": "Get Reduce CPM Goal Eligibility", "description": "Fetches the eligibility data for reducing CPM goals for the given campaign IDs.", "operationId": "getReduceCPMGoalEligibility", "requestBody": { "description": "Request body containing a list of campaign IDs.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "integer", "format": "int32" } } }, "examples": { "Reduce CPM Goal Eligibility Request": { "description": "Reduce CPM Goal Eligibility Request", "value": { "campaignIds": [123, 456, 789] } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Reduce CPM Goal Eligibility Response": { "description": "Reduce CPM Goal Eligibility Response", "value": [ { "campaignId": 123, "eligible": true }, { "campaignId": 456, "eligible": false } ] } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "examples": { "Bad Request": { "description": "Bad Request", "value": { "success": false, "error": "Invalid input provided." } } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "examples": { "Server Error": { "description": "Server Error", "value": { "success": false, "error": "An error occurred while processing the request." } } } } } } } } }, "/api/v3/internal/cmp/campaign/lifespans": { "post": { "tags": [ "Campaign API" ], "summary": "This API provides earliest campaign start date to campaign end-date of provided campaign ids or owIds.", "description": "From provided campaign ids or OwIds. API fetch minimum start date(earliest campaign start date) and Maximum end date", "operationId": "getCampaignsLifeSpan", "requestBody": { "description": "This API provides earliest campaign start date to latest campaign end-date of provided campaign ids or owIds. \n\n---\n\n#### Request Body Detail\n\n| **Field** | **Type** | **Description** |\n| --- | --- | --- |\n| campaignIds | Array of Integer | This represent campaign Ids filter. If provided, response data will be filtered for those campaign ids only.| \n| owIds `[optional]` | Array of Integer | This represent customer owIds filter. If provided, response data will be filtered for those customer owIds only.| \n", "content": { "application/json": { "schema": { "required": [ "campaignIds" ], "type": "object", "properties": { "campaignIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "owIds": { "type": "array", "items": { "type": "integer", "format": "int32" } } } }, "examples": { "Get campaign dates": { "description": "Get campaign dates", "value": { "campaignIds": [1, 2], "owIds": [3, 4] } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Get campaign dates": { "description": "Get campaign dates", "value": { "success": true, "data": { "minStartDate": 1691671023000, "maxEndDate": 1791671023000 } } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/internal/cmp/audience/update-locations": { "post": { "tags": [ "Campaign API" ], "summary": "This API will update locations", "description": "Internal API to update the location to set as excluded if it is there, and delete location details for given ids.", "operationId": "updateLocationsForCampaignAudiences", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "excludedLocationIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "removedLocationsIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "locationFileIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } } } }, "examples": { "Request body for updating locations": { "description": "Request body for updating locations", "value": { "excludedLocationIds": [1, 2, 3], "removedLocationsIds": [4, 5, 6], "locationFileIds": [100, 101] } } } } }, "required": true }, "responses": { "200": { "description": "Successful update of locations", "content": { "application/json": { "examples": { "Successful location update response": { "description": "Successful location update response", "value": { "success": true, "data": { "message": "Locations updated successfully." } } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/cmp/target/conversion": { "post": { "tags": [ "Campaign API" ], "summary": "It will target multiple conversions to multiple campaign at a time.", "operationId": "createCampaignConversionTargeting", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "conversionIds": { "type": "string" }, "campaignIds": { "type": "string" }, "conversionTypeId": { "type": "integer", "format": "int32" } } }, "examples": { "Target Conversions to Campaigns": { "description": "Target Conversions to Campaigns", "value": { "conversionIds": "123", "campaignIds": "276417" } }, "Delete campaign targeting of conversion": { "description": "Delete campaign targeting of conversion", "value": { "conversionIds": "123", "campaignIds": "" } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Replace values": { "description": "Replace values", "value": { "success": true, "data": { "message": "1 Conversions assigned to campaigns successfully." } } } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "examples": { "Empty values": { "description": "Empty values", "value": { "success": false, "errorObjects": [ { "error": "invalid conversion ids" } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/cmp/target/audience": { "post": { "tags": [ "Campaign API" ], "summary": "API to update audience targeting in campaigns", "description": "This API updates the audience targeting in the given campaign list. it supports include, exclude and remove audiences support", "operationId": "CampaignAudienceTargetingList", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "object", "properties": { "includedAudienceList": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "excludedAudienceList": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "removedAudienceList": { "type": "array", "items": { "type": "integer", "format": "int32" } } } } }, "examples": { "Successfully updates audience targeting.": { "description": "Successfully updates audience targeting.", "value": "{ \"477717\": { \"includedAudienceList\": [ 1064656, 1060603 ], \"excludedAudienceList\": [ 1064000, 1060111 ], \"removedAudienceList\": [[ 1064222, 1060333 ],}" }, "Partially updates audience targeting.": { "description": "Partially updates audience targeting.", "value": "{ \"477717\": { \"includedAudienceList\": [ 1064656, 1060603 ], \"excludedAudienceList\": [ 1064000, 1060111 ], \"removedAudienceList\": [[ 1064222, 1060333 ],}" } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "examples": { "Successfully updates audience targeting.": { "description": "Successfully updates audience targeting.", "value": { "success": true, "data": { "message": "Your changes have been successfully saved." } } }, "Partially updates audience targeting.": { "description": "Partially updates audience targeting.", "value": { "success": false, "data": { "message": "Your changes have been successfully saved.", "failedCampaigns": { "477717": "Can not target more than 20 audiences." } } } } } } } }, "422": { "description": "Error response for campaigns of type PG found in audience targeting", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "errorObjects": { "type": "array", "items": { "type": "object", "properties": { "error": { "type": "string" }, "reason": { "type": "string" }, "field": { "type": "string" } } } }, "data": { "type": "object" } } }, "examples": { "PG Campaigns Not Allowed": { "description": "PG Campaigns Not Allowed", "value": { "success": false, "errorObjects": [ { "error": "One or more campaigns are PG campaigns and cannot be used for audience targeting: [529192, 506992, 506991]" } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/cmp/startDate/list": { "post": { "tags": [ "Campaign API" ], "summary": "This API provides list of unique campaign's start date.", "description": "Get a paginated list of campaign's start date based on the provided filters.", "operationId": "getCampaignStartDateList", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "description": "#### Request Body Detail\n\n| **Field** | **Type** | **Description** |\n| --- | --- | --- |\n|| pageNo `[optional]` | Number | Page number for the required data. The default value is 1. Setting the page number to -1 will disable pagination and return all data in a single page.|| noOfEntries `[optional]` | Number | The maximum number of returned results per page. Default value is 300.|| sortBy `[optional]` | String | Sort the result set by specific field. For ascending use plus(+) sign(ascii value '%2B') and for descending use minus(-) sign. Sorting is only allowed on the `campaignDate` field. The default sorting order is descending on the campaign start date field and can be expressed as `-campaignDate`.|| startDate `[optional]` | String | This represents a date filter. If a date is provided, the response data will be filtered to only include entries that have a date greater than the specified date. || endDate `[optional]` | String | This represents a date filter. If a date is provided, the response data will be filtered to only include entries that have a date less than the specified date. || ids `[optional]` | Array of String | Prioritizing selected dates over other dates in a response.|| isAllOwIds `[optional]` | Boolean | This represent filter records with all allowed owIds. if provided as `true`. `isAllOwIds` is more of a priority than `owIds`. || owIds `[optional]` | Array of Integer | This represent customer owIds filter. If provided, response data will be filtered for those customer owIds only. |", "content": { "application/json": { "schema": { "type": "object", "properties": { "sortByFields": { "type": "object", "additionalProperties": { "type": "string" } }, "owIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "isAllOwIds": { "type": "boolean" }, "ids": { "type": "array", "items": { "type": "string" } }, "startDate": { "type": "string" }, "endDate": { "type": "string" }, "pageNo": { "type": "integer", "format": "int32" }, "noOfEntries": { "type": "integer", "format": "int32" }, "sortBy": { "type": "string" }, "searchField": { "type": "string" }, "order": { "type": "string", "enum": [ "com.iqm.commons.models.enums.SortOrderEnum@6f37475b[id=1,name=asc,symbol=+,name=ASC,ordinal=0]", "com.iqm.commons.models.enums.SortOrderEnum@3e0e6466[id=2,name=desc,symbol=-,name=DESC,ordinal=1]" ] } } }, "examples": { "Get all campaign's start date": { "description": "Get all campaign's start date", "value": { "noOfEntries": 10, "pageNo": 1, "owIds": [], "ids": [], "searchField": "", "sortBy": "-campaignDate" } }, "No record found": { "description": "No record found", "value": { "noOfEntries": 10, "pageNo": 1, "owIds": [], "ids": [], "searchField": "-", "sortBy": "-campaignDate" } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Get all campaign's start date": { "description": "Get all campaign's start date", "value": { "success": true, "data": { "data": [ "02/21/2023", "01/27/2023", "01/20/2023", "01/11/2023", "01/06/2023", "01/05/2023", "12/29/2022", "12/28/2022", "12/23/2022", "12/22/2022" ], "totalRecords": 42, "filteredRecords": 42 } } }, "No record found": { "description": "No record found", "value": { "success": true, "data": { "data": [], "totalRecords": 0, "filteredRecords": 0 } } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/cmp/pg/campaigns/draft/add": { "post": { "tags": [ "Campaign API" ], "summary": "It will Create the new draft PG Campaign for advertiser.", "description": "Given API will Create the new draft PG Campaign for advertiser User.\n\n---\n\n#### Request Body Detail\n\n| **Field** | **Type** | **Description** |\n| --- | --- | --- |\n| pgCampaignInfoVO |Object| Object contains of campaign information| |\n| campaignName | String | Name of the given campaign|\n| ioId | int | Id of insertion order associated with campaign|\n| timeZoneId | int | Represent timezone of campaign|\n| totalImpressions | int | Targeted impressions for impression based campaign as budget |\n| maxBid | double | Maximum allowed bid price for campaign|\n| startTime | long | Start time of the campaign in epoch seconds|\n| endTime | long | End time of the campaign in epoch seconds |\n| budgetTypeId | int | Id of Budget type of given campaign (impression based / dollar based)|\n| campaignTypeId | int | Id of Campaign Type (advanced Campaign(not supported in this API)/ PG deal campaign) |\n| advertiserDomain | String | Domain of the advertiser user|\n| budgetTotal | double | Total budget of the campaign in dollar for dollar based campaign|\n| creativeTargeting | Object | consist of campaign creative targeting details|\n| creativeTypeId | int | Type Id of creatives attached with campaign |\n| creativeIds | String | Ids of creatives attached with campaign |\n| inventoryTargeting | Object | Consist of campaign PG deal targeting details|\n| pgDealIds | String | Ids of PG Deal attached with campaign |\n| conversionTargeting | Object | Consist of campaign conversion targeting details |\n| conversionTypeId | int | Type Id of conversion attached with campaign|\n| conversionIds | String | Ids of conversion attached with campaign |\n| politicalAdvertiserClientId | int | Advertiser client Id if User is political advertiser |\n| countryId | int | Id of the targeted country |\n", "operationId": "addDraftPGCampaign", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "content": { "application/json": { "schema": { "required": [ "pgCampaignInfo" ], "type": "object", "properties": { "countryId": { "type": "integer", "format": "int32" }, "politicalAdvertiserClientId": { "type": "integer", "format": "int32" }, "conversionTargeting": { "required": [ "conversionIds" ], "type": "object", "properties": { "conversionTypeId": { "type": "integer", "format": "int32" }, "conversionIds": { "type": "array", "items": { "type": "integer", "format": "int32" } } } }, "templateId": { "type": "integer", "format": "int32" }, "creativeTargeting": { "required": [ "creativeIds", "creativeTypeId" ], "type": "object", "properties": { "creativeTypeId": { "type": "integer", "format": "int32" }, "creativeIds": { "type": "array", "items": { "type": "integer", "format": "int32" } } } }, "inventoryTargeting": { "required": [ "pgDealIds" ], "type": "object", "properties": { "pgDealIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "paymentTypeId": { "type": "integer", "format": "int32" } } }, "pgCampaignInfo": { "required": [ "advertiserDomain", "budgetTypeId", "campaignName", "ioId", "maxBid", "startTime", "timeZoneId" ], "type": "object", "properties": { "campaignName": { "maxLength": 1024, "minLength": 0, "type": "string" }, "timeZoneId": { "type": "integer", "format": "int32" }, "spendingBudget": { "type": "number", "format": "double" }, "maxBid": { "maximum": 1000, "exclusiveMaximum": false, "type": "number", "format": "double" }, "startTime": { "type": "integer", "format": "int64" }, "endTime": { "type": "integer", "format": "int64" }, "totalImpressions": { "type": "integer", "format": "int64" }, "advertiserDomain": { "type": "string" }, "advertiserType": { "type": "string" }, "ioId": { "type": "integer", "format": "int32" }, "budgetTypeId": { "type": "integer", "format": "int32" }, "campaignTypeId": { "type": "integer", "format": "int32" }, "owId": { "type": "integer", "format": "int32" }, "uowId": { "type": "integer", "format": "int32" }, "creativeTypeId": { "type": "integer", "format": "int32" }, "status": { "type": "string" }, "configObj": { "type": "string" }, "totalBudget": { "type": "number", "format": "double" }, "pgFeesPercentage": { "type": "number", "format": "double" }, "totalCPM": { "type": "number", "format": "double" } } } } }, "examples": { "Create new impression based PG Campaign by advertiser user": { "description": "Create new impression based PG Campaign by advertiser user", "value": { "pgCampaignInfo": { "campaignName": "test imps PG campaign", "ioId": 95179, "timeZoneId": 29, "totalImpressions": 12345, "maxBid": 8, "startTime": 1715662337, "endTime": 1717128000, "budgetTypeId": 2, "campaignTypeId": 2, "advertiserDomain": "https://www.xyz.com" }, "creativeTargeting": { "creativeTypeId": 11, "creativeIds": "[644506]" }, "inventoryTargeting": { "pgDealIds": "[30,12]" }, "conversionTargeting": { "conversionTypeId": 1, "conversionIds": "[465,687,987]" }, "politicalAdvertiserClientId": 989898, "countryId": 23 } }, "Create new budget based PG Campaign by advertiser user": { "description": "Create new budget based PG Campaign by advertiser user", "value": { "pgCampaignInfoVO": { "campaignName": "test imps PG campaign", "ioId": 95179, "timeZoneId": 29, "budgetTotal": 1234, "maxBid": 8, "startTime": 1715662337, "endTime": 1717128000, "budgetTypeId": 1, "campaignTypeId": 2, "advertiserType": "political", "advertiserDomain": "https://www.xyz.com" }, "creativeTargeting": { "creativeTypeId": 11, "creativeIds": "[644506]" }, "inventoryTargeting": { "pgDealIds": "[30,12]" }, "conversionTargeting": { "conversionTypeId": 1, "conversionIds": "[465,687,987]" }, "politicalAdvertiserClientId": 989898, "countryId": 23 } } } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "examples": { "Successful creation of new PG Campaign": { "description": "Successful creation of new PG Campaign", "value": { "success": true, "data": { "message": "PG Campaign Created successfully", "campaignId": 2 } } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/cmp/pg/campaigns/add": { "post": { "tags": [ "Campaign API" ], "summary": "It will Create the new PG Campaign for advertiser.", "description": "Given API will Create the new PG Campaign for advertiser User.\n\n---\n\n#### Request Body Detail\n\n| **Field** | **Type** | **Description** |\n| --- | --- | --- |\n| pgCampaignInfoVO |Object| Object contains of campaign information| |\n| campaignName | String | Name of the given campaign|\n| ioId | int | Id of insertion order associated with campaign|\n| timeZoneId | int | Represent timezone of campaign|\n| totalImpressions | int | Targeted impressions for impression based campaign as budget |\n| maxBid | double | Maximum allowed bid price for campaign|\n| startTime | long | Start time of the campaign in epoch seconds|\n| endTime | long | End time of the campaign in epoch seconds |\n| budgetTypeId | int | Id of Budget type of given campaign (impression based / dollar based)|\n| campaignTypeId | int | Id of Campaign Type (advanced Campaign(not supported in this API)/ PG deal campaign) |\n| advertiserDomain | String | Domain of the advertiser user|\n| budgetTotal | double | Total budget of the campaign in dollar for dollar based campaign|\n| creativeTargeting | Object | consist of campaign creative targeting details|\n| creativeTypeId | int | Type Id of creatives attached with campaign |\n| creativeIds | String | Ids of creatives attached with campaign |\n| inventoryTargeting | Object | Consist of campaign PG deal targeting details|\n| pgDealIds | String | Ids of PG Deal attached with campaign |\n| conversionTargeting | Object | Consist of campaign conversion targeting details |\n| conversionTypeId | int | Type Id of conversion attached with campaign|\n| conversionIds | String | Ids of conversion attached with campaign |\n| politicalAdvertiserClientId | int | Advertiser client Id if User is political advertiser |\n| countryId | int | Id of the targeted country |\n", "operationId": "addPGCampaign", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "content": { "application/json": { "schema": { "required": [ "creativeTargeting", "inventoryTargeting", "pgCampaignInfo" ], "type": "object", "properties": { "countryId": { "type": "integer", "format": "int32" }, "politicalAdvertiserClientId": { "type": "integer", "format": "int32" }, "conversionTargeting": { "required": [ "conversionIds" ], "type": "object", "properties": { "conversionTypeId": { "type": "integer", "format": "int32" }, "conversionIds": { "type": "array", "items": { "type": "integer", "format": "int32" } } } }, "templateId": { "type": "integer", "format": "int32" }, "creativeTargeting": { "required": [ "creativeIds", "creativeTypeId" ], "type": "object", "properties": { "creativeTypeId": { "type": "integer", "format": "int32" }, "creativeIds": { "type": "array", "items": { "type": "integer", "format": "int32" } } } }, "inventoryTargeting": { "required": [ "pgDealIds" ], "type": "object", "properties": { "pgDealIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "paymentTypeId": { "type": "integer", "format": "int32" } } }, "pgCampaignInfo": { "required": [ "advertiserDomain", "budgetTypeId", "campaignName", "ioId", "maxBid", "startTime", "timeZoneId" ], "type": "object", "properties": { "campaignName": { "maxLength": 1024, "minLength": 0, "type": "string" }, "timeZoneId": { "type": "integer", "format": "int32" }, "spendingBudget": { "type": "number", "format": "double" }, "maxBid": { "maximum": 1000, "exclusiveMaximum": false, "type": "number", "format": "double" }, "startTime": { "type": "integer", "format": "int64" }, "endTime": { "type": "integer", "format": "int64" }, "totalImpressions": { "type": "integer", "format": "int64" }, "advertiserDomain": { "type": "string" }, "advertiserType": { "type": "string" }, "ioId": { "type": "integer", "format": "int32" }, "budgetTypeId": { "type": "integer", "format": "int32" }, "campaignTypeId": { "type": "integer", "format": "int32" }, "owId": { "type": "integer", "format": "int32" }, "uowId": { "type": "integer", "format": "int32" }, "creativeTypeId": { "type": "integer", "format": "int32" }, "status": { "type": "string" }, "configObj": { "type": "string" }, "totalBudget": { "type": "number", "format": "double" }, "pgFeesPercentage": { "type": "number", "format": "double" }, "totalCPM": { "type": "number", "format": "double" } } } } }, "examples": { "Create new impression based PG Campaign by advertiser user": { "description": "Create new impression based PG Campaign by advertiser user", "value": { "pgCampaignInfo": { "campaignName": "test imps PG campaign", "ioId": 95179, "timeZoneId": 29, "totalImpressions": 12345, "maxBid": 8, "startTime": 1715662337, "endTime": 1717128000, "budgetTypeId": 2, "campaignTypeId": 2, "advertiserDomain": "https://www.xyz.com" }, "creativeTargeting": { "creativeTypeId": 11, "creativeIds": "[644506]" }, "inventoryTargeting": { "pgDealIds": "[30,12]" }, "conversionTargeting": { "conversionTypeId": 1, "conversionIds": "[465,687,987]" }, "politicalAdvertiserClientId": 989898, "countryId": 23 } }, "Create new budget based PG Campaign by advertiser user": { "description": "Create new budget based PG Campaign by advertiser user", "value": { "pgCampaignInfoVO": { "campaignName": "test imps PG campaign", "ioId": 95179, "timeZoneId": 29, "budgetTotal": 1234, "maxBid": 8, "startTime": 1715662337, "endTime": 1717128000, "budgetTypeId": 1, "advertiserType": "political", "campaignTypeId": 2, "advertiserDomain": "https://www.xyz.com" }, "creativeTargeting": { "creativeTypeId": 11, "creativeIds": "[644506]" }, "inventoryTargeting": { "pgDealIds": "[30,12]" }, "conversionTargeting": { "conversionTypeId": 1, "conversionIds": "[465,687,987]" }, "politicalAdvertiserClientId": 989898, "countryId": 23 } } } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "examples": { "Successful creation of new PG Campaign": { "description": "Successful creation of new PG Campaign", "value": { "success": true, "data": { "message": "PG Campaign Created successfully", "campaignId": 2 } } } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "examples": { "Invalid Campaign Type": { "description": "Invalid Campaign Type", "value": { "success": false, "errorObjects": [ { "error": "Invalid campaign Type provided" } ] } }, "Insertion order is not belong to user organisation": { "description": "Insertion order is not belong to user organisation", "value": { "success": false, "errorObjects": [ { "error": "The action cannot be completed as insertion order 112 does not belong to this organization" } ] } }, "IO and campaign budget type should be same": { "description": "IO and campaign budget type should be same", "value": { "success": false, "errorObjects": [ { "error": "IO and campaign budget type should be same" } ] } }, "Invalid IO ids.": { "description": "Invalid IO ids.", "value": { "success": false, "errorObjects": [ { "error": "Invalid IO ids." } ] } }, "Campaign start time can't be before IO start time": { "description": "Campaign start time can't be before IO start time", "value": { "success": false, "errorObjects": [ { "error": "Campaign start time can't be before IO start time" } ] } }, "Invalid budget type provided": { "description": "Invalid budget type provided", "value": { "success": false, "errorObjects": [ { "error": "Invalid budget type provided" } ] } }, "Total budget is required.": { "description": "Total budget is required.", "value": { "success": false, "errorObjects": [ { "error": "Total budget is required." } ] } }, "Total impression should not be empty": { "description": "Total impression should not be empty", "value": { "success": false, "errorObjects": [ { "error": "Total impression should not be empty" } ] } }, "Start date must be in future": { "description": "Start date must be in future", "value": { "success": false, "errorObjects": [ { "error": "You cannot input a start_date earlier than current minute." } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/cmp/io/startDate/list": { "post": { "tags": [ "Campaign API" ], "summary": "This API provides list of unique io's start date.", "description": "Get a paginated list of io's start date based on the provided filters.", "operationId": "getIOStartDateList", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "description": "#### Request Body Detail\n\n| **Field** | **Type** | **Description** |\n| --- | --- | --- |\n|\n| pageNo `[optional]` | Number | Page number for the required data. The default value is 1. Setting the page number to -1 will disable pagination and return all data in a single page.|\n| noOfEntries `[optional]` | Number | The maximum number of returned results per page. Default value is 300.|\n| sortBy `[optional]` | String | Sort the result set by specific field. For ascending use plus(+) sign(ascii value '%2B') and for descending use minus(-) sign. Sorting is only allowed on the `ioDate` field. The default sorting order is descending on the io start date field and can be expressed as `-ioDate`.|\n| startDate `[optional]` | String | This represents a date filter. If a date is provided, the response data will be filtered to only include entries that have a date greater than the specified date. |\n| endDate `[optional]` | String | This represents a date filter. If a date is provided, the response data will be filtered to only include entries that have a date less than the specified date. |\n| ids `[optional]` | Array of String | Prioritizing selected dates over other dates in a response.|\n| isAllOwIds `[optional]` | Boolean | This represent filter records with all allowed owIds. if provided as `true`. `isAllOwIds` is more of a priority than `owIds`. |\n| owIds `[optional]` | Array of Integer | This represent customer owIds filter. If provided, response data will be filtered for those customer owIds only. |\n", "content": { "application/json": { "schema": { "type": "object", "properties": { "sortByFields": { "type": "object", "additionalProperties": { "type": "string" } }, "owIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "isAllOwIds": { "type": "boolean" }, "ids": { "type": "array", "items": { "type": "string" } }, "startDate": { "type": "string" }, "endDate": { "type": "string" }, "pageNo": { "type": "integer", "format": "int32" }, "noOfEntries": { "type": "integer", "format": "int32" }, "sortBy": { "type": "string" }, "searchField": { "type": "string" }, "order": { "type": "string", "enum": [ "com.iqm.commons.models.enums.SortOrderEnum@6f37475b[id=1,name=asc,symbol=+,name=ASC,ordinal=0]", "com.iqm.commons.models.enums.SortOrderEnum@3e0e6466[id=2,name=desc,symbol=-,name=DESC,ordinal=1]" ] } } }, "examples": { "Get all io's start date": { "description": "Get all io's start date", "value": { "noOfEntries": 10, "pageNo": 1, "owIds": [], "ids": [], "searchField": "", "sortBy": "-ioDate" } }, "io's Start date with date filter": { "description": "io's Start date with date filter", "value": { "noOfEntries": 30, "pageNo": -1, "searchField": "", "sortBy": "-Date", "startDate": "08/17/2023", "endDate": "11/17/2023" } }, "io's Start date with date filter for super/workspace admin": { "description": "io's Start date with date filter for super/workspace admin", "value": { "noOfEntries": 30, "pageNo": -1, "isAllOwIds": "true", "sortBy": "-Date", "startDate": "08/17/2023", "endDate": "11/17/2023" } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Get all io's start date": { "description": "Get all io's start date", "value": { "success": true, "data": { "ioStartDateList": [ "02/21/2023", "01/27/2023", "01/20/2023", "01/11/2023", "01/06/2023", "01/05/2023", "12/29/2022", "12/28/2022", "12/23/2022", "12/22/2022" ], "totalRecords": 16, "filteredRecords": 10 } } }, "No record found": { "description": "No record found", "value": { "success": true, "data": { "ioStartDateList": [], "totalRecords": 0, "filteredRecords": 0 } } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/cmp/io/ids": { "post": { "tags": [ "Campaign API" ], "summary": "Get Campaign IO ID Listing", "description": "This API retrieves a list of IO IDs based on the provided filters such as `searchField`, `budgetTypeIds`, etc. Note: The response contains only IO IDs and not full IO details. If owIds are provided in the request, they will be filtered based on the user's access rights else the user's own owId and its child owIds will be used.", "operationId": "getCampaignIoListing", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "description": "Request body containing filters for retrieving campaign IO IDs.", "content": { "application/json": { "schema": { "type": "object", "properties": { "ioIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "budgetTypeIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "owIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "searchField": { "type": "string" } } }, "examples": { "sample request body": { "description": "sample request body", "value": { "searchField": "test", "budgetTypeIds": [2], "ioIds": [9230, 24255, 24252], "owIds": [202741, 204777, 204778] } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved campaign IO IDs.", "content": { "application/json": { "schema": { "type": "object", "properties": { "ioIds": { "type": "array", "items": { "type": "integer", "format": "int32" } } } }, "example": { "success": true, "data": { "ioIds": [578519, 578522, 578524, 578521] } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/cmp/io/endDate/list": { "post": { "tags": [ "Campaign API" ], "summary": "This API provides list of unique io's end date.", "description": "Get a paginated list of io's end date based on the provided filters.", "operationId": "getIOEndDateList", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "description": "#### Request Body Detail\n\n| **Field** | **Type** | **Description** |\n| --- | --- | --- |\n|\n| pageNo `[optional]` | Number | Page number for the required data. The default value is 1. Setting the page number to -1 will disable pagination and return all data in a single page.|\n| noOfEntries `[optional]` | Number | The maximum number of returned results per page. Default value is 300.|\n| sortBy `[optional]` | String | Sort the result set by specific field. For ascending use plus(+) sign(ascii value '%2B') and for descending use minus(-) sign. Sorting is only allowed on the `ioDate` field. The default sorting order is descending on the io start date field and can be expressed as `-ioDate`.|\n| startDate `[optional]` | String | This represents a date filter. If a date is provided, the response data will be filtered to only include entries that have a date greater than the specified date. |\n| endDate `[optional]` | String | This represents a date filter. If a date is provided, the response data will be filtered to only include entries that have a date less than the specified date. |\n| ids `[optional]` | Array of String | Prioritizing selected dates over other dates in a response.|\n| isAllOwIds `[optional]` | Boolean | This represent filter records with all allowed owIds. if provided as `true`. `isAllOwIds` is more of a priority than `owIds`. |\n| owIds `[optional]` | Array of Integer | This represent customer owIds filter. If provided, response data will be filtered for those customer owIds only. |\n", "content": { "application/json": { "schema": { "type": "object", "properties": { "sortByFields": { "type": "object", "additionalProperties": { "type": "string" }, "deprecated": true }, "sortByFieldsLinkedHashMap": { "type": "object", "additionalProperties": { "type": "string" } }, "searchBy": { "type": "array", "items": { "type": "string" } }, "owIdList": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "ids": { "type": "array", "items": { "type": "string" } }, "startDate": { "type": "string" }, "endDate": { "type": "string" }, "pagination": { "type": "string" }, "pageNo": { "type": "integer", "format": "int32" }, "noOfEntries": { "type": "integer", "format": "int32" }, "sortBy": { "type": "string" }, "searchField": { "type": "string" }, "order": { "type": "string", "enum": [ "com.iqm.api.common.model.enums.SortOrderEnum@44542a89[id=1,name=asc,symbol=+,name=ASC,ordinal=0]", "com.iqm.api.common.model.enums.SortOrderEnum@19cf2ba3[id=2,name=desc,symbol=-,name=DESC,ordinal=1]" ] }, "offset": { "type": "integer", "format": "int32" }, "isAllOwIds": { "type": "boolean" } } }, "examples": { "Get all io's End date": { "description": "Get all io's End date", "value": { "noOfEntries": 10, "pageNo": 1, "owIds": [], "ids": [], "searchField": "", "sortBy": "-ioDate" } }, "io's End date with date filter": { "description": "io's End date with date filter", "value": { "noOfEntries": 30, "pageNo": -1, "searchField": "", "sortBy": "-Date", "startDate": "08/17/2023", "endDate": "11/17/2023" } }, "io's End date with date filter for super/workspace admin": { "description": "io's End date with date filter for super/workspace admin", "value": { "noOfEntries": 30, "pageNo": -1, "isAllOwIds": "true", "sortBy": "-Date", "startDate": "08/17/2023", "endDate": "11/17/2023" } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Get all io's end date": { "description": "Get all io's end date", "value": { "success": true, "data": { "ioEndDateList": [ "02/21/2023", "01/27/2023", "01/20/2023", "01/11/2023", "01/06/2023", "01/05/2023", "12/29/2022", "12/28/2022", "12/23/2022", "12/22/2022" ], "totalRecords": 16, "filteredRecords": 10 } } }, "No record found": { "description": "No record found", "value": { "success": true, "data": { "ioEndDateList": [], "totalRecords": 0, "filteredRecords": 0 } } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/cmp/io/duplicate": { "post": { "tags": [ "Campaign API" ], "summary": "This method duplicates single IO ", "description": "This method duplicates single IO and also duplicates the campaigns with status : **Running, Paused, Pending, Expired, Rejected** And within the IO ", "operationId": "duplicateIO", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ioExistingCampaignIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "ioId": { "type": "integer", "format": "int32" }, "ioTimeZoneId": { "type": "integer", "format": "int32" }, "ioEndTime": { "type": "integer", "format": "int64" }, "ioStartTime": { "type": "integer", "format": "int64" } } }, "examples": { "duplicate io with end date": { "description": "duplicate io with end date", "value": { "ioStartTime": 1698295604000, "ioEndTime": 1698258600000, "ioId": 223, "ioTimeZoneId": 105, "ioExistingCampaignIds": [12345, 67890, 21345] } }, "duplicate io without end date": { "description": "duplicate io without end date", "value": { "ioStartTime": 1698295604000, "ioId": 241, "ioTimeZoneId": 105, "ioExistingCampaignIds": [12345, 54321] } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Success Response": { "description": "Success Response", "value": { "success": true, "data": { "duplicatedCampaignIds": [12345, 54321], "duplicatedIOId": 271 } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden!" } ] } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "examples": { "When Start time is not provided": { "description": "When Start time is not provided", "value": { "success": false, "errorObjects": [ { "error": "Start date is mandatory " } ] } }, "When End time is not provided for expired IO": { "description": "When End time is not provided for expired IO", "value": { "success": false, "errorObjects": [ { "error": "End date is mandatory for expired IO" } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/cmp/io/delete": { "post": { "tags": [ "Campaign API" ], "summary": "Update IO status to delete along with campaigns attached to it", "description": "This API updates the status to delete for the given list of IO ids.", "operationId": "updateIOStatusToDelete", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "content": { "application/json": { "schema": { "required": [ "ioIdsList" ], "type": "object", "properties": { "ioIdsList": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "owIdsList": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } } } }, "examples": { "Delete IO from Super": { "description": "Delete IO from Super", "value": { "ioIdsList": [1, 2, 3] } }, "Delete IO from Advertiser": { "description": "Delete IO from Advertiser", "value": "{ \"ioIdsList\":[1,2,3],}" } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Multiple IO Response ": { "description": "Multiple IO Response ", "value": { "success": true, "data": "3 Insertion Orders deleted successfully" } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden!" } ] } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "examples": { "Invalid Io Ids": { "description": "Invalid Io Ids", "value": { "success": false, "errorObjects": [ { "error": "Invalid IO ids." } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/cmp/io/config/save": { "post": { "tags": [ "Campaign API" ], "summary": "API for Creating or updating the IO listing configurations", "description": "This api saves the io listing configuration for user.", "operationId": "saveIOConfig", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "object" } }, "examples": { "Request body for IO Campaign basic details": { "description": "Request body for IO Campaign basic details", "value": { "config": { "columnOrder": [ "visits", "lastName", "progress", "firstName", "age", "status" ] } } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "examples": { "Configuration JSON": { "description": "Configuration JSON", "value": { "success": true, "data": { "config": { "columnOrder": [ "ioId", "ioName", "ioTotalBudget", "ioStatusId", "ioStartTime", "impressions" ] } } } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/cmp/io/campaigns/list": { "post": { "tags": [ "Campaign API" ], "summary": "Lists out the campaign and report details on the basis of ioId.", "description": "This API fetches campaign and report details with the supported filters and sorting on basis of ioId.\n---\n\n#### Request Body Detail\n\n| **Field** | **Type** | **Description** |\n| --- | --- | --- |\n| pageNo `[optional]` | Number | Page number for the required data. Default value is 1. |\n| noOfEntries `[optional]` | Number | The maximum number of returned results per page. Default value is 20.|\n| sortBy `[optional]` | String | Sort the result set by specific field. For ascending use plus(+) sign(ascii value '%2B') and for descending use minus(-) sign. Supported values are as follows : `clicks`, `impressions`, `bidImpressions`, `startCount`, `firstCount`, `midCount`, `thirdCount`, `completeCount`, `dataCost`, `spent`, `mediaSpent`, `winRate`, `VCR`, `eCPC`, `totalECPC`, `eCPM`, `totalECPM`, `eCPI`, `CTR`, `CVR`, `eCPCV`, `eCPV`, `budgetDay`, `budgetTotal`, `campaignId`, `campaignName`, `maxBid`, `startTime`, `endTime`, `campaignType`, `status`, `budgetDay`, `budgetTotal`, `reach`, `frequency`, `mappingDataCost`, `mappingSpent`, `percentageOfTotalSpent`, `organizationName`, `audioVideoViewed`, `campaignTimezone`, `pixalateViewAbility`, `ioName`, `ioId`, `targetImpression`, `creativesCount`, `pacingPercentage`, `dailyPacingPercentage`, `prebidCost`, `ioTotalImpressions`, `dailyImpressions`,`campaignPriority` ,`totalAttributedConversion`, `totalAttributedViewThroughConversion`,`totalAttributedClickThroughConversion`,`costPerAttributedConversion`,`totalAttributedConversionRate`|\n| searchField `[optional]` | String | Search the result by provided keyword in the searchField. |\n| ioIdsList `[optional]` | Array of Integer | The list includes selected campaign IO IDs. Records matching the provided IDs will be returned first, before other records. |\n| budgetTypeIdList `[optional]` | Array of Integer | The list includes selected budget type ids i.e impression based or budget based. Records matching the provided IDs will be returned. |\n| campaignIds `[optional]` | Array of Integer | The list includes selected campaign IDs. Records matching the provided IDs will be returned first, before other records. |\n| timeZoneId `[optional]` | Integer | It includes the filter for the timeZoneId for the campaigns list to fetched. |\n| campaignStatusList `[optional]` | Array of String | The list includes types of campaign status to be fetched. |\n| creativeTypeIds `[optional]` | String | This represent creative type ids filter. If provided, response data will be filtered for those creative type campaign ids only. |\n| campaignTypeIds `[optional]` | Array of Integer | This represent campaign type filter. If provided, response data will be filtered for those campaign type only. |\n| owIds `[optional]` | String | This represent customer owIds filter. If provided, response data will be filtered for those comma separated string of customer owIds only. |\n", "operationId": "getCampaignIODetailsByIoId", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "sortByFields": { "type": "object", "additionalProperties": { "type": "string" }, "deprecated": true }, "sortByFieldsLinkedHashMap": { "type": "object", "additionalProperties": { "type": "string" } }, "searchBy": { "type": "array", "items": { "type": "string" } }, "columns": { "type": "array", "items": { "type": "object", "additionalProperties": { "type": "object" } } }, "startDate": { "type": "integer", "format": "int64" }, "endDate": { "type": "integer", "format": "int64" }, "ioIdsList": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "timezoneId": { "type": "integer", "format": "int32" }, "timezoneName": { "type": "string" }, "resultType": { "type": "string" }, "campaignStatus": { "type": "string" }, "campaignStatusList": { "type": "array", "items": { "type": "string" } }, "creativeTypeIds": { "type": "string" }, "owIds": { "type": "string" }, "owIdsList": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "workspaceOwIdsList": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "customerOwIdsList": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "tab": { "type": "string" }, "dayDiff": { "type": "integer", "format": "int64" }, "download": { "type": "boolean" }, "fileType": { "type": "string" }, "fileName": { "type": "string" }, "campaignIds": { "type": "string" }, "campaignGroupIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "loggedInUowId": { "type": "integer", "format": "int32" }, "graphType": { "type": "string" }, "ids": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "budgetTypeIdList": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "campaignTypeIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "campaignRequest": { "type": "boolean" }, "graph": { "type": "boolean" }, "betaUser": { "type": "boolean" }, "audienceFlagsRequired": { "type": "boolean" }, "pagination": { "type": "string" }, "pageNo": { "type": "integer", "format": "int32" }, "noOfEntries": { "type": "integer", "format": "int32" }, "sortBy": { "type": "string" }, "searchField": { "type": "string" }, "order": { "type": "string", "enum": [ "com.iqm.api.common.model.enums.SortOrderEnum@44542a89[id=1,name=asc,symbol=+,name=ASC,ordinal=0]", "com.iqm.api.common.model.enums.SortOrderEnum@19cf2ba3[id=2,name=desc,symbol=-,name=DESC,ordinal=1]" ] }, "offset": { "type": "integer", "format": "int32" } } }, "example": { "campaignStatusList": [ "running" ], "timezoneId": 29, "owIds": "200425,201427", "ids": [1, 2], "ioIdsList": [1, 2, 38], "budgetTypeIdList": [1], "campaignTypeIds": [1], "campaignIds": "1,2,3", "sortBy": "+campaignName", "creativeTypeIds": "14", "searchField": "campaign" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Get campaign and report details": { "description": "Get campaign and report details", "value": { "success": true, "data": { "totalRecords": 2, "filteredRecords": 2, "recordsTotal": { "clicks": 0, "totalCount": 1, "winRate": 0, "logoURL": null, "avatarURL": null, "budgetDay": 0, "budgetSpent": 0, "budgetTotal": 56.3399999999999, "dataCost": 0, "mediaBudget": 0, "owId": 0, "orgId": 0, "impressions": 0, "industry": 0, "mediaSpent": 0, "spent": 0, "workspaceSpent": 0, "platformSpent": 0, "customerSpent": 0, "platformEarning": 0, "workspaceEarning": 0, "organizationName": null, "companySize": 0, "workspaceName": null, "workspaceId": 0, "workspaceDomain": null, "workspaceOrganizationName": null, "bidImpressions": 0, "startCount": 0, "firstCount": 0, "midCount": 0, "thirdCount": 0, "completeCount": 0, "audioVideoActualBids": 0, "audioVideoActualImpressions": 0, "eCPC": 0, "totalECPC": 0, "eCPM": 0, "totalECPM": 0, "eCPI": 0, "eCPCV": 0, "eCPV": 0, "totalAttributedConversion": 0, "totalAttributedViewThroughConversion": 0, "totalAttributedClickThroughConversion": 0, "costPerAttributedConversion": 0, "totalAttributedConversionRate": 0, "reach": 0, "frequency": 0, "date": null, "campaignId": 0, "campaignName": null, "maxBid": 0, "startTime": 0, "endTime": 0, "campaignType": null, "status": null, "mappingDataCost": 0, "mappingSpent": 0, "campaignTimezone": null, "creativeType": null, "budgetPacing": false, "isCampaignFromNewPlatform": false, "percentageOfTotalSpent": 0, "uowId": 0, "audioVideoViewed": 0, "ioId": 0, "ioName": null, "ioTimezone": 0, "ioBudgetDistributionMethod": 0, "ioStartTime": 0, "ioEndTime": 0, "ioTotalBudget": 0, "isAutoSumIoTotalBudget": false, "ioBudgetTypeId": 0, "ioTotalImpressions": null, "pacingPercentage": null, "actualSpent": 0, "expectedSpent": 0, "campaignDuration": null, "remainingDuration": 0, "dailyPacingPercentage": null, "expectedDailySpent": 0, "actualDailySpent": 0, "ioStatusId": 0, "exchangeId": 0, "creativesCount": null, "exchangeName": null, "budgetTypeId": 0, "campaignTypeId": 0, "targetImpression": null, "dailyImpression": 0, "budgetTotalCombined": 100, "budgetDayCombined": 10, "campaignPriority": null, "bidModelDataId": null, "ioTotalBudgetCombined": 1000, "CTR": 0, "VCR": 0, "CVR": 0 }, "recordsList": [ { "clicks": 0, "totalCount": 0, "winRate": 0, "logoURL": null, "avatarURL": null, "budgetDay": 5, "budgetSpent": 0, "budgetTotal": 13, "dataCost": 0, "mediaBudget": 0, "owId": 201427, "orgId": 0, "impressions": 0, "industry": 0, "mediaSpent": 0, "spent": 0, "workspaceSpent": 0, "platformSpent": 0, "customerSpent": 0, "platformEarning": 0, "workspaceEarning": 0, "organizationName": "Organisation Name", "companySize": 0, "workspaceName": null, "workspaceId": 0, "workspaceDomain": null, "workspaceOrganizationName": null, "bidImpressions": 0, "startCount": 0, "firstCount": 0, "midCount": 0, "thirdCount": 0, "completeCount": 0, "audioVideoActualBids": 0, "audioVideoActualImpressions": 0, "eCPC": 0, "totalECPC": 0, "eCPM": 0, "totalECPM": 0, "eCPI": 0, "eCPCV": 0, "eCPV": 0, "totalAttributedConversion": 0, "totalAttributedViewThroughConversion": 0, "totalAttributedClickThroughConversion": 0, "costPerAttributedConversion": 0, "totalAttributedConversionRate": 0, "reach": 0, "frequency": 0, "date": null, "campaignId": 445615, "campaignName": "Campaign For Child", "maxBid": 4, "startTime": 1698445456, "endTime": 1698739200, "campaignType": "cpv", "status": "pending", "mappingDataCost": 0, "mappingSpent": 0, "campaignTimezone": "US/Alaska", "creativeType": "Video", "budgetPacing": true, "isCampaignFromNewPlatform": true, "percentageOfTotalSpent": 0, "uowId": 9480, "audioVideoViewed": 0, "ioId": 2991, "ioName": "Insertion Order For Donation", "ioTimezone": 420, "ioBudgetDistributionMethod": 0, "ioStartTime": 1698446340000, "ioEndTime": 1698739200000, "ioTotalBudget": 26415, "isAutoSumIoTotalBudget": true, "ioBudgetTypeId": 0, "ioTotalImpressions": null, "pacingPercentage": 12.31, "actualSpent": 123, "expectedSpent": 212, "campaignDuration": 5, "remainingDuration": 2, "dailyPacingPercentage": null, "expectedDailySpent": 123, "actualDailySpent": 0, "ioStatusId": 1, "exchangeId": 0, "creativesCount": 2, "exchangeName": null, "budgetTypeId": 1, "campaignTypeId": 1, "targetImpression": null, "dailyImpression": 0, "budgetTotalCombined": 100, "budgetDayCombined": 10, "campaignPriority": 1, "bidModelDataId": 976, "ioTotalBudgetCombined": 1000, "CTR": 0, "VCR": 0, "CVR": 0 } ], "totalCount": 2 } } } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "examples": { "Unprocessable entity as invalid sortBy field": { "description": "Unprocessable entity as invalid sortBy field", "value": { "success": false, "errorObjects": [ { "error": "Invalid sortBy value." } ] } }, "Unprocessable entity as ioId field is empty": { "description": "Unprocessable entity as ioId field is empty", "value": { "success": false, "errorObjects": [ { "error": "IoIdsList field cannot be empty." } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/cmp/io/campaigns/list/download": { "post": { "tags": [ "Campaign API" ], "summary": "Download csv/xlsx file for campaigns details", "description": "This API will download the csv/xlsx file for campaign details based different parameters like start-date, end-date, time zone etc... \n---\n\n#### Request Body Detail\n\n| **Field** | **Type** | **Description** |\n| --- | --- | --- |\n| pageNo `[optional]` | Number | Page number for the required data. |\n| noOfEntries `[optional]` | Number | The maximum number of returned results per page. |\n| sortBy `[optional]` | String | Sort the result set by specific field. For ascending use plus(+) sign(ascii value '%2B') and for descending use minus(-) sign. |\n| searchField `[optional]` | String | Search the result by provided keyword in the searchField. |\n| ioIdsList `[optional]` | Array of Integer | The list includes selected campaign IO IDs. |\n| campaignIds `[optional]` | String | This String includes comma separated selected campaign IDs.|\n| timeZoneId `[optional]` | Integer | It includes the filter for the timeZoneId for the campaigns details to be downloaded. |\n| campaignStatus `[optional]` | String | This includes types of campaign status to be fetched.(comma separated string values) |\n| creativeTypeIds `[optional]` | String | This represent creative type ids filter. If provided, downloaded file only contains data for those creative type campaign ids only. |\n| columns | List of Map | This list includes the columns name which need to be displayed in downloaded file|\n| startDate | Long | It is date from which data need to be downloaded |\n| endDate | Long | It is date till which data need to be downloaded |\n| fileType | String | It is required to specify the type of file (csv/xlsx) |\n| fileName | String | It is required to specify downloaded file contains the data for campaigns.|\n| owIds `[optional]` | String | This represent customer owIds filter. If provided, downloaded file only contains data for those comma separated string of customer owIds only. |\n", "operationId": "downloadCampaignsReport", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "sortByFields": { "type": "object", "additionalProperties": { "type": "string" }, "deprecated": true }, "sortByFieldsLinkedHashMap": { "type": "object", "additionalProperties": { "type": "string" } }, "searchBy": { "type": "array", "items": { "type": "string" } }, "columns": { "type": "array", "items": { "type": "object", "additionalProperties": { "type": "object" } } }, "startDate": { "type": "integer", "format": "int64" }, "endDate": { "type": "integer", "format": "int64" }, "ioIdsList": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "timezoneId": { "type": "integer", "format": "int32" }, "timezoneName": { "type": "string" }, "campaignStatus": { "type": "string" }, "creativeTypeIds": { "type": "string" }, "owIds": { "type": "string" }, "conversionIds": { "type": "string" }, "fileType": { "type": "string" }, "fileName": { "type": "string" }, "campaignIds": { "type": "string" }, "owIdsList": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "campaignTypeIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "pagination": { "type": "string" }, "pageNo": { "type": "integer", "format": "int32" }, "noOfEntries": { "type": "integer", "format": "int32" }, "sortBy": { "type": "string" }, "searchField": { "type": "string" }, "order": { "type": "string", "enum": [ "com.iqm.api.common.model.enums.SortOrderEnum@44542a89[id=1,name=asc,symbol=+,name=ASC,ordinal=0]", "com.iqm.api.common.model.enums.SortOrderEnum@19cf2ba3[id=2,name=desc,symbol=-,name=DESC,ordinal=1]" ] }, "offset": { "type": "integer", "format": "int32" } } }, "example": { "startDate": "1698984000000", "endDate": "1699070399000", "timezoneId": 29, "campaignStatus": "pending,running", "creativeTypeIds": "", "searchField": "", "sortBy": "impressions", "order": "DESC", "owIds": "", "ioIdsList": [], "campaignIds": "", "conversionIds": "", "fileType": "csv", "fileName": "Campaigns", "columns": [ { "label": "ID", "value": "campaignId" }, { "label": "Campaign Name", "value": "campaignName" }, { "label": "Insertion Order Name", "value": "ioName" }, { "label": "Start date", "value": "startTime" }, { "label": "End date", "value": "endTime" }, { "label": "Max Bid($)", "value": "maxBid" }, { "label": "Daily Budget($)", "value": "budgetDay" }, { "label": "Total Budget($)", "value": "budgetTotal" }, { "label": "Total Spent($)", "value": "spent" }, { "label": "Budget Completion(%)", "value": "percentageOfTotalSpent" }, { "label": "Target Impressions", "value": "targetImpression" }, { "label": "Impressions", "value": "impressions" }, { "label": "Clicks", "value": "clicks" }, { "label": "CTR(%)", "value": "CTR" }, { "label": "Media eCPM($)", "value": "eCPM" }, { "label": "Total eCPM($)", "value": "totalECPM" }, { "label": "VCR(%)", "value": "VCR" }, { "label": "WinRate(%)", "value": "winRate" } ] } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Download csv/xlsx": { "description": "Download csv/xlsx", "value": { "success": true, "data": { "url": "https://tmpd3vsekqsh1zre3k8n-stage.s3.amazonaws.com/" } } } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "examples": { "Unprocessable entity as invalid sortBy field": { "description": "Unprocessable entity as invalid sortBy field", "value": { "success": false, "errorObjects": [ { "error": "Invalid sortBy value." } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/cmp/io/campaign/served/list": { "post": { "tags": [ "Campaign API" ], "summary": "API for List of Campaign Details grouped by Insertion Order Details based on custom filters like data range of campaigns served", "description": "This api provides list of Insertion Order basic details with List of Campaign details which are attached to that Insertion Order based on filters applied like startDate and endDate. startDate and endDate are mandatory and should not be older than a year", "operationId": "getServedIoMappedWithCampaignsDetails", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "sortByFields": { "type": "object", "additionalProperties": { "type": "string" }, "deprecated": true }, "sortByFieldsLinkedHashMap": { "type": "object", "additionalProperties": { "type": "string" } }, "searchBy": { "type": "array", "items": { "type": "string" } }, "status": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "creativeTypeIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "owIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "ioIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "ids": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "campaignIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "campaignTypeIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "ioBudgetTypeIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "paymentTypeId": { "type": "integer", "format": "int32" }, "includeTargetedAudienceList": { "type": "boolean" }, "campaignExpiredAfterEpoch": { "type": "integer", "format": "int64" }, "prebidProviders": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "audienceSubtypeId": { "type": "integer", "format": "int32" }, "startDate": { "type": "integer", "format": "int64" }, "endDate": { "type": "integer", "format": "int64" }, "allOwIds": { "type": "boolean" }, "pagination": { "type": "string" }, "pageNo": { "type": "integer", "format": "int32" }, "noOfEntries": { "type": "integer", "format": "int32" }, "sortBy": { "type": "string" }, "searchField": { "type": "string" }, "order": { "type": "string", "enum": [ "com.iqm.api.common.model.enums.SortOrderEnum@44542a89[id=1,name=asc,symbol=+,name=ASC,ordinal=0]", "com.iqm.api.common.model.enums.SortOrderEnum@19cf2ba3[id=2,name=desc,symbol=-,name=DESC,ordinal=1]" ] }, "offset": { "type": "integer", "format": "int32" }, "isOnlyABMAudienceRequiredFlag": { "type": "boolean" }, "isOnlyICTAudienceRequiredFlag": { "type": "boolean" } } }, "examples": { "Request body for IO Campaign basic details": { "description": "Request body for IO Campaign basic details", "value": { "creativeTypeIds": [11, 14], "status": [ "expired" ], "owIds": [201427], "ioIds": [5437], "campaignIds": [456354], "isAllOwIds": false, "searchField": "c", "pageNo": 0, "noOfEntries": 20, "offset": 1, "sortBy": "ioId", "startDate": 1676472364000, "endDate": 1708008364000 } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "examples": { "List of Insertion Order with List of campaign details": { "description": "List of Insertion Order with List of campaign details", "value": { "success": true, "data": { "ioCampaignsList": [ { "ioId": 363, "ioName": "Default Insertion Order", "ioBudgetTypeId": 2, "ioStatusId": 1, "created": 1691588961000, "lastModified": 1691588961000, "owId": 201427, "uowId": 9489, "campaignCount": 3, "campaigns": [ { "creativeTypeId": 11, "id": 321743, "name": "Campaign For Shoes", "owId": 201427, "status": "running", "lastModified": 1690329600000, "uowId": 9483, "organizationName": "Organisation Name", "organizationLogo": "https://webs.jpg" }, { "creativeTypeId": 17, "id": 326679, "name": "Cricket Campaign", "owId": 201427, "status": "running", "lastModified": 1690329600000, "uowId": 9485, "organizationName": "Organisation Name", "organizationLogo": "https://webs.jpg" }, { "creativeTypeId": 11, "id": 323919, "name": "Shirt Campaign", "owId": 201427, "status": "pending", "lastModified": 1692144000000, "uowId": 1, "organizationName": "Organisation Name", "organizationLogo": "https://webs.jpg" } ] } ], "totalRecords": 1477, "filteredRecords": 3 } } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/cmp/io/campaign/config/save": { "post": { "tags": [ "Campaign API" ], "summary": "API for Creating or updating the campaign listing configurations", "description": "This api saves the campaign listing configuration for user.", "operationId": "saveCampaignConfig", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "object" } }, "examples": { "Request body for config details": { "description": "Request body for config details", "value": { "config": { "columnOrder": [ "visits", "lastName", "progress", "firstName", "age", "status" ] } } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "examples": { "Configuration JSON": { "description": "Configuration JSON", "value": { "success": true, "data": { "config": { "columnOrder": [ "ioId", "ioName", "ioTotalBudget", "ioStatusId", "ioStartTime", "impressions" ] } } } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/cmp/io/campaign/basic/list": { "post": { "tags": [ "Campaign API" ], "summary": "API for List of Campaign Details grouped by Insertion Order Details", "description": "This api provides list of Insertion Order basic details with List of Campaign details which are attached to that Insertion Order.\n---\n\n#### Request Body Detail\n\n| **Field** | **Type** | **Description** |\n| --- | --- | --- |\n| pageNo `[optional]` | Number | Page number for the required data. Default value is 1. |\n| noOfEntries `[optional]` | Number | The maximum number of returned results per page. Default value is 20.|\n| sortBy `[optional]` | String | Sort the result set by specific field. For ascending use plus(+) sign(ascii value '%2B') and for descending use minus(-) sign. Supported values are as follows : `ioId`,`ioName`,`ioStartTime`,`ioEndTime`,`ioTotalBudget`,`campaignId`,`isRecordTargeted` |\n| searchField `[optional]` | String | Search the result by provided keyword in the searchField. |\n| ioIdsList `[optional]` | Array of Integer | The list includes selected campaign IO IDs. Records matching the provided IDs will be returned first, before other records. |\n| campaignTypeIds `[optional]` | Array of Integer | The list includes selected campaign type ids i.e Advanced campaign or PG campaign, Records matching the provided IDs will be returned. |\n| ids `[optional]` | Array of Integer | This represent campaign ids filter. |\n| ioIds `[optional]` | Array of Integer | This represent IO ids filter. |\n| status `[optional]` | Array of String | The list includes types of campaign status to be fetched. |\n| creativeTypeIds `[optional]` | Array of Integer | This represent creative type ids filter. |\n| ioBudgetTypeIds `[optional]` | Array of Integer | This represent io budget type ids filter. |\n| owIds `[optional]` | Array of Integer | This represent customer owIds filter.\n| audienceSubtypeId `[optional]` | Integer | This represent audience subtype id filter. |\n", "operationId": "getIoMappedWithCampaignsDetails", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "sortByFields": { "type": "object", "additionalProperties": { "type": "string" }, "deprecated": true }, "sortByFieldsLinkedHashMap": { "type": "object", "additionalProperties": { "type": "string" } }, "searchBy": { "type": "array", "items": { "type": "string" } }, "status": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "creativeTypeIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "owIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "ioIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "ids": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "campaignIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "campaignTypeIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "ioBudgetTypeIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "paymentTypeId": { "type": "integer", "format": "int32" }, "includeTargetedAudienceList": { "type": "boolean" }, "campaignExpiredAfterEpoch": { "type": "integer", "format": "int64" }, "prebidProviders": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "audienceSubtypeId": { "type": "integer", "format": "int32" }, "allOwIds": { "type": "boolean" }, "pagination": { "type": "string" }, "pageNo": { "type": "integer", "format": "int32" }, "noOfEntries": { "type": "integer", "format": "int32" }, "sortBy": { "type": "string" }, "searchField": { "type": "string" }, "order": { "type": "string", "enum": [ "com.iqm.api.common.model.enums.SortOrderEnum@44542a89[id=1,name=asc,symbol=+,name=ASC,ordinal=0]", "com.iqm.api.common.model.enums.SortOrderEnum@19cf2ba3[id=2,name=desc,symbol=-,name=DESC,ordinal=1]" ] }, "offset": { "type": "integer", "format": "int32" }, "isOnlyABMAudienceRequiredFlag": { "type": "boolean" }, "isOnlyICTAudienceRequiredFlag": { "type": "boolean" } } }, "examples": { "Request body for IO Campaign basic details for advanced campaigns": { "description": "Request body for IO Campaign basic details for advanced campaigns", "value": { "creativeTypeIds": [11, 14], "owIds": [201427], "ids": [321743], "searchField": "default", "pageNo": 1, "noOfEntries": 20, "sortBy": "+ioId", "status": [ "running", "pending" ], "ioIds": [363], "campaignTypeIds": [1], "ioBudgetTypeIds": [1], "offset": 1 } }, "Request body for IO Campaign basic details for pg campaigns": { "description": "Request body for IO Campaign basic details for pg campaigns", "value": { "creativeTypeIds": [11, 14], "owIds": [201427], "ids": [321743], "searchField": "default", "pageNo": 1, "noOfEntries": 20, "sortBy": "+ioId", "status": [ "running", "pending" ], "ioIds": [363], "campaignTypeIds": [2], "offset": 1 } }, "Request body for IO Campaign basic details for PG campaigns with payment type id": { "description": "Request body for IO Campaign basic details for PG campaigns with payment type id", "value": { "creativeTypeIds": [11, 14], "owIds": [201427], "ids": [321743], "searchField": "default", "pageNo": 1, "noOfEntries": 20, "sortBy": "+ioId", "status": [ "running", "pending" ], "ioIds": [363], "campaignTypeIds": [2], "paymentTypeId": 2, "offset": 1 } }, "Request body for IO Campaign basic details for both type of campaigns": { "description": "Request body for IO Campaign basic details for both type of campaigns", "value": { "creativeTypeIds": [11, 14], "owIds": [201427], "ids": [321743], "searchField": "default", "pageNo": 1, "noOfEntries": 20, "sortBy": "+ioId", "status": [ "running", "pending" ], "ioIds": [363], "offset": 1, "includeTargetedAudienceList": true } }, "Request body for IO Campaign basic details for expired campaign with filter on the expiry date": { "description": "Request body for IO Campaign basic details for expired campaign with filter on the expiry date", "value": { "creativeTypeIds": [11, 14], "owIds": [201427], "ids": [321743], "searchField": "default", "pageNo": 1, "noOfEntries": 20, "sortBy": "+ioId", "status": [ "running", "pending" ], "ioIds": [363], "offset": 1, "includeTargetedAudienceList": true, "campaignExpiredAfterEpoch": 1719839148000 } }, "Request body for IO Campaign basic details with audience filters and ABM flag": { "description": "Request body for IO Campaign basic details with audience filters and ABM flag", "value": { "status": [ "running", "paused", "expired", "draft", "pending", "rejected", "deleted" ], "pageNo": -1, "sortBy": "-ioId,-campaignId", "includeTargetedAudienceList": true, "campaignTypeIds": [1], "isOnlyABMAudienceRequiredFlag": false, "audienceSubtypeId": 1 } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "examples": { "List of Insertion Order with List of campaign details": { "description": "List of Insertion Order with List of campaign details", "value": { "success": true, "data": { "totalRecords": 272, "ioCampaignsList": [ { "ioId": 4091, "ioName": "Future start date", "ioBudgetTypeId": 1, "ioStatusId": 1, "created": 1700726026913, "lastModified": 1700726065000, "owId": 201353, "uowId": 8776, "campaignCount": 1, "campaigns": [ { "id": 450700, "campaignId": 450700, "name": "future date campaign", "creativeTypeId": 11, "campaignTypeId": 1, "status": "running", "startTime": 1732690800, "endTime": 1767164400, "createdAt": 1701078853, "modifiedAt": 1707091200000, "owId": 201353, "timezoneId": 21, "targetedAudienceIds": [1010324, 1054144, 1060433, 1063317] } ] }, { "ioId": 3979, "ioName": "Test IO for campaign popup", "ioBudgetTypeId": 1, "ioStatusId": 1, "created": 1700476689502, "lastModified": 1701248369000, "owId": 201353, "uowId": 8776, "campaignCount": 1, "campaigns": [ { "id": 451031, "campaignId": 451031, "name": "no end date", "creativeTypeId": 11, "campaignTypeId": 1, "status": "running", "startTime": 1701249000, "createdAt": 1701248369, "modifiedAt": 1707091200000, "owId": 201353, "timezoneId": 21, "targetedAudienceIds": [1010324, 1054144, 1060433, 1063317] } ] }, { "ioId": 225, "ioName": "Beatrice King", "ioBudgetTypeId": 1, "ioStatusId": 2, "created": 1677925263000, "lastModified": 1700888400000, "owId": 201353, "uowId": 112037, "campaignCount": 1, "campaigns": [ { "id": 450277, "campaignId": 450277, "name": "prod-campaign-20935 copy", "creativeTypeId": 11, "campaignTypeId": 1, "status": "running", "startTime": 1700819565, "endTime": 1709182800, "createdAt": 1700818673, "modifiedAt": 1707177600000, "owId": 201353, "timezoneId": 29, "targetedAudienceIds": null } ] }, { "ioId": 48, "ioName": "UAW", "ioBudgetTypeId": 1, "ioStatusId": 1, "created": 1665500839000, "lastModified": 1704704810000, "owId": 201353, "uowId": 8776, "campaignCount": 1, "campaigns": [ { "id": 20731, "campaignId": 20731, "name": "prod-campaign-20731", "creativeTypeId": 11, "campaignTypeId": 1, "status": "running", "startTime": 1676700273, "endTime": 1711857600, "createdAt": 1676700278, "modifiedAt": 1707177600000, "owId": 201353, "timezoneId": 29, "targetedAudienceIds": null } ] } ], "filteredRecords": 4 } } }, "Request body for IO Campaign basic details for expired campaign with filter on the expiry date": { "description": "Request body for IO Campaign basic details for expired campaign with filter on the expiry date", "value": { "success": true, "data": { "totalRecords": 24956, "ioCampaignsList": [ { "ioId": 27, "ioName": "Sample name", "ioBudgetTypeId": 1, "ioStatusId": 1, "created": 1667344573000, "lastModified": 1698304782000, "owId": 201427, "uowId": 9480, "campaignCount": 1, "campaigns": [ { "id": 262423, "campaignId": 262423, "name": "Sample Campaign 1", "creativeTypeId": 17, "status": "expired", "startTime": 1888705936, "endTime": 1888705937, "createdAt": 1653907326, "modifiedAt": 1711584000000, "owId": 201427, "ioId": 0, "ioName": null, "ioStatusId": 0, "timezoneId": 11, "campaignTypeId": 1, "ioBudgetTypeId": 0, "targetedAudienceIds": null } ] } ], "filteredRecords": 1 } } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/cmp/io/basic/list": { "post": { "tags": [ "Campaign API" ], "summary": "API to get basic details of insertion-order (IO)", "description": "This API provides the list of basic insertion order details\n\n---\n\n#### Request Body Detail\n\n| **Field** | **Type** | **Description** |\n| --- | --- | --- |\n| owIdList | List of Integers | List of **owIds** for which IO details required.|\n| ioIdList | List of integers | List of **ioIds** for which IO details required .|\n| ioBudgetTypeIdsList | List of integers | List of **ioBudgetTypeIds** for which IO details are required .|\n| ioStatusIdsList | List of integers | List of **ioStatusIds** for which IO details are required .|\n| ids | List of integers | List of **ioIds** for which IO details required at the top .|\n| isAllOWIds | Boolean | Flag for consider all the owId for IO details (true = consider all the owId for which user has access, false = consider only provided owIds).|\n| pageNo | int | page number for required data.|\n| noOfEntries | int | Number of records per page.|\n| searchField | String | Name of search field (Support is available for name and id).|\n| sortBy | String | Comma separated names of the sorting field. it support multiple column sorting. for descending order user -(minus) and +(plus)(ascii value '%2B') for ascending order. i.g. ioId, ioName, ioStartTime, ioEndTime, ioTotalBudget.|\n| offset | int | Offset is alternative of page number. Offset is number of records to be skipped.|\n", "operationId": "getIOBasicDetailsList", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "sortByFields": { "type": "object", "additionalProperties": { "type": "string" }, "deprecated": true }, "sortByFieldsLinkedHashMap": { "type": "object", "additionalProperties": { "type": "string" } }, "searchBy": { "type": "array", "items": { "type": "string" } }, "owIdList": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "ids": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "ioIdList": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "ioBudgetTypeIdsList": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "ioStatusIdsList": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "allOWIds": { "type": "boolean", "writeOnly": true }, "allOwIds": { "type": "boolean" }, "pagination": { "type": "string" }, "pageNo": { "type": "integer", "format": "int32" }, "noOfEntries": { "type": "integer", "format": "int32" }, "sortBy": { "type": "string" }, "searchField": { "type": "string" }, "order": { "type": "string", "enum": [ "com.iqm.api.common.model.enums.SortOrderEnum@44542a89[id=1,name=asc,symbol=+,name=ASC,ordinal=0]", "com.iqm.api.common.model.enums.SortOrderEnum@19cf2ba3[id=2,name=desc,symbol=-,name=DESC,ordinal=1]" ] }, "offset": { "type": "integer", "format": "int32" }, "isAllOwIds": { "type": "boolean" } } }, "examples": { "Request sample for Advertiser user": { "description": "Request sample for Advertiser user", "value": { "pageNo": 1, "noOfEntries": 20, "ioIdList": [12, 34], "ids": [2], "searchField": "io name", "sortBy": "-ioId", "ioBudgetTypeIdsList": [2], "ioStatusIdsList": [1, 2, 3], "offset": 1 } }, "Request sample for Workspace user (selected customers)": { "description": "Request sample for Workspace user (selected customers)", "value": { "pageNo": 1, "noOfEntries": 2, "owIdList": [1236, 4356], "ioIdList": [12, 34], "ids": [2], "isAllOwIds": false, "searchField": "io name", "ioBudgetTypeIdsList": [2], "ioStatusIdsList": [2], "sortBy": "-ioId", "offset": 3 } }, "Request sample for Workspace user (all customers)": { "description": "Request sample for Workspace user (all customers)", "value": { "pageNo": 1, "noOfEntries": 2, "ioIdList": [12, 34], "ids": [2], "isAllOwIds": true, "searchField": "io name", "ioBudgetTypeIdsList": [2], "ioStatusIdsList": [2, 1], "sortBy": "-ioId", "offset": 1 } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Success response": { "description": "Success response", "value": { "success": true, "data": { "totalRecords": 3, "ioBasicDetailsList": [ { "ioId": 1630, "ioName": "phase 2 test", "ioStartTime": 1792179297123, "ioEndTime": 1793179297123, "ioTimeZoneId": 29, "ioTotalBudget": 0, "ioBudgetDistributionMethodId": 1, "ioBudgetTypeId": 2, "ioStatusId": 1, "ioTotalImpressions": 0, "isBudgetAutoSum": true }, { "ioId": 741, "ioName": "testdatasync", "ioStartTime": 1692860161542, "ioEndTime": 1696226400000, "ioTimeZoneId": 21, "ioTotalBudget": 100001, "ioBudgetDistributionMethodId": 1, "ioBudgetTypeId": 2, "ioTotalImpressions": 0, "ioStatusId": 1, "isBudgetAutoSum": true }, { "ioId": 738, "ioName": "IO Bharat", "ioStartTime": 1693251767612, "ioEndTime": 1693353600000, "ioTimeZoneId": 29, "ioTotalBudget": 1100, "ioBudgetDistributionMethodId": 1, "ioBudgetTypeId": 2, "ioStatusId": 2, "ioTotalImpressions": 0, "isBudgetAutoSum": true } ], "filteredRecords": 3 } } }, "422_UNPROCESSABLE_ENTITY": { "description": "422_UNPROCESSABLE_ENTITY", "value": { "success": false, "errorObjects": [ { "error": "Error message." } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/cmp/io/advanced/list/download": { "post": { "tags": [ "Campaign API" ], "summary": "Download csv/xlsx file for io details", "description": "This API will download the csv/xlsx file for io details based different parameters like start-date, end-date, time zone etc... \n---\n\n#### Request Body Detail\n\n| **Field** | **Type** | **Description** |\n| --- | --- | --- |\n| pageNo `[optional]` | Number | Page number for the required data. |\n| noOfEntries `[optional]` | Number | The maximum number of returned results per page. |\n| sortBy `[optional]` | String | Sort the result set by specific field. For ascending use plus(+) sign(ascii value '%2B') and for descending use minus(-) sign. |\n| searchField `[optional]` | String | Search the result by provided keyword in the searchField. |\n| ioIdsList `[optional]` | Array of Integer | The list includes selected IO IDs. |\n| timeZoneId `[optional]` | Integer | It includes the filter for the timeZoneId for the io details to be downloaded. |\n| ioStatusIdsList `[optional]` | Array of Integer | This includes types of io status to be fetched. |\n| budgetTypeIdList `[optional]` | Array of Integer | To filter data based on IO's budget type. For example filter data by, Dollar based IO or Impressions based IO. |\n| columns | List of Map | This list includes the columns name which need to be displayed in downloaded file|\n| startDate | Long | It is date from which data need to be downloaded |\n| endDate | Long | It is date till which data need to be downloaded |\n| fileType | String | It is required to specify the type of file (csv/xlsx) |\n| fileName | String | It is required to specify downloaded file contains the data for IO.|\n| owIds `[optional]` | String | This represent customer owIds filter. If provided, downloaded file only contains data for those comma separated string of customer owIds only. |\n", "operationId": "downloadIOReport", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "sortByFields": { "type": "object", "additionalProperties": { "type": "string" }, "deprecated": true }, "sortByFieldsLinkedHashMap": { "type": "object", "additionalProperties": { "type": "string" } }, "searchBy": { "type": "array", "items": { "type": "string" } }, "columns": { "type": "array", "items": { "type": "object", "additionalProperties": { "type": "object" } } }, "startDate": { "type": "integer", "format": "int64" }, "endDate": { "type": "integer", "format": "int64" }, "ioIdsList": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "timezoneId": { "type": "integer", "format": "int32" }, "timezoneName": { "type": "string" }, "ioStatusIdsList": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "owIds": { "type": "string" }, "fileType": { "type": "string" }, "fileName": { "type": "string" }, "owIdsList": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "budgetTypeIdList": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "pagination": { "type": "string" }, "pageNo": { "type": "integer", "format": "int32" }, "noOfEntries": { "type": "integer", "format": "int32" }, "sortBy": { "type": "string" }, "searchField": { "type": "string" }, "order": { "type": "string", "enum": [ "com.iqm.api.common.model.enums.SortOrderEnum@44542a89[id=1,name=asc,symbol=+,name=ASC,ordinal=0]", "com.iqm.api.common.model.enums.SortOrderEnum@19cf2ba3[id=2,name=desc,symbol=-,name=DESC,ordinal=1]" ] }, "offset": { "type": "integer", "format": "int32" } } }, "example": { "startDate": "1698638400000", "endDate": "1698724799000", "timezoneId": 29, "searchField": "", "sortBy": "impressions", "order": "DESC", "owIds": "", "ioIdsList": [], "ioStatusIdsList": [1, 2], "fileType": "xlsx", "fileName": "IO", "budgetTypeIdList": [1, 2], "columns": [ { "label": "Insertion Order ID", "value": "ioId" }, { "label": "Insertion Order Name", "value": "ioName" }, { "label": "Status", "value": "ioStatus" }, { "label": "Start date", "value": "ioStartTime" }, { "label": "End date", "value": "ioEndTime" }, { "label": "Impressions", "value": "targetImpression" }, { "label": "Clicks", "value": "clicks" } ] } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Download csv/xlsx": { "description": "Download csv/xlsx", "value": { "success": true, "data": { "url": "https://tmpd3vsekqsh1zre3k8n-stage.s3.amazonaws.com/" } } } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "examples": { "Unprocessable entity as invalid sortBy field": { "description": "Unprocessable entity as invalid sortBy field", "value": { "success": false, "errorObjects": [ { "error": "Invalid sortBy value." } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/cmp/io/add": { "post": { "tags": [ "Campaign API" ], "summary": "It will add the insertion order details for campaign on IO creation.", "description": "This API will create IO and inserts it details as well as response with the added details.", "operationId": "createCampaignIO", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "content": { "application/json": { "schema": { "required": [ "ioName" ], "type": "object", "properties": { "ioId": { "type": "integer", "format": "int32" }, "ioName": { "maxLength": 255, "minLength": 0, "type": "string" }, "owId": { "type": "integer", "format": "int32" }, "createdByUowId": { "type": "integer", "format": "int32" }, "modifiedByUowId": { "type": "integer", "format": "int32" }, "ioStartTime": { "type": "integer", "format": "int64" }, "ioEndTime": { "type": "integer", "format": "int64" }, "ioTotalBudget": { "minimum": 0, "exclusiveMinimum": false, "type": "number", "format": "double" }, "ioTimeZoneId": { "type": "integer", "format": "int32" }, "isAutoSumIoTotalBudget": { "type": "boolean" }, "ioBudgetDistributionMethodId": { "type": "integer", "format": "int32" }, "ioBudgetTypeId": { "type": "integer", "format": "int32" }, "ioTotalImpressions": { "type": "integer", "format": "int64" }, "ioStatusId": { "type": "integer", "format": "int32" }, "ioNextPerformanceCheck": { "type": "integer", "format": "int64" }, "ioLastPriorityShift": { "type": "integer", "format": "int64" }, "ioCurrentPriority": { "type": "integer", "format": "int32" }, "isIoPrioritise": { "type": "boolean" } } }, "examples": { "budget based IO creation": { "description": "budget based IO creation", "value": { "ioName": "IO Name 1", "ioStartTime": 1690898148000, "ioEndTime": 1690898888000, "ioTotalBudget": 1000, "ioTimeZoneId": 29, "isAutoSumIoTotalBudget": true, "ioBudgetTypeId": 1, "ioBudgetDistributionMethodId": 1 } }, "impression based IO creation": { "description": "impression based IO creation", "value": { "ioName": "IO Name 2", "ioStartTime": 1690898148000, "ioEndTime": 1690898888000, "ioTimeZoneId": 29, "isAutoSumIoTotalBudget": true, "ioBudgetTypeId": 2, "ioStatusId": 1, "ioBudgetDistributionMethodId": 1 } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Successful creation of IO": { "description": "Successful creation of IO", "value": { "success": true, "data": { "ioId": 6, "ioName": "IO Name 1", "ioStartTime": 1690898148000, "ioEndTime": 1690898888000, "ioTotalBudget": 0, "ioTimeZoneId": 29, "ioBudgetTypeId": 1, "ioBudgetDistributionMethodId": 1, "isAutoSumIoTotalBudget": true, "ioTotalImpressions": null } } } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "examples": { "Unprocessable entity": { "description": "Unprocessable entity", "value": { "success": false, "errorObjects": [ { "error": "The field 'ioName' cannot be empty." } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/cmp/endDate/list": { "post": { "tags": [ "Campaign API" ], "summary": "This API provides list of unique campaign's end date.", "description": "Get a paginated list of campaign's end date based on the provided filters.", "operationId": "getCampaignEndDateList", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "description": "#### Request Body Detail\n\n| **Field** | **Type** | **Description** |\n| --- | --- | --- |\n|| pageNo `[optional]` | Number | Page number for the required data. The default value is 1. Setting the page number to -1 will disable pagination and return all data in a single page.|| noOfEntries `[optional]` | Number | The maximum number of returned results per page. Default value is 300.|| sortBy `[optional]` | String | Sort the result set by specific field. For ascending use plus(+) sign(ascii value '%2B') and for descending use minus(-) sign. Sorting is only allowed on the `campaignDate` field. The default sorting order is descending on the campaign end date field and can be expressed as `-campaignDate`.|| searchField `[optional]` | String | Search the result by provided keyword in the searchField. | startDate `[optional]` | String | This represents a date filter. If a date is provided, the response data will be filtered to only include entries that have a date greater than the specified date. || endDate `[optional]` | String | This represents a date filter. If a date is provided, the response data will be filtered to only include entries that have a date less than the specified date. || ids `[optional]` | Array of String | Prioritizing selected dates over other dates in a response.|| isAllOwIds `[optional]` | Boolean | This represent filter records with all allowed owIds. if provided as `true`. `isAllOwIds` is more of a priority than `owIds`. || owIds `[optional]` | Array of Integer | This represent customer owIds filter. If provided, response data will be filtered for those customer owIds only. |", "content": { "application/json": { "schema": { "type": "object", "properties": { "sortByFields": { "type": "object", "additionalProperties": { "type": "string" } }, "owIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "isAllOwIds": { "type": "boolean" }, "ids": { "type": "array", "items": { "type": "string" } }, "startDate": { "type": "string" }, "endDate": { "type": "string" }, "pageNo": { "type": "integer", "format": "int32" }, "noOfEntries": { "type": "integer", "format": "int32" }, "sortBy": { "type": "string" }, "searchField": { "type": "string" }, "order": { "type": "string", "enum": [ "com.iqm.commons.models.enums.SortOrderEnum@6f37475b[id=1,name=asc,symbol=+,name=ASC,ordinal=0]", "com.iqm.commons.models.enums.SortOrderEnum@3e0e6466[id=2,name=desc,symbol=-,name=DESC,ordinal=1]" ] } } }, "examples": { "Get all campaign's end date": { "description": "Get all campaign's end date", "value": { "noOfEntries": 10, "pageNo": 1, "owIds": [], "ids": [], "searchField": "", "sortBy": "-campaignDate" } }, "No record found": { "description": "No record found", "value": { "noOfEntries": 10, "pageNo": 1, "owIds": [], "ids": [], "searchField": "-", "sortBy": "-campaignDate" } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Get all campaign's end date": { "description": "Get all campaign's end date", "value": { "success": true, "data": { "data": [ "02/21/2023", "01/27/2023", "01/20/2023", "01/11/2023", "01/06/2023", "01/05/2023", "12/29/2022", "12/28/2022", "12/23/2022", "12/22/2022" ], "totalRecords": 42, "filteredRecords": 42 } } }, "No record found": { "description": "No record found", "value": { "success": true, "data": { "data": [], "totalRecords": 0, "filteredRecords": 0 } } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/cmp/customer/campaigns/list": { "post": { "tags": [ "Campaign API" ], "summary": "Filter Campaigns By owIds, status, creative types", "description": "This API Filter Campaigns By owIds, status, creative types. \n---\n\n#### Request Body Detail\n\n| **Field** | **Type** | **Description** |\n| --- | --- | --- |\n| pageNo `[optional]` | Number | Page number for the required data. The default value is 1. |\n| noOfEntries `[optional]` | Number | The maximum number of returned results per page. The default value is 20 and the maximum value is 500. |\n| sortBy `[optional]` | String | Sort the result set by specific field. |\n| order `[optional]` | String | Sorting order Supported values: `asc` or `desc`. The default value is `asc`. |\n| searchField `[optional]` | String | Search the result by provided keyword in the searchField. It filters records by campaign id, campaign name. |\n| campaignIds `[optional]` | Array of Integer | Filter Campaign list by provided campaignIds. |\n| owIds `[optional]` | Array of Integer | Filter Campaign List for provided Customer owIds. |\n| status `[optional]` | Array of String | Filter Campaign List for provided campaign statuses. |\n| creativeTypeIds `[optional]` | String | Filter Campaign List for provided creative type ids. |\n| campaignTypeIds `[optional]` | Array of Integer | Filter Campaign List for provided campaign type ids. |\n| ids `[optional]` | Array of Integer | Selected campaign id List, campaigns with provided ids will be returned first compared to other records. |\n", "operationId": "getCampaignDetails", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "sortByFields": { "type": "object", "additionalProperties": { "type": "string" } }, "owIds": { "type": "string" }, "creativeTypeIds": { "type": "string" }, "creativeTypeIdsList": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "status": { "type": "string" }, "created": { "type": "integer", "format": "int64" }, "isBasicInfo": { "type": "boolean" }, "campaignTypeIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "pageNo": { "type": "integer", "format": "int32" }, "noOfEntries": { "type": "integer", "format": "int32" }, "sortBy": { "type": "string" }, "searchField": { "type": "string" }, "order": { "type": "string", "enum": [ "com.iqm.commons.models.enums.SortOrderEnum@6f37475b[id=1,name=asc,symbol=+,name=ASC,ordinal=0]", "com.iqm.commons.models.enums.SortOrderEnum@3e0e6466[id=2,name=desc,symbol=-,name=DESC,ordinal=1]" ] } } }, "example": { "isBasicInfo": true, "sortBy": "modifiedDate", "pageNo": 1, "noOfEntries": 10, "status": "pending", "searchField": "", "owIds": "all", "creativeTypeIds": "", "campaignTypeIds": [2], "created": "" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "success": true, "data": { "totalRecords": 5435, "data": [ { "owId": 201900, "parentOrganizationName": "Yashwant Ad Org", "id": 440264, "name": "QA Dollar API Pending - 233", "creativeType": "Image", "creativeTypeId": 11, "budgetTotal": 10000, "budgetDay": 50, "maxBid": 21, "startTime": 1695873600, "uowId": 106792, "status": "pending", "created": 1695793014, "modifiedDate": 1695793014, "userName": "Yashwant", "timeZoneName": null, "endTime": 0, "totalSpent": 0, "organizationName": "Yashwant Ad workspace", "userEmail": "yashwant.p+adv@iqm.com", "budgetTypeId": 1, "impression": 0, "campaignTypeId": 2, "pgPaymentTypeId": 2, "totalImpressions": 0, "isParentInvoiceTemplateSet": true, "isApprovalAccess": true, "isEditAccess": true, "isMarginSet": true }, { "owId": 201923, "parentOrganizationName": "Yashwant Ad Org", "id": 440133, "name": "IMP camp budget API - 296", "creativeType": "Image", "creativeTypeId": 11, "budgetTotal": 100, "budgetDay": 2.2, "maxBid": 10, "startTime": 1697700365, "uowId": 107184, "status": "pending", "created": 1695744164, "modifiedDate": 1695744164, "userName": "Yashwant adv4", "timeZoneName": null, "endTime": 0, "totalSpent": 0, "organizationName": "Sample adv4", "userEmail": "yashwant.p+adv4@iqm.com", "budgetTypeId": 2, "campaignTypeId": 1, "impression": 0, "totalImpressions": 10000, "isParentInvoiceTemplateSet": true, "isApprovalAccess": true, "isEditAccess": true, "isMarginSet": false } ], "filteredRecords": 5435 } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "examples": { "Invalid status ": { "description": "Invalid status ", "value": { "success": false, "errorObjects": [ { "error": "Please provide valid value of status." } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/cmp/creative-types/count": { "post": { "tags": [ "Campaign API" ], "summary": "It will give the creative type and campaigns count details.", "description": "This API will fetch the campaigns count grouped by the creative type based on the given ioId.", "operationId": "getCampaignCountWithCreativeTypeByIoIds", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "description": "#### Request Body Detail\n\n| **Field** | **Type** | **Description** |\n| --- | --- | --- |\n|| owIds `[optional]` | Array of Integer | This represent customer owIds filter. If provided, response data will be filtered for those customer owIds only. || ioIds `[optional]` | Array of Integer | This represent customer ioIds filter. If provided, response data will be filtered for those ioIds only. || status `[optional]` | String | This represent the comma separated status of the campaign. provides the campaign status name to filter creative count based upon campaign status. pass `empty string` to filter based upon all status |", "content": { "application/json": { "schema": { "type": "object", "properties": { "ioIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "owIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "status": { "type": "string" }, "statusList": { "type": "array", "items": { "type": "string" } } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Successful fetching of campaign count with creative types": { "description": "Successful fetching of campaign count with creative types", "value": "{ \"success\": true, \"data\": [ { \"count\": 3, \"creativeType\": \"Image\", \"creativeTypeId\": 11 }, { \"count\": 0, \"creativeType\": \"HTML\", \"creativeTypeId\": 13 }, { \"count\": 0, \"creativeType\": \"Video\", \"creativeTypeId\": 14 }, { \"count\": 1, \"creativeType\": \"Audio\", \"creativeTypeId\": 17 }, ]}" } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "examples": { "Unprocessable entity as invalid ioIds": { "description": "Unprocessable entity as invalid ioIds", "value": { "success": false, "errorObjects": [ { "error": "Invalid ioIds." } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/cmp/campaigns/ids": { "post": { "tags": [ "Campaign API" ], "summary": "Get Campaign ID Listing", "description": "This API retrieves a list of campaign IDs based on the provided filters such as `searchField`, `campaignStatus`, etc. Note: The response contains only campaign IDs and not full campaign details. if owIds are provided in the request then the response will contain campaign IDs only for those owIds after applying owIds filter, else it will contain campaign IDs for all allowed owIds of the logged-in user.", "operationId": "getCampaignDetails_2", "requestBody": { "description": "Request body containing filters for retrieving campaign IDs.", "content": { "application/json": { "schema": { "type": "object", "properties": { "owIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "searchField": { "type": "string" }, "campaignStatus": { "type": "array", "items": { "type": "string" } }, "creativeTypeIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "campaignTypeIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "budgetTypeIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "ioIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "campaignIds": { "type": "array", "items": { "type": "integer", "format": "int32" } } } }, "examples": { "sample request body": { "description": "sample request body", "value": { "searchField": "cam", "budgetTypeIds": [2], "creativeTypeIds": [11], "ioIds": [9230, 24255, 24252], "campaignIds": [1, 2, 3], "campaignTypeIds": [1], "campaignStatus": [ "running" ], "owIds": [202741, 204777, 204778] } } } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved campaign IDs.", "content": { "application/json": { "schema": { "type": "object", "properties": { "campaignIds": { "type": "array", "items": { "type": "integer", "format": "int32" } } } }, "example": { "success": true, "data": { "campaignIds": [578519, 578522, 578524, 578521, 578523, 578525, 579148, 579152] } } } } } } } }, "/api/v3/cmp/campaigns/count": { "post": { "tags": [ "Campaign API" ], "summary": "Get campaign count by status. ", "description": "This API returns the campaigns count for each campaign status as per the provided filter.\nOwIds: is a filter to fetch the campaigns count for the given OwIds.\nsearchFiled: is a filter to fetch the campaigns count where the campaigns Id Or Name matched with the given search field.", "operationId": "getCampaignsCount", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "content": { "application/json": { "schema": { "required": [ "exchanges", "publisherAdCategory" ], "type": "object", "properties": { "advertiserId": { "type": "integer", "format": "int32" }, "dspId": { "type": "integer", "format": "int32" }, "owId": { "type": "integer", "format": "int32" }, "uowId": { "type": "integer", "format": "int32" }, "id": { "type": "integer", "format": "int32" }, "campaignName": { "type": "string" }, "advertiserDomain": { "type": "string" }, "creativeType": { "type": "integer", "format": "int32" }, "campaignType": { "type": "integer", "format": "int32" }, "totalBudgetPacing": { "type": "boolean" }, "budgetDay": { "minimum": 0, "type": "number", "format": "double" }, "budgetTotal": { "minimum": 0, "type": "number", "format": "double" }, "maxBid": { "type": "number", "format": "double" }, "minBid": { "type": "number", "format": "double" }, "allowedMinBid": { "type": "number", "format": "double" }, "timezone": { "type": "integer", "format": "int32" }, "startTime": { "type": "integer", "format": "int64" }, "endTime": { "type": "integer", "format": "int64" }, "status": { "type": "string" }, "created": { "type": "integer", "format": "int32" }, "excludeFromPlatformServing": { "type": "boolean" }, "forTest": { "type": "boolean" }, "modifiedDate": { "type": "string", "format": "date-time" }, "dspMarginJson": { "type": "string" }, "platformMarginJson": { "type": "string" }, "dspMargin": { "type": "integer", "format": "int32" }, "platformMargin": { "type": "integer", "format": "int32" }, "userDealMargin": { "type": "integer", "format": "int32" }, "isAgreementChecked": { "type": "boolean" }, "spentScale": { "type": "boolean" }, "creativeIds": { "type": "string" }, "targetCPI": { "type": "integer", "format": "int64" }, "conversionType": { "type": "string" }, "conversionTypeId": { "type": "integer", "format": "int32" }, "appURL": { "type": "string" }, "bidOptimization": { "type": "boolean" }, "bidPacing": { "type": "boolean" }, "impressionCapping": { "minimum": 0, "type": "integer", "format": "int32" }, "frequencyCapEnabled": { "type": "boolean" }, "frequencyCapping": { "type": "object", "additionalProperties": { "type": "object", "properties": { "frequencyCapDuration": { "type": "integer", "format": "int32" }, "frequencyCapValue": { "type": "integer", "format": "int32" } } } }, "maxDayImpressions": { "minimum": 0, "type": "integer", "format": "int32" }, "maxDayClicks": { "minimum": 0, "type": "integer", "format": "int32" }, "maxDayConversions": { "minimum": 0, "type": "integer", "format": "int32" }, "totalImpressions": { "minimum": 0, "type": "integer", "format": "int32" }, "totalClicks": { "minimum": 0, "type": "integer", "format": "int32" }, "totalConversions": { "minimum": 0, "type": "integer", "format": "int32" }, "bidStrategyFlag": { "type": "boolean" }, "ioId": { "type": "integer", "format": "int32" }, "prebidAudienceSegmentIdList": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "isBidShading": { "type": "boolean" }, "totalCPM": { "minimum": 0, "type": "number", "format": "double" }, "templateId": { "type": "integer", "format": "int32" }, "carriers": { "type": "string" }, "networkType": { "type": "string" }, "deviceType": { "type": "string" }, "trafficType": { "type": "string" }, "manufacturer": { "type": "string" }, "device": { "type": "string" }, "os": { "type": "string" }, "osVersion": { "type": "string" }, "technologyFlag": { "type": "boolean" }, "exchanges": { "type": "string" }, "whiteListedDeviceId": { "type": "string" }, "whiteListedIp": { "type": "string" }, "whiteListedAppId": { "type": "string" }, "whiteListedPackageName": { "type": "string" }, "whiteListedSiteDomain": { "type": "string" }, "blackListedDeviceId": { "type": "string" }, "blackListedIp": { "type": "string" }, "blackListedAppId": { "type": "string" }, "blackListedPackageName": { "type": "string" }, "blackListedSiteDomain": { "type": "string" }, "advancedFlag": { "type": "boolean" }, "userDealId": { "type": "string" }, "groupDealId": { "type": "string" }, "publisherAdCategory": { "type": "string" }, "campaignIabCategoryIds": { "type": "string" }, "stateIds": { "type": "string" }, "whiteListedStateIds": { "type": "string" }, "blackListedStateIds": { "type": "string" }, "countryId": { "type": "integer", "format": "int32" }, "dmaIds": { "type": "string" }, "whiteListedDmaIds": { "type": "string" }, "blackListedDmaIds": { "type": "string" }, "zipcodes": { "type": "string" }, "whiteListedZipcodes": { "type": "string" }, "blackListedZipcodes": { "type": "string" }, "geoRadiusDetails": { "type": "array", "items": { "type": "object", "properties": { "latitude": { "type": "number", "format": "double" }, "longitude": { "type": "number", "format": "double" }, "radius": { "type": "number", "format": "double" }, "address": { "type": "string" }, "stateShortName": { "type": "string" }, "countryShortName": { "type": "string" }, "locationId": { "type": "integer", "format": "int32" }, "rejectionReason": { "type": "string" }, "polypath": { "type": "object" }, "placemarkName": { "type": "string" }, "isIncluded": { "type": "boolean" }, "cid": { "type": "string" }, "sid": { "type": "string" }, "type": { "type": "string" }, "unit": { "type": "string" }, "cdId": { "type": "integer", "format": "int32" }, "sdId": { "type": "integer", "format": "int32" }, "hdId": { "type": "integer", "format": "int32" } } } }, "whiteListedGeoRadiusDetails": { "type": "array", "items": { "type": "object", "properties": { "latitude": { "type": "number", "format": "double" }, "longitude": { "type": "number", "format": "double" }, "radius": { "type": "number", "format": "double" }, "address": { "type": "string" }, "stateShortName": { "type": "string" }, "countryShortName": { "type": "string" }, "locationId": { "type": "integer", "format": "int32" }, "rejectionReason": { "type": "string" }, "polypath": { "type": "object" }, "placemarkName": { "type": "string" }, "isIncluded": { "type": "boolean" }, "cid": { "type": "string" }, "sid": { "type": "string" }, "type": { "type": "string" }, "unit": { "type": "string" }, "cdId": { "type": "integer", "format": "int32" }, "sdId": { "type": "integer", "format": "int32" }, "hdId": { "type": "integer", "format": "int32" } } } }, "blackListedGeoRadiusDetails": { "type": "array", "items": { "type": "object", "properties": { "latitude": { "type": "number", "format": "double" }, "longitude": { "type": "number", "format": "double" }, "radius": { "type": "number", "format": "double" }, "address": { "type": "string" }, "stateShortName": { "type": "string" }, "countryShortName": { "type": "string" }, "locationId": { "type": "integer", "format": "int32" }, "rejectionReason": { "type": "string" }, "polypath": { "type": "object" }, "placemarkName": { "type": "string" }, "isIncluded": { "type": "boolean" }, "cid": { "type": "string" }, "sid": { "type": "string" }, "type": { "type": "string" }, "unit": { "type": "string" }, "cdId": { "type": "integer", "format": "int32" }, "sdId": { "type": "integer", "format": "int32" }, "hdId": { "type": "integer", "format": "int32" } } } }, "gotvLocationId": { "type": "integer", "format": "int32" }, "congressionalDistrictIds": { "type": "string" }, "whiteListedCongressionalDistrictIds": { "type": "string" }, "blackListedCongressionalDistrictIds": { "type": "string" }, "senateDistrictIds": { "type": "string" }, "whiteListedSenateDistrictIds": { "type": "string" }, "blackListedSenateDistrictIds": { "type": "string" }, "houseDistrictIds": { "type": "string" }, "whiteListedHouseDistrictIds": { "type": "string" }, "blackListedHouseDistrictIds": { "type": "string" }, "locationFileIds": { "type": "string" }, "whiteListedLocationIds": { "type": "string" }, "blackListedLocationIds": { "type": "string" }, "radiusUpdatedLocations": { "type": "object", "additionalProperties": { "type": "number", "format": "double" } }, "removedLocationIds": { "type": "string" }, "whiteListedCityIds": { "type": "string" }, "blackListedCityIds": { "type": "string" }, "whiteListedCountyIds": { "type": "string" }, "blackListedCountyIds": { "type": "string" }, "blackListedInventoryGroupIds": { "type": "string" }, "whiteListedInventoryGroupIds": { "type": "string" }, "inventoryKeywords": { "type": "array", "items": { "type": "string" } }, "inventoryUrls": { "type": "array", "items": { "type": "string" } }, "pmpDealIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "blackListedAudienceIds": { "type": "string" }, "whiteListedAudienceIds": { "type": "string" }, "blackListedCustomAudienceIds": { "type": "string" }, "whiteListedCustomAudienceIds": { "type": "string" }, "advertiserType": { "type": "string" }, "politicalAdvertiserClientId": { "type": "integer", "format": "int32" }, "scheduling": { "type": "object", "additionalProperties": { "type": "object" } }, "ageRangeIds": { "type": "string" }, "genderIds": { "type": "string" }, "languageIds": { "type": "string" }, "incomeRangeIds": { "type": "string" }, "ethnicityIds": { "type": "string" }, "interestIds": { "type": "string" }, "demographicTargetingFlag": { "type": "boolean" }, "whiteListedAudienceSegmentGroupIds": { "type": "string" }, "blackListedAudienceSegmentGroupIds": { "type": "string" }, "blackListedConversionTagIds": { "type": "string" }, "whiteListedConversionTagIds": { "type": "string" }, "conversionIds": { "type": "string" }, "creativesPlacementMapping": { "type": "object", "additionalProperties": { "type": "integer", "format": "int32" } }, "isTvAd": { "type": "boolean" }, "creativeAdvanceTargeting": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "integer", "format": "int32" } } }, "budgetTypeId": { "type": "integer", "format": "int32" }, "campaignEstimatorMetaData": { "type": "object", "properties": { "reachMeta": { "type": "object", "additionalProperties": { "type": "object" } }, "landScapeMeta": { "type": "object", "additionalProperties": { "type": "object" } }, "sliderMeta": { "type": "object", "additionalProperties": { "type": "object" } } } }, "campaignOptimization": { "type": "object", "properties": { "aiObjective": { "type": "integer", "format": "int32" }, "aiGoal": { "type": "integer", "format": "int32" }, "aiTargetKpi": { "type": "number", "format": "double" }, "aiConversionId": { "type": "integer", "format": "int32" } } }, "campaignOptimizationType": { "type": "string" }, "modelledDimensionIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "advanceAudioVideoTargeted": { "type": "boolean" }, "customAudienceTargeted": { "type": "boolean" }, "isAdvanceAudioVideoTargeted": { "type": "boolean" } } }, "examples": { "Get campaign count by status with search field and OwIds filter.": { "description": "Get campaign count by status with search field and OwIds filter.", "value": { "owIds": "1,2,3,4,5", "searchField": "sample-campaign-name" } }, "Get campaign count by status with all OwIds filter.": { "description": "Get campaign count by status with all OwIds filter.", "value": { "owIds": "all" } }, "Get campaign count by status with all ioIds filter.": { "description": "Get campaign count by status with all ioIds filter.", "value": { "owIds": "all", "ioIds": "1,2,3" } }, "Get campaign count by campaign type filter and ioIds filter.": { "description": "Get campaign count by campaign type filter and ioIds filter.", "value": { "ioIds": "1,2,3", "campaignTypeIds": "[1]" } }, "Get campaign count by ioIds filter and expired after filter.": { "description": "Get campaign count by ioIds filter and expired after filter.", "value": { "ioIds": "1,2,3", "campaignExpiredAfterEpoch": 1720722600000 } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Get all Status count": { "description": "Get all Status count", "value": { "success": true, "data": [ { "order": 0, "status_key": "running", "status_label": "Running", "status_count": 10 }, { "order": 1, "status_key": "pending", "status_label": "Pending", "status_count": 11 }, { "order": 2, "status_key": "paused", "status_label": "Paused", "status_count": 22 }, { "order": 5, "status_key": "deleted", "status_label": "Deleted", "status_count": 33 }, { "order": 6, "status_key": "expired", "status_label": "Expired", "status_count": 44 }, { "order": 3, "status_key": "draft", "status_label": "Draft", "status_count": 55 }, { "order": 7, "status_key": "rejected", "status_label": "Rejected", "status_count": 66 }, { "order": 8, "status_key": "all", "status_label": "ALL", "status_count": 77 } ] } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "examples": { "Validation error": { "description": "Validation error", "value": { "statusCode": 412, "responseObject": { "errorMsg": "Invalid arguments audience ids!", "errorCode": 412 } } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "statusCode": 500, "responseObject": { "errorMsg": "Internal server error", "errorCode": 500 } } } } } } } }, "/api/v3/cmp/campaigngroup/list": { "post": { "tags": [ "Campaign API" ], "summary": "Get List of campaign group", "description": "This API returns the list of campaign group as per the filters provided in the request body. \n\n---\n\n#### Request Body Detail\n\n| **Field** | **Type** | **Description** |\n| --- | --- | --- |\n| pageNo `[optional]` | Number | Page number for the required data. The default value is 1. |\n| noOfEntries `[optional]` | Number | The maximum number of returned results per page. The default value is 20 and the maximum value is 500. |\n| sortBy `[optional]` | String | Sort the result set by specific field. |\n| order `[optional]` | String | Sorting order Supported values: `asc` or `desc`. The default value is `asc`. |\n| searchField `[optional]` | String | Search the result by provided keyword in the searchField. It filters records by campaign group id, campaign group name. |\n| ids `[optional]` | Array of Integer | The list includes selected campaign group IDs. Records matching the provided IDs will be returned first, before other records. |\n| campaignGroupIds `[optional]` | Array of Integer | This represent campaign group ids filter. If provided, response data will be filtered for those campaign group ids only. |\n| isAllOwIds `[optional]` | Boolean | This represent filter records with all allowed owIds. if provided as `true`. `isAllOwIds` is more of a priority than `owIds`. |\n| owIds `[optional]` | Array of Integer | This represent customer owIds filter. If provided, response data will be filtered for those customer owIds only. |\n", "operationId": "getCampaignGroupList", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "conversionIds": { "type": "string" }, "campaignIds": { "type": "string" }, "conversionTypeId": { "type": "integer", "format": "int32" } } }, "examples": { "Fetch campaign group for all allowed owIds.": { "description": "Fetch campaign group for all allowed owIds.", "value": { "pageNo": 1, "noOfEntries": 20, "owIds": [], "sortBy": "id", "order": "asc", "searchField": "" } }, "Fetch campaign group for all allowed owIds with selected group ids.": { "description": "Fetch campaign group for all allowed owIds with selected group ids.", "value": { "pageNo": 1, "noOfEntries": 20, "owIds": [], "ids": [1235], "sortBy": "id", "order": "asc", "searchField": "" } }, "Filtered campaign groups with campaign group ids.": { "description": "Filtered campaign groups with campaign group ids.", "value": { "pageNo": 1, "noOfEntries": 20, "owIds": [], "campaignGroupIds": [1235], "sortBy": "id", "order": "asc", "searchField": "" } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Fetch campaign group for all allowed owIds.": { "description": "Fetch campaign group for all allowed owIds.", "value": { "success": true, "data": { "data": [ { "groupId": 1234, "groupName": "campaign group -1", "createdDate": 1668201219, "owId": 1 }, { "groupId": 1235, "groupName": "campaign group -2", "createdDate": 1674798403, "owId": 1 } ], "totalRecords": 2, "filteredRecords": 2 } } }, "Fetch campaign group for all allowed owIds with selected group ids.": { "description": "Fetch campaign group for all allowed owIds with selected group ids.", "value": { "success": true, "data": { "data": [ { "groupId": 1235, "groupName": "campaign group -2", "createdDate": 1668201219, "owId": 1 }, { "groupId": 1234, "groupName": "campaign group -1", "createdDate": 1674798403, "owId": 1 } ], "totalRecords": 2, "filteredRecords": 2 } } }, "Filtered campaign groups with campaign group ids.": { "description": "Filtered campaign groups with campaign group ids.", "value": { "success": true, "data": { "data": [ { "groupId": 1235, "groupName": "campaign group -2", "createdDate": 1668201219, "owId": 1 } ], "totalRecords": 1, "filteredRecords": 2 } } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "examples": { "Invalid owIds ": { "description": "Invalid owIds ", "value": { "success": false, "errorObjects": [ { "error": "invalid arguments owIds!" } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/cmp/campaign/estimation/reach": { "post": { "tags": [ "Campaign API" ], "summary": "Get the audience reach estimation.", "description": "This API returns the audience reach estimation bases on the given parameters. Request body supports the dimensions available with 'true' value in the following API: [API DOCs](?path=/Campaign%20API/getEstimatorDimensionList)", "operationId": "getAudienceReachEstimation", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "object" } }, "example": { "stateIds": "30200032", "whitelistCityIds": "30434428,30434491,30434474,30434611,30434282,30434161,30434352,30434090,30499999", "whitelistZipCodes": "08016,08048,08036,07825,07650,08879", "ethnicityIds": "10700001", "ageIds": "10100006,10100007,10100004,10100003", "incomeIds": "10300001,10300002,10300004,10300006", "bidPacing": true, "budgetDay": 120, "creativesPlacementMapping": { "537448": 0 } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "success": true, "data": { "targetingType": "Specific", "estimatedReachMin": 4392, "estimatedReachMax": 5369, "estimatedReachAvg": 4881 } } } } }, "408": { "description": "Request Timeout", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Server request timed out!" } ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/cmp/campaign/estimation/bid-landscape": { "post": { "tags": [ "Campaign API" ], "summary": "Get the bid landscape estimation.", "description": "This API returns the bid landscape estimation bases on the given parameters. Request body supports the dimensions available with 'true' value in the following API: [API DOCs](?path=/Campaign%20API/getEstimatorDimensionList)", "operationId": "getBidLandscapeEstimation", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "object" } }, "example": { "stateIds": "30200032", "whitelistCityIds": "30434428,30434491,30434474,30434611,30434282,30434161,30434352,30434090,30499999", "whitelistZipCodes": "08016,08048,08036,07825,07650,08879", "ethnicityIds": "10700001", "ageIds": "10100006,10100007,10100004,10100003", "incomeIds": "10300001,10300002,10300004,10300006", "bidPacing": true, "budgetDay": 120, "creativesPlacementMapping": { "537448": 0 } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "success": true, "data": { "axis": { "x": "bidFloor", "y": "numImp" }, "bidGuidance": [ { "bidfloorPercentile": 0, "bidFloor": 0.141666666666667, "numImp": 0 }, { "bidfloorPercentile": 5, "bidFloor": 0.20439, "numImp": 7414 }, { "bidfloorPercentile": 10, "bidFloor": 0.20439, "numImp": 14828 }, { "bidfloorPercentile": 20, "bidFloor": 0.47691, "numImp": 29657 }, { "bidfloorPercentile": 30, "bidFloor": 0.88569, "numImp": 44485 }, { "bidfloorPercentile": 40, "bidFloor": 1.10333333333333, "numImp": 59314 }, { "bidfloorPercentile": 50, "bidFloor": 1.31086, "numImp": 74142 }, { "bidfloorPercentile": 60, "bidFloor": 1.77777666666667, "numImp": 88971 }, { "bidfloorPercentile": 70, "bidFloor": 1.991, "numImp": 103799 }, { "bidfloorPercentile": 80, "bidFloor": 2.33, "numImp": 118628 }, { "bidfloorPercentile": 90, "bidFloor": 2.72233333333333, "numImp": 133456 }, { "bidfloorPercentile": 95, "bidFloor": 2.99625333333333, "numImp": 140870 }, { "bidfloorPercentile": 99, "bidFloor": 3.12416666666667, "numImp": 146802 } ] } } } } }, "408": { "description": "Request Timeout", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Server request timed out!" } ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/cmp/campaign/cost": { "post": { "tags": [ "Campaign API" ], "summary": "Get Cost Details for provided input", "description": "This API retrieves the cost details for a specific campaign. The request body must include either the `campaignId` or a combination of `audienceIds`, `creativeIds`, and `preBidSegmentIds`.", "operationId": "getCostDetails", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "campaignId": { "type": "integer", "format": "int32" }, "owId": { "type": "integer", "format": "int32" }, "audienceIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "creativeIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "preBidSegmentIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "creativeTypeId": { "type": "integer", "format": "int32" } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "success": true, "data": { "maxBidPrice": 25, "adServingCost": 1.25, "dataCost": 15, "preBidCost": null, "msaExistsWith": "Partner A", "logoURL": "https://example.com/logo.png", "thirdPartyCost": 10.5 } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "examples": { "Invalid Request": { "description": "Invalid Request", "value": { "success": false, "errorObjects": [ { "error": "Invalid campaignId or missing required fields." } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/cmp/campaign-type/count": { "post": { "tags": [ "Campaign API" ], "summary": "This API will provide the Values of Campaign type with count of campaigns.", "description": "This API will provide the values of Campaign type with the count of campaigns with same type based on provided filters .---#### Request Body Detail\n\n| **Field** | **Type** | **Description** |\n| --- | --- | --- |\n| budgetTypeIds `[optional]` | Array of Integer | The list includes selected budget type ids i.e dollar based campaign or Impressions based campaign. [budget-type](?path=/Campaign%20API/getBudgetTypeList) || statusList `[optional]` | Array of String | The list includes types of campaign status to be fetched. || countRequired `[optional]` | boolean | Represent the need of campaigns count with campaign type. || campaignIds `[optional]` | Array of Integer | This represent campaign ids filter. || ioIds `[optional]` | Array of Integer | This represent io ids filter. || creativeTypeIds `[optional]` | Array of Integer | This represent creative type ids filter.[creative-type](?path=/Campaign%20API/getCampaignCountWithCreativeTypeByIoIds) |", "operationId": "getCampaignsCountWithCampaignType", "requestBody": { "content": { "application/json": { "schema": { "required": [ "exchanges", "publisherAdCategory" ], "type": "object", "properties": { "advertiserId": { "type": "integer", "format": "int32" }, "dspId": { "type": "integer", "format": "int32" }, "owId": { "type": "integer", "format": "int32" }, "uowId": { "type": "integer", "format": "int32" }, "id": { "type": "integer", "format": "int32" }, "campaignName": { "type": "string" }, "advertiserDomain": { "type": "string" }, "creativeType": { "type": "integer", "format": "int32" }, "campaignType": { "type": "integer", "format": "int32" }, "totalBudgetPacing": { "type": "boolean" }, "budgetDay": { "minimum": 0, "type": "number", "format": "double" }, "budgetTotal": { "minimum": 0, "type": "number", "format": "double" }, "maxBid": { "type": "number", "format": "double" }, "minBid": { "type": "number", "format": "double" }, "allowedMinBid": { "type": "number", "format": "double" }, "timezone": { "type": "integer", "format": "int32" }, "startTime": { "type": "integer", "format": "int64" }, "endTime": { "type": "integer", "format": "int64" }, "status": { "type": "string" }, "created": { "type": "integer", "format": "int32" }, "excludeFromPlatformServing": { "type": "boolean" }, "forTest": { "type": "boolean" }, "modifiedDate": { "type": "string", "format": "date-time" }, "dspMarginJson": { "type": "string" }, "platformMarginJson": { "type": "string" }, "dspMargin": { "type": "integer", "format": "int32" }, "platformMargin": { "type": "integer", "format": "int32" }, "userDealMargin": { "type": "integer", "format": "int32" }, "isAgreementChecked": { "type": "boolean" }, "spentScale": { "type": "boolean" }, "creativeIds": { "type": "string" }, "targetCPI": { "type": "integer", "format": "int64" }, "conversionType": { "type": "string" }, "conversionTypeId": { "type": "integer", "format": "int32" }, "appURL": { "type": "string" }, "bidOptimization": { "type": "boolean" }, "bidPacing": { "type": "boolean" }, "impressionCapping": { "minimum": 0, "type": "integer", "format": "int32" }, "frequencyCapEnabled": { "type": "boolean" }, "frequencyCapping": { "type": "object", "additionalProperties": { "type": "object", "properties": { "frequencyCapDuration": { "type": "integer", "format": "int32" }, "frequencyCapValue": { "type": "integer", "format": "int32" } } } }, "maxDayImpressions": { "minimum": 0, "type": "integer", "format": "int32" }, "maxDayClicks": { "minimum": 0, "type": "integer", "format": "int32" }, "maxDayConversions": { "minimum": 0, "type": "integer", "format": "int32" }, "totalImpressions": { "minimum": 0, "type": "integer", "format": "int32" }, "totalClicks": { "minimum": 0, "type": "integer", "format": "int32" }, "totalConversions": { "minimum": 0, "type": "integer", "format": "int32" }, "bidStrategyFlag": { "type": "boolean" }, "ioId": { "type": "integer", "format": "int32" }, "prebidAudienceSegmentIdList": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "isBidShading": { "type": "boolean" }, "totalCPM": { "minimum": 0, "type": "number", "format": "double" }, "templateId": { "type": "integer", "format": "int32" }, "carriers": { "type": "string" }, "networkType": { "type": "string" }, "deviceType": { "type": "string" }, "trafficType": { "type": "string" }, "manufacturer": { "type": "string" }, "device": { "type": "string" }, "os": { "type": "string" }, "osVersion": { "type": "string" }, "technologyFlag": { "type": "boolean" }, "exchanges": { "type": "string" }, "whiteListedDeviceId": { "type": "string" }, "whiteListedIp": { "type": "string" }, "whiteListedAppId": { "type": "string" }, "whiteListedPackageName": { "type": "string" }, "whiteListedSiteDomain": { "type": "string" }, "blackListedDeviceId": { "type": "string" }, "blackListedIp": { "type": "string" }, "blackListedAppId": { "type": "string" }, "blackListedPackageName": { "type": "string" }, "blackListedSiteDomain": { "type": "string" }, "advancedFlag": { "type": "boolean" }, "userDealId": { "type": "string" }, "groupDealId": { "type": "string" }, "publisherAdCategory": { "type": "string" }, "campaignIabCategoryIds": { "type": "string" }, "stateIds": { "type": "string" }, "whiteListedStateIds": { "type": "string" }, "blackListedStateIds": { "type": "string" }, "countryId": { "type": "integer", "format": "int32" }, "dmaIds": { "type": "string" }, "whiteListedDmaIds": { "type": "string" }, "blackListedDmaIds": { "type": "string" }, "zipcodes": { "type": "string" }, "whiteListedZipcodes": { "type": "string" }, "blackListedZipcodes": { "type": "string" }, "geoRadiusDetails": { "type": "array", "items": { "type": "object", "properties": { "latitude": { "type": "number", "format": "double" }, "longitude": { "type": "number", "format": "double" }, "radius": { "type": "number", "format": "double" }, "address": { "type": "string" }, "stateShortName": { "type": "string" }, "countryShortName": { "type": "string" }, "locationId": { "type": "integer", "format": "int32" }, "rejectionReason": { "type": "string" }, "polypath": { "type": "object" }, "placemarkName": { "type": "string" }, "isIncluded": { "type": "boolean" }, "cid": { "type": "string" }, "sid": { "type": "string" }, "type": { "type": "string" }, "unit": { "type": "string" }, "cdId": { "type": "integer", "format": "int32" }, "sdId": { "type": "integer", "format": "int32" }, "hdId": { "type": "integer", "format": "int32" } } } }, "whiteListedGeoRadiusDetails": { "type": "array", "items": { "type": "object", "properties": { "latitude": { "type": "number", "format": "double" }, "longitude": { "type": "number", "format": "double" }, "radius": { "type": "number", "format": "double" }, "address": { "type": "string" }, "stateShortName": { "type": "string" }, "countryShortName": { "type": "string" }, "locationId": { "type": "integer", "format": "int32" }, "rejectionReason": { "type": "string" }, "polypath": { "type": "object" }, "placemarkName": { "type": "string" }, "isIncluded": { "type": "boolean" }, "cid": { "type": "string" }, "sid": { "type": "string" }, "type": { "type": "string" }, "unit": { "type": "string" }, "cdId": { "type": "integer", "format": "int32" }, "sdId": { "type": "integer", "format": "int32" }, "hdId": { "type": "integer", "format": "int32" } } } }, "blackListedGeoRadiusDetails": { "type": "array", "items": { "type": "object", "properties": { "latitude": { "type": "number", "format": "double" }, "longitude": { "type": "number", "format": "double" }, "radius": { "type": "number", "format": "double" }, "address": { "type": "string" }, "stateShortName": { "type": "string" }, "countryShortName": { "type": "string" }, "locationId": { "type": "integer", "format": "int32" }, "rejectionReason": { "type": "string" }, "polypath": { "type": "object" }, "placemarkName": { "type": "string" }, "isIncluded": { "type": "boolean" }, "cid": { "type": "string" }, "sid": { "type": "string" }, "type": { "type": "string" }, "unit": { "type": "string" }, "cdId": { "type": "integer", "format": "int32" }, "sdId": { "type": "integer", "format": "int32" }, "hdId": { "type": "integer", "format": "int32" } } } }, "gotvLocationId": { "type": "integer", "format": "int32" }, "congressionalDistrictIds": { "type": "string" }, "whiteListedCongressionalDistrictIds": { "type": "string" }, "blackListedCongressionalDistrictIds": { "type": "string" }, "senateDistrictIds": { "type": "string" }, "whiteListedSenateDistrictIds": { "type": "string" }, "blackListedSenateDistrictIds": { "type": "string" }, "houseDistrictIds": { "type": "string" }, "whiteListedHouseDistrictIds": { "type": "string" }, "blackListedHouseDistrictIds": { "type": "string" }, "locationFileIds": { "type": "string" }, "whiteListedLocationIds": { "type": "string" }, "blackListedLocationIds": { "type": "string" }, "radiusUpdatedLocations": { "type": "object", "additionalProperties": { "type": "number", "format": "double" } }, "removedLocationIds": { "type": "string" }, "whiteListedCityIds": { "type": "string" }, "blackListedCityIds": { "type": "string" }, "whiteListedCountyIds": { "type": "string" }, "blackListedCountyIds": { "type": "string" }, "blackListedInventoryGroupIds": { "type": "string" }, "whiteListedInventoryGroupIds": { "type": "string" }, "inventoryKeywords": { "type": "array", "items": { "type": "string" } }, "inventoryUrls": { "type": "array", "items": { "type": "string" } }, "pmpDealIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "blackListedAudienceIds": { "type": "string" }, "whiteListedAudienceIds": { "type": "string" }, "blackListedCustomAudienceIds": { "type": "string" }, "whiteListedCustomAudienceIds": { "type": "string" }, "advertiserType": { "type": "string" }, "politicalAdvertiserClientId": { "type": "integer", "format": "int32" }, "scheduling": { "type": "object", "additionalProperties": { "type": "object" } }, "ageRangeIds": { "type": "string" }, "genderIds": { "type": "string" }, "languageIds": { "type": "string" }, "incomeRangeIds": { "type": "string" }, "ethnicityIds": { "type": "string" }, "interestIds": { "type": "string" }, "demographicTargetingFlag": { "type": "boolean" }, "whiteListedAudienceSegmentGroupIds": { "type": "string" }, "blackListedAudienceSegmentGroupIds": { "type": "string" }, "blackListedConversionTagIds": { "type": "string" }, "whiteListedConversionTagIds": { "type": "string" }, "conversionIds": { "type": "string" }, "creativesPlacementMapping": { "type": "object", "additionalProperties": { "type": "integer", "format": "int32" } }, "isTvAd": { "type": "boolean" }, "creativeAdvanceTargeting": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "integer", "format": "int32" } } }, "budgetTypeId": { "type": "integer", "format": "int32" }, "campaignEstimatorMetaData": { "type": "object", "properties": { "reachMeta": { "type": "object", "additionalProperties": { "type": "object" } }, "landScapeMeta": { "type": "object", "additionalProperties": { "type": "object" } }, "sliderMeta": { "type": "object", "additionalProperties": { "type": "object" } } } }, "campaignOptimization": { "type": "object", "properties": { "aiObjective": { "type": "integer", "format": "int32" }, "aiGoal": { "type": "integer", "format": "int32" }, "aiTargetKpi": { "type": "number", "format": "double" }, "aiConversionId": { "type": "integer", "format": "int32" } } }, "campaignOptimizationType": { "type": "string" }, "modelledDimensionIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "advanceAudioVideoTargeted": { "type": "boolean" }, "customAudienceTargeted": { "type": "boolean" }, "isAdvanceAudioVideoTargeted": { "type": "boolean" } } }, "examples": { "Get campaign count with campaign type with status filter.": { "description": "Get campaign count with campaign type with status filter.", "value": { "statusList": "[pending]", "countRequired": "true" } }, "Get campaign count with campaign type with status and creative type filters.": { "description": "Get campaign count with campaign type with status and creative type filters.", "value": { "statusList": "[pending]", "creativeTypeIds": "[11]", "countRequired": "true" } }, "Get campaign count with campaign type with status,creative type,budget type,campaign ids filters.": { "description": "Get campaign count with campaign type with status,creative type,budget type,campaign ids filters.", "value": { "statusList": "[pending]", "creativeTypeIds": "[11]", "budgetTypeIds": "[1]", "campaignIds": "[23434,4645]", "countRequired": "true" } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "success": true, "data": { "totalRecords": 2, "filteredRecords": 2, "campaignTypeDetails": [ { "id": 1, "order": 1, "name": "advanced", "label": "Advanced", "count": 1 }, { "id": 2, "order": 2, "name": "pg", "label": "PG", "count": 3 } ] } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/cmp/basic/list": { "post": { "tags": [ "Campaign API" ], "summary": "This API provides basic details of the campaigns", "description": "This API will provide basic campaign details for provided campaigns or provided customers' campaigns with organization detail which has created campaign.", "operationId": "getCampaignBasicDetailList", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "description": "API to get basic details of the campaign. \n\n---\n\n#### Request Body Detail\n\n| **Field** | **Type** | **Description** |\n| --- | --- | --- |\n| pageNo `[optional]` | Number | Page number for the required data. The default value is 1. |\n| noOfEntries `[optional]` | Number | The maximum number of returned results per page. The default value is 20 and the maximum value is 500. |\n| sortBy `[optional]` | String | Sort the result set by specific field. |\n| order `[optional]` | String | Sorting order Supported values: `asc` or `desc`. The default value is `asc`. |\n| searchField `[optional]` | String | Search the result by provided keyword in the searchField. It filters records by campaign id, campaign name. |\n| campaignIds `[optional]` | Array of Integer | Filter Campaign list by provided campaignIds. |\n| owIds `[optional]` | Array of Integer | Filter Campaign List for provided Customer owIds. |\n| status `[optional]` | Array of String | Filter Campaign List for provided campaign statuses. |\n| responseFields `[optional]` | Array of String | API allows you to request only the fields that you need in the response, which can help reduce unnecessary data transfer and improve performance. \u003Cbr/\u003E By default, API includes all allowed fields in the response, \u003Cbr/\u003E allowed values are `id`, `campaignId`, `name`, `creativeTypeId`, `status`, `startTime`, `endTime`, `createdAt`, `modifiedAt`, `owId`, `organizationName`, `organizationLogo` |\n| creativeTypeIds `[optional]` | Array of Integer | Filter Campaign List for provided creative type ids. |\n| campaignTypeIds `[optional]` | Array of Integer | Filter Campaign List for provided campaign type ids. |\n| isAllOwIds `[optional]` | Boolean | `True` when data needs to be provided for all Customer owIds. \u003Cbr\u003E\u003Cbr\u003E `False` when data needs to be provided for specific customer owIds. |\n| ids `[optional]` | Array of Integer | Selected campaign id List, campaigns with provided ids will be returned first compared to other records. |\n| ioIdsList `[optional]` | Array of Integer | Filter campaign List for provided IO (insertion-order) ids. |\n", "content": { "application/json": { "schema": { "type": "object", "properties": { "sortByFields": { "type": "object", "additionalProperties": { "type": "string" } }, "campaignIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "owIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "isAllOwIds": { "type": "boolean" }, "status": { "type": "array", "items": { "type": "string" } }, "creativeTypeIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "ids": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "responseFields": { "type": "array", "items": { "type": "string" } }, "ioIdsList": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "campaignTypeIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "pageNo": { "type": "integer", "format": "int32" }, "noOfEntries": { "type": "integer", "format": "int32" }, "sortBy": { "type": "string" }, "searchField": { "type": "string" }, "order": { "type": "string", "enum": [ "com.iqm.commons.models.enums.SortOrderEnum@6f37475b[id=1,name=asc,symbol=+,name=ASC,ordinal=0]", "com.iqm.commons.models.enums.SortOrderEnum@3e0e6466[id=2,name=desc,symbol=-,name=DESC,ordinal=1]" ] } } }, "examples": { "Get all campaign details": { "description": "Get all campaign details", "value": { "isAllOwIds": true, "owIds": [], "searchField": "", "pageNo": 1, "noOfEntries": 50 } }, "Filtered campaigns with customers": { "description": "Filtered campaigns with customers", "value": { "isAllOwIds": false, "owIds": [200002], "searchField": "", "pageNo": 1, "noOfEntries": 50 } }, "Filtered campaigns by creative-types": { "description": "Filtered campaigns by creative-types", "value": { "isAllOwIds": true, "owIds": [], "searchField": "", "pageNo": 1, "noOfEntries": 50 } }, "Filtered campaigns by ids": { "description": "Filtered campaigns by ids", "value": { "status": [ "running" ], "pageNo": 1, "noOfEntries": 5, "ids": "292694" } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Get all campaign details": { "description": "Get all campaign details", "value": { "success": true, "data": { "data": [ { "campaignId": 273438, "name": "Campaign-1", "creativeTypeId": 11, "campaignTypeId": 1, "status": "deleted", "startTime": 1658217468, "endTime": 1658303868, "createdAt": 1658217469, "modifiedAt": 1661150517, "owId": 201427, "organizationName": "organization-1", "organizationLogo": "https://iqm-web-assets-c92d6b6cbde1-stage.s3.amazonaws.com/avatar/SA.png", "ioId": 1, "ioStatusId": 1, "timezoneId": 11, "ioBudgetTypeId": 1, "ioName": "Name Insertion Order" }, { "campaignId": 261497, "name": "Campaign-2", "creativeTypeId": 11, "campaignTypeId": 1, "status": "running", "startTime": 1653551400, "endTime": 1674777600, "createdAt": 1653550497, "modifiedAt": 1661150407, "owId": 201457, "organizationName": "organization-1", "organizationLogo": "https://iqm-web-assets-c92d6b6cbde1-stage.s3.amazonaws.com/avatar/ZO.png", "ioId": 1, "ioStatusId": 1, "timezoneId": 11, "ioBudgetTypeId": 1, "ioName": "Name Insertion Order" } ], "totalRecords": 50, "filteredRecords": 50 } } }, "Filtered campaigns with customers": { "description": "Filtered campaigns with customers", "value": { "success": true, "data": { "data": [ { "campaignId": 273438, "name": "Campaign-1", "creativeTypeId": 11, "campaignTypeId": 1, "status": "deleted", "startTime": 1658217468, "endTime": 1658303868, "createdAt": 1658217469, "modifiedAt": 1661150517, "owId": 200002, "organizationName": "Organization-1", "organizationLogo": "https://iqm-web-assets-c92d6b6cbde1-stage.s3.amazonaws.com/avatar/SA.png", "ioId": 1, "ioStatusId": 1, "timezoneId": 11, "ioBudgetTypeId": 1, "ioName": "Name Insertion Order" }, { "campaignId": 261497, "name": "Campaign-2", "creativeTypeId": 11, "campaignTypeId": 1, "status": "running", "startTime": 1653551400, "endTime": 1674777600, "createdAt": 1653550497, "modifiedAt": 1661150407, "owId": 200002, "organizationName": "Organization-1", "organizationLogo": "https://iqm-web-assets-c92d6b6cbde1-stage.s3.amazonaws.com/avatar/SA.png", "ioId": 1, "ioStatusId": 1, "timezoneId": 11, "ioBudgetTypeId": 1, "ioName": "Name Insertion Order" } ], "totalRecords": 2, "filteredRecords": 50 } } }, "Filtered campaigns with creative-types": { "description": "Filtered campaigns with creative-types", "value": { "success": true, "data": { "data": [ { "campaignId": 273438, "name": "Campaign-1", "creativeTypeId": 11, "campaignTypeId": 1, "status": "deleted", "startTime": 1658217468, "endTime": 1658303868, "createdAt": 1658217469, "modifiedAt": 1661150517, "owId": 200002, "organizationName": "Organization-1", "organizationLogo": "https://iqm-web-assets-c92d6b6cbde1-stage.s3.amazonaws.com/avatar/SA.png", "ioId": 1, "ioStatusId": 1, "timezoneId": 11, "ioBudgetTypeId": 1, "ioName": "Name Insertion Order" }, { "campaignId": 261497, "name": "Campaign-2", "creativeTypeId": 11, "campaignTypeId": 1, "status": "running", "startTime": 1653551400, "endTime": 1674777600, "createdAt": 1653550497, "modifiedAt": 1661150407, "owId": 200002, "organizationName": "Organization-1", "organizationLogo": "https://iqm-web-assets-c92d6b6cbde1-stage.s3.amazonaws.com/avatar/SA.png", "ioId": 1, "ioStatusId": 1, "timezoneId": 11, "ioBudgetTypeId": 1, "ioName": "Name Insertion Order" } ], "totalRecords": 2, "filteredRecords": 50 } } }, "Filtered campaigns by ids": { "description": "Filtered campaigns by ids", "value": { "success": true, "data": { "data": [ { "campaignId": 123456, "name": "Campaign-1", "creativeTypeId": 11, "campaignTypeId": 1, "status": "running", "startTime": 1666347943, "endTime": 1672462800, "createdAt": 1666347950, "modifiedAt": 1668747600, "owId": 201427, "organizationName": "Organization - 1", "organizationLogo": "https://iqm-web-assets-c92d6b6cbde1-stage.s3.amazonaws.com/organization-profile/4831/1668757546029.jpg", "ioId": 1, "ioStatusId": 1, "timezoneId": 11, "ioBudgetTypeId": 1, "ioName": "Name Insertion Order" }, { "campaignId": 456789, "name": "Campaign-2", "creativeTypeId": 14, "campaignTypeId": 1, "status": "running", "startTime": 1668043201, "endTime": 1701331200, "createdAt": 1668042554, "modifiedAt": 1668758400, "owId": 201427, "organizationName": "Organization - 1", "organizationLogo": "https://iqm-web-assets-c92d6b6cbde1-stage.s3.amazonaws.com/organization-profile/4831/1668757546029.jpg", "ioId": 1, "ioStatusId": 1, "timezoneId": 11, "ioBudgetTypeId": 1, "ioName": "Name Insertion Order" } ], "totalRecords": 546, "filteredRecords": 2 } } }, "No record found": { "description": "No record found", "value": { "success": true, "data": { "data": [], "totalRecords": 0, "filteredRecords": 0 } } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/cmp/audience/targeting": { "post": { "tags": [ "Campaign API" ], "summary": "This API provides campaign wise basic details of the audience", "description": "This API provides campaign wise basic details of the audience including audience ids and type", "operationId": "getAudienceBasicDetailByCampaign", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "description": "API to get campaign wise basic details of the audience. \n", "content": { "application/json": { "schema": { "type": "object", "properties": { "sortByFields": { "type": "object", "additionalProperties": { "type": "string" } }, "campaignIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "owIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "isAllOwIds": { "type": "boolean" }, "status": { "type": "array", "items": { "type": "string" } }, "creativeTypeIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "ids": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "responseFields": { "type": "array", "items": { "type": "string" } }, "ioIdsList": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "campaignTypeIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "pageNo": { "type": "integer", "format": "int32" }, "noOfEntries": { "type": "integer", "format": "int32" }, "sortBy": { "type": "string" }, "searchField": { "type": "string" }, "order": { "type": "string", "enum": [ "com.iqm.commons.models.enums.SortOrderEnum@6f37475b[id=1,name=asc,symbol=+,name=ASC,ordinal=0]", "com.iqm.commons.models.enums.SortOrderEnum@3e0e6466[id=2,name=desc,symbol=-,name=DESC,ordinal=1]" ] } } }, "examples": { "Get all campaign details": { "description": "Get all campaign details", "value": { "campaignIds": [5224, 503] } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Get all campaign details": { "description": "Get all campaign details", "value": { "success": true, "data": { "543363": [], "553441": [ { "audienceTypeId": 1, "audienceIds": [1101833, 1101834, 1101835, 1102476] } ], "553443": [ { "audienceTypeId": 1, "audienceIds": [1101831, 1101835, 1102476] }, { "audienceTypeId": 9, "audienceIds": [1124205, 1124206] } ] } } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v2/cmp/campaigns/duplicate": { "post": { "tags": [ "Campaign API" ], "summary": "This method will duplicate campaigns within an Insertion Order", "description": "This API will duplicate campaigns in the Insertion Order with start date and end date", "operationId": "duplicateCampaign", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "advertiserId": { "type": "integer", "format": "int32" }, "dspId": { "type": "integer", "format": "int32" }, "owId": { "type": "integer", "format": "int32" }, "uowId": { "type": "integer", "format": "int32" }, "existingCampaignIds": { "type": "string" }, "endDate": { "type": "integer", "format": "int64" }, "startDate": { "type": "integer", "format": "int64" }, "ioId": { "type": "integer", "format": "int32" }, "timeZoneId": { "type": "integer", "format": "int32" }, "campaignTypeId": { "type": "integer", "format": "int32" }, "pgDealIds": { "type": "array", "items": { "type": "integer", "format": "int32" } } } }, "example": { "existingCampaignIds": "331575", "ioId": 9, "timeZoneId": 9, "startDate": 1693612135, "endDate": 0 } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Successful creation of IO": { "description": "Successful creation of IO", "value": { "statusCode": 200, "responseObject": { "duplicatedCampaignIds": [334676], "status": true } } } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "examples": { "Insertion Order Or other owId": { "description": "Insertion Order Or other owId", "value": { "statusCode": 400, "responseObject": { "errorMsg": "The action cannot be completed as insertion order 1 does not belong to this organization", "errorCode": 400 } } }, "Invalid Time Zone Id": { "description": "Invalid Time Zone Id", "value": { "statusCode": 400, "responseObject": { "errorMsg": "Invalid timezone.", "errorCode": 400 } } }, "Invalid Existing Campaign Ids": { "description": "Invalid Existing Campaign Ids", "value": { "statusCode": 400, "responseObject": { "errorMsg": "existingCampaignIds is required.", "errorCode": 400 } } }, "Invalid Start time": { "description": "Invalid Start time", "value": { "statusCode": 400, "responseObject": { "errorMsg": "startDate is required.", "errorCode": 400 } } }, "Invalid End time": { "description": "Invalid End time", "value": { "statusCode": 400, "responseObject": { "errorMsg": "End date value must be zero or more, except for budget pacing off campaigns where it can be zero.", "errorCode": 400 } } }, "Invalid Earlier Start time": { "description": "Invalid Earlier Start time", "value": { "statusCode": 400, "responseObject": { "errorMsg": "Start date can not be less than current time.", "errorCode": 400 } } }, "Invalid End Time": { "description": "Invalid End Time", "value": { "statusCode": 400, "responseObject": { "errorMsg": "End date can not be less than start date.", "errorCode": 400 } } }, "Invalid Time difference": { "description": "Invalid Time difference", "value": { "statusCode": 400, "responseObject": { "errorMsg": "There should be at least 15 min difference between start date and end date.", "errorCode": 400 } } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "statusCode": 500, "responseObject": { "errorMsg": "Internal server error", "errorCode": 500 } } } } } } } }, "/api/v2/cmp/campaigns/draft/add": { "post": { "tags": [ "Campaign API" ], "summary": "Save Campaign as a draft", "description": "This API saves the campaign as a draft with given targeting and with `draft` status.", "operationId": "saveDraftCampaign", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "content": { "application/json": { "schema": { "required": [ "exchanges", "publisherAdCategory" ], "type": "object", "properties": { "advertiserId": { "type": "integer", "format": "int32" }, "dspId": { "type": "integer", "format": "int32" }, "owId": { "type": "integer", "format": "int32" }, "uowId": { "type": "integer", "format": "int32" }, "id": { "type": "integer", "format": "int32" }, "campaignName": { "type": "string" }, "advertiserDomain": { "type": "string" }, "creativeType": { "type": "integer", "format": "int32" }, "campaignType": { "type": "integer", "format": "int32" }, "totalBudgetPacing": { "type": "boolean" }, "budgetDay": { "minimum": 0, "type": "number", "format": "double" }, "budgetTotal": { "minimum": 0, "type": "number", "format": "double" }, "maxBid": { "type": "number", "format": "double" }, "minBid": { "type": "number", "format": "double" }, "allowedMinBid": { "type": "number", "format": "double" }, "timezone": { "type": "integer", "format": "int32" }, "startTime": { "type": "integer", "format": "int64" }, "endTime": { "type": "integer", "format": "int64" }, "status": { "type": "string" }, "created": { "type": "integer", "format": "int32" }, "excludeFromPlatformServing": { "type": "boolean" }, "forTest": { "type": "boolean" }, "modifiedDate": { "type": "string", "format": "date-time" }, "dspMarginJson": { "type": "string" }, "platformMarginJson": { "type": "string" }, "dspMargin": { "type": "integer", "format": "int32" }, "platformMargin": { "type": "integer", "format": "int32" }, "userDealMargin": { "type": "integer", "format": "int32" }, "isAgreementChecked": { "type": "boolean" }, "spentScale": { "type": "boolean" }, "creativeIds": { "type": "string" }, "targetCPI": { "type": "integer", "format": "int64" }, "conversionType": { "type": "string" }, "conversionTypeId": { "type": "integer", "format": "int32" }, "appURL": { "type": "string" }, "bidOptimization": { "type": "boolean" }, "bidPacing": { "type": "boolean" }, "impressionCapping": { "minimum": 0, "type": "integer", "format": "int32" }, "frequencyCapEnabled": { "type": "boolean" }, "frequencyCapping": { "type": "object", "additionalProperties": { "type": "object", "properties": { "frequencyCapDuration": { "type": "integer", "format": "int32" }, "frequencyCapValue": { "type": "integer", "format": "int32" } } } }, "maxDayImpressions": { "minimum": 0, "type": "integer", "format": "int32" }, "maxDayClicks": { "minimum": 0, "type": "integer", "format": "int32" }, "maxDayConversions": { "minimum": 0, "type": "integer", "format": "int32" }, "totalImpressions": { "minimum": 0, "type": "integer", "format": "int32" }, "totalClicks": { "minimum": 0, "type": "integer", "format": "int32" }, "totalConversions": { "minimum": 0, "type": "integer", "format": "int32" }, "bidStrategyFlag": { "type": "boolean" }, "ioId": { "type": "integer", "format": "int32" }, "prebidAudienceSegmentIdList": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "isBidShading": { "type": "boolean" }, "totalCPM": { "minimum": 0, "type": "number", "format": "double" }, "templateId": { "type": "integer", "format": "int32" }, "carriers": { "type": "string" }, "networkType": { "type": "string" }, "deviceType": { "type": "string" }, "trafficType": { "type": "string" }, "manufacturer": { "type": "string" }, "device": { "type": "string" }, "os": { "type": "string" }, "osVersion": { "type": "string" }, "technologyFlag": { "type": "boolean" }, "exchanges": { "type": "string" }, "whiteListedDeviceId": { "type": "string" }, "whiteListedIp": { "type": "string" }, "whiteListedAppId": { "type": "string" }, "whiteListedPackageName": { "type": "string" }, "whiteListedSiteDomain": { "type": "string" }, "blackListedDeviceId": { "type": "string" }, "blackListedIp": { "type": "string" }, "blackListedAppId": { "type": "string" }, "blackListedPackageName": { "type": "string" }, "blackListedSiteDomain": { "type": "string" }, "advancedFlag": { "type": "boolean" }, "userDealId": { "type": "string" }, "groupDealId": { "type": "string" }, "publisherAdCategory": { "type": "string" }, "campaignIabCategoryIds": { "type": "string" }, "stateIds": { "type": "string" }, "whiteListedStateIds": { "type": "string" }, "blackListedStateIds": { "type": "string" }, "countryId": { "type": "integer", "format": "int32" }, "dmaIds": { "type": "string" }, "whiteListedDmaIds": { "type": "string" }, "blackListedDmaIds": { "type": "string" }, "zipcodes": { "type": "string" }, "whiteListedZipcodes": { "type": "string" }, "blackListedZipcodes": { "type": "string" }, "geoRadiusDetails": { "type": "array", "items": { "type": "object", "properties": { "latitude": { "type": "number", "format": "double" }, "longitude": { "type": "number", "format": "double" }, "radius": { "type": "number", "format": "double" }, "address": { "type": "string" }, "stateShortName": { "type": "string" }, "countryShortName": { "type": "string" }, "locationId": { "type": "integer", "format": "int32" }, "rejectionReason": { "type": "string" }, "polypath": { "type": "object" }, "placemarkName": { "type": "string" }, "isIncluded": { "type": "boolean" }, "cid": { "type": "string" }, "sid": { "type": "string" }, "type": { "type": "string" }, "unit": { "type": "string" }, "cdId": { "type": "integer", "format": "int32" }, "sdId": { "type": "integer", "format": "int32" }, "hdId": { "type": "integer", "format": "int32" } } } }, "whiteListedGeoRadiusDetails": { "type": "array", "items": { "type": "object", "properties": { "latitude": { "type": "number", "format": "double" }, "longitude": { "type": "number", "format": "double" }, "radius": { "type": "number", "format": "double" }, "address": { "type": "string" }, "stateShortName": { "type": "string" }, "countryShortName": { "type": "string" }, "locationId": { "type": "integer", "format": "int32" }, "rejectionReason": { "type": "string" }, "polypath": { "type": "object" }, "placemarkName": { "type": "string" }, "isIncluded": { "type": "boolean" }, "cid": { "type": "string" }, "sid": { "type": "string" }, "type": { "type": "string" }, "unit": { "type": "string" }, "cdId": { "type": "integer", "format": "int32" }, "sdId": { "type": "integer", "format": "int32" }, "hdId": { "type": "integer", "format": "int32" } } } }, "blackListedGeoRadiusDetails": { "type": "array", "items": { "type": "object", "properties": { "latitude": { "type": "number", "format": "double" }, "longitude": { "type": "number", "format": "double" }, "radius": { "type": "number", "format": "double" }, "address": { "type": "string" }, "stateShortName": { "type": "string" }, "countryShortName": { "type": "string" }, "locationId": { "type": "integer", "format": "int32" }, "rejectionReason": { "type": "string" }, "polypath": { "type": "object" }, "placemarkName": { "type": "string" }, "isIncluded": { "type": "boolean" }, "cid": { "type": "string" }, "sid": { "type": "string" }, "type": { "type": "string" }, "unit": { "type": "string" }, "cdId": { "type": "integer", "format": "int32" }, "sdId": { "type": "integer", "format": "int32" }, "hdId": { "type": "integer", "format": "int32" } } } }, "gotvLocationId": { "type": "integer", "format": "int32" }, "congressionalDistrictIds": { "type": "string" }, "whiteListedCongressionalDistrictIds": { "type": "string" }, "blackListedCongressionalDistrictIds": { "type": "string" }, "senateDistrictIds": { "type": "string" }, "whiteListedSenateDistrictIds": { "type": "string" }, "blackListedSenateDistrictIds": { "type": "string" }, "houseDistrictIds": { "type": "string" }, "whiteListedHouseDistrictIds": { "type": "string" }, "blackListedHouseDistrictIds": { "type": "string" }, "locationFileIds": { "type": "string" }, "whiteListedLocationIds": { "type": "string" }, "blackListedLocationIds": { "type": "string" }, "radiusUpdatedLocations": { "type": "object", "additionalProperties": { "type": "number", "format": "double" } }, "removedLocationIds": { "type": "string" }, "whiteListedCityIds": { "type": "string" }, "blackListedCityIds": { "type": "string" }, "whiteListedCountyIds": { "type": "string" }, "blackListedCountyIds": { "type": "string" }, "blackListedInventoryGroupIds": { "type": "string" }, "whiteListedInventoryGroupIds": { "type": "string" }, "inventoryKeywords": { "type": "array", "items": { "type": "string" } }, "inventoryUrls": { "type": "array", "items": { "type": "string" } }, "pmpDealIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "blackListedAudienceIds": { "type": "string" }, "whiteListedAudienceIds": { "type": "string" }, "blackListedCustomAudienceIds": { "type": "string" }, "whiteListedCustomAudienceIds": { "type": "string" }, "advertiserType": { "type": "string" }, "politicalAdvertiserClientId": { "type": "integer", "format": "int32" }, "scheduling": { "type": "object", "additionalProperties": { "type": "object" } }, "ageRangeIds": { "type": "string" }, "genderIds": { "type": "string" }, "languageIds": { "type": "string" }, "incomeRangeIds": { "type": "string" }, "ethnicityIds": { "type": "string" }, "interestIds": { "type": "string" }, "demographicTargetingFlag": { "type": "boolean" }, "whiteListedAudienceSegmentGroupIds": { "type": "string" }, "blackListedAudienceSegmentGroupIds": { "type": "string" }, "blackListedConversionTagIds": { "type": "string" }, "whiteListedConversionTagIds": { "type": "string" }, "conversionIds": { "type": "string" }, "creativesPlacementMapping": { "type": "object", "additionalProperties": { "type": "integer", "format": "int32" } }, "isTvAd": { "type": "boolean" }, "creativeAdvanceTargeting": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "integer", "format": "int32" } } }, "budgetTypeId": { "type": "integer", "format": "int32" }, "campaignEstimatorMetaData": { "type": "object", "properties": { "reachMeta": { "type": "object", "additionalProperties": { "type": "object" } }, "landScapeMeta": { "type": "object", "additionalProperties": { "type": "object" } }, "sliderMeta": { "type": "object", "additionalProperties": { "type": "object" } } } }, "campaignOptimization": { "type": "object", "properties": { "aiObjective": { "type": "integer", "format": "int32" }, "aiGoal": { "type": "integer", "format": "int32" }, "aiTargetKpi": { "type": "number", "format": "double" }, "aiConversionId": { "type": "integer", "format": "int32" } } }, "campaignOptimizationType": { "type": "string" }, "modelledDimensionIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "advanceAudioVideoTargeted": { "type": "boolean" }, "customAudienceTargeted": { "type": "boolean" }, "isAdvanceAudioVideoTargeted": { "type": "boolean" } } }, "examples": { "Save Campaign as draft with all details.": { "description": "Save Campaign as draft with all details.", "value": "{ \"campaignName\": \"Sample campaign name \", \"isAgreementChecked\": true, \"advertiserDomain\": \"https://www.example.com\", \"creativeType\": 14, \"budgetTotal\": 100, \"budgetTypeId\": 1, \"startTime\": 1598427074, \"budgetDay\": 18, \"timezone\": 105, \"creativeIds\": \"100027,100028\", \"maxBid\": 10.5, \"minBid\": 5.5, \"bidOptimization\": false, \"bidPacing\": true, \"isBidShading\": true, \"impressionCapping\": 2, \"frequencyCapEnabled\": true, \"frequencyCapping\": { 1: { \"frequencyCapDuration\": 6, \"frequencyCapValue\": 5 }, 2: { \"frequencyCapDuration\": 3, \"frequencyCapValue\": 20 }, 3: { \"frequencyCapDuration\": 3, \"frequencyCapValue\": 60 }, 4: { \"frequencyCapDuration\": 0, \"frequencyCapValue\": 100 } }, \"conversionType\": \"install\", \"conversionTypeId\": 1, \"appURL\": \"https://www.example.com\", \"totalBudgetPacing\": false, \"carriers\": \"293,294\", \"networkType\": \"13\", \"deviceType\": \"15\", \"trafficType\": \"11\", \"manufacturer\": \"451,155\", \"os\": \"11,14\", \"osVersion\": \"11,12,13\", \"exchanges\": \"27,21\", \"whiteListedIp\": \"df\", \"whiteListedPackageName\": \"sdf\", \"whiteListedSiteDomain\": \"example,https://www.example.com\", \"blackListedDeviceId\": \"id1,id2\", \"blackListedIp\": \"id11,id22\", \"blackListedAppId\": \"id1, id2\", \"blackListedPackageName\": \"id1,id2\", \"blackListedSiteDomain\": \"https://www.example.com\", \"prebidAudienceSegmentIdList\": [10,11,12], \"publisherAdCategory\": \"112\", \"userDealId\": \"1,2,b\", \"countryId\": 246, \"ioId\": \"1\", \"politicalAdvertiserClientId\": 17, \"locationFileIds\": \"1011,1010\", \"whiteListedLocationIds\": \"48377\", \"advertiserType\": \"political\", \"blackListedLocationIds\": \"48376,48363\", \"whiteListedGeoRadiusDetails\": [ { \"unit\": \"mile\", \"address\": \"Cimarron, KS 67835, USA\", \"latitude\": 37.80248612144266, \"radius\": 2, \"type\": \"circle\", \"longitude\": -100.27823091234018, \"sid\": \"4678\", \"cid\": \"246\" }, { \"polypath\": [ { \"lng\": -99.39437061774724, \"lat\": 37.76021967782698 }, { \"lng\": -99.61959034430974, \"lat\": 37.63852171601434 } ], \"unit\": \"mile\", \"address\": \"Greensburg, KS 67054, USA\", \"latitude\": 37.5741000760343, \"type\": \"custom\", \"radius\": 24.1195753931379, \"longitude\": -99.33119923102849, \"sid\": \"4678\", \"cid\": \"246\" } ], \"blackListedDmaIds\": \"3,4\", \"whiteListedDeviceId\": \"123,jh34,jkd34\", \"blackListedHouseDistrictIds\": \"5202,1684,1685\", \"whiteListedCongressionalDistrictIds\": \"78,174,222\", \"stateIds\": \"30200031,30200032\", \"whiteListedStateIds\": \"30200031,30200032\", \"blackListedStateIds\": \"30200033,30200035\", \"blackListedZipcodes\": \"35007\", \"whiteListedSenateDistrictIds\": \"662,665,2303\", \"whiteListedHouseDistrictIds\": \"5096,5067,5201\", \"blackListedSenateDistrictIds\": \"2308,988,992\", \"whiteListedDmaIds\": \"1,2\", \"whiteListedZipcodes\": \"35005\", \"blackListedAudienceIds\": \"889185,888981\", \"whiteListedAudienceIds\": \"900254,900271\", \"blackListedCongressionalDistrictIds\": \"368,53,100\", \"isAdvanceAudioVideoTargeted\":true, \"campaignEstimatorMetaData\": { \"reachMeta\": {}, \"landScapeMeta\": {}, \"sliderMeta\": {} }, \"creativeAdvanceTargeting\":{ \"placementType\":[20600001], \"rollPosition\":[20700001], \"playerSize\":[20800001], \"skippability\":[20900001], \"playbackMethod\":[21000001] }, \"inventoryKeywords\": [ \"Clothing\", \"Education\" ], \"inventoryUrls\": [ \"https://www.google.com\", \"https://www.iqm.com\" ]}" } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Save Campaign as draft with all details.": { "description": "Save Campaign as draft with all details.", "value": { "statusCode": 201, "responseObject": { "data": 123456, "message": "Campaign saved successfully.", "status": "draft" } } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "examples": { "Validation error": { "description": "Validation error", "value": { "statusCode": 412, "responseObject": { "errorMsg": "Invalid arguments audience ids!", "errorCode": 412 } } }, "Frequency capping error": { "description": "Frequency capping error", "value": { "statusCode": 400, "responseObject": { "errorMsg": "Frequency capping map is required.", "errorCode": 400, "errorField": "frequencyCapping" } } }, "Frequency cap type error": { "description": "Frequency cap type error", "value": { "statusCode": 400, "responseObject": { "errorMsg": "Invalid frequency cap type.", "errorCode": 400, "errorField": "frequencyCapId" } } }, "Frequency cap type duration error": { "description": "Frequency cap type duration error", "value": { "statusCode": 400, "responseObject": { "errorMsg": "Invalid frequency duration for frequency cap type 'Campaign Duration'", "errorCode": 400, "errorField": "frequencyDuration" } } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "statusCode": 500, "responseObject": { "errorMsg": "Internal server error", "errorCode": 500 } } } } } } } }, "/api/v2/cmp/campaigns/add": { "post": { "tags": [ "Campaign API" ], "summary": "Save Campaign", "description": "This API saves the campaign with given targeting and with `pending` status.\n\n---\n\n#### Request Body Detail\n\n| **Field** | **Type** | **Description** |\n| --- | --- | --- |\n| advertiserDomain | String | add domain |\n| budgetDay | Number | Daily budget |\n| budgetTotal | Number | Total budget |\n| campaignName | String | name of campaign |\n| campaignType | Number | Campaign type id |\n| creativeIds | String | Comma separated creative Ids |\n| creativeType | Number | Creative type id |\n| isAgreementChecked | Boolean | agreement check |\n| maxBid | Number | max bid |\n| startTime | Number | campaign start time |\n| timezone | Number | timezone id. |\n| bidOptimization `[optional]` | Boolean | Optimize bid price based on analysis. |\n| bidPacing `[optional]` | Boolean | Budget is spent equally every hour. |\n| impressionCapping `[optional]` | Number | Maximum impressions in one inventory. |\n| maxDayClicks `[optional]` | Number | Maximum daily clicks |\n| totalClicks `[optional]` | Number | Total clicks |\n| maxDayImpressions `[optional]` | Number | Maximum daily impressions |\n| totalImpressions `[optional]` | Number | Total impressions |\n| maxDayConversions `[optional]` | Number | Maximum daily conversions |\n| totalConversions `[optional]` | Number | Total conversions |\n| conversionType `[optional]` | String | User conversion type. Allowed values: 'install', 'non-install'. |\n| appURL `[optional]` | String | If conversion type is install, specify URL of inventory. |\n| targetCPI `[optional]` | Number | Cost per install if conversion type is install. |\n| carriers `[optional]` | String | Carrier targeting. Value in form of String of comma separated IDs of targeted carrier(s). |\n| networkType `[optional]` | String | Network targeting. Value in form of String of comma separated IDs of targeted network(s). |\n| deviceType `[optional]` | String | Device targeting. Value in form of String of comma separated IDs of targeted device type(s). |\n| trafficType `[optional]` | String | Traffic type targeting. Value in form of String of comma separated IDs of targeted traffic type(s). |\n| manufacturer `[optional]` | String | Manufacturer targeting. Value in form of String of comma separated IDs of targeted manufacturer type(s). |\n| os `[optional]` | String | OS targeting. Value in form of String of comma separated IDs of targeted OS. |\n| osVersion `[optional]` | String | OS version targeting. Value in form of String of comma separated IDs of targeted OS version based on targeted OS. |\n| exchanges `[optional]` | String | Targeted exchanges. Value in form of String of comma separated IDs of exchanges. |\n| prebidAudienceSegmentIdList `[optional]` | Array | Prebid Audience Segment Ids to attach campaign to segment Ids. |\n| whiteListedDeviceId `[optional]` | String | Target Device Ids. Value in form of String of comma separated device IDs. |\n| whiteListedIp `[optional]` | String | IPV4 address. Value in form of String of comma separated IP Address. |\n| whiteListedAppId `[optional]` | String | iOS app ID |\n| whiteListedPackageName `[optional]` | String | Android package names. Value in form of String of comma separated package names. |\n| whiteListedSiteDomain `[optional]` | String | Target sites. Value in form of String of comma separated domain urls. |\n| blackListedDeviceId `[optional]` | String | Target Device Ids. Value in form of String of comma separated device IDs. |\n| blackListedIp `[optional]` | String | IPV4 address. Value in form of String of comma separated IP Address. |\n| blackListedAppId `[optional]` | String | iOS app ID |\n| blackListedPackageName `[optional]` | String | Android package names. Value in form of String of comma separated package names. |\n| blackListedSiteDomain `[optional]` | String | Target sites. Value in form of String of comma separated domain urls. |\n| publisherAdCategory `[optional]` | String | Target Publisher ad category. Value in form of String of comma separated IDs. |\n| ioId | Number | Target Insertion OrderId in which this campaign belongs. |\n| blackListedInventoryGroupIds `[optional]` | String | Target already created Inventory groups. Value in form of String of comma separated IDs. |\n| whiteListedInventoryGroupIds `[optional]` | String | Target already created Inventory groups. Value in form of String of comma separated IDs. |\n| blackListedCustomAudienceIds `[optional]` | String | Target already created custom audience Groups. Value in form of String of comma separated IDs. |\n| whiteListedCustomAudienceIds `[optional]` | String | Target already created custom audience Groups. Value in form of String of comma separated IDs. |\n| blackListedAudienceSegmentGroupIds `[optional]` | String | Target already created audience segment Groups. Value in form of String of comma separated IDs. |\n| whiteListedAudienceSegmentGroupIds `[optional]` | String | Target already created audience segment Groups. Value in form of String of comma separated IDs. |\n| blackListedConversionTagIds `[optional]` | String | Target already created conversion tags. Value in form of String of comma separated IDs. |\n| whiteListedConversionTagIds `[optional]` | String | Target already created conversion tags. Value in form of String of comma separated IDs. |\n| userDealId `[optional]` | String | User specific deal IDs. Value in form of String of comma separated deal IDs. |\n| groupDealId `[optional]` | String | Group of selected deals. Value in form of String of comma separated deal IDs. |\n| politicalAdvertiserClientId `[optional]` | Number | Id of political advertiser in case of campaign is political campaign. |\n| stateIds `[optional]` | String | State Target (It will be considered as White list State Target). Value in form of String of comma separated IDs. |\n| whiteListedStateIds `[optional]` | String | White list State Target . Value in form of String of comma separated IDs. |\n| blackListedStateIds `[optional]` | String | Black list State Target . Value in form of String of comma separated IDs. |\n| countryId | String | Country Target |\n| dmaIds `[optional]` `deprecated` | String | DMA Target. Value in form of String of comma separated IDs. |\n| whiteListedDmaIds `[optional]` | String | white list DMA Target. Value in form of String of comma separated IDs. |\n| blackListedDmaIds `[optional]` | String | black list DMA Target. Value in form of String of comma separated IDs. |\n| senateDistrictIds `[optional]` `deprecated` | String | Senate districts Target. Value in form of String of comma separated IDs. |\n| whiteListedSenateDistrictIds `[optional]` | String | white list senate districts Target. Value in form of String of comma separated IDs. |\n| blackListedSenateDistrictIds `[optional]` | String | black list senate districts Target. Value in form of String of comma separated IDs. |\n| congressionalDistrictIds `[optional]` `deprecated` | String | Congressional districts Target. Value in form of String of comma separated IDs. |\n| whiteListedCongressionalDistrictIds `[optional]` | String | white list congressional districts Target. Value in form of String of comma separated IDs. |\n| blackListedCongressionalDistrictIds `[optional]` | String | black list congressional districts Target. Value in form of String of comma separated IDs. |\n| houseDistrictIds `[optional]` `deprecated` | String | House districts Target. Value in form of String of comma separated IDs. |\n| whiteListedHouseDistrictIds `[optional]` | String | white list house districts Target. Value in form of String of comma separated IDs. |\n| blackListedHouseDistrictIds `[optional]` | String | black list house districts Target. Value in form of String of comma separated IDs. |\n| geoRadiusDetails `[optional]` `deprecated` | String | To target custom ares in circle or polygon. Value in form of JSON. |\n| whiteListedGeoRadiusDetails `[optional]` | String | To white list custom ares in circle or polygon. Value in form of JSON. |\n| blackListedGeoRadiusDetails `[optional]` | String | To black list custom ares in circle or polygon. Value in form of JSON. |\n| zipcodes `[optional]` `deprecated` | String | ZipCode Target. Value in form of String of comma separated IDs. |\n| whiteListedZipcodes `[optional]` | String | white list zipCode Target. Value in form of String of comma separated IDs. |\n| blackListedZipcodes `[optional]` | String | black list zipCode Target. Value in form of String of comma separated IDs. |\n| locationFileIds `[optional]` | String | Target location by uploading file. Value in form of String of comma separated csv file ids.(pre uploaded) |\n| whiteListedLocationIds `[optional]` | String | white list location ids from uploaded files. Value in form of String of comma separated location ids. |\n| blackListedLocationIds `[optional]` | String | black list location ids from uploaded files. Value in form of String of comma separated location ids. |\n| whiteListedCityIds `[optional]` | String | white list city Target. Value in form of String of comma separated IDs. |\n| blackListedCityIds `[optional]` | String | black list city Target. Value in form of String of comma separated IDs. |\n| whiteListedCountyIds `[optional]` | String | white list county Target. Value in form of String of comma separated IDs. |\n| blackListedCountyIds `[optional]` | String | black list county Target. Value in form of String of comma separated IDs. |\n| ageRangeIds `[optional]` | String | Target age range. Value in form of string of comma separated IDs. |\n| genderIds `[optional]` | String | Target gender. Value in form of String of comma-separated IDs. |\n| interestIds `[optional]` | String | Target user interest. Value in form of a string of comma-separated IDs. |\n| incomeRangeIds `[optional]` | String | Target user income range. Value in form of a string of comma-separated IDs. |\n| languageIds `[optional]` | String | Target user language. Value in form of a string of comma-separated IDs. |\n| ethnicityIds `[optional]` | String | Target user ethnicity. Value in form of a string of comma-separated ID. |\n| schedule `[optional]` | String\\[\\]\\[\\] | key as \\[0 to 6\\] maps to \\[Monday to Sunday\\] & values \\[\\['hh:mm:ss','hh:mm:ss'\\], ...\\] |\n| conversionIds `[optional]` | String | Target pixel conversions. Value in form of a string of comma-separated ID. |\n| isAdvanceAudioVideoTargeted | Boolean | To indicate if the advance targeting is enabled if this is true, 'creativeAdvanceTargeting' is optional and it is assumed that every video creative segment is targeted. |\n| isBidPacing | Boolean | To indicate whether the bid shading is enabled. |\n| creativeAdvanceTargeting | JSON Map: String to Integer | Map of Creative advanced targeting group to list of creative advance targeting segment ids. |\n| campaignEstimatorMetaData | JSON | Campaign Estimator data with `reachMeta`, `landScapeMeta` and `sliderMeta` |\n\n---\n\n#### Scheduling example\n\n```\n\"scheduling\": {\n \"0\": [\n [\n \"03:00:00\",\n \"05:00:00\"\n ],\n [\n \"06:00:00\",\n \"11:00:00\"\n ]\n ]\n}\n\n```\n\n---\n\n#### GeoRadiusDetails example (below is the common format for whitelist and blacklist both)\n\n```\n\"whiteListedGeoRadiusDetails\" : [\n {\n \"unit\": \"mile\",\n \"address\": \"Denver, CO 80202, USA\",\n \"latitude\": 39.739235,\n \"radius\": 2,\n \"type\": \"circle\",\n \"longitude\": -104.99025,\n \"sid\": \"4666\",\n \"cid\": \"246\"\n },\n {\n \"unit\": \"mile\",\n \"address\": \"Grand Lake, CO 80447, USA\",\n \"latitude\": 40.19427,\n \"radius\": 1,\n \"type\": \"circle\",\n \"longitude\": -105.84889,\n \"sid\": \"4666\",\n \"cid\": \"246\"\n },\n {\n \"unit\": \"mile\",\n \"address\": \"Yonkers, NY 10710, USA\",\n \"latitude\": 40.95017,\n \"radius\": 3,\n \"type\": \"circle\",\n \"longitude\": -73.84669,\n \"sid\": \"4694\",\n \"cid\": \"246\"\n },\n {\n \"polypath\": [\n {\n \"lng\": -112.05635319323119,\n \"lat\": 40.80285757668772\n },\n {\n \"lng\": -111.44111881823119,\n \"lat\": 38.15773779255543\n },\n {\n \"lng\": -108.45283756823119,\n \"lat\": 39.25508137287102\n },\n {\n \"lng\": -109.15596256823119,\n \"lat\": 41.266931755469045\n }\n ],\n \"unit\": \"mile\",\n \"address\": \"Dry Creek Rd, Utah, USA\",\n \"latitude\": 39.712334774012234,\n \"type\": \"custom\",\n \"radius\": 164.41,\n \"longitude\": -110.25459538073119,\n \"sid\": \"4709\",\n \"cid\": \"246\"\n },\n {\n \"polypath\": [\n {\n \"lng\": -98.60998217413051,\n \"lat\": 39.527470270360105\n },\n {\n \"lng\": -93.16076342413051,\n \"lat\": 41.662771525199084\n }\n ],\n \"unit\": \"mile\",\n \"address\": \"Nebraska City, NE 68410, USA\",\n \"latitude\": 40.595120897779594,\n \"type\": \"square\",\n \"radius\": 259.09,\n \"longitude\": -95.88537279913051,\n \"sid\": \"4689\",\n \"cid\": \"246\"\n }\n ]\n\n```", "operationId": "saveCampaign", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "content": { "application/json": { "schema": { "required": [ "exchanges", "publisherAdCategory" ], "type": "object", "properties": { "advertiserId": { "type": "integer", "format": "int32" }, "dspId": { "type": "integer", "format": "int32" }, "owId": { "type": "integer", "format": "int32" }, "uowId": { "type": "integer", "format": "int32" }, "id": { "type": "integer", "format": "int32" }, "campaignName": { "type": "string" }, "advertiserDomain": { "type": "string" }, "creativeType": { "type": "integer", "format": "int32" }, "campaignType": { "type": "integer", "format": "int32" }, "totalBudgetPacing": { "type": "boolean" }, "budgetDay": { "minimum": 0, "type": "number", "format": "double" }, "budgetTotal": { "minimum": 0, "type": "number", "format": "double" }, "maxBid": { "type": "number", "format": "double" }, "minBid": { "type": "number", "format": "double" }, "allowedMinBid": { "type": "number", "format": "double" }, "timezone": { "type": "integer", "format": "int32" }, "startTime": { "type": "integer", "format": "int64" }, "endTime": { "type": "integer", "format": "int64" }, "status": { "type": "string" }, "created": { "type": "integer", "format": "int32" }, "excludeFromPlatformServing": { "type": "boolean" }, "forTest": { "type": "boolean" }, "modifiedDate": { "type": "string", "format": "date-time" }, "dspMarginJson": { "type": "string" }, "platformMarginJson": { "type": "string" }, "dspMargin": { "type": "integer", "format": "int32" }, "platformMargin": { "type": "integer", "format": "int32" }, "userDealMargin": { "type": "integer", "format": "int32" }, "isAgreementChecked": { "type": "boolean" }, "spentScale": { "type": "boolean" }, "creativeIds": { "type": "string" }, "targetCPI": { "type": "integer", "format": "int64" }, "conversionType": { "type": "string" }, "conversionTypeId": { "type": "integer", "format": "int32" }, "appURL": { "type": "string" }, "bidOptimization": { "type": "boolean" }, "bidPacing": { "type": "boolean" }, "impressionCapping": { "minimum": 0, "type": "integer", "format": "int32" }, "frequencyCapEnabled": { "type": "boolean" }, "frequencyCapping": { "type": "object", "additionalProperties": { "type": "object", "properties": { "frequencyCapDuration": { "type": "integer", "format": "int32" }, "frequencyCapValue": { "type": "integer", "format": "int32" } } } }, "maxDayImpressions": { "minimum": 0, "type": "integer", "format": "int32" }, "maxDayClicks": { "minimum": 0, "type": "integer", "format": "int32" }, "maxDayConversions": { "minimum": 0, "type": "integer", "format": "int32" }, "totalImpressions": { "minimum": 0, "type": "integer", "format": "int32" }, "totalClicks": { "minimum": 0, "type": "integer", "format": "int32" }, "totalConversions": { "minimum": 0, "type": "integer", "format": "int32" }, "bidStrategyFlag": { "type": "boolean" }, "ioId": { "type": "integer", "format": "int32" }, "prebidAudienceSegmentIdList": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "isBidShading": { "type": "boolean" }, "totalCPM": { "minimum": 0, "type": "number", "format": "double" }, "templateId": { "type": "integer", "format": "int32" }, "carriers": { "type": "string" }, "networkType": { "type": "string" }, "deviceType": { "type": "string" }, "trafficType": { "type": "string" }, "manufacturer": { "type": "string" }, "device": { "type": "string" }, "os": { "type": "string" }, "osVersion": { "type": "string" }, "technologyFlag": { "type": "boolean" }, "exchanges": { "type": "string" }, "whiteListedDeviceId": { "type": "string" }, "whiteListedIp": { "type": "string" }, "whiteListedAppId": { "type": "string" }, "whiteListedPackageName": { "type": "string" }, "whiteListedSiteDomain": { "type": "string" }, "blackListedDeviceId": { "type": "string" }, "blackListedIp": { "type": "string" }, "blackListedAppId": { "type": "string" }, "blackListedPackageName": { "type": "string" }, "blackListedSiteDomain": { "type": "string" }, "advancedFlag": { "type": "boolean" }, "userDealId": { "type": "string" }, "groupDealId": { "type": "string" }, "publisherAdCategory": { "type": "string" }, "campaignIabCategoryIds": { "type": "string" }, "stateIds": { "type": "string" }, "whiteListedStateIds": { "type": "string" }, "blackListedStateIds": { "type": "string" }, "countryId": { "type": "integer", "format": "int32" }, "dmaIds": { "type": "string" }, "whiteListedDmaIds": { "type": "string" }, "blackListedDmaIds": { "type": "string" }, "zipcodes": { "type": "string" }, "whiteListedZipcodes": { "type": "string" }, "blackListedZipcodes": { "type": "string" }, "geoRadiusDetails": { "type": "array", "items": { "type": "object", "properties": { "latitude": { "type": "number", "format": "double" }, "longitude": { "type": "number", "format": "double" }, "radius": { "type": "number", "format": "double" }, "address": { "type": "string" }, "stateShortName": { "type": "string" }, "countryShortName": { "type": "string" }, "locationId": { "type": "integer", "format": "int32" }, "rejectionReason": { "type": "string" }, "polypath": { "type": "object" }, "placemarkName": { "type": "string" }, "isIncluded": { "type": "boolean" }, "cid": { "type": "string" }, "sid": { "type": "string" }, "type": { "type": "string" }, "unit": { "type": "string" }, "cdId": { "type": "integer", "format": "int32" }, "sdId": { "type": "integer", "format": "int32" }, "hdId": { "type": "integer", "format": "int32" } } } }, "whiteListedGeoRadiusDetails": { "type": "array", "items": { "type": "object", "properties": { "latitude": { "type": "number", "format": "double" }, "longitude": { "type": "number", "format": "double" }, "radius": { "type": "number", "format": "double" }, "address": { "type": "string" }, "stateShortName": { "type": "string" }, "countryShortName": { "type": "string" }, "locationId": { "type": "integer", "format": "int32" }, "rejectionReason": { "type": "string" }, "polypath": { "type": "object" }, "placemarkName": { "type": "string" }, "isIncluded": { "type": "boolean" }, "cid": { "type": "string" }, "sid": { "type": "string" }, "type": { "type": "string" }, "unit": { "type": "string" }, "cdId": { "type": "integer", "format": "int32" }, "sdId": { "type": "integer", "format": "int32" }, "hdId": { "type": "integer", "format": "int32" } } } }, "blackListedGeoRadiusDetails": { "type": "array", "items": { "type": "object", "properties": { "latitude": { "type": "number", "format": "double" }, "longitude": { "type": "number", "format": "double" }, "radius": { "type": "number", "format": "double" }, "address": { "type": "string" }, "stateShortName": { "type": "string" }, "countryShortName": { "type": "string" }, "locationId": { "type": "integer", "format": "int32" }, "rejectionReason": { "type": "string" }, "polypath": { "type": "object" }, "placemarkName": { "type": "string" }, "isIncluded": { "type": "boolean" }, "cid": { "type": "string" }, "sid": { "type": "string" }, "type": { "type": "string" }, "unit": { "type": "string" }, "cdId": { "type": "integer", "format": "int32" }, "sdId": { "type": "integer", "format": "int32" }, "hdId": { "type": "integer", "format": "int32" } } } }, "gotvLocationId": { "type": "integer", "format": "int32" }, "congressionalDistrictIds": { "type": "string" }, "whiteListedCongressionalDistrictIds": { "type": "string" }, "blackListedCongressionalDistrictIds": { "type": "string" }, "senateDistrictIds": { "type": "string" }, "whiteListedSenateDistrictIds": { "type": "string" }, "blackListedSenateDistrictIds": { "type": "string" }, "houseDistrictIds": { "type": "string" }, "whiteListedHouseDistrictIds": { "type": "string" }, "blackListedHouseDistrictIds": { "type": "string" }, "locationFileIds": { "type": "string" }, "whiteListedLocationIds": { "type": "string" }, "blackListedLocationIds": { "type": "string" }, "radiusUpdatedLocations": { "type": "object", "additionalProperties": { "type": "number", "format": "double" } }, "removedLocationIds": { "type": "string" }, "whiteListedCityIds": { "type": "string" }, "blackListedCityIds": { "type": "string" }, "whiteListedCountyIds": { "type": "string" }, "blackListedCountyIds": { "type": "string" }, "blackListedInventoryGroupIds": { "type": "string" }, "whiteListedInventoryGroupIds": { "type": "string" }, "inventoryKeywords": { "type": "array", "items": { "type": "string" } }, "inventoryUrls": { "type": "array", "items": { "type": "string" } }, "pmpDealIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "blackListedAudienceIds": { "type": "string" }, "whiteListedAudienceIds": { "type": "string" }, "blackListedCustomAudienceIds": { "type": "string" }, "whiteListedCustomAudienceIds": { "type": "string" }, "advertiserType": { "type": "string" }, "politicalAdvertiserClientId": { "type": "integer", "format": "int32" }, "scheduling": { "type": "object", "additionalProperties": { "type": "object" } }, "ageRangeIds": { "type": "string" }, "genderIds": { "type": "string" }, "languageIds": { "type": "string" }, "incomeRangeIds": { "type": "string" }, "ethnicityIds": { "type": "string" }, "interestIds": { "type": "string" }, "demographicTargetingFlag": { "type": "boolean" }, "whiteListedAudienceSegmentGroupIds": { "type": "string" }, "blackListedAudienceSegmentGroupIds": { "type": "string" }, "blackListedConversionTagIds": { "type": "string" }, "whiteListedConversionTagIds": { "type": "string" }, "conversionIds": { "type": "string" }, "creativesPlacementMapping": { "type": "object", "additionalProperties": { "type": "integer", "format": "int32" } }, "isTvAd": { "type": "boolean" }, "creativeAdvanceTargeting": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "integer", "format": "int32" } } }, "budgetTypeId": { "type": "integer", "format": "int32" }, "campaignEstimatorMetaData": { "type": "object", "properties": { "reachMeta": { "type": "object", "additionalProperties": { "type": "object" } }, "landScapeMeta": { "type": "object", "additionalProperties": { "type": "object" } }, "sliderMeta": { "type": "object", "additionalProperties": { "type": "object" } } } }, "campaignOptimization": { "type": "object", "properties": { "aiObjective": { "type": "integer", "format": "int32" }, "aiGoal": { "type": "integer", "format": "int32" }, "aiTargetKpi": { "type": "number", "format": "double" }, "aiConversionId": { "type": "integer", "format": "int32" } } }, "campaignOptimizationType": { "type": "string" }, "modelledDimensionIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "advanceAudioVideoTargeted": { "type": "boolean" }, "customAudienceTargeted": { "type": "boolean" }, "isAdvanceAudioVideoTargeted": { "type": "boolean" } } }, "examples": { "Save Campaign with all details.": { "description": "Save Campaign with all details.", "value": "{ \"campaignName\": \"Sample campaign name \", \"isAgreementChecked\": true, \"advertiserDomain\": \"https://www.example.com\", \"creativeType\": 14, \"budgetTotal\": 100, \"budgetTypeId\": 1, \"startTime\": 1598427074, \"budgetDay\": 18, \"timezone\": 105, \"creativeIds\": \"100027,100028\", \"maxBid\": 10.5, \"minBid\": 5.5, \"bidOptimization\": false, \"bidPacing\": true, \"isBidShading\": true, \"impressionCapping\": 2, \"frequencyCapEnabled\": true, \"frequencyCapping\": { 1: { \"frequencyCapDuration\": 6, \"frequencyCapValue\": 5 }, 2: { \"frequencyCapDuration\": 3, \"frequencyCapValue\": 20 }, 3: { \"frequencyCapDuration\": 3, \"frequencyCapValue\": 60 }, 4: { \"frequencyCapDuration\": 0, \"frequencyCapValue\": 100 } }, \"conversionType\": \"install\", \"advertiserType\": \"political\", \"conversionTypeId\": 1, \"appURL\": \"https://www.example.com\", \"totalBudgetPacing\": false, \"carriers\": \"293,294\", \"networkType\": \"13\", \"deviceType\": \"15\", \"trafficType\": \"11\", \"manufacturer\": \"451,155\", \"os\": \"11,14\", \"osVersion\": \"11,12,13\", \"exchanges\": \"27,21\", \"whiteListedIp\": \"df\", \"whiteListedPackageName\": \"sdf\", \"whiteListedSiteDomain\": \"example,https://www.example.com\", \"blackListedDeviceId\": \"id1,id2\", \"blackListedIp\": \"id11,id22\", \"blackListedAppId\": \"id1, id2\", \"blackListedPackageName\": \"id1,id2\", \"blackListedSiteDomain\": \"https://www.example.com\", \"publisherAdCategory\": \"112\", \"userDealId\": \"1,2,b\", \"countryId\": 246, \"ioId\": \"20\", \"politicalAdvertiserClientId\": 17, \"locationFileIds\": \"1011,1010\", \"whiteListedLocationIds\": \"48377\", \"blackListedLocationIds\": \"48376,48363\", \"whiteListedGeoRadiusDetails\": [{ \"unit\": \"mile\", \"address\": \"Cimarron, KS 67835, USA\", \"latitude\": 37.80248612144266, \"radius\": 2, \"type\": \"circle\", \"longitude\": -100.27823091234018, \"sid\": \"4678\", \"cid\": \"246\" },{ \"polypath\": [{ \"lng\": -99.39437061774724, \"lat\": 37.76021967782698 },{ \"lng\": -99.61959034430974, \"lat\": 37.63852171601434 }], \"unit\": \"mile\", \"address\": \"Greensburg, KS 67054, USA\", \"latitude\": 37.5741000760343, \"type\": \"custom\", \"radius\": 24.1195753931379, \"longitude\": -99.33119923102849, \"sid\": \"4678\", \"cid\": \"246\" }], \"blackListedDmaIds\": \"3,4\", \"whiteListedDeviceId\": \"123,jh34,jkd34\", \"blackListedHouseDistrictIds\": \"5202,1684,1685\", \"whiteListedCongressionalDistrictIds\": \"78,174,222\", \"stateIds\": \"30200031,30200032\", \"whiteListedStateIds\": \"30200031,30200032\", \"blackListedStateIds\": \"30200033,30200035\", \"blackListedZipcodes\": \"35007\", \"whiteListedSenateDistrictIds\": \"662,665,2303\", \"whiteListedHouseDistrictIds\": \"5096,5067,5201\", \"blackListedSenateDistrictIds\": \"2308,988,992\", \"whiteListedDmaIds\": \"1,2\", \"whiteListedZipcodes\": \"35005\", \"blackListedAudienceIds\": \"889185,888981\", \"whiteListedAudienceIds\": \"900254,900271\", \"prebidAudienceSegmentIdList\": [10,11,12], \"blackListedCongressionalDistrictIds\": \"368,53,100\", \"campaignEstimatorMetaData\": { \"reachMeta\": {}, \"landScapeMeta\": {}, \"sliderMeta\": {} }, \"isAdvanceAudioVideoTargeted\":true, \"creativeAdvanceTargeting\":{ \"placementType\":[20600001], \"rollPosition\":[20700001], \"playerSize\":[20800001], \"skippability\":[20900001], \"playbackMethod\":[21000001] }, \"inventoryKeywords\": [ \"Clothing\", \"Education\" ], \"inventoryUrls\": [ \"https://www.google.com\", \"https://www.iqm.com\" ]}" } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Save Campaign with all details.": { "description": "Save Campaign with all details.", "value": { "statusCode": 201, "responseObject": { "data": 123456, "message": "Campaign saved successfully.", "status": "pending" } } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "examples": { "Validation error": { "description": "Validation error", "value": { "statusCode": 412, "responseObject": { "errorMsg": "Invalid arguments audience ids!", "errorCode": 412 } } }, "Frequency capping error": { "description": "Frequency capping error", "value": { "statusCode": 400, "responseObject": { "errorMsg": "Frequency capping map is required.", "errorCode": 400, "errorField": "frequencyCapping" } } }, "Frequency cap type error": { "description": "Frequency cap type error", "value": { "statusCode": 400, "responseObject": { "errorMsg": "Invalid frequency cap type.", "errorCode": 400, "errorField": "frequencyCapId" } } }, "Frequency cap type duration error": { "description": "Frequency cap type duration error", "value": { "statusCode": 400, "responseObject": { "errorMsg": "Invalid frequency duration for frequency cap type 'Campaign Duration'", "errorCode": 400, "errorField": "frequencyDuration" } } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "statusCode": 500, "responseObject": { "errorMsg": "Internal server error", "errorCode": 500 } } } } } } } }, "/api/v3/internal/cmp/template": { "patch": { "tags": [ "Campaign API" ], "summary": "Update template targeting dimensions", "description": "Updates targeting dimensions for a template using the provided removal request.", "operationId": "updateTemplate", "parameters": [ { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "description": "Template Dimension Removal Request VO", "content": { "application/json": { "schema": { "type": "object", "properties": { "dimension": { "type": "string" }, "subDimension": { "type": "string" }, "dimensionValues": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "owId": { "type": "integer", "format": "int32" } } }, "examples": { "Template Dimension Removal Request Example": { "summary": "Example of a request to remove targeting dimensions from a template", "description": "Template Dimension Removal Request Example", "value": { "dimension": "inventories", "subDimension": "pg", "dimensionValues": [101, 102, 103], "owId": 1 } } } } }, "required": true }, "responses": { "200": { "description": "Templates updated successfully", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "errorObjects": { "type": "array", "items": { "type": "object", "properties": { "error": { "type": "string" }, "reason": { "type": "string" }, "field": { "type": "string" } } } }, "data": { "type": "object" } } }, "examples": { "Templates Updated Response Example": { "summary": "Example of a successful templates updated response", "description": "Templates Updated Response Example", "value": { "status": "success", "message": "Templates updated successfully." } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden!" } ] } } } }, "422": { "description": "Unprocessable Entity - Invalid Template Target Dimension", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "errorObjects": { "type": "array", "items": { "type": "object", "properties": { "error": { "type": "string" }, "reason": { "type": "string" }, "field": { "type": "string" } } } }, "data": { "type": "object" } } }, "examples": { "Invalid Template Target Dimension Response Example": { "summary": "Example of an error response for invalid template target dimension", "description": "Invalid Template Target Dimension Response Example", "value": { "status": "error", "message": "Invalid Template Target Dimension: [dimension]" } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/internal/cmp/campaigns/ai-optimization/enable-disable": { "patch": { "tags": [ "Campaign API" ], "summary": "This API update AI optimization flag for given campaign ids.", "description": "This API updates the AI optimization flag for the specified campaign IDs. Provide the campaign IDs and the desired AI optimization status in the request body. The response contains a success message", "operationId": "updateCampaignAIOptimization", "requestBody": { "description": "This API updates the AI optimization flag for specified campaign IDs. \n\n---\n\n#### Request Body Detail\n\n| **Field** | **Type** | **Description** |\n| --- | --- | --- |\n| campaignIds | Array of Integer | Campaign IDs for which the AI optimization flag needs to be updated. | \n| enableAIOptimization | Boolean | Flag indicating whether AI optimization should be enabled (true) or disabled (false). | \n", "content": { "application/json": { "schema": { "type": "object", "properties": { "campaignToggles": { "type": "array", "items": { "type": "object", "properties": { "campaignIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "enableAIOptimization": { "type": "boolean" } } } } } }, "examples": { "Enable and disable AI optimization for campaigns": { "description": "Enable and disable AI optimization for campaigns", "value": { "campaignToggles": [ { "campaignIds": [11772], "enableAIOptimization": true }, { "campaignIds": [11773], "enableAIOptimization": false } ] } }, "Enable AI optimization for campaigns": { "description": "Enable AI optimization for campaigns", "value": { "campaignToggles": [ { "campaignIds": [11772, 11773], "enableAIOptimization": true } ] } }, "Disable AI optimization for campaigns": { "description": "Disable AI optimization for campaigns", "value": { "campaignToggles": [ { "campaignIds": [11772, 11773], "enableAIOptimization": false } ] } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Get campaign dates": { "description": "Get campaign dates", "value": { "success": true, "data": "AI optimization flag updated successfully." } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "examples": { "Invalid campaign ids": { "description": "Invalid campaign ids", "value": { "success": false, "errorObjects": [ { "error": "Please provide valid campaign ids." } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/cmp/target/creative": { "patch": { "tags": [ "Campaign API" ], "summary": "Assign/Un-assign creatives targeting from campaigns", "description": "This API assigns/un-assigns creatives from campaigns.\n\n\n---\n\n#### Request Body Detail\n\n| **Field** | **Type** | **Description** |\n| --- | --- | --- |\n| assignedCampaignIds `[optional]` | Array of Integer | List of campaign IDs for assigning creative targeting. |\n| removedCampaignIds `[optional]` | Array of Integer | List of campaign IDs for un-assigning/removing creative targeting. |\n| creativeIds | Array of Integer | List of creatives for assign/un-assign. |\n", "operationId": "createCampaignCreativeTargeting", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "content": { "application/json": { "schema": { "required": [ "creativeIds" ], "type": "object", "properties": { "creativeIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "assignedCampaignIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "removedCampaignIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } } } }, "examples": { "Assign Creatives to Campaigns": { "description": "Assign Creatives to Campaigns", "value": { "assignedCampaignIds": [1, 2, 3], "creativeIds": [11, 22] } }, "Unassign Creatives from Campaigns": { "description": "Unassign Creatives from Campaigns", "value": { "removedCampaignIds": [2], "creativeIds": [11] } } } } }, "required": true }, "responses": { "200": { "description": "Operation completed successfully.", "content": { "application/json": { "examples": { "Success": { "description": "Success", "value": { "success": true, "data": "Creatives assigned/un-assigned successfully." } } } } } }, "422": { "description": "Validation error occurred.", "content": { "application/json": { "examples": { "Invalid Ids for assign/un-assign": { "description": "Invalid Ids for assign/un-assign", "value": { "success": false, "errorObjects": [ { "error": "Please provide valid Campaign IDs for assign/un-assign action" } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/cmp/pmp/campaigns/mappings": { "patch": { "tags": [ "Campaign API" ], "summary": "Bulk Assign/De-assign PMP Deals to/from Campaigns", "description": "Performs bulk assignment or de-assignment of PMP deals to/from campaigns based on the provided operations.\n\n**Request Body Details**:\n| Field | Type | Description |\n|-------------|--------|------------------------------------------------------------------------|\n| operations | Array | List of operations specifying the action, campaign IDs and PMP deal IDs |\n| action | String | Action to perform: 'assign' or 'deassign' |\n| campaignIds | Array | List of campaign IDs to be assigned/de-assigned PMP deals |\n| pmpDealIds | Array | List of PMP deal IDs to assign/de-assign to/from campaigns |\n", "operationId": "managePMPDealCampaignMappings", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "description": "Contains details for bulk assigning or de-assigning PMP deals to/from campaigns", "content": { "application/json": { "schema": { "required": [ "operations" ], "type": "object", "properties": { "operations": { "type": "array", "items": { "required": [ "action", "campaignIds", "pmpDealIds" ], "type": "object", "properties": { "action": { "type": "string" }, "campaignIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "pmpDealIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } } } } } } }, "examples": { "Bulk Assign/De-assign PMP Deals Request Example": { "description": "Bulk Assign/De-assign PMP Deals Request Example", "value": "{ \"operations\": [pmpDealIds { \"action\": \"assign\", \"campaignIds\": [ 201, 203 ], \"pmpDealIds\": [ 101, 102 ] }, { \"action\": \"assign\", \"campaignIds\": [ 202 ], \"pmpDealIds\": [ 103 ] }, { \"action\": \"deassign\", \"campaignIds\": [ 202 ], \"pmpDealIds\": [ 102 ] } ]}" } } } }, "required": true }, "responses": { "200": { "description": "Successfully processed bulk assign/de-assign operations", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "errorObjects": { "type": "array", "items": { "type": "object", "properties": { "error": { "type": "string" }, "reason": { "type": "string" }, "field": { "type": "string" } } } }, "data": { "type": "object" } } }, "examples": { "Bulk Assign/De-assign Operations Response": { "description": "Bulk Assign/De-assign Operations Response", "value": { "success": true, "data": "PMP deal campaign mappings updated successfully" } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden!" } ] } } } }, "422": { "description": "Error response for PMP deal assignment if deal ids are invalid", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "errorObjects": { "type": "array", "items": { "type": "object", "properties": { "error": { "type": "string" }, "reason": { "type": "string" }, "field": { "type": "string" } } } }, "data": { "type": "object" } } }, "examples": { "Invalid PMP deal ids passed": { "description": "Invalid PMP deal ids passed", "value": { "success": false, "errorObjects": [ { "error": "PMP deal id/s is/are invalid or not accessible for logged-in user" } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/cmp/pg/campaigns/{campaignId}": { "patch": { "tags": [ "Campaign API" ], "summary": "It will edit the already created PG Campaign for advertiser.", "description": "Given API edit already created PG Campaign for advertiser User. User can edit any information from mentioned below fields\n\n---\n\n#### Request Body Detail\n\n| **Field** | **Type** | **Description** |\n| --- | --- | --- |\n| pgCampaignInfoVO |Object| Object contains of campaign information| |\n| campaignName | String | Name of the given campaign|\n| timeZoneId | int | Represent timezone of campaign|\n| totalImpressions | int | Targeted impressions for impression based campaign as budget |\n| maxBid | double | Maximum allowed bid price for campaign|\n| startTime | long | Start time of the campaign in epoch seconds|\n| endTime | long | End time of the campaign in epoch seconds |\n| advertiserDomain | String | Domain of the advertiser user|\n| budgetTotal | double | Total budget of the campaign in dollar for dollar based campaign|\n| creativeTargeting | Object | consist of campaign creative targeting details|\n| creativeTypeId | int | Type Id of creatives attached with campaign |\n| creativeIds | String | Ids of creatives attached with campaign |\n| inventoryTargeting | Object | Consist of campaign PG deal targeting details|\n| pgDealIds | String | Ids of PG Deal attached with campaign |\n| conversionTargeting | Object | Consist of campaign conversion targeting details |\n| conversionTypeId | int | Type Id of conversion attached with campaign|\n| conversionIds | String | Ids of conversion attached with campaign |\n| politicalAdvertiserClientId | int | Advertiser client Id if User is political advertiser |\n| countryId | int | Id of the targeted country |\n", "operationId": "editPGCampaign", "parameters": [ { "name": "campaignId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "campaignId": { "type": "integer", "format": "int32" }, "countryId": { "type": "integer", "format": "int32" }, "politicalAdvertiserClientId": { "type": "integer", "format": "int32" }, "conversionTargeting": { "required": [ "conversionIds" ], "type": "object", "properties": { "conversionTypeId": { "type": "integer", "format": "int32" }, "conversionIds": { "type": "array", "items": { "type": "integer", "format": "int32" } } } }, "creativeTargeting": { "required": [ "creativeIds", "creativeTypeId" ], "type": "object", "properties": { "creativeTypeId": { "type": "integer", "format": "int32" }, "creativeIds": { "type": "array", "items": { "type": "integer", "format": "int32" } } } }, "inventoryTargeting": { "required": [ "pgDealIds" ], "type": "object", "properties": { "pgDealIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "paymentTypeId": { "type": "integer", "format": "int32" } } }, "pgCampaignInfo": { "required": [ "advertiserDomain", "budgetTypeId", "campaignName", "ioId", "maxBid", "startTime", "timeZoneId" ], "type": "object", "properties": { "campaignName": { "maxLength": 1024, "minLength": 0, "type": "string" }, "timeZoneId": { "type": "integer", "format": "int32" }, "spendingBudget": { "type": "number", "format": "double" }, "maxBid": { "maximum": 1000, "exclusiveMaximum": false, "type": "number", "format": "double" }, "startTime": { "type": "integer", "format": "int64" }, "endTime": { "type": "integer", "format": "int64" }, "totalImpressions": { "type": "integer", "format": "int64" }, "advertiserDomain": { "type": "string" }, "advertiserType": { "type": "string" }, "ioId": { "type": "integer", "format": "int32" }, "budgetTypeId": { "type": "integer", "format": "int32" }, "campaignTypeId": { "type": "integer", "format": "int32" }, "owId": { "type": "integer", "format": "int32" }, "uowId": { "type": "integer", "format": "int32" }, "creativeTypeId": { "type": "integer", "format": "int32" }, "status": { "type": "string" }, "configObj": { "type": "string" }, "totalBudget": { "type": "number", "format": "double" }, "pgFeesPercentage": { "type": "number", "format": "double" }, "totalCPM": { "type": "number", "format": "double" } } } } }, "examples": { "Edit impression based PG Campaign (all the fields)": { "description": "Edit impression based PG Campaign (all the fields)", "value": { "pgCampaignInfo": { "campaignName": "test imps PG campaign", "timeZoneId": 29, "totalImpressions": 12345, "maxBid": 8, "startTime": 1715662337, "endTime": 1717128000, "advertiserType": "political", "advertiserDomain": "https://www.xyz.com" }, "creativeTargeting": { "creativeTypeId": 11, "creativeIds": "[644506]" }, "inventoryTargeting": { "pgDealIds": "[30,12]" }, "conversionTargeting": { "conversionTypeId": 1, "conversionIds": "[465,687,987]" }, "politicalAdvertiserClientId": 989898, "countryId": 23 } }, "Edit budget based PG Campaign (all the fields)": { "description": "Edit budget based PG Campaign (all the fields)", "value": { "pgCampaignInfoVO": { "campaignName": "test imps PG campaign", "timeZoneId": 29, "spendingBudget": 1234, "maxBid": 8, "startTime": 1715662337, "endTime": 1717128000, "advertiserDomain": "https://www.xyz.com" }, "creativeTargeting": { "creativeTypeId": 11, "creativeIds": "[644506]" }, "inventoryTargeting": { "pgDealIds": "[30,12]" }, "conversionTargeting": { "conversionTypeId": 1, "conversionIds": "[465,687,987]" }, "politicalAdvertiserClientId": 989898, "countryId": 23 } }, "Edit some fields of PG Campaign info only": { "description": "Edit some fields of PG Campaign info only", "value": { "pgCampaignInfoVO": { "campaignName": "test imps PG campaign", "timeZoneId": 29, "spendingBudget": 1234, "endTime": 1717128000, "advertiserDomain": "https://www.xyz.com" } } } } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "examples": { "Success response of PG campaign update": { "description": "Success response of PG campaign update", "value": { "success": true, "data": { "message": "PG Campaign Updated successfully", "campaignId": 2 } } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/cmp/pg/campaigns/mappings": { "patch": { "tags": [ "Campaign API" ], "summary": "Bulk Assign/Deassign PG Deals to/from Campaigns", "description": "Performs bulk assignment or deassignment of PG deals to/from campaigns based on the provided operations.\n\n**Request Body Details**:\n| Field | Type | Description |\n|-------------|--------|------------------------------------------------------------------------|\n| operations | Array | List of operations specifying the action, campaign IDs and PG deal IDs |\n| action | String | Action to perform: 'assign' or 'deassign' |\n| campaignIds | Array | List of campaign IDs to be assigned/deassigned PG deals |\n| pgDealIds | Array | List of PG deal IDs to assign/deassign to/from campaigns |\n", "operationId": "managePgDealCampaignMappings", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "description": "Contains details for bulk assigning or deassigning PG deals to/from campaigns", "content": { "application/json": { "schema": { "required": [ "operations" ], "type": "object", "properties": { "operations": { "type": "array", "items": { "required": [ "action", "campaignIds", "pgDealIds" ], "type": "object", "properties": { "action": { "type": "string" }, "campaignIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "pgDealIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } } } } } } }, "examples": { "Bulk Assign/Deassign PG Deals Request Example": { "description": "Bulk Assign/Deassign PG Deals Request Example", "value": { "operations": [ { "action": "assign", "campaignIds": [201, 203], "pgDealIds": [101, 102] }, { "action": "assign", "campaignIds": [202], "pgDealIds": [103] }, { "action": "deassign", "campaignIds": [202], "pgDealIds": [102] } ] } } } } }, "required": true }, "responses": { "200": { "description": "Successfully processed bulk assign/deassign operations", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "errorObjects": { "type": "array", "items": { "type": "object", "properties": { "error": { "type": "string" }, "reason": { "type": "string" }, "field": { "type": "string" } } } }, "data": { "type": "object" } } }, "examples": { "Bulk Assign/Deassign Operations Response": { "description": "Bulk Assign/Deassign Operations Response", "value": { "success": true, "data": "PG deal campaign mappings updated successfully" } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden!" } ] } } } }, "422": { "description": "Error response for PG deal assignment if maximum limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "errorObjects": { "type": "array", "items": { "type": "object", "properties": { "error": { "type": "string" }, "reason": { "type": "string" }, "field": { "type": "string" } } } }, "data": { "type": "object" } } }, "examples": { "Maximum Deals Exceeded Error": { "description": "Maximum Deals Exceeded Error", "value": { "success": false, "errorObjects": [ { "error": "Campaign ID 506992 exceeds the maximum limit of 25 deals" } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/cmp/pg/campaigns/draft/{campaignId}": { "patch": { "tags": [ "Campaign API" ], "summary": "It will edit the already created Draft PG Campaign for advertiser.", "description": "Given API edit already created Draft PG Campaign for advertiser User. User can edit any information from mentioned below fields\n\n---\n\n#### Request Body Detail\n\n| **Field** | **Type** | **Description** |\n| --- | --- | --- |\n| pgCampaignInfoVO |Object| Object contains of campaign information| |\n| campaignName | String | Name of the given campaign|\n| timeZoneId | int | Represent timezone of campaign|\n| totalImpressions | int | Targeted impressions for impression based campaign as budget |\n| maxBid | double | Maximum allowed bid price for campaign|\n| startTime | long | Start time of the campaign in epoch seconds|\n| endTime | long | End time of the campaign in epoch seconds |\n| advertiserDomain | String | Domain of the advertiser user|\n| budgetTotal | double | Total budget of the campaign in dollar for dollar based campaign|\n| creativeTargeting | Object | consist of campaign creative targeting details|\n| creativeTypeId | int | Type Id of creatives attached with campaign |\n| creativeIds | String | Ids of creatives attached with campaign |\n| inventoryTargeting | Object | Consist of campaign PG deal targeting details|\n| pgDealIds | String | Ids of PG Deal attached with campaign |\n| conversionTargeting | Object | Consist of campaign conversion targeting details |\n| conversionTypeId | int | Type Id of conversion attached with campaign|\n| conversionIds | String | Ids of conversion attached with campaign |\n| politicalAdvertiserClientId | int | Advertiser client Id if User is political advertiser |\n| countryId | int | Id of the targeted country |\n", "operationId": "editDraftPGCampaign", "parameters": [ { "name": "campaignId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "campaignId": { "type": "integer", "format": "int32" }, "countryId": { "type": "integer", "format": "int32" }, "politicalAdvertiserClientId": { "type": "integer", "format": "int32" }, "conversionTargeting": { "required": [ "conversionIds" ], "type": "object", "properties": { "conversionTypeId": { "type": "integer", "format": "int32" }, "conversionIds": { "type": "array", "items": { "type": "integer", "format": "int32" } } } }, "creativeTargeting": { "required": [ "creativeIds", "creativeTypeId" ], "type": "object", "properties": { "creativeTypeId": { "type": "integer", "format": "int32" }, "creativeIds": { "type": "array", "items": { "type": "integer", "format": "int32" } } } }, "inventoryTargeting": { "required": [ "pgDealIds" ], "type": "object", "properties": { "pgDealIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "paymentTypeId": { "type": "integer", "format": "int32" } } }, "pgCampaignInfo": { "required": [ "advertiserDomain", "budgetTypeId", "campaignName", "ioId", "maxBid", "startTime", "timeZoneId" ], "type": "object", "properties": { "campaignName": { "maxLength": 1024, "minLength": 0, "type": "string" }, "timeZoneId": { "type": "integer", "format": "int32" }, "spendingBudget": { "type": "number", "format": "double" }, "maxBid": { "maximum": 1000, "exclusiveMaximum": false, "type": "number", "format": "double" }, "startTime": { "type": "integer", "format": "int64" }, "endTime": { "type": "integer", "format": "int64" }, "totalImpressions": { "type": "integer", "format": "int64" }, "advertiserDomain": { "type": "string" }, "advertiserType": { "type": "string" }, "ioId": { "type": "integer", "format": "int32" }, "budgetTypeId": { "type": "integer", "format": "int32" }, "campaignTypeId": { "type": "integer", "format": "int32" }, "owId": { "type": "integer", "format": "int32" }, "uowId": { "type": "integer", "format": "int32" }, "creativeTypeId": { "type": "integer", "format": "int32" }, "status": { "type": "string" }, "configObj": { "type": "string" }, "totalBudget": { "type": "number", "format": "double" }, "pgFeesPercentage": { "type": "number", "format": "double" }, "totalCPM": { "type": "number", "format": "double" } } } } }, "examples": { "Edit impression based PG Campaign (all the fields)": { "description": "Edit impression based PG Campaign (all the fields)", "value": { "pgCampaignInfo": { "campaignName": "test imps PG campaign", "timeZoneId": 29, "totalImpressions": 12345, "maxBid": 8, "startTime": 1715662337, "endTime": 1717128000, "advertiserType": "political", "advertiserDomain": "https://www.xyz.com" }, "creativeTargeting": { "creativeTypeId": 11, "creativeIds": "[644506]" }, "inventoryTargeting": { "pgDealIds": "[30,12]" }, "conversionTargeting": { "conversionTypeId": 1, "conversionIds": "[465,687,987]" }, "politicalAdvertiserClientId": 989898, "countryId": 23 } }, "Edit budget based PG Campaign (all the fields)": { "description": "Edit budget based PG Campaign (all the fields)", "value": { "pgCampaignInfoVO": { "campaignName": "test imps PG campaign", "timeZoneId": 29, "spendingBudget": 1234, "maxBid": 8, "startTime": 1715662337, "endTime": 1717128000, "advertiserDomain": "https://www.xyz.com" }, "creativeTargeting": { "creativeTypeId": 11, "creativeIds": "[644506]" }, "inventoryTargeting": { "pgDealIds": "[30,12]" }, "conversionTargeting": { "conversionTypeId": 1, "conversionIds": "[465,687,987]" }, "politicalAdvertiserClientId": 989898, "countryId": 23 } }, "Edit some fields of PG Campaign info only": { "description": "Edit some fields of PG Campaign info only", "value": { "pgCampaignInfoVO": { "campaignName": "test imps PG campaign", "timeZoneId": 29, "spendingBudget": 1234, "endTime": 1717128000, "advertiserDomain": "https://www.xyz.com" } } } } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "examples": { "Success response of PG campaign update": { "description": "Success response of PG campaign update", "value": { "success": true, "data": { "message": "PG Campaign Updated successfully", "campaignId": 2 } } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/cmp/io/{ioId}": { "get": { "tags": [ "Campaign API" ], "summary": "It will retrieve the insertion order details for campaign based on IO id.", "description": "This API will fetch the basic details based on insertion order Id.", "operationId": "getBasicIODetailsById", "parameters": [ { "name": "insertionOrderId", "in": "path", "description": "insertion order identity number", "required": true }, { "name": "ioId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Successful creation of IO": { "description": "Successful creation of IO", "value": "{ \"success\": true, \"data\": { \"ioId\": 985, \"ioName\": \"TEST UPDATE\", \"ioStartTime\": 1793251767612, \"ioEndTime\": 1794251767612, \"ioTotalBudget\": 0.0, \"ioTimeZoneId\": 29, \"isAutoSumIoTotalBudget\": true, \"ioBudgetDistributionMethodId\": 1, \"ioBudgetTypeId\": 1, \"ioStatusId\": 1, \"ioTotalImpressions\": 0 \"isIoPrioritise\": true, \"ioNextPerformanceCheck\": 1708606327000 , \"ioLastPriorityShift\": 1704976116958, \"ioCurrentPriority\": 4 }}" }, "IO without priority shift data": { "description": "IO without priority shift data", "value": { "success": true, "data": { "ioId": 985, "ioName": "TEST UPDATE", "ioStartTime": 1793251767612, "ioEndTime": 1794251767612, "ioTotalBudget": 0, "ioTimeZoneId": 29, "isAutoSumIoTotalBudget": true, "ioBudgetDistributionMethodId": 1, "ioBudgetTypeId": 1, "ioStatusId": 1, "ioTotalImpressions": 0, "isIoPrioritise": true, "ioNextPerformanceCheck": null, "ioLastPriorityShift": null, "ioCurrentPriority": null } } } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "examples": { "Unprocessable entity": { "description": "Unprocessable entity", "value": { "success": false, "errorObjects": [ { "error": "Invalid insertion order id." } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } }, "patch": { "tags": [ "Campaign API" ], "summary": "It will edit the insertion order details for campaign on IO creation.", "description": "This API will edit IO and inserts its details with the added details.\n---\n\n#### Request Body Detail\n\n| **Field** | **Type** | **Description** |\n| --- | --- | --- |\n| ioName `[optional]` | String | Name to be updated for the IO |\n| ioEndTime `[optional]` | Long | IO end time that is to be updated in epochs (milliseconds) |\n| ioTotalBudget `[optional]` | Double | IO total budget to be updated. |\n| ioTimeZoneId `[optional]` | Integer | IO time zone id to be updated |\n| ioTotalImpressions `[optional]` | Long | IO total impressions to be updated. |\n| isAutoSumIoTotalBudget `[optional]` | Boolean | IO time zone id to be updated |\n", "operationId": "editIODetails", "parameters": [ { "name": "ioId", "in": "path", "description": "insertion order identity number", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ioName": { "maxLength": 255, "minLength": 0, "type": "string" }, "ioEndTime": { "type": "integer", "format": "int64" }, "ioStartTime": { "type": "integer", "format": "int64" }, "ioTotalBudget": { "minimum": 0, "exclusiveMinimum": false, "type": "number", "format": "double" }, "isAutoSumIoTotalBudget": { "type": "boolean" }, "ioTimeZoneId": { "type": "integer", "format": "int32" }, "ioTotalImpressions": { "type": "integer", "format": "int64" } } }, "example": { "ioName": "IO Name 1", "ioStartTime": 1690898148000, "ioEndTime": 1690898888000, "ioTotalBudget": 1000, "ioTotalImpressions": 0, "ioTimeZoneId": 29, "ioBudgetTypeId": 1, "isAutoSumIoTotalBudget": true } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Successful creation of IO": { "description": "Successful creation of IO", "value": { "success": true, "data": "IO Name 1 saved successfully." } } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "examples": { "Unprocessable entity": { "description": "Unprocessable entity", "value": { "success": false, "errorObjects": [ { "error": "Invalid ioId." } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/cmp/io/update-end-date": { "patch": { "tags": [ "Campaign API" ], "summary": "Updates end-date for list of IO IDs.", "description": "This API updates the end-date for the given list of IO ids, if the end-date is updated the timezone id is a required field.", "operationId": "updateIOEndDate", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ioIdsList": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "ioEndTime": { "type": "integer", "format": "int64" }, "ioTimezoneId": { "type": "integer", "format": "int32" }, "ioOwId": { "type": "integer", "format": "int32" } } }, "examples": { "IO end-date update from advertiser": { "description": "IO end-date update from advertiser", "value": { "ioIdsList": [1, 2, 3], "ioEndTime": 1690898148000, "ioTimezoneId": 29 } }, "IO end-date update from workspace/super": { "description": "IO end-date update from workspace/super", "value": { "ioIdsList": [1, 2, 3], "ioEndTime": 1690898148000, "ioTimezoneId": 29, "ioOwId": 201427 } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "IO end-date update.": { "description": "IO end-date update.", "value": { "success": true, "data": "EndDate updated successfully" } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden!" } ] } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "examples": { "Unprocessable entity": { "description": "Unprocessable entity", "value": { "success": false, "errorObjects": [ { "error": "IO Ids list can not be empty." } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/cmp/io/update-budget": { "patch": { "tags": [ "Campaign API" ], "summary": "Updates budget for list of IO IDs.", "description": "This API updates the budget for the given list of IO ids.", "operationId": "updateIOBudgetByIOList", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ioIdsList": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "budget": { "type": "number", "format": "double" }, "budgetUpdateType": { "type": "string" }, "ioOwId": { "type": "integer", "format": "int32" }, "ioBudgetTypeId": { "type": "integer", "format": "int32" }, "ioTotalImpressions": { "type": "integer", "format": "int64" } } }, "examples": { "IO budget update with ADD for Budget based IO": { "description": "IO budget update with ADD for Budget based IO", "value": { "ioIdsList": [1, 2, 3], "budget": 169089.909, "budgetUpdateType": "add" } }, "IO budget update with SET for Budget based IO": { "description": "IO budget update with SET for Budget based IO", "value": { "ioIdsList": [1, 2, 3], "budget": 100000, "budgetUpdateType": "set" } }, "IO budget update from workspace/super for Budget based IO": { "description": "IO budget update from workspace/super for Budget based IO", "value": { "ioIdsList": [1, 2, 3], "budget": 100000, "budgetUpdateType": "set", "ioOwId": 201427 } }, "IO budget update with ADD for Impressions based IO": { "description": "IO budget update with ADD for Impressions based IO", "value": { "ioIdsList": [1, 2, 3], "ioTotalImpressions": 1690, "budgetUpdateType": "add" } }, "IO budget update with SET for Impressions based IO": { "description": "IO budget update with SET for Impressions based IO", "value": { "ioIdsList": [1, 2, 3], "ioTotalImpressions": 10003, "budgetUpdateType": "set" } }, "IO budget update from workspace/super for Impressions based IO": { "description": "IO budget update from workspace/super for Impressions based IO", "value": { "ioIdsList": [1, 2, 3], "ioTotalImpressions": 10023, "budgetUpdateType": "set", "ioOwId": 201427 } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "IO budget update ": { "description": "IO budget update ", "value": { "success": true, "data": "Budget updated successfully" } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden!" } ] } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "examples": { "Unprocessable entity": { "description": "Unprocessable entity", "value": { "success": false, "errorObjects": [ { "error": "IO list can not be empty." } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v2/cmp/campaign/{campaignId}": { "get": { "tags": [ "Campaign API" ], "summary": "Get all details of the campaign", "description": "This API will provide all the campaign details for provided campaign Id", "operationId": "getCampaign", "parameters": [ { "name": "campaignId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "isSpentRequired", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "description": "API to get all details of the campaign.", "content": { "application/json": { "schema": { "type": "object", "properties": { "sortByFields": { "type": "object", "additionalProperties": { "type": "string" } }, "campaignIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "owIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "isAllOwIds": { "type": "boolean" }, "status": { "type": "array", "items": { "type": "string" } }, "creativeTypeIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "ids": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "responseFields": { "type": "array", "items": { "type": "string" } }, "ioIdsList": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "campaignTypeIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "pageNo": { "type": "integer", "format": "int32" }, "noOfEntries": { "type": "integer", "format": "int32" }, "sortBy": { "type": "string" }, "searchField": { "type": "string" }, "order": { "type": "string", "enum": [ "com.iqm.commons.models.enums.SortOrderEnum@6f37475b[id=1,name=asc,symbol=+,name=ASC,ordinal=0]", "com.iqm.commons.models.enums.SortOrderEnum@3e0e6466[id=2,name=desc,symbol=-,name=DESC,ordinal=1]" ] } } }, "examples": { "Get all campaign details": { "description": "Get all campaign details", "value": { "isSpentRequired": false } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Get all campaign details": { "description": "Get all campaign details", "value": { "statusCode": 200, "responseObject": { "ioId": 1, "ioName": "Insertion Order Name", "owId": 100288, "parentOrganizationName": "sample", "id": 253397, "uowId": 4767, "campaignName": "Sample name", "advertiserDomain": "https://sample.com", "creativeType": 11, "campaignType": 1, "totalBudgetPacing": false, "isTvAd": false, "budgetDay": 120, "budgetTotal": 1200, "budgetTypeId": 1, "maxBid": 12, "baseBid": 12, "ioCampaignPriority": 3, "timezone": 11, "startTime": 1640543431, "endTime": 1640629831, "campaignTypeId": 2, "pgDealIds": [378], "spendingBudget": 98.76, "pgFeesPercentage": 10, "pgFeesBudget": 9.87, "pgPaymentTypeId": 2, "status": "draft", "advertiserType": "political", "dspMargin": 0, "platformMargin": 0, "userDealMargin": 0, "spentScale": false, "creativeIds": "394572", "prebidAudienceSegmentIdList": [10, 11, 12], "conversionType": "None", "conversionTypeId": 1, "conversionIds": "3277,3278", "bidOptimization": true, "bidPacing": true, "isBidShading": true, "impressionCapping": 0, "frequencyCapEnabled": true, "frequencyCapping": { "1": { "frequencyCapDuration": 6, "frequencyCapValue": 5 }, "2": { "frequencyCapDuration": 3, "frequencyCapValue": 20 }, "3": { "frequencyCapDuration": 3, "frequencyCapValue": 60 }, "4": { "frequencyCapDuration": 0, "frequencyCapValue": 100 } }, "deviceType": "13,15,11,12", "trafficType": "11,14,13,12", "exchanges": "27,21,26", "isLocationWithOrFilter": true, "countryId": "246", "stateIds": "30200031,30200032", "whiteListedStateIds": "30200031,30200032", "blackListedStateIds": "30200033,30200035", "locationDetails": { }, "blackListedCustomAudienceIds": "888981", "whiteListedCustomAudienceIds": "889185", "isCampaignFromNewPlatform": true, "whiteListedAudienceSegmentGroupIds": "900269", "blackListedAudienceSegmentGroupIds": "900254", "blackListedConversionTagIds": "901341", "whiteListedConversionTagIds": "901342", "blackListedAudienceIds": "888981,900254,901341,901537", "whiteListedAudienceIds": "889185,900269,901342,901538", "organizationName": "Company 288", "userName": "Display Name 288", "isEditAccess": false, "isApprovalAccess": true, "isMarginSet": true, "isParentInvoiceTemplateSet": true, "isUnapprovedAudienceTargeted": true, "isAllAudienceUnapproved": false, "isAdvanceAudioVideoTargeted": true, "isEstimatorAvailable": true, "pmpDealIds": [588, 589], "campaignEstimatorMetaData": { "reachMeta": { }, "landScapeMeta": { }, "sliderMeta": { } }, "creativeAdvanceTargeting": { "skippability": [20900001], "playbackMethod": [21000001], "placementType": [20600001], "playerSize": [20800001], "rollPosition": [20700001] }, "campaignNextPerformanceCheckTime": 1709119192000, "campaignLastPriorityShiftTime": 1709119192000, "campaignDimensionCurrentPriority": 3 } } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "statusCode": 500, "responseObject": { "errorMsg": "Internal server error", "errorCode": 500 } } } } } } }, "patch": { "tags": [ "Campaign API" ], "summary": "Update campaign", "description": "This API updates campaign. Whichever fields needs to updated only those needs to be sent in request body.\n\nIf campaign is in `DRAFT` mode that this api will automatically update status from `DRAFT` to `PENDING`. In all other cases it will not update status.\n\n---\n\n#### Request Body Detail\n\n| **Field** | **Type** | **Description** |\n| --- | --- | --- |\n| id | Integer | campaign id |\n| campaignName | String | campaign name |\n| advertiserDomain | String | add domain |\n| creativeType | Number | Creative type id |\n| campaignType | Number | Campaign type id |\n| totalBudgetPacing `[optional]` | Boolean | Budget is spent equally every hour. |\n| budgetDay | Number | Daily budget for campaign serving daily |\n| budgetTotal | Number | Total budget for campaign serving period |\n| maxBid | Number | max bid for each bid request |\n| timezone | Number | timezone id for campaign |\n| startTime | Number | campaign start time |\n| endTime | Number | campaign end time |\n| status | String | status of campaign |\n| creativeIds | Number | camapign creation time update |\n| excludeFromPlatformServing | Boolean | exclude campaign from platform serving |\n| forTest | Boolean | indicates campaign for test |\n| modifiedDate | Timestamp | campign modified date |\n| dspMarginJson | String | campaign dsp marging json |\n| platformMarginJson | String | campaign platform marging json |\n| dspMargin | Integer | camapign dsp margin number |\n| platformMargin | Integer | camapign platform margin number |\n| userDealMargin | Integer | camapign user deal margin number |\n| bidStrategyFlag | Boolean | bid statergy allowed or not for user |\n| bidOptimization `[optional]` | Boolean | Optimize bid price based on analysis. |\n| bidPacing `[optional]` | Boolean | Budget is spent equally every hour. |\n| impressionCapping `[optional]` | Number | Maximum impressions in one inventory. |\n| maxDayClicks `[optional]` | Number | Maximum daily clicks |\n| totalClicks `[optional]` | Number | Total clicks |\n| maxDayImpressions `[optional]` | Number | Maximum daily impressions |\n| totalImpressions `[optional]` | Number | Total impressions |\n| maxDayConversions `[optional]` | Number | Maximum daily conversions |\n| totalConversions `[optional]` | Number | Total conversions |\n| spentScale | Boolean | spent scale on/off |\n| creativeIds | String | Targeted creative ids |\n| targetCPI | Long | Target CPI for Campaign Serving |\n| conversionType `[optional]` | String | User conversion type. Allowed values: 'install', 'non-install'. |\n| conversionTypeId `[optional]` | int | Conversion type Id which represents the type of conversion attached to it. This parameter is mandatory with conversionIds. [Here](?path=/Conversion%20API/getListOfConversionTypes) is the list of supported conversion types. |\n| appURL `[optional]` | String | If conversion type is install, specify URL of inventory. |\n| targetCPI `[optional]` | Number | Cost per install if conversion type is install. |\n| technologyFlag | Boolean | technology enabled or disblebed based on policy of user |\n| carriers `[optional]` | String | Carrier targeting. Value in form of String of comma separated IDs of targeted carrier(s). |\n| networkType `[optional]` | String | Network targeting. Value in form of String of comma separated IDs of targeted network(s). |\n| deviceType `[optional]` | String | Device targeting. Value in form of String of comma separated IDs of targeted device type(s). |\n| trafficType `[optional]` | String | Traffic type targeting. Value in form of String of comma separated IDs of targeted traffic type(s). |\n| manufacturer `[optional]` | String | Manufacturer targeting. Value in form of String of comma separated IDs of targeted manufacturer type(s). |\n| os `[optional]` | String | OS targeting. Value in form of String of comma separated IDs of targeted OS. |\n| osVersion `[optional]` | String | OS version targeting. Value in form of String of comma separated IDs of targeted OS version based on targeted OS. |\n| exchanges `[optional]` | String | Targeted exchanges. Value in form of String of comma separated IDs of exchanges. |\n| prebidAudienceSegmentIdList `[optional]` | Array | Prebid Audience Segment Ids to attach campaign to segment Ids. |\n| device `[optional]` | String | Targeted devices as string |\n| whiteListedDeviceId `[optional]` | String | Target Device Ids. Value in form of String of comma separated device IDs. |\n| whiteListedIp `[optional]` | String | IPV4 address. Value in form of String of comma separated IP Address. |\n| whiteListedAppId `[optional]` | String | iOS app ID |\n| whiteListedPackageName `[optional]` | String | Android package names. Value in form of String of comma separated package names. |\n| whiteListedSiteDomain `[optional]` | String | Target sites. Value in form of String of comma separated domain urls. |\n| blackListedDeviceId `[optional]` | String | Target Device Ids. Value in form of String of comma separated device IDs. |\n| blackListedIp `[optional]` | String | IPV4 address. Value in form of String of comma separated IP Address. |\n| blackListedAppId `[optional]` | String | iOS app ID |\n| blackListedPackageName `[optional]` | String | Android package names. Value in form of String of comma separated package names. |\n| blackListedSiteDomain `[optional]` | String | Target sites. Value in form of String of comma separated domain urls. |\n| publisherAdCategory `[optional]` | String | Target Publisher ad category. Value in form of String of comma separated IDs. |\n| blackListedInventoryGroupIds `[optional]` | String | Target already created Inventory groups. Value in form of String of comma separated IDs. |\n| whiteListedInventoryGroupIds `[optional]` | String | Target already created Inventory groups. Value in form of String of comma separated IDs. |\n| blackListedCustomAudienceIds `[optional]` | String | Target already created custom audience Groups. Value in form of String of comma separated IDs. |\n| whiteListedCustomAudienceIds `[optional]` | String | Target already created custom audience Groups. Value in form of String of comma separated IDs. |\n| blackListedAudienceSegmentGroupIds `[optional]` | String | Target already created audience segment Groups. Value in form of String of comma separated IDs. |\n| whiteListedAudienceSegmentGroupIds `[optional]` | String | Target already created audience segment Groups. Value in form of String of comma separated IDs. |\n| blackListedConversionTagIds `[optional]` | String | Target already created conversion tags. Value in form of String of comma separated IDs. |\n| whiteListedConversionTagIds `[optional]` | String | Target already created conversion tags. Value in form of String of comma separated IDs. |\n| userDealId `[optional]` | String | User specific deal IDs. Value in form of String of comma separated deal IDs. |\n| groupDealId `[optional]` | String | Group of selected deals. Value in form of String of comma separated deal IDs. |\n| politicalAdvertiserClientId `[optional]` | Number | Id of political advertiser in case of campaign is political campaign. |\n| stateIds `[optional]` | String | State Target (It will be considered as White list State Target). Value in form of String of comma separated IDs. |\n| whiteListedStateIds `[optional]` | String | White list State Target . Value in form of String of comma separated IDs. |\n| blackListedStateIds `[optional]` | String | Black list State Target . Value in form of String of comma separated IDs. |\n| countryId | String | Country Target |\n| dmaIds `[optional]` `deprecated` | String | DMA Target. Value in form of String of comma separated IDs. |\n| whiteListedDmaIds `[optional]` | String | white list DMA Target. Value in form of String of comma separated IDs. |\n| blackListedDmaIds `[optional]` | String | black list DMA Target. Value in form of String of comma separated IDs. |\n| senateDistrictIds `[optional]` `deprecated` | String | Senate districts Target. Value in form of String of comma separated IDs. |\n| whiteListedSenateDistrictIds `[optional]` | String | white list senate districts Target. Value in form of String of comma separated IDs. |\n| blackListedSenateDistrictIds `[optional]` | String | black list senate districts Target. Value in form of String of comma separated IDs. |\n| congressionalDistrictIds `[optional]` `deprecated` | String | Congressional districts Target. Value in form of String of comma separated IDs. |\n| whiteListedCongressionalDistrictIds `[optional]` | String | white list congressional districts Target. Value in form of String of comma separated IDs. |\n| blackListedCongressionalDistrictIds `[optional]` | String | black list congressional districts Target. Value in form of String of comma separated IDs. |\n| houseDistrictIds `[optional]` `deprecated` | String | House districts Target. Value in form of String of comma separated IDs. |\n| whiteListedHouseDistrictIds `[optional]` | String | white list house districts Target. Value in form of String of comma separated IDs. |\n| blackListedHouseDistrictIds `[optional]` | String | black list house districts Target. Value in form of String of comma separated IDs. |\n| geoRadiusDetails `[optional]` `deprecated` | String | To target custom ares in circle or polygon. Value in form of JSON. |\n| whiteListedGeoRadiusDetails `[optional]` | String | To white list custom ares in circle or polygon. Value in form of JSON. |\n| blackListedGeoRadiusDetails `[optional]` | String | To black list custom ares in circle or polygon. Value in form of JSON. |\n| zipcodes `[optional]` `deprecated` | String | ZipCode Target. Value in form of String of comma separated IDs. |\n| whiteListedZipcodes `[optional]` | String | white list zipCode Target. Value in form of String of comma separated IDs. |\n| blackListedZipcodes `[optional]` | String | black list zipCode Target. Value in form of String of comma separated IDs. |\n| locationFileIds `[optional]` | String | Target location by uploading file. Value in form of String of comma separated csv file ids.(pre uploaded) |\n| whiteListedLocationIds `[optional]` | String | white list location ids from uploaded files. Value in form of String of comma separated location ids. |\n| blackListedLocationIds `[optional]` | String | black list location ids from uploaded files. Value in form of String of comma separated location ids. |\n| whiteListedCityIds `[optional]` | String | white list city Target. Value in form of String of comma separated IDs. |\n| blackListedCityIds `[optional]` | String | black list city Target. Value in form of String of comma separated IDs. |\n| whiteListedCountyIds `[optional]` | String | white list county Target. Value in form of String of comma separated IDs. |\n| blackListedCountyIds `[optional]` | String | black list county Target. Value in form of String of comma separated IDs. |\n| ageRangeIds `[optional]` | String | Target age range. Value in form of string of comma separated IDs. |\n| genderIds `[optional]` | String | Target gender. Value in form of String of comma-separated IDs. |\n| interestIds `[optional]` | String | Target user interest. Value in form of a string of comma-separated IDs. |\n| incomeRangeIds `[optional]` | String | Target user income range. Value in form of a string of comma-separated IDs. |\n| languageIds `[optional]` | String | Target user language. Value in form of a string of comma-separated IDs. |\n| ethnicityIds `[optional]` | String | Target user ethnicity. Value in form of a string of comma-separated ID. |\n| schedule \\[optional\\] | String\\[\\]\\[\\] | key as \\[0 to 6\\] maps to \\[Monday to Sunday\\] & values \\[\\['hh:mm:ss','hh:mm:ss'\\], ...\\] |\n| campaignIabCategoryIds `[optional]` | String | Target iab categories. Value in form of a string of comma-separated ID. Only super user can update iab categories |\n| isAdvanceAudioVideoTargeted | Boolean | To indicate if the advance targeting is enabled if this is true, 'creativeAdvanceTargeting' is optional and it is assumed that every video creative segment is targeted. |\n| isBidShading | Boolean | To indicate if the bid shading is enabled |\n| creativeAdvanceTargeting | JSON Map: String to Integer | Map of Creative advanced targeting group to list of creative advance targeting segment ids. |\n| campaignEstimatorMetaData | JSON | Campaign Estimator data with `reachMeta`, `landScapeMeta` and `sliderMeta` |\n\n---\n\n#### Scheduling example\n\n```\n\"scheduling\": {\n \"0\": [\n [\n \"03:00:00\",\n \"05:00:00\"\n ],\n [\n \"06:00:00\",\n \"11:00:00\"\n ]\n ]\n}\n\n```\n\n---\n\n#### GeoRadiusDetails example (below is the common format for whitelist and blacklist both)\n\n```\n\"whiteListedGeoRadiusDetails\" : [\n {\n \"unit\": \"mile\",\n \"address\": \"Denver, CO 80202, USA\",\n \"latitude\": 39.739235,\n \"radius\": 2,\n \"type\": \"circle\",\n \"longitude\": -104.99025,\n \"sid\": \"4666\",\n \"cid\": \"246\"\n },\n {\n \"unit\": \"mile\",\n \"address\": \"Grand Lake, CO 80447, USA\",\n \"latitude\": 40.19427,\n \"radius\": 1,\n \"type\": \"circle\",\n \"longitude\": -105.84889,\n \"sid\": \"4666\",\n \"cid\": \"246\"\n },\n {\n \"unit\": \"mile\",\n \"address\": \"Yonkers, NY 10710, USA\",\n \"latitude\": 40.95017,\n \"radius\": 3,\n \"type\": \"circle\",\n \"longitude\": -73.84669,\n \"sid\": \"4694\",\n \"cid\": \"246\"\n },\n {\n \"polypath\": [\n {\n \"lng\": -112.05635319323119,\n \"lat\": 40.80285757668772\n },\n {\n \"lng\": -111.44111881823119,\n \"lat\": 38.15773779255543\n },\n {\n \"lng\": -108.45283756823119,\n \"lat\": 39.25508137287102\n },\n {\n \"lng\": -109.15596256823119,\n \"lat\": 41.266931755469045\n }\n ],\n \"unit\": \"mile\",\n \"address\": \"Dry Creek Rd, Utah, USA\",\n \"latitude\": 39.712334774012234,\n \"type\": \"custom\",\n \"radius\": 164.41,\n \"longitude\": -110.25459538073119,\n \"sid\": \"4709\",\n \"cid\": \"246\"\n },\n {\n \"polypath\": [\n {\n \"lng\": -98.60998217413051,\n \"lat\": 39.527470270360105\n },\n {\n \"lng\": -93.16076342413051,\n \"lat\": 41.662771525199084\n }\n ],\n \"unit\": \"mile\",\n \"address\": \"Nebraska City, NE 68410, USA\",\n \"latitude\": 40.595120897779594,\n \"type\": \"square\",\n \"radius\": 259.09,\n \"longitude\": -95.88537279913051,\n \"sid\": \"4689\",\n \"cid\": \"246\"\n }\n ]\n\n```", "operationId": "editCampaignPatch", "parameters": [ { "name": "campaignId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "content": { "application/json": { "schema": { "required": [ "exchanges", "publisherAdCategory" ], "type": "object", "properties": { "advertiserId": { "type": "integer", "format": "int32" }, "dspId": { "type": "integer", "format": "int32" }, "owId": { "type": "integer", "format": "int32" }, "uowId": { "type": "integer", "format": "int32" }, "id": { "type": "integer", "format": "int32" }, "campaignName": { "type": "string" }, "advertiserDomain": { "type": "string" }, "creativeType": { "type": "integer", "format": "int32" }, "campaignType": { "type": "integer", "format": "int32" }, "totalBudgetPacing": { "type": "boolean" }, "budgetDay": { "minimum": 0, "type": "number", "format": "double" }, "budgetTotal": { "minimum": 0, "type": "number", "format": "double" }, "maxBid": { "type": "number", "format": "double" }, "minBid": { "type": "number", "format": "double" }, "allowedMinBid": { "type": "number", "format": "double" }, "timezone": { "type": "integer", "format": "int32" }, "startTime": { "type": "integer", "format": "int64" }, "endTime": { "type": "integer", "format": "int64" }, "status": { "type": "string" }, "created": { "type": "integer", "format": "int32" }, "excludeFromPlatformServing": { "type": "boolean" }, "forTest": { "type": "boolean" }, "modifiedDate": { "type": "string", "format": "date-time" }, "dspMarginJson": { "type": "string" }, "platformMarginJson": { "type": "string" }, "dspMargin": { "type": "integer", "format": "int32" }, "platformMargin": { "type": "integer", "format": "int32" }, "userDealMargin": { "type": "integer", "format": "int32" }, "isAgreementChecked": { "type": "boolean" }, "spentScale": { "type": "boolean" }, "creativeIds": { "type": "string" }, "targetCPI": { "type": "integer", "format": "int64" }, "conversionType": { "type": "string" }, "conversionTypeId": { "type": "integer", "format": "int32" }, "appURL": { "type": "string" }, "bidOptimization": { "type": "boolean" }, "bidPacing": { "type": "boolean" }, "impressionCapping": { "minimum": 0, "type": "integer", "format": "int32" }, "frequencyCapEnabled": { "type": "boolean" }, "frequencyCapping": { "type": "object", "additionalProperties": { "type": "object", "properties": { "frequencyCapDuration": { "type": "integer", "format": "int32" }, "frequencyCapValue": { "type": "integer", "format": "int32" } } } }, "maxDayImpressions": { "minimum": 0, "type": "integer", "format": "int32" }, "maxDayClicks": { "minimum": 0, "type": "integer", "format": "int32" }, "maxDayConversions": { "minimum": 0, "type": "integer", "format": "int32" }, "totalImpressions": { "minimum": 0, "type": "integer", "format": "int32" }, "totalClicks": { "minimum": 0, "type": "integer", "format": "int32" }, "totalConversions": { "minimum": 0, "type": "integer", "format": "int32" }, "bidStrategyFlag": { "type": "boolean" }, "ioId": { "type": "integer", "format": "int32" }, "prebidAudienceSegmentIdList": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "isBidShading": { "type": "boolean" }, "totalCPM": { "minimum": 0, "type": "number", "format": "double" }, "templateId": { "type": "integer", "format": "int32" }, "carriers": { "type": "string" }, "networkType": { "type": "string" }, "deviceType": { "type": "string" }, "trafficType": { "type": "string" }, "manufacturer": { "type": "string" }, "device": { "type": "string" }, "os": { "type": "string" }, "osVersion": { "type": "string" }, "technologyFlag": { "type": "boolean" }, "exchanges": { "type": "string" }, "whiteListedDeviceId": { "type": "string" }, "whiteListedIp": { "type": "string" }, "whiteListedAppId": { "type": "string" }, "whiteListedPackageName": { "type": "string" }, "whiteListedSiteDomain": { "type": "string" }, "blackListedDeviceId": { "type": "string" }, "blackListedIp": { "type": "string" }, "blackListedAppId": { "type": "string" }, "blackListedPackageName": { "type": "string" }, "blackListedSiteDomain": { "type": "string" }, "advancedFlag": { "type": "boolean" }, "userDealId": { "type": "string" }, "groupDealId": { "type": "string" }, "publisherAdCategory": { "type": "string" }, "campaignIabCategoryIds": { "type": "string" }, "stateIds": { "type": "string" }, "whiteListedStateIds": { "type": "string" }, "blackListedStateIds": { "type": "string" }, "countryId": { "type": "integer", "format": "int32" }, "dmaIds": { "type": "string" }, "whiteListedDmaIds": { "type": "string" }, "blackListedDmaIds": { "type": "string" }, "zipcodes": { "type": "string" }, "whiteListedZipcodes": { "type": "string" }, "blackListedZipcodes": { "type": "string" }, "geoRadiusDetails": { "type": "array", "items": { "type": "object", "properties": { "latitude": { "type": "number", "format": "double" }, "longitude": { "type": "number", "format": "double" }, "radius": { "type": "number", "format": "double" }, "address": { "type": "string" }, "stateShortName": { "type": "string" }, "countryShortName": { "type": "string" }, "locationId": { "type": "integer", "format": "int32" }, "rejectionReason": { "type": "string" }, "polypath": { "type": "object" }, "placemarkName": { "type": "string" }, "isIncluded": { "type": "boolean" }, "cid": { "type": "string" }, "sid": { "type": "string" }, "type": { "type": "string" }, "unit": { "type": "string" }, "cdId": { "type": "integer", "format": "int32" }, "sdId": { "type": "integer", "format": "int32" }, "hdId": { "type": "integer", "format": "int32" } } } }, "whiteListedGeoRadiusDetails": { "type": "array", "items": { "type": "object", "properties": { "latitude": { "type": "number", "format": "double" }, "longitude": { "type": "number", "format": "double" }, "radius": { "type": "number", "format": "double" }, "address": { "type": "string" }, "stateShortName": { "type": "string" }, "countryShortName": { "type": "string" }, "locationId": { "type": "integer", "format": "int32" }, "rejectionReason": { "type": "string" }, "polypath": { "type": "object" }, "placemarkName": { "type": "string" }, "isIncluded": { "type": "boolean" }, "cid": { "type": "string" }, "sid": { "type": "string" }, "type": { "type": "string" }, "unit": { "type": "string" }, "cdId": { "type": "integer", "format": "int32" }, "sdId": { "type": "integer", "format": "int32" }, "hdId": { "type": "integer", "format": "int32" } } } }, "blackListedGeoRadiusDetails": { "type": "array", "items": { "type": "object", "properties": { "latitude": { "type": "number", "format": "double" }, "longitude": { "type": "number", "format": "double" }, "radius": { "type": "number", "format": "double" }, "address": { "type": "string" }, "stateShortName": { "type": "string" }, "countryShortName": { "type": "string" }, "locationId": { "type": "integer", "format": "int32" }, "rejectionReason": { "type": "string" }, "polypath": { "type": "object" }, "placemarkName": { "type": "string" }, "isIncluded": { "type": "boolean" }, "cid": { "type": "string" }, "sid": { "type": "string" }, "type": { "type": "string" }, "unit": { "type": "string" }, "cdId": { "type": "integer", "format": "int32" }, "sdId": { "type": "integer", "format": "int32" }, "hdId": { "type": "integer", "format": "int32" } } } }, "gotvLocationId": { "type": "integer", "format": "int32" }, "congressionalDistrictIds": { "type": "string" }, "whiteListedCongressionalDistrictIds": { "type": "string" }, "blackListedCongressionalDistrictIds": { "type": "string" }, "senateDistrictIds": { "type": "string" }, "whiteListedSenateDistrictIds": { "type": "string" }, "blackListedSenateDistrictIds": { "type": "string" }, "houseDistrictIds": { "type": "string" }, "whiteListedHouseDistrictIds": { "type": "string" }, "blackListedHouseDistrictIds": { "type": "string" }, "locationFileIds": { "type": "string" }, "whiteListedLocationIds": { "type": "string" }, "blackListedLocationIds": { "type": "string" }, "radiusUpdatedLocations": { "type": "object", "additionalProperties": { "type": "number", "format": "double" } }, "removedLocationIds": { "type": "string" }, "whiteListedCityIds": { "type": "string" }, "blackListedCityIds": { "type": "string" }, "whiteListedCountyIds": { "type": "string" }, "blackListedCountyIds": { "type": "string" }, "blackListedInventoryGroupIds": { "type": "string" }, "whiteListedInventoryGroupIds": { "type": "string" }, "inventoryKeywords": { "type": "array", "items": { "type": "string" } }, "inventoryUrls": { "type": "array", "items": { "type": "string" } }, "pmpDealIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "blackListedAudienceIds": { "type": "string" }, "whiteListedAudienceIds": { "type": "string" }, "blackListedCustomAudienceIds": { "type": "string" }, "whiteListedCustomAudienceIds": { "type": "string" }, "advertiserType": { "type": "string" }, "politicalAdvertiserClientId": { "type": "integer", "format": "int32" }, "scheduling": { "type": "object", "additionalProperties": { "type": "object" } }, "ageRangeIds": { "type": "string" }, "genderIds": { "type": "string" }, "languageIds": { "type": "string" }, "incomeRangeIds": { "type": "string" }, "ethnicityIds": { "type": "string" }, "interestIds": { "type": "string" }, "demographicTargetingFlag": { "type": "boolean" }, "whiteListedAudienceSegmentGroupIds": { "type": "string" }, "blackListedAudienceSegmentGroupIds": { "type": "string" }, "blackListedConversionTagIds": { "type": "string" }, "whiteListedConversionTagIds": { "type": "string" }, "conversionIds": { "type": "string" }, "creativesPlacementMapping": { "type": "object", "additionalProperties": { "type": "integer", "format": "int32" } }, "isTvAd": { "type": "boolean" }, "creativeAdvanceTargeting": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "integer", "format": "int32" } } }, "budgetTypeId": { "type": "integer", "format": "int32" }, "campaignEstimatorMetaData": { "type": "object", "properties": { "reachMeta": { "type": "object", "additionalProperties": { "type": "object" } }, "landScapeMeta": { "type": "object", "additionalProperties": { "type": "object" } }, "sliderMeta": { "type": "object", "additionalProperties": { "type": "object" } } } }, "campaignOptimization": { "type": "object", "properties": { "aiObjective": { "type": "integer", "format": "int32" }, "aiGoal": { "type": "integer", "format": "int32" }, "aiTargetKpi": { "type": "number", "format": "double" }, "aiConversionId": { "type": "integer", "format": "int32" } } }, "campaignOptimizationType": { "type": "string" }, "modelledDimensionIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "advanceAudioVideoTargeted": { "type": "boolean" }, "customAudienceTargeted": { "type": "boolean" }, "isAdvanceAudioVideoTargeted": { "type": "boolean" } } }, "examples": { "Update campaign with all details.": { "description": "Update campaign with all details.", "value": { "campaignName": "Sample campaign name ", "isAgreementChecked": true, "advertiserDomain": "https://www.example.com", "creativeType": 14, "budgetTotal": 100, "startTime": 1598427074, "budgetDay": 18, "timezone": 105, "creativeIds": "100027,100028", "maxBid": 10.5, "minBid": 5.5, "bidOptimization": false, "bidPacing": true, "isBidShading": true, "impressionCapping": 2, "frequencyCapEnabled": true, "frequencyCapping": { "1": { "frequencyCapDuration": 6, "frequencyCapValue": 5 }, "2": { "frequencyCapDuration": 3, "frequencyCapValue": 20 }, "3": { "frequencyCapDuration": 3, "frequencyCapValue": 60 }, "4": { "frequencyCapDuration": 0, "frequencyCapValue": 100 } }, "conversionType": "install", "advertiserType": "political", "conversionTypeId": 1, "appURL": "https://www.example.com", "totalBudgetPacing": false, "carriers": "293,294", "networkType": "13", "deviceType": "15", "trafficType": "11", "manufacturer": "451,155", "os": "11,14", "osVersion": "11,12,13", "exchanges": "27,21", "whiteListedIp": "df", "whiteListedPackageName": "sdf", "whiteListedSiteDomain": "example,https://www.example.com", "blackListedDeviceId": "id1,id2", "blackListedIp": "id11,id22", "blackListedAppId": "id1, id2", "blackListedPackageName": "id1,id2", "blackListedSiteDomain": "https://www.example.com", "prebidAudienceSegmentIdList": [10, 11, 12], "publisherAdCategory": "112", "userDealId": "1,2,b", "countryId": 246, "politicalAdvertiserClientId": 17, "locationFileIds": "1011,1010", "whiteListedLocationIds": "48377", "blackListedLocationIds": "48376,48363", "campaignEstimatorMetaData": { "reachMeta": { }, "landScapeMeta": { }, "sliderMeta": { } }, "whiteListedGeoRadiusDetails": [ { "unit": "mile", "address": "Cimarron, KS 67835, USA", "latitude": 37.8024861214427, "radius": 2, "type": "circle", "longitude": -100.27823091234, "sid": "4678", "cid": "246" }, { "polypath": [ { "lng": -99.3943706177472, "lat": 37.760219677827 }, { "lng": -99.6195903443097, "lat": 37.6385217160143 } ], "unit": "mile", "address": "Greensburg, KS 67054, USA", "latitude": 37.5741000760343, "type": "custom", "radius": 24.1195753931379, "longitude": -99.3311992310285, "sid": "4678", "cid": "246" } ], "blackListedDmaIds": "3,4", "whiteListedDeviceId": "123,jh34,jkd34", "blackListedHouseDistrictIds": "5202,1684,1685", "whiteListedCongressionalDistrictIds": "78,174,222", "stateIds": "30200031,30200032", "whiteListedStateIds": "30200031,30200032", "blackListedStateIds": "30200033,30200035", "blackListedZipcodes": "35007", "whiteListedSenateDistrictIds": "662,665,2303", "whiteListedHouseDistrictIds": "5096,5067,5201", "blackListedSenateDistrictIds": "2308,988,992", "whiteListedDmaIds": "1,2", "whiteListedZipcodes": "35005", "blackListedAudienceIds": "889185,888981", "whiteListedAudienceIds": "900254,900271", "blackListedCongressionalDistrictIds": "368,53,100", "isAdvanceAudioVideoTargeted": true, "creativeAdvanceTargeting": { "placementType": [20600001], "rollPosition": [20700001], "playerSize": [20800001], "skippability": [20900001], "playbackMethod": [21000001] }, "inventoryKeywords": [ "Clothing", "Education" ], "inventoryUrls": [ "https://www.google.com", "https://www.iqm.com" ] } }, "Update campaign with partial details.": { "description": "Update campaign with partial details.", "value": { "campaignName": "Sample campaign name ", "manufacturer": "451,155", "os": "11,14", "osVersion": "11,12,13", "exchanges": "27,21", "whiteListedIp": "df", "whiteListedPackageName": "sdf", "prebidAudienceSegmentIdList": [10, 11, 12], "whiteListedSiteDomain": "example,https://www.example.com", "blackListedDeviceId": "id1,id2", "blackListedIp": "id11,id22", "blackListedAppId": "id1, id2", "blackListedPackageName": "id1,id2", "blackListedSiteDomain": "https://www.example.com", "publisherAdCategory": "112", "userDealId": "1,2,b", "countryId": 246, "politicalAdvertiserClientId": 17, "locationFileIds": "1011,1010", "whiteListedLocationIds": "48377", "blackListedLocationIds": "48376,48363", "inventoryUrls": [ "https://www.google.com", "https://www.iqm.com" ] } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "update campaign with all details.": { "description": "update campaign with all details.", "value": { "statusCode": 201, "responseObject": { "data": 123456, "message": "Campaign saved successfully.", "status": "pending" } } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "examples": { "Validation error": { "description": "Validation error", "value": { "statusCode": 400, "responseObject": { "errorMsg": "zipcodes are modelled, so it can not be removed from this campaign", "errorCode": 400, "description": "uri=/api/v2/cmp/campaign/{campaignId}" } } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "statusCode": 500, "responseObject": { "errorMsg": "Internal server error", "errorCode": 500 } } } } } } } }, "/api/v3/internal/cmp/political/creatives": { "get": { "tags": [ "Campaign API" ], "summary": "Get campaigns with political advertisers and their creative IDs", "description": "This API fetches all campaigns that have political advertisers attached, along with their associated creative IDs. Returns a map where the key is the campaign ID and the value is a set of creative IDs.", "operationId": "getCampaignsWithPoliticalAdvertisers", "parameters": [ { "name": "advertiserIds", "in": "query", "description": "Optional list of political advertiser IDs to filter the results. If not provided, all political advertisers will be included.", "required": false, "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Get political advertiser creatives": { "description": "Get political advertiser creatives", "value": { "success": true, "data": { "1": [301316, 301444, 301442, 301443], "2": [122388, 121193], "3": [301510, 302758, 301511, 301315], "3074": [644506] } } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/internal/cmp/conversion/associated/campaign-list": { "get": { "tags": [ "Campaign API" ], "summary": "This api provides list of campaign details based on conversion id and ow id", "description": " This api provides list of basic campaign details which are associated with conversion", "operationId": "getAssociatedCampaignDetailsByConversionId", "parameters": [ { "name": "conversionId", "in": "query", "description": "ConversionId for which the campaign details needs to be fetched.", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "owId", "in": "query", "description": "OwId for searching the campaign details.", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Basic List": { "description": "This response contains all details about campaign as a list.", "value": { "success": true, "data": [ { "campaignId": 262423, "campaignName": "Campaign Name", "creativeTypeId": 17, "aiConversionId": 460, "status": "expired", "startTime": 1688705936, "endTime": 1869420800, "ioId": 1, "ioName": "Insertion Order Name", "ioStatusId": 1, "ioBudgetTypeId": 1, "conversionIds": "460" } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/internal/cmp/conversion/assigned/campaign-ids": { "get": { "tags": [ "Campaign API" ], "summary": "API for providing mapping of conversion id to campaign details", "description": "This API generates a list of conversion ids associated with campaigns details.", "operationId": "getCampaignIdsByConversionIds", "parameters": [ { "name": "conversionIds", "in": "query", "description": "Comma separated conversion ids whose mapping with campaign needs to be searched.", "required": true, "schema": { "type": "string" } }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "success": true, "data": { "data": [ { "conversionId": 143, "campaignCount": 3, "aiBasedConversion": true }, { "conversionId": 151, "campaignCount": 2, "aiBasedConversion": false } ], "totalRecords": 2, "filteredRecords": 2 } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden!" } ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/internal/cmp/conversion/allowed/campaign-list": { "get": { "tags": [ "Campaign API" ], "summary": "API for providing campaign details for conversion ids", "description": "This API generates a list of campaign details associated with conversion ids based on isGroup flag.Group details are fetched when isGroup is true otherwise basic list are fetched.", "operationId": "getCampaignGroupForConversion", "parameters": [ { "name": "conversionIds", "in": "query", "description": "Comma separated conversion ids whose mapping with campaign needs to be searched.", "required": false, "schema": { "type": "string" } }, { "name": "owId", "in": "query", "description": "OwId for searching the campaign details.", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "isGroup", "in": "query", "description": "Flag for fetching group details or basic details." }, { "name": "limit", "in": "query", "description": "The maximum number of returned results per page. ", "required": false, "schema": { "type": "integer", "format": "int32", "default": 50 } }, { "name": "pageNo", "in": "query", "description": "Page number for the required data. The default value is 1. ", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "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. ", "required": false, "schema": { "type": "string", "default": "-modified" } }, { "name": "conversionTypeId", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "searchField", "in": "query", "required": false, "schema": { "type": "string", "default": "" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Basic List": { "description": "This response contains all details about campaign as a list.", "value": { "success": true, "data": [ { "ioId": 1215, "ioName": "new name", "ioBudgetTypeId": 1, "ioStatusId": 1, "created": 1693886215726, "lastModified": 1695216128000, "owId": 201427, "uowId": 111357, "campaignCount": 1, "campaigns": [ { "id": 437060, "campaignId": 437060, "name": "Test-CB-2229", "creativeTypeId": 11, "status": "running", "startTime": 1793972800, "endTime": 0, "createdAt": 1694153838, "modifiedAt": 1695945600000, "owId": 201427, "ioId": 0, "ioName": null } ] } ] } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden!" } ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/cmp/static/io/status/list": { "get": { "tags": [ "Campaign API" ], "summary": "Gets the types of IO status which are currently permitted", "description": "This API fetches the IO status and its corresponding details like id, display_name, order and name.", "operationId": "getIOStatusTypeList", "parameters": [ { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Successful API response sample": { "description": "Successful API response sample", "value": { "success": true, "data": { "ioStatusList": [ { "name": "active", "id": 1, "label": "Active", "order": 1 }, { "name": "expired", "id": 2, "label": "Expired", "order": 2 }, { "name": "deleted", "id": 3, "label": "Deleted", "order": 3 } ], "totalRecords": 3, "filteredRecords": 3 } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden!" } ] } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "examples": { "Unprocessable entity": { "description": "Unprocessable entity", "value": { "success": false, "errorObjects": [ { "error": "Exception while fetching IO status Types Detailsø" } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/cmp/static/frequency-cap-types": { "get": { "tags": [ "Campaign API" ], "summary": "Get the frequency cap types.", "description": "This API returns the frequency cap types.", "operationId": "getFrequencyCapTypeList", "parameters": [ { "name": "frequencyCapTypeIds", "in": "query", "description": "Optional list of frequency cap type IDs to filter the results. If not provided, all active frequency cap types will be returned.", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "Successful retrieval of frequency cap types.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "errorObjects": { "type": "array", "items": { "type": "object", "properties": { "error": { "type": "string" }, "reason": { "type": "string" }, "field": { "type": "string" } } } }, "data": { "type": "object" } } }, "examples": { "Frequency Cap Types": { "description": "Frequency Cap Types", "value": "{ \"success\": true, \"data\": \"frequencyCapTypes\": [ { \"id\": 1, \"name\": \"days\", \"order\": 1, \"displayName\": \"Day(s)\", \"minDuration\": 1, \"maxDuration\": 6 }, { \"id\": 2, \"name\": \"weeks\", \"order\": 2, \"displayName\": \"Week(s)\", \"minDuration\": 1, \"maxDuration\": 3 }, { \"id\": 3, \"name\": \"months\", \"order\": 3, \"displayName\": \"Month(s)\", \"minDuration\": 1, \"maxDuration\": 3 }, { \"id\": 4, \"name\": \"campaign_duration\", \"order\": 4, \"displayName\": \"Campaign Duration\", \"minDuration\": null, \"maxDuration\": null } ] \"totalRecords\": 4, \"filteredRecords\": 4}" } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden!" } ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/cmp/static/campaign/estimator/dimension/list": { "get": { "tags": [ "Campaign API" ], "summary": "Get the campaign estimator supported parameter's list.", "description": "This api returns the list of supported parameters/dimensions for campaign estimator\u003Cbr\u003E.This is a static API.", "operationId": "getEstimatorDimensionList", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "success": true, "data": { "targetableAudience": { "countryIds": true, "stateIds": true, "countyIdsIncluded": true, "cityIdsIncluded": true, "zipCodesIncluded": true, "ethnicityIds": true, "ageIds": true, "genderIds": true, "incomeIds": true, "whitelistLocationJson": true, "deviceTypeIds": true }, "bidLandscapeEstimation": { "countryIds": false, "creativeRtbTypes": true, "creativeTypes": true, "maxBid": true, "deviceTypeNames": true, "whitelistCustomAudienceStateCodes": true, "stateCodes": true, "excludedExchangeNames": true, "dmaCodesIncluded": true, "whitelistCustomAudienceIds": true, "blacklistCustomAudienceIds": true, "whitelistDeviceIds": false, "whitelistCookieIds": false, "blacklistDeviceIds": true, "blacklistCookieIds": true, "whitelistAudienceSegmentsGroupCookieIds": true, "whitelistAudienceSegmentsGroupDeviceIds": true, "blacklistAudienceSegmentsGroupCookieIds": true, "blacklistAudienceSegmentsGroupDeviceIds": true, "campaignPublisherCategoryTargetingCodes": true, "campaignIabCategoryCodes": true, "dealIds": true, "whitelistInventoryGroupIds": true, "blacklistInventoryGroupIds": true, "whitelistSiteDomains": true, "blacklistSiteDomains": true, "whitelistAppIds": true, "blacklistAppIds": true, "whitelistAndroidPackages": true, "blacklistAndroidPackages": true, "excludedInventories": true, "exchangeURLs": true, "congressionalDistrictCodes": true, "senateDistrictCodes": true, "houseDistrictCodes": true, "zipCodes": true, "whitelistCustomAudienceZipCodes": true, "locationJson": true, "whitelistLocationJson": true, "trafficTypeNames": true } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/cmp/static/campaign/budget-type": { "get": { "tags": [ "Campaign API" ], "summary": "This API will provide the Values of budget type.", "description": "This API will provide the values of budget type.", "operationId": "getBudgetTypeList", "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "success": true, "data": { "totalRecords": 2, "filteredRecords": 2, "budgetTypeData": [ { "id": 1, "name": "budget", "label": "Budget", "order": 1 }, { "id": 2, "name": "impression", "label": "Impression", "order": 2 } ] } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/cmp/static/budget-distribution-method/list": { "get": { "tags": [ "Campaign API" ], "summary": "API for static list of budget distribution methods", "description": "This API provides details about static list of budget distribution methods. Also, if a budgetDistributionMethod is passed as a request parameter, then if budget method details of that Id are passed", "operationId": "getStaticBudgetDistributionList", "parameters": [ { "name": "budgetDistributionMethod", "in": "query", "description": "Id of budget distribution method for which budget distribution method is present or not.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "List of Budget Distribution Method": { "description": "List of Budget Distribution Method", "value": { "success": true, "data": { "budgetDistributionMethodData": [ { "name": "manual", "id": 1, "label": "Manual", "order": 1 }, { "name": "auto", "id": 2, "label": "Auto", "order": 2 } ], "totalRecords": 2, "filteredRecords": 2 } } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/cmp/locations/{fileId}/download": { "get": { "tags": [ "Campaign API" ], "summary": "This API return download URL of location file uploaded by user.", "description": "This API return download URL of location file uploaded by user.", "operationId": "downloadLocationData", "parameters": [ { "name": "fileId", "in": "path", "description": "File Id associated with user uploaded location file", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Get location data file download url": { "description": "Get location data file download url", "value": { "success": true, "data": { "locationFileUrl": "https://domain.com/locations.csv" } } } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "examples": { "Invalid location file id": { "description": "Invalid location file id", "value": { "success": false, "errorObjects": [ { "error": "Please provide valid file id value." } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/cmp/io/config": { "get": { "tags": [ "Campaign API" ], "summary": "API for getting the IO listing configurations", "description": "This api fetches the IO listing configuration for user.", "operationId": "getIOConfig", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "examples": { "Configuration JSON": { "description": "Configuration JSON", "value": { "success": true, "data": { "config": { "columnOrder": [ "ioId", "ioName", "ioTotalBudget", "ioStatusId", "ioStartTime", "impressions" ] } } } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/cmp/io/campaign/config": { "get": { "tags": [ "Campaign API" ], "summary": "API for fetching the campaign listing configurations", "description": "This api gets the campaign listing configuration for user.", "operationId": "getCampaignConfig", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "examples": { "Configuration JSON": { "description": "Configuration JSON", "value": { "success": true, "data": { "config": { "columnOrder": [ "ioId", "ioName", "ioTotalBudget", "ioStatusId", "ioStartTime", "impressions" ] } } } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/cmp/io/campaign/budget-impression/info": { "get": { "tags": [ "Campaign API" ], "summary": "Get IOs campaign's budget and spent information for an IO ", "description": "This API provides the IOs campaign's budget and spent for the given IO Id.", "operationId": "getBudgetAndImpressionInfoByIOId", "parameters": [ { "name": "ioId", "in": "query", "description": "ioId for which the budget and spent to be fetched.", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Successful API response sample": { "description": "Successful API response sample", "value": { "success": true, "data": { "totalAllocatedBudget": 0.01154397815666, "totalSpentBudget": 0.01154397815666, "totalAllocatedImpression": 0, "totalSpentImpression": 0, "totalImpressions": 0, "totalBudget": 0.011543 } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden!" } ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/cmp/io/advanced/list": { "get": { "tags": [ "Campaign API" ], "summary": "API to get details of insertion-order (IO) along with reports data.", "description": "This API provides the list of basic insertion order details with reports data, the reports data includes impressions, clicks, conversion count, etc.", "operationId": "getIOListWithReportData", "parameters": [ { "name": "searchField", "in": "query", "description": "Search the result by provided keyword in the searchField. Search Insertion-Order by name or id.", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "pageSize", "in": "query", "description": "The maximum number of returned results per page. ", "required": false, "schema": { "type": "integer", "format": "int32", "default": 20 } }, { "name": "offset", "in": "query", "description": "Offset for the pagination. If the offset is provided, the page number will not have affect on the result and API will provide the number of entries starting from the provided offset.", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNo", "in": "query", "description": "Page number for the required data. ", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "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, startTime, endTime, totalBudget", "required": false, "schema": { "type": "string", "default": "-ioId" } }, { "name": "startDate", "in": "query", "description": "It is date from which data need to be fetched", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "endDate", "in": "query", "description": "It is date till which data need to be fetched", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "budgetTypeIds", "in": "query", "description": "Budget types of IO that needs to be fetched", "required": false, "schema": { "type": "string" } }, { "name": "timeZoneId", "in": "query", "description": "It includes the filter for the timeZoneId for the campaigns details to be fetched.", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "ioStatusIds", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Success response": { "description": "Success response", "value": { "success": true, "data": { "totalRecords": 40, "recordsTotal": { "clicks": 0, "totalCount": 0, "winRate": 0, "logoURL": null, "avatarURL": null, "budgetDay": 0, "budgetSpent": 0, "ioTotalBudget": 4.444444444444444e+124, "dataCost": 0, "mediaBudget": 0, "owId": 0, "orgId": 0, "impressions": 0, "industry": 0, "mediaSpent": 0, "spent": 0, "bidImpressions": 0, "startCount": 0, "firstCount": 0, "midCount": 0, "thirdCount": 0, "completeCount": 0, "audioVideoActualBids": 0, "audioVideoActualImpressions": 0, "eCPC": 0, "totalECPC": 0, "eCPM": 0, "totalECPM": 0, "eCPI": 0, "eCPCV": 0, "eCPV": 0, "totalAttributedConversion": 0, "totalAttributedViewThroughConversion": 0, "totalAttributedClickThroughConversion": 0, "costPerAttributedConversion": 0, "totalAttributedConversionRate": 0, "reach": 0, "frequency": 0, "date": null, "campaignId": 0, "campaignName": null, "maxBid": 0, "ioStartTime": 0, "ioEndTime": 0, "campaignType": null, "status": null, "mappingDataCost": 0, "mappingSpent": 0, "campaignTimezone": null, "creativeType": null, "budgetPacing": false, "isCampaignFromNewPlatform": false, "percentageOfTotalSpent": 0, "uowId": 0, "audioVideoViewed": 0, "ioId": 0, "ioName": null, "ioTimezone": 0, "ioBudgetDistributionMethod": 0, "ioPacingPercentage": null, "ioActualSpent": 0, "ioExpectedSpent": 0, "ioDuration": null, "ioRemainingDuration": 0, "ioStatusId": 0, "campaignsCount": null, "exchangeId": 0, "exchangeName": null, "isAutoSumToTotalBudget": false, "budgetTotalCombined": 100, "budgetDayCombined": 10, "ioTotalBudgetCombined": 1000, "CTR": 0, "VCR": 0, "CVR": 0 }, "recordsList": [ { "clicks": 0, "totalCount": 0, "winRate": 0, "logoURL": null, "avatarURL": null, "budgetDay": 0, "budgetSpent": 0, "ioTotalBudget": 0, "dataCost": 0, "mediaBudget": 0, "owId": 0, "orgId": 0, "impressions": 0, "industry": 0, "mediaSpent": 0, "spent": 0, "bidImpressions": 0, "startCount": 0, "firstCount": 0, "midCount": 0, "thirdCount": 0, "completeCount": 0, "audioVideoActualBids": 0, "audioVideoActualImpressions": 0, "eCPC": 0, "totalECPC": 0, "eCPM": 0, "totalECPM": 0, "eCPI": 0, "eCPCV": 0, "eCPV": 0, "totalAttributedConversion": 0, "totalAttributedViewThroughConversion": 0, "totalAttributedClickThroughConversion": 0, "costPerAttributedConversion": 0, "totalAttributedConversionRate": 0, "reach": 0, "frequency": 0, "date": null, "campaignId": 0, "campaignName": null, "maxBid": 0, "ioStartTime": 1691735117664, "ioEndTime": 1691821517664, "campaignType": null, "status": null, "mappingDataCost": 0, "mappingSpent": 0, "campaignTimezone": null, "creativeType": null, "budgetPacing": false, "isCampaignFromNewPlatform": false, "percentageOfTotalSpent": 0, "uowId": 0, "audioVideoViewed": 0, "ioId": 124, "ioName": "Sample IO 1", "ioTimezone": 29, "ioPacingPercentage": 29.45, "ioActualSpent": 293, "ioExpectedSpent": 388, "ioDuration": 293, "ioRemainingDuration": 29, "ioBudgetDistributionMethod": 1, "ioStatusId": 1, "campaignsCount": 1, "exchangeId": 0, "exchangeName": null, "isAutoSumToTotalBudget": false, "budgetTotalCombined": 100, "budgetDayCombined": 10, "ioTotalBudgetCombined": 1000, "CTR": 0, "VCR": 0, "CVR": 0 }, { "clicks": 0, "totalCount": 0, "winRate": 0, "logoURL": null, "avatarURL": null, "budgetDay": 0, "budgetSpent": 0, "ioTotalBudget": 0, "dataCost": 0, "mediaBudget": 0, "owId": 0, "orgId": 0, "impressions": 0, "industry": 0, "mediaSpent": 0, "spent": 0, "bidImpressions": 0, "startCount": 0, "firstCount": 0, "midCount": 0, "thirdCount": 0, "completeCount": 0, "audioVideoActualBids": 0, "audioVideoActualImpressions": 0, "eCPC": 0, "totalECPC": 0, "eCPM": 0, "totalECPM": 0, "eCPI": 0, "eCPCV": 0, "eCPV": 0, "totalAttributedConversion": 0, "totalAttributedViewThroughConversion": 0, "totalAttributedClickThroughConversion": 0, "costPerAttributedConversion": 0, "totalAttributedConversionRate": 0, "reach": 0, "frequency": 0, "date": null, "campaignId": 0, "campaignName": null, "maxBid": 0, "ioStartTime": 1691734840109, "ioEndTime": 1691821240109, "campaignType": null, "status": null, "mappingDataCost": 0, "mappingSpent": 0, "campaignTimezone": null, "creativeType": null, "budgetPacing": false, "isCampaignFromNewPlatform": false, "percentageOfTotalSpent": 0, "uowId": 0, "audioVideoViewed": 0, "ioId": 125, "ioName": "Sample IO 2", "ioTimezone": 29, "ioBudgetTypeId": 1, "campaignsCount": 1, "ioTotalImpressions": 2934, "ioPacingPercentage": 29.45, "ioActualSpent": 293, "ioExpectedSpent": 388, "ioDuration": 293, "ioRemainingDuration": 29, "ioBudgetDistributionMethod": 1, "ioStatusId": 1, "exchangeId": 0, "exchangeName": null, "isAutoSumToTotalBudget": false, "budgetTotalCombined": 100, "budgetDayCombined": 10, "ioTotalBudgetCombined": 1000, "CTR": 0, "VCR": 0, "CVR": 0 } ] } } } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Invalid sortBy value." } ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/cmp/conversions/list": { "get": { "tags": [ "Campaign API" ], "summary": "Get all details of the postback or pixel conversion based on the given conversionIds ", "description": "This API will provide all the conversion details for provided comma separated string of conversionIds", "operationId": "getConversionDetailsByConversionIds", "parameters": [ { "name": "conversionIds", "in": "query", "description": "Comma separated string of conversionIds for which the data is to be fetched.", "required": true, "schema": { "type": "string" } }, { "name": "owId", "in": "query", "description": "Organization workspace ID. It will be owId of organization whose conversion details needs to be fetched.", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Get pixel conversion details": { "description": "Get pixel conversion details", "value": { "success": true, "data": { "totalRecords": 2, "conversionData": [ { "id": 3436, "name": "pixel conversion-1", "status": "Active", "created": 1688369815 }, { "id": 3434, "name": "pixel conversion-2", "status": "Active", "created": 1688369669 } ], "filteredRecords": 2 } } }, "Get postback conversion details": { "description": "Get postback conversion details", "value": { "success": true, "data": { "totalRecords": 1, "conversionData": [ { "id": 3903, "name": "App Track", "created": 1689147625, "partnerName": "Singular", "logoUrl": "https://logo-bucket/partners/singular.png" } ], "filteredRecords": 1 } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "examples": { "Get conversion details with invalid owId id.": { "description": "Get conversion details with invalid owId id.", "value": { "success": false, "errorObjects": [ { "error": "User is not allowed to access provided organization's conversions." } ] } } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "examples": { "Get conversion details with invalid conversion ids.": { "description": "Get conversion details with invalid conversion ids.", "value": { "success": false, "errorObjects": [ { "error": "Invalid conversion id." } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/cmp/conversion/basic/list": { "get": { "tags": [ "Campaign API" ], "summary": "List of basic conversion details based on conversionIds, owId and conversionTypeId", "description": "This api provides a paginated response of conversion details along with record count details", "operationId": "getBasicConversionDetailsListByOwId", "parameters": [ { "name": "includeConversionIds", "in": "query", "description": "Comma separated conversionIds. If provided, then api will return details for only those conversionIds.", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "excludeConversionIds", "in": "query", "description": "Comma separated conversionIds for excluding them from all conversions.", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "conversionTypeId", "in": "query", "description": "Ids of conversion type like pixel or postback for filtering the records. TypeIds should be from \"\"[typeIds](\" + APIDocumentConstants.URLConstants.CONVERSION_TYPE_API_DOC_URL + \") |\\n", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "searchField", "in": "query", "description": "Search the result by provided keyword in the searchField. ", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "limit", "in": "query", "description": "The maximum number of returned results per page. ", "required": false, "schema": { "type": "integer", "format": "int32", "default": 20 } }, { "name": "pageNo", "in": "query", "description": "Page number for the required data. The default value is 1. ", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "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. ", "required": false, "schema": { "type": "string", "default": "-created" } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Success": { "description": "Success", "value": { "success": true, "data": { "data": [ { "id": 3991, "name": "Name of Conversion", "uuid": "80543cfa18674057923df7aa1fa1f8d6", "typeId": 2, "owId": 201427, "createdByUowId": 9480, "modifiedByUowId": 9480, "statusId": 1, "created": 1689378218, "postbackPartnerId": 2 } ], "totalRecords": 28, "filteredRecords": 1 } } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "statusCode": 500, "responseObject": { "errorMsg": "Internal server error", "errorCode": 500 } } } } } } } }, "/api/v3/cmp/campaigns/{campaignTypeId}/deals": { "get": { "tags": [ "Campaign API" ], "summary": "Retrieves the list of PG or PMP deals associated with campaigns of a specified type", "description": "Returns the list of PG or PMP deals associated with campaigns of a specified type (1 for ADVANCED, which maps to PMP deals, 2 for PG, which maps to PG deals)", "operationId": "getDealsPerCampaign", "parameters": [ { "name": "campaignTypeId", "in": "path", "description": "The type of campaign (1 for ADVANCED, 2 for PG)", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "Successful retrieval of deals per campaign", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "errorObjects": { "type": "array", "items": { "type": "object", "properties": { "error": { "type": "string" }, "reason": { "type": "string" }, "field": { "type": "string" } } } }, "data": { "type": "object" } } }, "examples": { "Response including PG/PMP deals": { "description": "Response including PG/PMP deals", "value": { "success": true, "data": { "503584": [468, 469, 23], "503947": [468, 469], "504447": [468, 469], "504448": [589, 588], "505743": [468, 469], "505753": [468, 469], "505754": [468, 469], "505755": [588, 589], "505758": [468, 469] } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden!" } ] } } } }, "422": { "description": "Provided campaign type ID is not supported or recognized", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "errorObjects": { "type": "array", "items": { "type": "object", "properties": { "error": { "type": "string" }, "reason": { "type": "string" }, "field": { "type": "string" } } } }, "data": { "type": "object" } } }, "examples": { "Invalid campaign type ID": { "description": "Invalid campaign type ID", "value": { "success": false, "errorObjects": [ { "error": "Invalid campaign type ID: [7]" } ] } }, "Unsupported campaign type ID for PMP deals": { "description": "Unsupported campaign type ID for PMP deals", "value": { "success": false, "errorObjects": [ { "error": "Unsupported campaign type ID, PMP deals are not supported currently: [1]" } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/cmp/campaign/goal-ai/objectives-goals": { "get": { "tags": [ "Campaign API" ], "summary": "This API will provide the Values of Campaign Goal AI Objectives and Goals.", "description": "Get a list of Campaign Goal AI objectives and goals. No request body is required (GET). Requires Authorization and X-IAA-OW-ID headers. Uses the logged-in OW ID for context and access control. Response includes objective id, name, displayName, displayOrder, applicableGoals; and goals with id, name, displayName, compatibleCreativeTypes, kpi, minKpi, maxKpi, displayOrder.", "operationId": "getCampaignGoalAIObjectiveAndGoals", "parameters": [ { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "success": true, "data": { "objectives": [ { "id": 1, "name": "awareness", "displayName": "Awareness", "applicableGoals": [1, 2, 3, 4, 5, 8], "displayOrder": 1 }, { "id": 2, "name": "consideration", "displayName": "Consideration", "applicableGoals": [9, 10, 2, 3, 4], "displayOrder": 2 }, { "id": 3, "name": "conversion", "displayName": "Conversion", "applicableGoals": [11, 6, 7], "displayOrder": 3 } ], "goals": [ { "id": 1, "name": "increase_reach", "displayName": "Increase Reach", "compatibleCreativeTypes": [11, 13, 14, 15, 17], "kpi": null, "minKpi": 1, "maxKpi": 100, "displayOrder": 1 }, { "id": 2, "name": "increase_ctr", "displayName": "Increase CTR", "compatibleCreativeTypes": [11, 13, 14, 15, 17], "kpi": "CTR", "minKpi": 1, "maxKpi": 100, "displayOrder": 2 }, { "id": 3, "name": "increase_vcr", "displayName": "Increase VCR", "compatibleCreativeTypes": [14], "kpi": "VCR", "minKpi": 1, "maxKpi": 100, "displayOrder": 3 }, { "id": 4, "name": "increase_acr", "displayName": "Increase ACR", "compatibleCreativeTypes": [17], "kpi": "ACR", "minKpi": 1, "maxKpi": 100, "displayOrder": 4 }, { "id": 5, "name": "increase_viewable_impressions", "displayName": "Increase Viewable Impressions", "compatibleCreativeTypes": [11, 13, 14, 15], "kpi": "Viewable Impressions", "minKpi": 1, "maxKpi": 100, "displayOrder": 5 }, { "id": 6, "name": "increase_conversion_rate", "displayName": "Increase Conversion Rate", "compatibleCreativeTypes": [11, 13, 14, 15, 17], "kpi": "Conversion Rate", "minKpi": 1, "maxKpi": 100, "displayOrder": 6 }, { "id": 7, "name": "increase_roas", "displayName": "Increase ROAS", "compatibleCreativeTypes": [11, 13, 14, 15, 17], "kpi": "ROAS", "minKpi": 1, "maxKpi": 100, "displayOrder": 7 }, { "id": 8, "name": "reduce_cpm", "displayName": "Reduce CPM", "compatibleCreativeTypes": [11, 13, 14, 15, 17], "kpi": "CPM", "minKpi": 1, "maxKpi": 100, "displayOrder": 8 }, { "id": 9, "name": "reduce_cpc", "displayName": "Reduce CPC", "compatibleCreativeTypes": [11, 13, 14, 15, 17], "kpi": "CPC", "minKpi": 1, "maxKpi": 100, "displayOrder": 9 }, { "id": 10, "name": "reduce_cpcv", "displayName": "Reduce CPCV", "compatibleCreativeTypes": [14], "kpi": "CPCV", "minKpi": 1, "maxKpi": 100, "displayOrder": 10 }, { "id": 11, "name": "reduce_cpa", "displayName": "Reduce CPA", "compatibleCreativeTypes": [11, 13, 14, 15, 17], "kpi": "CPA", "minKpi": 1, "maxKpi": 100, "displayOrder": 11 } ] } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden!" } ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/internal/cmp/delete-device-cookie-audience-data/{campaignId}": { "delete": { "tags": [ "Campaign API" ], "summary": "This API will check and delete audience data from aerospike for given campaign", "operationId": "deleteDeviceCookieAudienceDataForCampaign", "parameters": [ { "name": "campaignId", "in": "path", "description": "Campaign Id", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "servingSets", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": "{\"success\":true,\"data\":\":true\"}}" } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v2/conversion/pixel": { "delete": { "tags": [ "Conversion API" ], "summary": "Conversion delete API", "operationId": "ConversiondeleteAPI", "parameters": [ { "name": "conversionIds", "in": "query", "description": "", "required": true, "style": "form", "explode": true, "schema": { "type": "string", "example": "2,3,4" } }, { "name": "X-IAA-OW-ID", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "{{ow_id}}" } }, { "name": "Authorization", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "{{bearer_token}}" } } ], "responses": { "200": { "description": "OK", "headers": { }, "content": { "application/json": { "schema": { "title": "m200", "required": [ "statusCode", "responseObject" ], "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "responseObject": { "title": "ResponseObject2", "required": [ "message" ], "type": "object", "properties": { "message": { "type": "string" } }, "example": { "message": "Pixel conversion deleted successfully." } } }, "example": { "statusCode": 200, "responseObject": { "message": "Pixel conversion deleted successfully." } } }, "example": { "statusCode": 200, "responseObject": { "message": "Pixel conversion deleted successfully." } } } } }, "400": { "description": "Bad Request", "headers": { }, "content": { "application/json": { "schema": { "title": "m4001", "required": [ "statusCode", "responseObject" ], "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "responseObject": { "title": "ResponseObject", "required": [ "errorMsg", "errorCode" ], "type": "object", "properties": { "errorMsg": { "type": "string" }, "errorCode": { "type": "integer", "format": "int32" } }, "example": { "errorMsg": "Invalid conversion id.", "errorCode": 400 } } }, "example": { "statusCode": 400, "responseObject": { "errorMsg": "Invalid conversion id.", "errorCode": 400 } } }, "example": { "statusCode": 400, "responseObject": { "errorMsg": "Invalid conversion id.", "errorCode": 400 } } } } } }, "deprecated": false, "security": [] } }, "/api/v2/conversion/list/basic": { "get": { "tags": [ "Conversion API" ], "summary": "Conversions basic list", "description": "## Get list of conversions with basic details(id, name, isROAS).\n\nGet list of all conversions with \"isROAS\" field in the response object. \"isROAS\" is boolean and is true for a conversion only if the conversion has either \"conversion value\" or \"financial metric\",This also support pagination, and search by id or name. This API is accessible only by an Advertiser.\n\n### SUPPORTED FEATURES: \n* Pagination. \n* Search by name or id.\n\n### HEADER: \n\n\n| Key | Sample Value |\n| ---------------- | ----------- | \n| x-iaa-api-token | hpZucdYn66n9PqYkqqJEikiib1J_zC8xmCvCbYF8LA |\n\n\n### PARAMS: \n\n\n| Key | Sample Value | Default value |\n| ---------------- | ----------- | ----- |\n| searchField | xyz | |\n| pageNo | 2 | -1 | \n| limit | hpZucdYn66n9PqYkqqJEikiib1J_zC8xmCvCbYF8LA | 10 | \n\n\n* If pageNo is set to -1, no pagination will be applied.", "operationId": "Conversionsbasiclist", "parameters": [ { "name": "searchField", "in": "query", "description": "", "required": true, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "", "required": true, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "pageNo", "in": "query", "description": "", "required": true, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "x-iaa-api-token", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "_V8DeeYlaciOhzXrjdQDh3Hxx6W/Aq_rvbLHyOq3tnQ" } } ], "responses": { "200": { "description": "OK", "headers": { "Transfer-Encoding": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "chunked" } } }, "Date": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fri, 13 Aug 2021 04:47:40 GMT" } } } }, "content": { "application/json;charset=UTF-8": { "schema": { "title": "200OK", "required": [ "statusCode", "responseObject" ], "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "responseObject": { "type": "array", "items": { "title": "ResponseObject7", "required": [ "id", "name", "isROAS" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "isROAS": { "type": "boolean" } }, "example": { "id": 4, "name": "ccc", "isROAS": true } }, "description": "" } }, "example": { "statusCode": 200, "responseObject": [ { "id": 4, "name": "ccc", "isROAS": true }, { "id": 5, "name": "test pixel", "isROAS": false }, { "id": 6, "name": "test pixel", "isROAS": true } ] } }, "example": { "statusCode": 200, "responseObject": [ { "id": 4, "name": "ccc", "isROAS": true }, { "id": 5, "name": "test pixel", "isROAS": false }, { "id": 6, "name": "test pixel", "isROAS": true } ] } } } }, "403": { "description": "Forbidden", "headers": { "Transfer-Encoding": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "chunked" } } }, "Date": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fri, 13 Aug 2021 04:49:29 GMT" } } } }, "content": { "application/json;charset=UTF-8": { "schema": { "title": "UnauthorisedAccess1", "required": [ "statusCode", "responseObject" ], "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "responseObject": { "title": "ResponseObject", "required": [ "errorMsg", "errorCode" ], "type": "object", "properties": { "errorMsg": { "type": "string" }, "errorCode": { "type": "integer", "format": "int32" } }, "example": { "errorMsg": "Invalid conversion id.", "errorCode": 400 } } }, "example": { "statusCode": 403, "responseObject": { "errorMsg": "User is not advertiser!", "errorCode": 403 } } }, "example": { "statusCode": 403, "responseObject": { "errorMsg": "User is not advertiser!", "errorCode": 403 } } } } }, "500": { "description": "Internal Server Error", "headers": { "Transfer-Encoding": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "chunked" } } }, "Date": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "Fri, 13 Aug 2021 04:58:13 GMT" } } }, "Connection": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "close" } } } }, "content": { "application/json;charset=UTF-8": { "schema": { "title": "internalServerError1", "required": [ "statusCode", "responseObject" ], "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "responseObject": { "title": "ResponseObject", "required": [ "errorMsg", "errorCode" ], "type": "object", "properties": { "errorMsg": { "type": "string" }, "errorCode": { "type": "integer", "format": "int32" } }, "example": { "errorMsg": "Invalid conversion id.", "errorCode": 400 } } }, "example": { "statusCode": 500, "responseObject": { "errorMsg": "server encountered an error !", "errorCode": 500 } } }, "example": { "statusCode": 500, "responseObject": { "errorMsg": "server encountered an error !", "errorCode": 500 } } } } } }, "deprecated": false } }, "/api/v3/internal/conversion/update/count": { "post": { "tags": [ "Conversion API" ], "summary": "Updates total conversions count , updates its status to active as well as send the email on status change.", "description": "These api updates total conversions count , updates its status to active as well as send the email on status change on basis of conversion UUID and its count map.", "operationId": "updateTotalConversionByUUIDList", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "integer", "format": "int32" } }, "examples": { "RequestBody updating Conversion count": { "description": "RequestBody updating Conversion count", "value": { "cf15bc21-d128-404a-898c-07914c16b914": 2, "df15bc21-d128-404a-898c-07914c16b914": 1 } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Success": { "description": "Success", "value": { "success": true, "data": "Total conversion count and status have been updated successfully." } } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "examples": { "Invalid conversion uuid": { "description": "Invalid conversion uuid", "value": { "success": false, "errorObjects": [ { "error": "Invalid conversion uuid." } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/internal/conversion/custom-field/list": { "post": { "tags": [ "Conversion API" ], "summary": "Get the list of conversion custom fields.", "description": "This API fetches the list of conversion's custom fields based on the given filter parameters.\n\n\n**Request Body Description:**\n\n| **Filed** | **Type** | **Description** |\n| --- | --- | --- |\n| owIds | Array of integer | [Optional] - List of Customer IDs for which custom fields list to be fetched. Default is all customer list, for default and owner customer it can be empty, but for other always provide the customers list. |\n| searchField | String | [Optional] - Search field for custom fields listing data. Search is supported for ID and name of the pixel and name name of the custom field. |\n| sortBy | String | [Optional] - Sort the result set by specific field. For ascending use plus(asc) and for descending use minus(desc) string. \u003Cbr\u003EDefault value is `-id`|\n| pageNo | Integer | [Optional] - Page number for the required data. \u003Cbr\u003EDefault value is `1`|\n| noOfEntries | Integer | [Optional] - The maximum number of returned results per page. \u003Cbr\u003EDefault value is `20`|\n", "operationId": "getConversionsCustomFieldList", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "sortCriteriaMap": { "type": "object", "additionalProperties": { "type": "string" } }, "pageNo": { "type": "integer", "format": "int32" }, "noOfEntries": { "type": "integer", "format": "int32" }, "sortBy": { "type": "string" }, "searchField": { "type": "string" }, "order": { "type": "string", "enum": [ "SortOrderEnum[id=1, name='asc', symbol='+']", "SortOrderEnum[id=2, name='desc', symbol='-']" ] }, "owIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } } } }, "examples": { "Custom Field list": { "description": "Custom Field list", "value": { "customerIds": [123, 234, 345], "pageNo": 1, "noOfEntries": 30, "sortBy": "id", "searchField": "Pixel" } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "success": true, "data": { "totalRecords": 10, "filterRecords": 3, "customFieldData": [ { "id": 3114, "pixelName": "Pixel Conversion 1", "customFieldName": "sample_one" }, { "id": 3114, "pixelName": "Pixel Conversion 1", "customFieldName": "sample_two" }, { "id": 3221, "pixelName": "Pixel Conversion 2", "customFieldName": "product_sales" } ] } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Invalid sortBy value." } ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/conversion/postback/add": { "post": { "tags": [ "Conversion API" ], "summary": "API for adding postback type conversion.", "description": "This API facilitates the insertion of postback type conversion records", "operationId": "addPostbackConversion", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "content": { "application/json": { "schema": { "required": [ "clickUrl", "impressionUrl", "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "maxLength": 255, "minLength": 0, "type": "string" }, "uuid": { "type": "string" }, "typeId": { "type": "integer", "format": "int32" }, "owId": { "type": "integer", "format": "int32" }, "createdByUowId": { "type": "integer", "format": "int32" }, "modifiedByUowId": { "type": "integer", "format": "int32" }, "statusId": { "type": "integer", "format": "int32" }, "status": { "type": "string" }, "created": { "type": "integer", "format": "int64" }, "postbackPartnerId": { "type": "integer", "format": "int32" }, "partnerTypeId": { "type": "integer", "format": "int32" }, "impressionUrl": { "type": "string" }, "clickUrl": { "type": "string" } } }, "examples": { "RequestBody for Adding Postback Conversion": { "description": "RequestBody for Adding Postback Conversion", "value": { "name": "testing postback", "partnerTypeId": "1", "impressionUrl": "https://imp.control.kochava.com/track/impression?campaign_id=kodragons-blade-1svu3szpd4b2be3253705&network_id=3603", "clickUrl": "https://control.kochava.com/v1/cpi/click?campaign_id?campaign_id=kodragons-blade-1svu3szpd4b2be3253705&network_id=3603" } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "success": true, "data": { "id": 3215, "name": "testing postback", "partnerName": null, "status": "Active", "type": "Postback", "created": 1687460629, "totalConversions": 0, "owId": 202017, "createdByUowId": 108658, "modifiedByUowId": 108658, "uuid": "879127abaab7459585b602b1f25dec41", "attributedConversions": 0, "attributedViewThroughConversions": 0, "attributedClickThroughConversions": 0, "pixelFinancialMetric": null, "postbackPartnerLogoURL": "http://partnerUrl/partnerName", "partnerUrl": "http://partnerUrl/partnerName" } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden !" } ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/conversion/pixel/send-email": { "post": { "tags": [ "Conversion API" ], "summary": "Send Email for Pixel Integration.", "description": "This API allows to send email containing information of integration pixel in html while allowing to customize subject and greeting text.", "operationId": "sendEmailForPixelConversion", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "content": { "application/json": { "schema": { "required": [ "emailSubject", "recipients" ], "type": "object", "properties": { "conversionId": { "type": "integer", "format": "int32" }, "recipients": { "type": "string" }, "recipientsList": { "type": "array", "items": { "type": "string" } }, "owId": { "type": "integer", "format": "int32" }, "uowId": { "type": "integer", "format": "int32" }, "emailSubject": { "type": "string" }, "emailText": { "type": "string" } } }, "examples": { "RequestBody for Sending Email for pixel integration": { "description": "RequestBody for Sending Email for pixel integration", "value": { "conversionId": 3114, "recipients": "username@gmail.com,anotherUser@yahoo.com", "emailSubject": "Integrate Pixel Conversion", "emailText": "Hello ${userName} has sent you a pixel code to integrate. Please follow the steps below to integrate the pixel code." } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "success": true, "data": "Pixel conversion e-mail sent successfully." } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden !" } ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/conversion/pixel/add": { "post": { "tags": [ "Conversion API" ], "summary": "Create Pixel type Conversion.", "description": "This api is used to create a pixel type conversion.", "operationId": "addPixelConversion", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "content": { "application/json": { "schema": { "required": [ "conversionSetting", "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "maxLength": 255, "minLength": 0, "type": "string" }, "uuid": { "type": "string" }, "typeId": { "type": "integer", "format": "int32" }, "owId": { "type": "integer", "format": "int32" }, "createdByUowId": { "type": "integer", "format": "int32" }, "modifiedByUowId": { "type": "integer", "format": "int32" }, "statusId": { "type": "integer", "format": "int32" }, "status": { "type": "string" }, "created": { "type": "integer", "format": "int64" }, "postbackPartnerId": { "type": "integer", "format": "int32" }, "attributionId": { "type": "integer", "format": "int32" }, "customFields": { "type": "array", "items": { "type": "string" } }, "financialMetrics": { "type": "string" }, "piggybackData": { "type": "object", "properties": { "url": { "type": "string" }, "type": { "type": "integer", "format": "int32" } } }, "pixelConversionScript": { "type": "string" }, "conversionSetting": { "required": [ "conversionDuration", "repeatConversion" ], "type": "object", "properties": { "conversionDuration": { "type": "object", "properties": { "view": { "maximum": 30, "minimum": 1, "type": "integer", "format": "int32" }, "click": { "maximum": 60, "minimum": 7, "type": "integer", "format": "int32" } } }, "repeatConversion": { "required": [ "count", "frequency", "unit" ], "type": "object", "properties": { "count": { "type": "integer", "format": "int32" }, "frequency": { "type": "integer", "format": "int32" }, "unit": { "type": "string" } } }, "crossModelling": { "type": "boolean" } } } } }, "examples": { "RequestBody for Adding Pixel Conversion": { "description": "RequestBody for Adding Pixel Conversion", "value": { "name": "PixelConversion", "attributionId": "1", "customFields": [ "field_1", "field_2", "field_3" ], "financialMetrics": "field_4", "piggybackData": { "url": "http://piggybackdata.com/url", "type": 1 }, "conversionSetting": { "conversionDuration": { "view": 10, "click": 10 }, "repeatConversion": { "count": 1, "frequency": 1, "unit": "Day" }, "crossModelling": true } } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "success": true, "data": { "id": 3213, "name": "PixelConversion", "postbackPartnerName": null, "status": "Pending", "type": "Pixel", "created": 1687459918, "totalConversions": 0, "owId": 202017, "createdByUowId": 108658, "modifiedByUowId": 108658, "uuid": "a574ca49cc244c3bb3089491a11aae43", "attributedConversions": 0, "attributedViewThroughConversions": 0, "attributedClickThroughConversions": 0, "pixelFinancialMetric": "name", "postbackPartnerLogoURL": null, "pixelConversionScript": "\u003Cscript src='https://pxl.stage.iqm.com/i/pixel/8f3165d0-b714-440e-bc1d-621127fa5fad?cv={CONVERSION_VALUE}' async\u003E\u003C/script\u003E", "partnerUrl": null } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden !" } ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/conversion/assign-to/campaign": { "post": { "tags": [ "Conversion API" ], "summary": "API for assign conversion to campaign", "description": "This api assigns conversion to campaign while validating the conversionIds as well as the campaignIds.", "operationId": "assignConversionToCampaign", "parameters": [ { "name": "assignConversionToCampaign", "in": "query", "description": "Map containing details list of campaignIds which needs to be added/removed." }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "conversionIdList": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "addCampaignsList": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "removeCampaignsList": { "type": "array", "items": { "type": "integer", "format": "int32" } } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Assign to Campaign with Valid CampaignIds and Valid ConversionIds": { "description": "This responses provides message for saved conversionIds and campaignIds.", "value": { "success": true, "data": { "conversionIdsList": 3925, "validAddCampaignIdsList": [253396, 256374], "invalidAddCampaignIdsList": [234567], "validRemoveCampaignIdsList": [256321, 256432], "invalidRemoveCampaignIdsList": [256433] } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden !" } ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/conversion/allowed/campaign-list": { "post": { "tags": [ "Conversion API" ], "summary": "API for providing allowed campaign details for conversion ids", "description": "This API fetches a list of campaign details which can be associated with provided conversion ids based on isGroup flag.Group details are fetched when isGroup is true otherwise basic list of campaigns are fetched.\n---\n\n\n**Request Body Details:**\n\n| **Field** | **Type** | **Description** |\n| --- | --- | --- |\n| pageNo `[optional]` | Number | Page number for the required data. The default value is 1. Setting the page number to -1 will disable pagination and return all data in a single page. |\n| noOfEntries `[optional]` | Number | The maximum number of returned results per page. The default value is 50. |\n| searchField `[optional]` | String | Search the result by provided keyword in the searchField. |\n| conversionIds `[required]` | Array of Integer | Conversion Ids which needs to be excluded from the campaign which have pixel conversions already attached. |\n| sortBy `[optional]` | String | Sort the result set by specific field. For ascending use plus(+) sign(ascii value '%2B') and for descending use minus(-) sign. |\n", "operationId": "getAttachableCampaignListByConversionIds", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "sortCriteriaMap": { "type": "object", "additionalProperties": { "type": "string" } }, "typeIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "owId": { "type": "integer", "format": "int32" }, "conversionIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "statusIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "postbackPartnerIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "pageNo": { "type": "integer", "format": "int32" }, "noOfEntries": { "type": "integer", "format": "int32" }, "sortBy": { "type": "string" }, "searchField": { "type": "string" }, "order": { "type": "string", "enum": [ "SortOrderEnum[id=1, name='asc', symbol='+']", "SortOrderEnum[id=2, name='desc', symbol='-']" ] } } }, "example": { "conversionIds": [5109, 5108, 5107], "pageNo": 1, "noOfEntries": 50, "searchField": "test", "sortBy": "ioId,-campaignId" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Basic Campaign List": { "description": "This response contains all details about campaign as a list.", "value": { "success": true, "data": [ { "ioId": 1215, "ioName": "new name", "ioBudgetTypeId": 1, "ioStatusId": 0, "created": 1693886215726, "lastModified": 1695216128000, "owId": 201427, "uowId": 111357, "campaignCount": 1, "campaigns": [ { "id": 437060, "campaignId": 437060, "name": "Test-CB-2229", "creativeTypeId": 11, "status": "running", "startTime": 1793972800, "endTime": 0, "createdAt": 1694153838, "modifiedAt": 1695945600000, "owId": 201427, "ioId": 0, "ioName": null } ] } ] } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden !" } ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/internal/conversion/{conversionUUID}/update/count": { "patch": { "tags": [ "Conversion API" ], "summary": "Updates total conversions count, updates its status to active as well as send the email on status change.", "description": "These api updates total conversions count , updates its status to active as well as send the email on status change on basis of conversion UUID.", "operationId": "updateTotalConversionByUUID", "parameters": [ { "name": "conversionUUID", "in": "path", "description": "Conversion UUID for which the total conversions and status needs to be updated.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Success": { "description": "Success", "value": { "success": true, "data": "Total conversion count and status have been updated successfully." } } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "examples": { "Invalid conversion uuid": { "description": "Invalid conversion uuid", "value": { "success": false, "errorObjects": [ { "error": "Invalid conversion uuid." } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } }, "deprecated": true } }, "/api/v3/conversion/postback/update": { "patch": { "tags": [ "Conversion API" ], "summary": "Update Postback type Conversion.", "description": "This api is used to update name of a postback type conversion.", "operationId": "updateConversion", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "content": { "application/json": { "schema": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "maxLength": 255, "minLength": 0, "type": "string" } } }, "examples": { "RequestBody for Updating Pixel Conversion": { "description": "RequestBody for Updating Pixel Conversion", "value": { "id": 3114, "name": "Postback Conversion Update testing" } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "success": true, "data": { "id": 3114, "name": "Postback Conversion Update testing" } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden !" } ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/conversion/pixel/update": { "patch": { "tags": [ "Conversion API" ], "summary": "Update Pixel type Conversion.", "description": "This api is used to update name and piggyback data of a pixel type conversion.", "operationId": "updateConversion_1", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "content": { "application/json": { "schema": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "maxLength": 255, "minLength": 0, "type": "string" }, "piggybackData": { "type": "object", "properties": { "url": { "type": "string" }, "type": { "type": "integer", "format": "int32" } } } } }, "examples": { "RequestBody for Updating Pixel Conversion": { "description": "RequestBody for Updating Pixel Conversion", "value": { "id": 3114, "name": "Pixel Conversion Update testing", "piggybackData": { "url": "update piggybackData", "type": 1 } } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "success": true, "data": { "id": 3114, "name": "Pixel Conversion Update testing", "piggybackData": { "url": "update piggybackData", "type": 1 } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden !" } ] } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Invalid conversion id." } ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/internal/conversion/{conversionUUID}": { "get": { "tags": [ "Conversion API" ], "summary": "Get Conversion details by conversion uuid", "description": "These api provides details about a conversion based on conversion uuid provided as a path variable", "operationId": "getConversionDetailByUUID", "parameters": [ { "name": "conversionUUID", "in": "path", "description": "Conversion UUID for which the conversion details needs to be fetched.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Conversion detail": { "description": "Conversion detail", "value": { "success": true, "data": { "statusId": 1, "customFields": [ "product_buy", "product_sales", "device_type", "sales", "product_revenue" ], "id": 3122, "conversionUUID": "9fd4ecdbb66845b5961b2e0c7e26ce85", "piggybackData": { "url": "piggybackurl", "type": 1 } } } } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "examples": { "Invalid conversion uuid": { "description": "Invalid conversion uuid", "value": { "success": false, "errorObjects": [ { "error": "Invalid conversion uuid." } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/internal/conversion/conversions/list": { "get": { "tags": [ "Conversion API" ], "summary": "Get all details of the postback or pixel conversion based on the given conversionIds ", "description": "This API will provide all the conversion details for provided comma separated string of conversionIds", "operationId": "getConversionDetailByConversionIds", "parameters": [ { "name": "conversionIds", "in": "query", "description": "List of conversionIds for which the data is to be fetched.", "required": true, "schema": { "type": "string" } }, { "name": "owId", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Get pixel conversion details": { "description": "Get pixel conversion details", "value": { "success": true, "data": { "totalRecords": 2, "conversionData": [ { "id": 3436, "name": "pixel conversion-1", "status": "Active", "created": 1688369815 }, { "id": 3434, "name": "pixel conversion-2", "status": "Active", "created": 1688369669 } ], "filteredRecords": 2 } } }, "Get postback conversion details": { "description": "Get postback conversion details", "value": { "success": true, "data": { "totalRecords": 1, "conversionData": [ { "id": 3903, "name": "App Track", "created": 1689147625, "partnerName": "Singular", "logoUrl": "https://logo-bucket/partners/singular.png" } ], "filteredRecords": 1 } } } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "examples": { "Get conversion details with invalid conversion ids.": { "description": "Get conversion details with invalid conversion ids.", "value": { "success": false, "errorObjects": [ { "error": "Invalid conversion id." } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/internal/conversion/basic/list": { "get": { "tags": [ "Conversion API" ], "summary": "List of basic conversion details based on conversionIds, owId and conversionTypeId", "description": "This api provides a paginated response of conversion details along with record count details", "operationId": "getBasicConversionDetailsByOwId", "parameters": [ { "name": "searchField", "in": "query", "description": "Search the result by provided keyword in the searchField. ", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "limit", "in": "query", "description": "The maximum number of returned results per page. ", "required": false, "schema": { "type": "integer", "format": "int32", "default": 20 } }, { "name": "pageNo", "in": "query", "description": "Page number for the required data. The default value is 1. ", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "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. ", "required": false, "schema": { "type": "string", "default": "-created" } }, { "name": "includeConversionIds", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "excludeConversionIds", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "conversionTypeId", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "owId", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Success": { "description": "Success", "value": { "success": true, "data": { "data": [ { "id": 3991, "name": "Name of Conversion", "uuid": "80543cfa18674057923df7aa1fa1f8d6", "typeId": 2, "owId": 201427, "createdByUowId": 9480, "modifiedByUowId": 9480, "statusId": 1, "created": 1689378218, "postbackPartnerId": 2 } ], "totalRecords": 28, "filteredRecords": 1 } } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/conversion/{conversionId}": { "get": { "tags": [ "Conversion API" ], "summary": "Get Conversion details by conversion id", "description": "These api provides details about a conversion based on conversion id provided as a path variable", "operationId": "getConversionDetailsById", "parameters": [ { "name": "conversionId", "in": "path", "description": "Id for which the conversion details needs to be fetched.", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "typeId", "in": "query", "description": "Type of conversion for which the details needs to fetched[typeIds](?path=/Conversion%20API/getListOfConversionTypes) |\n", "required": false, "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Pixel Based Conversion": { "description": "Pixel Based Conversion", "value": { "success": true, "data": { "id": 3121, "name": "PixelConversion", "uuid": "7e955ccbb92340f7b28c744eb876c9c6", "typeId": 1, "owId": 202017, "createdByUowId": 12121, "modifiedByUowId": 12121, "attributionId": 1, "statusId": 1, "customFields": [ "field_1", "field_2", "field_3" ], "financialMetrics": "field_1", "piggybackData": { "url": "http://thisPiggybackUrl.com/piggy", "type": 1 }, "pixelConversionScript": "\u003Cscript src='https://pxl.stage.iqm.com/i/pixel/7e955ccbb92340f7b28c744eb876c9c6?cv={CONVERSION_VALUE}' async\u003E\u003C/script\u003E", "conversionSetting": { "conversionDuration": { "view": 10, "click": 10 }, "repeatConversion": { "count": 1, "frequency": 1, "unit": "Day" }, "crossModelling": true } } } }, "Postback Based Conversion": { "description": "Postback Based Conversion", "value": { "success": true, "data": { "id": 3109, "name": "Postback Conversion", "uuid": "fb75a80c7b254234b910399f34be5482", "typeId": 2, "owId": 202017, "createdByUowId": 108658, "modifiedByUowId": 108658, "statusId": 0, "partnerTypeId": 1, "impressionUrl": "https://imp.control.kochava.com/track/impression?campaign_id=kodragons-blade-1svu3szpd4b2be3253705&network_id=3603", "clickUrl": "https://imp.control.kochava.com/track/impression?campaign_id=kodragons-blade-1svu3szpd4b2be3253705&network_id=3603" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden !" } ] } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Invalid conversion id." } ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/conversion/type-wise-count": { "get": { "tags": [ "Conversion API" ], "summary": "List of type wise Conversion count", "description": "This api provides details about number of conversion according to the type of conversions.", "operationId": "getConversionCountTypeWise", "parameters": [ { "name": "searchField", "in": "query", "description": "Search the result by provided keyword in the searchField. ", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "success": true, "data": [ { "conversionType": "PIXEL", "conversionCount": 1, "order": 1 }, { "conversionType": "POSTBACK", "conversionCount": 9, "order": 2 } ] } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden !" } ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/conversion/static/postback/partner-type": { "get": { "tags": [ "Conversion API" ], "summary": "Get list of partner types for postback type of conversion.", "description": "This api provides details about partner details for postback conversions like logo and name", "operationId": "getListOfConversionPartnerType", "parameters": [ { "name": "searchField", "in": "query", "description": "Search the result by provided keyword in the searchField. ", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "partnerTypeIds", "in": "query", "description": "This parameter is optional just as to provide support for filtering list based on partner type ids.", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "success": true, "data": { "data": [ { "id": 1, "name": "Kochava", "logoUrl": "https://logo-bucket/partners/kochava.com", "order": 1, "active": true }, { "id": 2, "name": "Singular", "logoUrl": "https://logo-bucket/partners/singular.net", "order": 2, "active": true }, { "id": 3, "name": "Appsflyr", "logoUrl": "https://logo-bucket/partners/appsflyer.com", "order": 3, "active": true }, { "id": 4, "name": "Adjust", "logoUrl": "https://logo-bucket/partners/adjust.com", "order": 4, "active": true } ], "totalRecords": 4, "filteredRecords": 4 } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden !" } ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/conversion/static/pixel/conversion-default-advanced-setting-data": { "get": { "tags": [ "Conversion API" ], "summary": "Get list of default value of advanced setting for pixel based conversion.", "description": "This api provides details about default values of advanced setting for pixel based conversions", "operationId": "getConversionDefaultAdvancedSettingData", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "success": true, "data": { "data": [ { "id": 1, "name": "post_click_interval", "displayName": "Post Click Interval", "value": "15", "active": true }, { "id": 2, "name": "post_view_interval", "displayName": "Post View Interval", "value": "28", "active": true }, { "id": 3, "name": "cross_device", "displayName": "Cross Device", "value": "true", "active": true } ], "totalRecords": 3, "filteredRecords": 3 } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden !" } ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/conversion/static/conversion-type": { "get": { "tags": [ "Conversion API" ], "summary": "Get list of conversion types.", "description": "This api provides details about conversion types i.e. pixel and postback", "operationId": "getListOfConversionTypes", "parameters": [ { "name": "searchField", "in": "query", "description": "Search the result by provided keyword in the searchField. ", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "conversionTypeIds", "in": "query", "description": "This parameter is optional just as to provide support for filtering list based on conversion type ids.", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "success": true, "data": { "data": [ { "id": 1, "name": "pixel", "displayName": "Pixel", "order": 1, "active": true }, { "id": 2, "name": "postback", "displayName": "Postback", "order": 2, "active": true } ], "totalRecords": 2, "filteredRecords": 2 } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden !" } ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/conversion/static/conversion-status": { "get": { "tags": [ "Conversion API" ], "summary": "Get list of conversion status.", "description": "This api provides details about conversion status i.e. active and pending", "operationId": "getListOfConversionStatus", "parameters": [ { "name": "searchField", "in": "query", "description": "Search the result by provided keyword in the searchField. ", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "statusIds", "in": "query", "description": "This parameter is optional just as to provide support for filtering list based on status ids.", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "success": true, "data": { "data": [ { "id": 1, "name": "active", "displayName": "Active", "order": 1, "active": true }, { "id": 2, "name": "pending", "displayName": "Pending", "order": 2, "active": true } ], "totalRecords": 2, "filteredRecords": 2 } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden !" } ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/conversion/static/conversion-piggyback-type": { "get": { "tags": [ "Conversion API" ], "summary": "Get list of conversion piggyback types.", "description": "This api provides details about conversion piggyback types i.e. image_pixel and javascript_pixel", "operationId": "getListOfConversionPiggybackTypes", "parameters": [ { "name": "searchField", "in": "query", "description": "Search the result by provided keyword in the searchField. ", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "piggybackTypeIds", "in": "query", "description": "This parameter is optional just as to provide support for filtering list based on piggyback type ids.", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "success": true, "data": { "data": [ { "id": 1, "name": "image_pixel", "displayName": "Image Pixel", "order": 1, "active": true }, { "id": 2, "name": "javascript_pixel", "displayName": "Javascript Pixel", "order": 2, "active": true } ], "totalRecords": 2, "filteredRecords": 2 } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden !" } ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/conversion/static/conversion-attribution-type": { "get": { "tags": [ "Conversion API" ], "summary": "Get list of conversion atttribution types.", "description": "This api provides details about conversion attribution types i.e. bybrid, click_based and view_based", "operationId": "getListOfConversionAttributionTypes", "parameters": [ { "name": "searchField", "in": "query", "description": "Search the result by provided keyword in the searchField. ", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "attributionTypeIds", "in": "query", "description": "This parameter is optional just as to provide support for filtering list based on attribution type ids.", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "success": true, "data": { "data": [ { "id": 1, "name": "hybrid", "displayName": "Hybrid", "order": 1, "active": true, "description": "this is a hybrid type of attribution" }, { "id": 2, "name": "click_based", "displayName": "Click Based", "order": 2, "active": true, "description": "This conversion attribution is based on the click." }, { "id": 3, "name": "view_based", "displayName": "View Based", "order": 3, "active": true, "description": "this is the view based conversion attribution type." } ], "totalRecords": 3, "filteredRecords": 3 } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden !" } ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/conversion/list": { "get": { "tags": [ "Conversion API" ], "summary": "Listing api for the Conversions", "description": "This api provides details for the listing of conversions with pagination searching on name and id along with sorting.", "operationId": "getConversionList", "parameters": [ { "name": "searchField", "in": "query", "description": "Search the result by provided keyword in the searchField. ", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "limit", "in": "query", "description": "The maximum number of returned results per page. ", "required": false, "schema": { "type": "integer", "format": "int32", "default": 20 } }, { "name": "pageNo", "in": "query", "description": "Page number for the required data. The default value is 1. ", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "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. ", "required": false, "schema": { "type": "string", "default": "-created" } }, { "name": "conversionIds", "in": "query", "description": "Conversion ids which needs to be searched.", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "typeIds", "in": "query", "description": "Ids of conversion type like pixel or postback for filtering the records. TypeIds should be from [typeIds](?path=/Conversion%20API/getListOfConversionTypes) |\n", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "statusIds", "in": "query", "description": "Ids of conversion status like pending or active for filtering the records. StatusIds should be from [statusIds](?path=/Conversion%20API/getListOfConversionStatus) |\n", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "postbackPartnerIds", "in": "query", "description": "Ids of postback conversion partner type for filtering the records. PartnerIds should be from [postbackPartnerIds](?path=/Conversion%20API/getListOfConversionPartnerType) |\n", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "success": true, "data": { "data": [ { "id": 2539, "name": "conversion-197", "postbackPartnerName": null, "status": "Active", "type": "Pixel", "created": 1677805806, "totalConversion": 0, "owId": 201352, "createdByUowId": 6255, "modifiedByUowId": 6255, "uuid": "8f3165d0-b714-440e-bc1d-621127fa5fad", "pixelConversionScript": "\u003Cscript src='https://pxl.stage.iqm.com/i/pixel/8f3165d0-b714-440e-bc1d-621127fa5fad?cv={CONVERSION_VALUE}' async\u003E\u003C/script\u003E", "attributedConversion": 0, "attributedViewThroughConversion": 0, "attributedClickThroughConversion": 0, "pixelFinancialMetric": "test_metric", "postbackPartnerLogoUrl": "https://logo-bucket/partners/kochava.com", "campaignCount": 0 } ], "totalRecords": 8, "filteredRecords": 1 } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden !" } ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/conversion/attached/campaigns/list": { "get": { "tags": [ "Conversion API" ], "summary": "API for providing campaign details for provided conversion id", "description": "This API fetches a list of campaign details attached with provided conversion id", "operationId": "getAttachedCampaignsListByConversionId", "parameters": [ { "name": "conversionId", "in": "query", "description": "Single conversion id whose mapping with campaign needs to be derived.", "required": false, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Get Campaign List For Provided Conversion": { "description": "This response contains all campaign details attached to the provided conversion id", "value": { "success": true, "data": [ { "campaignId": 1000, "campaignName": "Campaign - 1", "creativeTypeId": 17, "status": "expired", "startTime": 1888705936, "endTime": 1669420800, "ioId": 1, "ioName": "Insertion Order Name", "ioStatusId": 1, "ioBudgetTypeId": 1 } ], "totalRecords": 4, "filteredRecords": 1 } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden !" } ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/conversion/delete": { "delete": { "tags": [ "Conversion API" ], "summary": "Delete Conversion API ", "description": "The API provides a soft delete functionality for conversions.", "operationId": "deleteConversions", "parameters": [ { "name": "conversionIds", "in": "query", "description": "Multiple conversionIds separated with comma", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "success": true, "data": "Conversion has been deleted successfully!" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden !" } ] } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "examples": { "Invalid Conversion Id": { "description": "Invalid Conversion Id", "value": { "success": false, "errorObjects": [ { "error": "Invalid conversion id." } ] } }, "Attached To Campaign": { "description": "Attached To Campaign", "value": { "success": false, "errorObjects": [ { "error": "This conversion is associated with a running campaign and cannot be deleted" } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/crt/creatives/{creativeId}/html5": { "get": { "tags": [ "Creative API" ], "summary": "Fetch HTML5 creative content from S3", "description": "Retrieve the HTML5 content (index.html) stored in S3 for a specific HTML5 creative. This endpoint extracts the src attribute from the creative's iframe source, parses the S3 path, and fetches the content from S3.", "operationId": "getHtml5Content", "parameters": [ { "name": "creativeId", "in": "path", "description": "Unique ID of the HTML5 creative whose content is to be retrieved", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "HTML5 content retrieved successfully", "content": { "application/json": { "examples": { "HTML5 content fetched successfully": { "description": "HTML5 content fetched successfully", "value": { "success": true, "data": { "creativeId": 720273, "html5Content": "\u003C!DOCTYPE html\u003E\u003Chtml\u003E\u003Chead\u003E\u003Ctitle\u003ECreative\u003C/title\u003E\u003C/head\u003E\u003Cbody\u003E...\u003C/body\u003E\u003C/html\u003E", "s3Path": "assets/204876/eJP1zca_1772170251691/index.html" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden !" } ] } } } }, "422": { "description": "Unprocessable Entity - Invalid creative or missing HTML5 source", "content": { "application/json": { "examples": { "Creative not found": { "description": "Creative not found", "value": { "success": false, "errorObjects": [ { "error": "No creative details found for creativeId: 720273" } ] } }, "Unable to extract src from iframe": { "description": "Unable to extract src from iframe", "value": { "success": false, "errorObjects": [ { "error": "Unable to extract src from creative source for creativeId: 720273" } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } }, "put": { "tags": [ "Creative API" ], "summary": "Update HTML5 creative content in S3", "description": "Update the HTML5 content (index.html) stored in S3 for a specific HTML5 creative. This endpoint validates user edit access, uploads the new content to S3, increments the cb version parameter in the iframe src, and updates the creative record with modified timestamps.", "operationId": "updateHtml5Content", "parameters": [ { "name": "creativeId", "in": "path", "description": "Unique ID of the HTML5 creative whose content is to be updated", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "content": { "application/json": { "schema": { "required": [ "html5Content" ], "type": "object", "properties": { "creativeId": { "type": "integer", "format": "int32" }, "html5Content": { "type": "string" } } }, "examples": { "Update HTML5 content": { "description": "Update HTML5 content", "value": { "html5Content": "\u003C!DOCTYPE html\u003E\u003Chtml\u003E\u003Chead\u003E\u003Ctitle\u003EUpdated Creative\u003C/title\u003E\u003C/head\u003E\u003Cbody\u003E\u003Ch1\u003EUpdated Content\u003C/h1\u003E\u003C/body\u003E\u003C/html\u003E" } } } } }, "required": true }, "responses": { "200": { "description": "HTML5 content updated successfully", "content": { "application/json": { "examples": { "HTML5 content updated successfully": { "description": "HTML5 content updated successfully", "value": { "success": true, "data": { "creativeId": 720273, "s3Path": "assets/204876/eJP1zca_1772170251691/index.html?cb=2", "cbVersion": 2, "message": "HTML5 content updated successfully" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden !" } ] } } } }, "422": { "description": "Unprocessable Entity - Invalid creative or not HTML5 type", "content": { "application/json": { "examples": { "Not HTML5 creative": { "description": "Not HTML5 creative", "value": { "success": false, "errorObjects": [ { "error": "Creative with ID 720273 does not have html5 metadata. This is not an HTML5 creative." } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/internal/crt/creatives/list": { "post": { "tags": [ "Creative API" ], "summary": "To fetch creative detail list", "description": "This API will provide list of creatives with details", "operationId": "getCreatives", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "sortCriteriaMap": { "type": "object", "additionalProperties": { "type": "string" } }, "creativeStatusIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "platformCreativeTypeIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "creativeIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "creativeGroupId": { "type": "integer", "format": "int32" }, "campaignIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "owIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "allOwIds": { "type": "boolean" }, "includeCreativeSourceDetails": { "type": "boolean" }, "includeOrganizationDetails": { "type": "boolean" }, "includeUserDetails": { "type": "boolean" }, "startTime": { "type": "integer", "format": "int64" }, "endTime": { "type": "integer", "format": "int64" }, "pageNo": { "type": "integer", "format": "int32" }, "noOfEntries": { "type": "integer", "format": "int32" }, "sortBy": { "type": "string" }, "searchField": { "type": "string" }, "order": { "type": "string", "enum": [ "SortOrderEnum[id=1, name='asc', symbol='+']", "SortOrderEnum[id=2, name='desc', symbol='-']" ] } } }, "examples": { "Get creative list - Advertiser": { "description": "Get creative list - Advertiser", "value": { "creativeIds": [130141, 130142] } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Creative list": { "description": "Creative list", "value": " {\n \"success\": true,\n \"data\": {\n \"creativeDetailsList\": [\n {\n \"id\": 701520,\n \"name\": \"3aa0dc5d-3282-4732-bffa-917a2d3d5d8b\",\n \"rtbCreativeTypeId\": 1,\n \"platformCreativeTypeId\": 11,\n \"externalCreativeId\": \"\",\n \"statusId\": 1,\n \"creativeSource\": \"https://d3jme5si7t6llb.cloudfront.png\",\n \"mimeType\": \"image/png\",\n \"creativeScreenshotSource\": \"woEnRzZ_1737353231247.png\",\n \"clickUrl\": \"http://iqm.com\",\n \"internallyExcluded\": false,\n \"creativeMetadata\": {\n \"image\": {\n \"width\": 582,\n \"height\": 699\n }\n },\n \"sourceType\": \"url\",\n \"previewFlag\": 1,\n \"owId\": 0,\n \"createdByUowId\": 0,\n \"modifiedByUowId\": 0,\n \"createdAt\": 0\n },\n {\n \"id\": 701525,\n \"name\": \"Native Video Vast Url copy\",\n \"rtbCreativeTypeId\": 4,\n \"platformCreativeTypeId\": 15,\n \"subMediaType\": \"video\",\n \"statusId\": 1,\n \"creativeSource\": \"{\"2.0\":\"<VAST version="2.0&\"}\",\n \"creativeScreenshotSource\": \"MalegUQ_1702742343236.jpg\",\n \"internallyExcluded\": false,\n \"creativeMetadata\": {\n \"video\": {\n \"duration\": 30,\n \"xml_type\": \"wrapper\",\n \"creative_source_url\": \"https://cdn.com\",\n \"xml_version\": [\n 5,\n 6,\n 8,\n 12\n ],\n \"is_transformed\": true,\n \"tracking_data\": {}\n },\n \"native_metadata\": {\n \"title\": \"Fries\",\n \"description\": \"McD Desc\",\n \"cta_id\": 1,\n \"brand_name\": \"McDonalds\",\n \"brand_icon_height\": 0,\n \"brand_icon_width\": 0,\n \"brand_icon_source_url\": \"https://tempavcd.jpg\"\n }\n },\n \"sourceType\": \"vast-url\",\n \"previewFlag\": -1,\n \"owId\": 0,\n \"createdByUowId\": 0,\n \"modifiedByUowId\": 0,\n \"createdAt\": 0\n }\n ]\n }\n}\n" } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/crt/image/compress": { "post": { "tags": [ "Creative API" ], "summary": "Compress images uploaded by the user", "description": "This API compresses the images uploaded by the user, validates the file types and size, and returns the list of compressed image URLs.", "operationId": "compressImages", "parameters": [ { "name": "files", "in": "query", "description": "Array of Multipart files to be compressed", "required": true, "schema": { "type": "array", "items": { "type": "string", "format": "binary" } } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "Successfully compressed all the files", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "errorObjects": { "type": "array", "items": { "type": "object", "properties": { "error": { "type": "string" }, "reason": { "type": "string" }, "field": { "type": "string" } } } }, "data": { "type": "object" } } }, "examples": { "Success response of multiple compressed files": { "description": "Success response of multiple compressed files", "value": { "success": true, "data": [ { "fileName": "sample_1MB_img1.jpg", "originalSizeInBytes": 1042592, "compressedSizeInBytes": 138572, "compressedFileUrl": "https://tmpd3vsekqsh1zre3k8n-stage.s3.amazonaws.com/images/1730986298115-1730986300299.jpg" }, { "fileName": "Screenshot 2024-08-27 at 6.46.23 PM.png", "originalSizeInBytes": 916933, "compressedSizeInBytes": 230436, "compressedFileUrl": "https://tmpd3vsekqsh1zre3k8n-stage.s3.amazonaws.com/images/1730986298110-1730986302423.png" } ] } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden !" } ] } } } }, "422": { "description": "File with unsupported type is provided", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "errorObjects": { "type": "array", "items": { "type": "object", "properties": { "error": { "type": "string" }, "reason": { "type": "string" }, "field": { "type": "string" } } } }, "data": { "type": "object" } } }, "examples": { "Unsupported file error response": { "description": "Unsupported file error response", "value": { "success": false, "errorObjects": [ { "error": "Unsupported file type provided. Supported file types are: [jpg, jpeg, png, gif]" } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/crt/creatives": { "post": { "tags": [ "Creative API" ], "summary": "Add creative", "description": "This API allows you to create creatives of various types by providing the creative metadata and creative files. The API accepts a JSON payload with creative details and supports file uploads in the form of multipart form data. The API handles both the metadata and creative file uploads simultaneously.", "operationId": "createCreatives", "parameters": [ { "name": "creativeRequest", "in": "query", "description": "This parameter accepts a Map of UUIDs to creative details. Each UUID corresponds to a single creative. The metadata includes information such as creative name, external creative ID, creative type, and click URL. Additionally, the creative files are sent as multipart form data.", "required": true, "schema": { "type": "string" } }, { "name": "creativeFiles", "in": "query", "description": "Array of creative files uploaded as multipart files. These files will be used for creating the creatives. Each file is processed according to its type (image, video, etc.).", "required": false, "schema": { "type": "array", "items": { "type": "string", "format": "binary" } } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "content": { "application/json": { "examples": { "Create html creative": { "description": "Create html creative", "value": { "H001": { "creativeName": "html", "externalCreativeId": "google_421_dcm_435", "platformCreativeTypeId": 13, "creativeSourceType": "HTML", "creativeSource": "\u003Ca href=https://iqm.com/political?utm_medium=rtb&utm_campaign=wreckathon-2024-play-1\u003E\u003Cimg src=https://cdn-cfy-p0.iqm.com/wreckathon/2024/Images/w24-728x90-P.jpg\u003E\u003C/a\u003E", "clickUrl": "www.example.com", "htmlDetails": { "pixelUrls": [ "https://iqm.pixel.com" ], "creativeWidth": 500, "creativeHeight": 1200 } } } }, "Create image creative - file": { "description": "Create image creative - file", "value": { "I001": { "creativeName": "image-file", "externalCreativeId": "google_421_dcm_435", "platformCreativeTypeId": 11, "creativeSourceType": "FILE", "creativeSource": "green.jpeg", "clickUrl": "www.example.com", "imageDetails": { "pixelUrls": [ "www.example.com" ], "creativeWidth": 750, "creativeHeight": 750 } } } }, "Create image creative - URL": { "description": "Create image creative - URL", "value": { "I002": { "creativeName": "image-url", "externalCreativeId": "google_421_dcm_435", "platformCreativeTypeId": 11, "creativeSourceType": "URL", "creativeSource": "https://tmpd3vsekqsh1zre3k8n-stage.s3.amazonaws.com/Image/200001/Mcn7L08_1731899937158.png", "clickUrl": "www.example.com", "imageDetails": { "pixelUrls": [ "www.example.com" ], "creativeWidth": 3800, "creativeHeight": 2534 } } } }, "Create audio creative - file": { "description": "Create audio creative - file", "value": { "A001": { "creativeName": "audio-file", "externalCreativeId": "google_421_dcm_435", "platformCreativeTypeId": 17, "clickUrl": "www.example.com", "creativeSourceType": "FILE", "creativeSource": "38823f5d-8dea-40ed-8a53-78ff9910befa-wl.mp3", "audioDetails": { "duration": 15, "pixelUrls": [ "https://pixel1.iqm.com", "https://pixel2.iqm.com" ], "customTracking": { "startUrl": "www.example.com", "firstQuartileURL": "www.example.com", "midPointURL": "www.example.com", "thirdQuartileURL": "www.example.com", "completeURL": "www.example.com", "impressionURL": "www.example.com" }, "logoSource": "https://d15mohg007lzeb.cloudfront.net/mu/20241210/182931.406010-green.jpeg" } } } }, "Create audio creative - URL": { "description": "Create audio creative - URL", "value": { "A002": { "creativeName": "audio-url", "externalCreativeId": "google_421_dcm_435", "platformCreativeTypeId": 17, "clickUrl": "www.example.com", "creativeSourceType": "URL", "creativeSource": "https://d15mohg007lzeb.cloudfront.net/mu/20250116/163554.948946-38823f5d-8dea-40ed-8a53-78ff9910befa.mp3", "audioDetails": { "duration": 19, "pixelUrls": [ "https://pixel1.iqm.com", "https://pixel2.iqm.com" ], "customTracking": { "startUrl": "www.example.com", "firstQuartileURL": "www.example.com", "midPointURL": "www.example.com", "thirdQuartileURL": "www.example.com", "completeURL": "www.example.com", "impressionURL": "www.example.com" } } } } }, "Create audio creative - VAST URL": { "description": "Create audio creative - VAST URL", "value": { "A003": { "creativeName": "audio-vast-url", "externalCreativeId": "google_421_dcm_435", "platformCreativeTypeId": 17, "creativeSourceType": "VAST_URL", "creativeSource": "https://d15mohg007lzeb.cloudfront.net/mu/20241210/180837.894423-nisha-dev-audio-vast.xml" } } }, "Create audio creative - VAST XML": { "description": "Create audio creative - VAST XML", "value": { "A004": { "creativeName": "audio-vast", "externalCreativeId": "google_421_dcm_435", "platformCreativeTypeId": 17, "creativeSourceType": "VAST_XML", "creativeSource": "\u003CVAST ... \u003E...\u003C/VAST\u003E" } } }, "Create audio creative - DAAST URL": { "description": "Create audio creative - DAAST URL", "value": { "A005": { "creativeName": "audio-daast-url", "externalCreativeId": "google_421_dcm_435", "platformCreativeTypeId": 17, "creativeSourceType": "DAAST_URL", "creativeSource": "https://d15mohg007lzeb.cloudfront.net/mu/20241014/112237.434288-DAAST1_(1).xml" } } }, "Create audio creative - DAAST XML": { "description": "Create audio creative - DAAST XML", "value": { "A006": { "creativeName": "audio-daast", "externalCreativeId": "google_421_dcm_435", "platformCreativeTypeId": 17, "creativeSourceType": "DAAST_XML", "creativeSource": "\u003CDAAST ... \u003E...\u003C/DAAST\u003E" } } }, "Create video creative - file": { "description": "Create video creative - file", "value": { "V001": { "creativeName": "video-file", "externalCreativeId": "google_421_dcm_435", "platformCreativeTypeId": 14, "clickUrl": "www.example.com", "creativeSourceType": "FILE", "creativeSource": "4b2c2dca-6919-432a-9ac6-91405b8c4489.mp4", "videoDetails": { "creativeHeight": 2160, "creativeWidth": 4096, "duration": 22, "pixelUrls": [ "https://pixel1.iqm.com", "https://pixel2.iqm.com" ], "customTracking": { "startUrl": "www.example.com", "firstQuartileURL": "www.example.com", "midPointURL": "www.example.com", "thirdQuartileURL": "www.example.com", "completeURL": "www.example.com", "impressionURL": "www.example.com" } } } } }, "Create video creative - URL": { "description": "Create video creative - URL", "value": { "V002": { "creativeName": " video-url", "externalCreativeId": "google_421_dcm_435", "platformCreativeTypeId": 14, "clickUrl": "www.example.com", "creativeSourceType": "URL", "creativeSource": "https://d15mohg007lzeb.cloudfront.net/mu/20241204/094645.459858-4b2c2dca-6919-432a-9ac6-91405b8c4489.mp4", "videoDetails": { "creativeHeight": 2160, "creativeWidth": 4096, "duration": 22, "pixelUrls": [ "https://pixel1.iqm.com", "https://pixel2.iqm.com" ], "customTracking": { "startUrl": "www.example.com", "firstQuartileURL": "www.example.com", "midPointURL": "www.example.com", "thirdQuartileURL": "www.example.com", "completeURL": "www.example.com", "impressionURL": "www.example.com" } } } } }, "Create video creative - VAST URL": { "description": "Create video creative - VAST URL", "value": { "V003": { "creativeName": " vast-url", "externalCreativeId": "google_421_dcm_435", "platformCreativeTypeId": 14, "creativeSourceType": "VAST_URL", "creativeSource": "https://cdn-cfy-p0.iqm.com/wreckathon/2024/Videos/vast-static-DVP-15s-playbook.xml" } } }, "Create video creative - VAST XML": { "description": "Create video creative - VAST XML", "value": { "V004": { "creativeName": "video-vast", "externalCreativeId": "google_421_dcm_435", "platformCreativeTypeId": 14, "creativeSourceType": "VAST_XML", "creativeSource": "\u003CVAST ... \u003E...\u003C/VAST\u003E" } } }, "Create native image creative - file": { "description": "Create native image creative - file", "value": { "NI001": { "creativeName": "native-image-file", "externalCreativeId": "google_421_dcm_435", "subMediaType": "image", "platformCreativeTypeId": 15, "creativeSourceType": "FILE", "creativeSource": "image_creative.jpeg", "clickUrl": "www.example.com", "imageDetails": { "pixelUrls": [ "www.example.com" ] }, "nativeDetails": { "title": "Native image file upload", "description": "Native image file upload, with pixel url, no CTA", "brandName": "iqm", "brandIconSourceUrl": "https://d15mohg007lzeb.cloudfront.net/mu/20241210/182931.406010-green.jpeg", "brandIconHeight": 750, "brandIconWidth": 750 } } } }, "Create native image creative - URL": { "description": "Create native image creative - URL", "value": { "NI002": { "creativeName": "native-image-url", "externalCreativeId": "google_421_dcm_435", "subMediaType": "image", "platformCreativeTypeId": 15, "creativeSourceType": "URL", "creativeSource": "https://d3jme5si7t6llb.cloudfront.net/assets/201427/y4SLpav_1734345286762.jpeg", "clickUrl": "www.example.com", "imageDetails": { "pixelUrls": [ "www.example.com" ] }, "nativeDetails": { "title": "Native image url upload", "description": "Native image with pixel url and existing CTA", "brandName": "green", "brandIconSourceUrl": "https://d15mohg007lzeb.cloudfront.net/mu/20241210/182931.406010-green.jpeg", "brandIconHeight": 750, "brandIconWidth": 750 } } } }, "Create native video creative - file": { "description": "Create native video creative - file", "value": { "NV001": { "creativeName": "native-video-file", "externalCreativeId": "google_421_dcm_435", "subMediaType": "video", "platformCreativeTypeId": 15, "clickUrl": "www.example.com", "creativeSourceType": "FILE", "creativeSource": "4b2c2dca-6919-432a-9ac6-91405b8c4489.mp4", "videoDetails": { "creativeHeight": 2160, "creativeWidth": 4096, "duration": 22, "customTracking": { "startUrl": "www.example.com", "firstQuartileURL": "www.example.com", "midPointURL": "www.example.com", "thirdQuartileURL": "www.example.com", "completeURL": "www.example.com", "impressionURL": "www.example.com" } }, "nativeDetails": { "title": "native-video-file-title", "description": "native-video-file-description", "cta": { "id": 1, "ctaText": "Sign Up", "defaultCta": true }, "brandName": "green", "brandIconSourceUrl": "https://d15mohg007lzeb.cloudfront.net/mu/20241210/182931.406010-green.jpeg", "brandIconHeight": 750, "brandIconWidth": 750, "thumbnailSourceUrl": "https://d15mohg007lzeb.cloudfront.net/mu/20241210/182931.406010-green.jpeg", "thumbnailHeight": 750, "thumbnailWidth": 750 } } } }, "Create native video creative - URL": { "description": "Create native video creative - URL", "value": { "NV002": { "creativeName": "native-video-url", "externalCreativeId": "google_421_dcm_435", "subMediaType": "video", "platformCreativeTypeId": 15, "clickUrl": "www.example.com", "creativeSourceType": "URL", "creativeSource": "https://d15mohg007lzeb.cloudfront.net/mu/20241204/094645.459858-4b2c2dca-6919-432a-9ac6-91405b8c4489.mp4", "videoDetails": { "creativeHeight": 2160, "creativeWidth": 4096, "duration": 22, "customTracking": { "startUrl": "www.example.com", "firstQuartileURL": "www.example.com", "midPointURL": "www.example.com", "thirdQuartileURL": "www.example.com", "completeURL": "www.example.com", "impressionURL": "www.example.com" } }, "nativeDetails": { "title": "native-video-url-title", "description": "native-video-url-description", "cta": { "id": 1, "ctaText": "Sign Up", "defaultCta": true }, "brandName": "green", "brandIconSourceUrl": "https://d15mohg007lzeb.cloudfront.net/mu/20241210/182931.406010-green.jpeg", "brandIconHeight": 750, "brandIconWidth": 750, "thumbnailSourceUrl": "https://d15mohg007lzeb.cloudfront.net/mu/20241210/182931.406010-green.jpeg", "thumbnailHeight": 750, "thumbnailWidth": 750 } } } }, "Create native video creative - VAST URL": { "description": "Create native video creative - VAST URL", "value": { "NV003": { "creativeName": " native-video-vast-url", "externalCreativeId": "google_421_dcm_435", "platformCreativeTypeId": 15, "subMediaType": "video", "creativeSourceType": "VAST_URL", "creativeSource": "https://cdn-cfy-p0.iqm.com/wreckathon/2024/Videos/vast-static-DVP-15s-playbook.xml", "nativeDetails": { "title": "native-video-url-title", "description": "native-video-url-description", "cta": { "id": 1, "ctaText": "Sign Up", "defaultCta": true }, "brandName": "green", "brandIconSourceUrl": "https://d15mohg007lzeb.cloudfront.net/mu/20241210/182931.406010-green.jpeg", "brandIconHeight": 750, "brandIconWidth": 750, "thumbnailSourceUrl": "https://d15mohg007lzeb.cloudfront.net/mu/20241210/182931.406010-green.jpeg", "thumbnailHeight": 750, "thumbnailWidth": 750 } } } }, "Create native video creative - VAST XML": { "description": "Create native video creative - VAST XML", "value": { "NV004": { "creativeName": "native-video-vast-xml", "externalCreativeId": "google_421_dcm_435", "subMediaType": "video", "platformCreativeTypeId": 15, "creativeSourceType": "VAST_XML", "creativeSource": "\u003CVAST ... \u003E...\u003C/VAST\u003E", "nativeDetails": { "title": "native-video-url-title", "description": "native-video-url-description", "cta": { "id": 1, "ctaText": "Sign Up", "defaultCta": true }, "brandName": "green", "brandIconSourceUrl": "https://d15mohg007lzeb.cloudfront.net/mu/20241210/182931.406010-green.jpeg", "brandIconHeight": 750, "brandIconWidth": 750, "thumbnailSourceUrl": "https://d15mohg007lzeb.cloudfront.net/mu/20241210/182931.406010-green.jpeg", "thumbnailHeight": 750, "thumbnailWidth": 750 } } } }, "Create Creatives - partial success and partial failure": { "description": "Create Creatives - partial success and partial failure", "value": { "PS": { "creativeName": "audio-file-attached", "externalCreativeId": "google_421_dcm_435", "platformCreativeTypeId": 17, "clickUrl": "www.example.com", "creativeSourceType": "FILE", "creativeSource": "38823f5d-8dea-40ed-8a53-78ff9910befa.mp3", "audioDetails": { "duration": 15, "customTracking": { "startUrl": "www.example.com", "firstQuartileURL": "www.example.com", "midPointURL": "www.example.com", "thirdQuartileURL": "www.example.com", "completeURL": "www.example.com", "impressionURL": "www.example.com" }, "logoSource": "https://d15mohg007lzeb.cloudfront.net/mu/20241210/182931.406010-green.jpeg" } }, "PF": { "creativeName": "audio-file-not-attached", "externalCreativeId": "google_421_dcm_435", "platformCreativeTypeId": 17, "clickUrl": "www.example.com", "creativeSourceType": "FILE", "creativeSource": "38823f5d-8dea-40ed-8a53-78ff9910befa-wl.mp3", "audioDetails": { "duration": 15, "customTracking": { "startUrl": "www.example.com", "firstQuartileURL": "www.example.com", "midPointURL": "www.example.com", "thirdQuartileURL": "www.example.com", "completeURL": "www.example.com", "impressionURL": "www.example.com" }, "logoSource": "https://d15mohg007lzeb.cloudfront.net/mu/20241210/182931.406010-green.jpeg" } } } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Create Creatives - partial success and partial failure": { "description": "Create Creatives - partial success and partial failure", "value": { "success": true, "data": { "successData": { "PS": "701388" }, "failedData": { "PF": "Creative file missing. Please attach the required file. : null" } } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden !" } ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/crt/creatives/list": { "post": { "tags": [ "Creative API" ], "summary": "To fetch creative detail list", "description": "This API will provide list of creatives with details", "operationId": "getCreatives_1", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "sortCriteriaMap": { "type": "object", "additionalProperties": { "type": "string" } }, "creativeStatusIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "platformCreativeTypeIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "creativeIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "creativeGroupId": { "type": "integer", "format": "int32" }, "campaignIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "owIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "allOwIds": { "type": "boolean" }, "includeCreativeSourceDetails": { "type": "boolean" }, "includeOrganizationDetails": { "type": "boolean" }, "includeUserDetails": { "type": "boolean" }, "startTime": { "type": "integer", "format": "int64" }, "endTime": { "type": "integer", "format": "int64" }, "pageNo": { "type": "integer", "format": "int32" }, "noOfEntries": { "type": "integer", "format": "int32" }, "sortBy": { "type": "string" }, "searchField": { "type": "string" }, "order": { "type": "string", "enum": [ "SortOrderEnum[id=1, name='asc', symbol='+']", "SortOrderEnum[id=2, name='desc', symbol='-']" ] } } }, "examples": { "Get creative list - Advertiser": { "description": "Get creative list - Advertiser", "value": { "pageNo": 1, "noOfEntries": 2, "sortBy": "-creativeId", "searchField": "creative", "platformCreativeTypeIds": [11, 13, 14, 15, 17], "creativeStatusIds": [1, 2, 3, 4], "creativeIds": [130141, 130142], "creativeGroupId": null, "campaignIds": [20141], "startTime": 1734998399000, "endTime": 1735206867000, "includeCreativeSourceDetails": true, "includeOrganizationDetails": false, "includeUserDetails": false } }, "Get creative list - Super/Workspace": { "description": "Get creative list - Super/Workspace", "value": { "pageNo": 1, "noOfEntries": 2, "sortBy": "-creativeId", "searchField": "creative", "platformCreativeTypeIds": [11, 13, 14, 15, 17], "creativeStatusIds": [1, 2, 3, 4], "creativeIds": [130141, 130142], "creativeGroupId": null, "campaignIds": [20141], "startTime": 1734998399000, "endTime": 1735206867000, "owIds": [201353], "allOwIds": true, "includeOrganizationDetails": true, "includeUserDetails": true } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Creative list - Advertiser": { "description": "Creative list - Advertiser", "value": { "success": true, "data": { "totalRecords": 120, "filteredRecords": 2, "filteredList": [ { "creativeId": 130141, "creativeName": "Creative 1", "platformCreativeTypeId": 11, "creativeStatusId": 2, "creativePreviewFlag": 1, "creativeSourceType": "file", "creativeSource": "https://cdn-cfy-p0.iqm.com/image/457/3W8FRdl_1671813949060.gif", "creativeThumbnailSource": "https://d3jme5si7t6llb.cloudfront.net/Screenshots/201353/136x82/3W8FRdl_1671813949060.gif", "creativeCardSource": "https://d3jme5si7t6llb.cloudfront.net/Screenshots/201353/278x220/3W8FRdl_1671813949060.gif", "createdAt": 1671813949233, "modifiedAt": 1671819653000, "clickUrl": "https://example.com/id=130141", "creativeHeight": 50, "creativeWidth": 320, "campaignDetails": { "campaignIds": [20141] }, "userDetails": { "uowId": 981 }, "organizationDetails": { "owId": 201353 } }, { "creativeId": 130142, "creativeName": "Creative 2", "platformCreativeTypeId": 14, "creativeStatusId": 2, "creativePreviewFlag": 1, "creativeSourceType": "file", "creativeSource": "<VAST xmlns="http://www.iab.com/VAST" version="4.0"> <Ad conditionalAd="false" id="{IAA_CREATIVE_ID}" sequence="1"> <InLine> <AdSystem version="4.0">4.0</AdSystem> <Impression id="Impression-ID"> <![CDATA[http://example.com/track/impression]]> </Impression> </InLine> </Ad> </VAST>", "creativeThumbnailSource": "https://d3jme5si7t6llb.cloudfront.net/Screenshots/201353/136x82/EQ4SWN1_1671813949262.png", "creativeCardSource": "https://d3jme5si7t6llb.cloudfront.net/Screenshots/201353/278x220/EQ4SWN1_1671813949262.png", "createdAt": 1671813949351, "modifiedAt": 1671819653000, "clickUrl": "https://example.com/id=130142", "duration": 16, "campaignDetails": { "campaignIds": [20141] }, "userDetails": { "uowId": 981 }, "organizationDetails": { "owId": 201353 } } ] } } }, "Creative list - Super/Workspace": { "description": "Creative list - Super/Workspace", "value": { "success": true, "data": { "totalRecords": 120, "filteredRecords": 2, "filteredList": [ { "creativeId": 130141, "creativeName": "Creative 1", "platformCreativeTypeId": 11, "creativeStatusId": 2, "creativePreviewFlag": 1, "creativeSourceType": "file", "creativeThumbnailSource": "https://d3jme5si7t6llb.cloudfront.net/Screenshots/201353/136x82/3W8FRdl_1671813949060.gif", "creativeCardSource": "https://d3jme5si7t6llb.cloudfront.net/Screenshots/201353/278x220/3W8FRdl_1671813949060.gif", "createdAt": 1671813949233, "modifiedAt": 1671819653000, "clickUrl": "https://example.com/id=130141", "pixelUrls": [ "http://app.iqm.com" ], "creativeHeight": 50, "creativeWidth": 320, "subMediaType": "Image", "approvalRequiredPostUrlUpdate": true, "campaignDetails": { "campaignIds": [20141] }, "userDetails": { "uowId": 981, "userName": "User Name", "userEmail": "email@domain.com", "hasEditAccess": true, "hasApprovalAccess": true }, "organizationDetails": { "owId": 201353, "organizationName": "Organization Name", "organizationLogo": "https://iqm-web-assets-c92d6b6cbde1-stage.s3.amazonaws.com/avatar/ON.png" } }, { "creativeId": 130142, "creativeName": "Creative 2", "platformCreativeTypeId": 14, "creativeStatusId": 2, "creativePreviewFlag": 1, "creativeSourceType": "file", "creativeThumbnailSource": "https://d3jme5si7t6llb.cloudfront.net/Screenshots/201353/136x82/EQ4SWN1_1671813949262.png", "creativeCardSource": "https://d3jme5si7t6llb.cloudfront.net/Screenshots/201353/278x220/EQ4SWN1_1671813949262.png", "createdAt": 1671813949351, "modifiedAt": 1671819653000, "clickUrl": "https://example.com/id=130142", "duration": 16, "subMediaType": "Video", "approvalRequiredPostUrlUpdate": false, "campaignDetails": { "campaignIds": [20141] }, "userDetails": { "uowId": 981, "userName": "User Name", "userEmail": "email@domain.com", "hasEditAccess": true, "hasApprovalAccess": true }, "organizationDetails": { "owId": 201353, "organizationName": "Organization Name", "organizationLogo": "https://iqm-web-assets-c92d6b6cbde1-stage.s3.amazonaws.com/avatar/ON.png" } } ] } } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/crt/creatives/groups": { "post": { "tags": [ "Creative API" ], "summary": "Create a new creative group", "description": "Create a new creative group and add the provided creatives to the group (mapping table).", "operationId": "createCreativeGroup", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "content": { "application/json": { "schema": { "required": [ "creativeGroupName", "creativeIds", "creativeTypeId" ], "type": "object", "properties": { "creativeGroupName": { "maxLength": 255, "minLength": 1, "type": "string" }, "creativeIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "creativeTypeId": { "type": "integer", "format": "int32" } } }, "examples": { "Create Creative Group Request": { "description": "Create Creative Group Request", "value": { "creativeGroupName": "Group Name", "creativeTypeId": 1, "creativeIds": [1, 2, 3] } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Group created successfully": { "description": "Group created successfully", "value": { "success": true, "data": { "creativeGroupId": 45089, "message": "testCreatives group created successfully" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden !" } ] } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "examples": { "Creative Ids are invalid": { "description": "Creative Ids are invalid", "value": { "success": false, "errorObjects": [ { "error": "Invalid creative ids found. Please provide valid creative ids" } ] } }, "Creative ids have multiple creative types": { "description": "Creative ids have multiple creative types", "value": { "success": false, "errorObjects": [ { "error": "Selected creatives are of different types. Please ensure all selected creatives have the same creative type for assigning them to a group" } ] } }, "Creative type is invalid": { "description": "Creative type is invalid", "value": { "success": false, "errorObjects": [ { "error": "Creative type of all the creatives must be same as the provided creative type" } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } }, "delete": { "tags": [ "Creative API" ], "summary": "Delete creative group", "description": "Delete the provided creative group(s), and remove the mapping of creatives from the group(s).\nThe API will soft delete the group(s) and remove the mapping of creatives from the group(s).\n", "operationId": "deleteCreativeGroups", "parameters": [ { "name": "creativeGroupIds", "in": "query", "description": "Comma-separated list of creative group Ids to delete.", "required": true, "schema": { "type": "array", "example": "1,2,3" } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Single group deleted successfully": { "description": "Single group deleted successfully", "value": { "success": true, "data": { "message": "creativeGroup group deleted successfully" } } }, "Multiple groups deleted successfully": { "description": "Multiple groups deleted successfully", "value": { "success": true, "data": { "message": "2 groups deleted successfully" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden !" } ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/crt/creatives/groups/modify-creatives": { "post": { "tags": [ "Creative API" ], "summary": "Add or remove creatives from creative groups", "description": "API to add or remove creatives from creative groups. The input includes creative IDs, group IDs, and an action type ('add' or 'remove'). For the 'add' action, the API will add the specified creatives to the provided groups. Creatives already present in the groups will be ignored. For the 'remove' action, the API will remove the specified creatives from the provided groups. If any of the creatives are not present in the groups, an exception will be thrown.", "operationId": "modifyCreativesInGroups", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "content": { "application/json": { "schema": { "required": [ "actionType", "creativeGroupIds", "creativeIds" ], "type": "object", "properties": { "creativeIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "creativeGroupIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "actionType": { "type": "string", "enum": [ "ADD", "REMOVE" ] } } }, "examples": { "Add Creatives to Groups Request": { "description": "Add Creatives to Groups Request", "value": { "creativeIds": [123456, 123457], "creativeGroupIds": [1, 2], "action": "ADD" } }, "Remove Creatives from Groups Request": { "description": "Remove Creatives from Groups Request", "value": { "creativeIds": [123456, 123457], "creativeGroupIds": [1, 2], "action": "REMOVE" } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Multiple creatives added to single group successfully": { "description": "Multiple creatives added to single group successfully", "value": { "success": true, "data": { "message": "2 creatives added to Group_06 group successfully" } } }, "Multiple creatives added to Multiple groups successfully": { "description": "Multiple creatives added to Multiple groups successfully", "value": { "success": true, "data": { "message": "2 creatives added to 2 groups successfully" } } }, "single creative added to single group successfully": { "description": "single creative added to single group successfully", "value": { "success": true, "data": { "message": "SampleHtml2 creative added to Group_06 group successfully" } } }, "Multiple creatives removed from Multiple groups successfully": { "description": "Multiple creatives removed from Multiple groups successfully", "value": { "success": true, "data": { "message": "2 creatives removed from 2 groups successfully" } } }, "single creative removed from single group successfully": { "description": "single creative removed from single group successfully", "value": { "success": true, "data": { "message": "SampleHtml2 creative removed from Group_06 group successfully" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden !" } ] } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "examples": { "Invalid group id(s) found": { "description": "Invalid group id(s) found", "value": { "success": false, "errorObjects": [ { "error": "Invalid group ids found. Please provide valid group ids" } ] } }, "Invalid creative id(s) found": { "description": "Invalid creative id(s) found", "value": { "success": false, "errorObjects": [ { "error": "Invalid creative ids found. Please provide valid creative ids" } ] } }, "Creative ids have multiple creative types": { "description": "Creative ids have multiple creative types", "value": { "success": false, "errorObjects": [ { "error": "Selected creatives are of different types. Please ensure all selected creatives have the same creative type for assigning them to a group" } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/crt/creatives/groups/list": { "post": { "tags": [ "Creative API" ], "summary": "To fetch creative group list", "description": "This API will provide list of creative groups", "operationId": "getCreativeGroupList", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "sortCriteriaMap": { "type": "object", "additionalProperties": { "type": "string" } }, "platformCreativeTypeIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "creativeStatusIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "creativeGroupIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "startTime": { "type": "integer", "format": "int64" }, "endTime": { "type": "integer", "format": "int64" }, "owIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "allOwIds": { "type": "boolean" }, "pageNo": { "type": "integer", "format": "int32" }, "noOfEntries": { "type": "integer", "format": "int32" }, "sortBy": { "type": "string" }, "searchField": { "type": "string" }, "order": { "type": "string", "enum": [ "SortOrderEnum[id=1, name='asc', symbol='+']", "SortOrderEnum[id=2, name='desc', symbol='-']" ] } } }, "examples": { "Get creative group list - Advertiser": { "description": "Get creative group list - Advertiser", "value": { "pageNo": 1, "noOfEntries": 2, "searchField": "test", "creativeGroupIds": [46652, 46639], "startTime": 1737023769000, "endTime": 1737369441000, "sortBy": "-creativeGroupId", "platformCreativeTypeIds": [11, 13, 14, 15, 17], "creativeStatusIds": [1, 2, 3, 4] } }, "Get creative group list - Super/Workspace": { "description": "Get creative group list - Super/Workspace", "value": { "pageNo": 1, "noOfEntries": 2, "sortBy": "-creativeGroupId", "platformCreativeTypeIds": [11, 13, 14, 15, 17], "creativeStatusIds": [1, 2, 3, 4], "startTime": 1737023769000, "endTime": 1737369441000, "owIds": [1234, 2345], "allOwIds": false } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Creative group list - Advertiser": { "description": "Creative group list - Advertiser", "value": { "success": true, "data": { "totalRecords": 106, "filteredRecords": 27, "creativeGroupList": [ { "creativeGroupId": 46652, "creativeGroupName": "TEst HTML copy copy", "creativeTypeId": 13, "createdAt": 1734521089677, "creativesCount": 3 }, { "creativeGroupId": 46639, "creativeGroupName": "TEst HTML copy", "creativeTypeId": 13, "createdAt": 1734521074577, "creativesCount": 3 } ] } } }, "Creative group list - Super/Workspace": { "description": "Creative group list - Super/Workspace", "value": { "success": true, "data": { "totalRecords": 141, "filteredRecords": 3, "creativeGroupList": [ { "creativeGroupId": 46654, "creativeGroupName": "New Video group", "creativeTypeId": 14, "createdAt": 1737354156609, "creativesCount": 3 }, { "creativeGroupId": 46652, "creativeGroupName": "g12", "creativeTypeId": 15, "createdAt": 1737347190305, "creativesCount": 1 } ] } } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/crt/creatives/groups/duplicate/{creativeGroupId}": { "post": { "tags": [ "Creative API" ], "summary": "Duplicate creative group", "description": "Duplicate the provided creative group. The API will duplicate creatives present in the group and create a new group with the new creatives.", "operationId": "duplicateCreativeGroup", "parameters": [ { "name": "creativeGroupId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Group duplicated successfully": { "description": "Group duplicated successfully", "value": { "success": true, "data": { "duplicatedCreativeGroupId": 45089, "message": "testCreatives group duplicated successfully" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden !" } ] } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "examples": { "Invalid creative group id": { "description": "Invalid creative group id", "value": { "success": false, "errorObjects": [ { "error": "Invalid group ids found. Please provide valid group ids" } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/crt/creatives/duplicate": { "post": { "tags": [ "Creative API" ], "summary": "Duplicate creatives API", "description": "This API endpoint allows authorized users to duplicate one or more creatives.\nThe request includes a list of creative IDs and click URL(optional) to duplicate the creatives.\n", "operationId": "CreateDuplicateCreatives", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "content": { "application/json": { "schema": { "required": [ "creativeIds" ], "type": "object", "properties": { "creativeIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "clickUrl": { "type": "string" } } }, "examples": { "Duplicate creatives with click URL": { "description": "Duplicate creatives with click URL", "value": { "creativeIds": [130141, 130142], "clickUrl": "www.example.com" } }, "Duplicate creatives without click URL": { "description": "Duplicate creatives without click URL", "value": { "creativeIds": [130141, 130142] } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Single creative duplicated successfully": { "description": "Single creative duplicated successfully", "value": { "success": true, "data": { "message": "Native image 3 creative duplicated successfully" } } }, "Multiple creatives duplicated successfully": { "description": "Multiple creatives duplicated successfully", "value": { "success": true, "data": { "message": "2 creatives duplicated successfully" } } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/crt/creatives/count-by-type": { "post": { "tags": [ "Creative API" ], "summary": "Creative type count API", "operationId": "getCreativeTypeCount", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "searchField": { "type": "string" }, "owIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "allOwIds": { "type": "boolean" } } }, "examples": { "Type wise creative count": { "description": "Type wise creative count", "value": { "searchField": "creative" } }, "Type wise creative count - Super/Workspace": { "description": "Type wise creative count - Super/Workspace", "value": { "searchField": "creative", "owIds": [], "allOwIds": true } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Type wise creative count": { "description": "Type wise creative count", "value": { "success": true, "data": { "totalRecords": 6, "creativeTypeList": [ { "id": 0, "creativeCount": 88829 }, { "id": 11, "creativeCount": 52951 }, { "id": 13, "creativeCount": 7520 }, { "id": 14, "creativeCount": 15004 }, { "id": 17, "creativeCount": 1732 }, { "id": 15, "creativeCount": 11622 } ], "filteredRecords": 6 } } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/crt/creatives/count-by-status": { "post": { "tags": [ "Creative API" ], "summary": "Creative status count API", "operationId": "getCreativeStatusCount", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "searchField": { "type": "string" }, "creativeStatusIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "platformCreativeTypeIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "allCreatives": { "type": "boolean" }, "groupedCreatives": { "type": "boolean" }, "owIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "allOwIds": { "type": "boolean" }, "campaignIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "startTime": { "type": "integer", "format": "int64" }, "endTime": { "type": "integer", "format": "int64" } } }, "examples": { "Status wise creative count for All creatives - Advertiser": { "description": "Status wise creative count for All creatives - Advertiser", "value": { "searchField": "creative", "creativeStatusIds": [1, 2, 3, 4], "platformCreativeTypeIds": [11, 13, 14, 15, 17], "creativeIds": [123, 456], "allCreatives": true, "groupedCreatives": false, "startTime": 1734998399000, "endTime": 1735206867000, "campaignIds": [123456] } }, "Status wise creative count for Ungrouped creatives - Advertiser": { "description": "Status wise creative count for Ungrouped creatives - Advertiser", "value": { "searchField": "creative", "creativeStatusIds": [1, 2, 3, 4], "platformCreativeTypeIds": [11, 13, 14, 15, 17], "creativeIds": [123, 456], "allCreatives": false, "groupedCreatives": false, "startTime": 1734998399000, "endTime": 1735206867000, "campaignIds": [123456] } }, "Status wise creative count for Grouped creatives - Advertiser": { "description": "Status wise creative count for Grouped creatives - Advertiser", "value": { "searchField": "creative", "creativeStatusIds": [1, 2, 3, 4], "platformCreativeTypeIds": [11, 13, 14, 15, 17], "creativeIds": [123, 456], "allCreatives": false, "groupedCreatives": true, "startTime": 1734998399000, "endTime": 1735206867000, "campaignIds": [123456] } }, "Status wise creative count - Super/Workspace": { "description": "Status wise creative count - Super/Workspace", "value": { "searchField": "creative", "creativeStatusIds": [1, 2, 3, 4], "platformCreativeTypeIds": [11, 13, 14, 15, 17], "creativeIds": [123, 456], "allCreatives": true, "groupedCreatives": false, "startTime": 1734998399000, "endTime": 1735206867000, "owIds": [], "allOwIds": true, "campaignIds": [123456] } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Status wise creative count": { "description": "Status wise creative count", "value": { "success": true, "data": { "creativeStatusList": [ { "id": 0, "creativeCount": 587 }, { "id": 1, "creativeCount": 212 }, { "id": 2, "creativeCount": 281 }, { "id": 3, "creativeCount": 6 }, { "id": 5, "creativeCount": 13 }, { "id": 4, "creativeCount": 75 } ], "totalRecords": 6, "filteredRecords": 6 } } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/internal/crt/creatives/{advertiserId}/enable/submission": { "patch": { "tags": [ "Creative API" ], "summary": "Enable creative submission approval for an advertiser", "description": "Enables the approval requirement for creative submissions for the specified advertiser.", "operationId": "enableCreativeSubmissionApproval", "parameters": [ { "name": "advertiserId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Approval requirement enabled successfully", "content": { "application/json": { "examples": { "Enable creative submission approval": { "description": "Enable creative submission approval", "value": { "success": true, "data": "Creative submission approval enabled for advertiserId: 123" } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/crt/creatives/{creativeId}": { "get": { "tags": [ "Creative API" ], "summary": "Get creative details", "description": "This API can be used to fetch creative details of all the types of creatives", "operationId": "getCreative", "parameters": [ { "name": "creativeId", "in": "path", "description": "creativeId of the creative (primary key) to retrieve details", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Image creative details fetched successfully": { "description": "Image creative details fetched successfully", "value": { "success": true, "data": { "creativeId": 686855, "creativeName": "300x600-w23-01", "rtbCreativeTypeId": 1, "platformCreativeTypeId": 11, "creativeStatusId": 2, "creativeSource": "https://d3jme5si7t6llb.cloudfront.net/image/202760/efk0sUk_1730201855013.jpg", "creativeCardSource": "https://d3jme5si7t6llb.cloudfront.net/Screenshots/202760/278x220/efk0sUk_1730201855013.jpg", "clickUrl": "http://iqm.com", "imageDetails": { "pixelUrls": [ "http://pixel.com" ], "creativeWidth": 300, "creativeHeight": 600 }, "creativeSourceType": "file", "creativePreviewFlag": 1, "createdAt": 1730201855165, "modifiedAt": "2024-10-29T06:10:15.000+00:00", "userDetails": { "uowId": 175891, "userName": "Hardik", "userEmail": "hardik.v+iqmsuper@iqm.com", "hasApprovalAccess": true, "hasEditAccess": true }, "organizationDetails": { "owId": 202760, "organizationName": "AdWing" } } } }, "Html creative details fetched successfully": { "description": "Html creative details fetched successfully", "value": { "success": true, "data": { "creativeId": 686855, "creativeName": "300x600-w23-01", "rtbCreativeTypeId": 1, "platformCreativeTypeId": 11, "creativeStatusId": 2, "creativeSource": "<a href=https://iqm.com/political?utm_medium=rtb&utm_campaign=wreckathon-2024-play-1><img src=https://cdn-cfy-p0.iqm.com/wreckathon/2024/Images/w24-728x90-P.jpg></a>", "creativeCardSource": "https://d3jme5si7t6llb.cloudfront.net/Screenshots/201427/278x220/6qfdQrD_1733727160404.png", "clickUrl": "http://iqm.com ", "htmlDetails": { "pixelUrls": [ "https://iqm.pixel.com" ], "creativeWidth": 500, "creativeHeight": 1200 }, "creativeSourceType": "html", "creativePreviewFlag": 1, "createdAt": 1730201855165, "modifiedAt": "2024-10-29T06:10:15.000+00:00", "userDetails": { "uowId": 175891, "userName": "Hardik", "userEmail": "hardik.v+iqmsuper@iqm.com", "hasApprovalAccess": true, "hasEditAccess": true }, "organizationDetails": { "owId": 202760, "organizationName": "AdWing" } } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden !" } ] } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "examples": { "Invalid creativeId passed": { "description": "Invalid creativeId passed", "value": { "success": false, "errorObjects": [ { "error": "No creative details found for creativeId: 686855" } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } }, "patch": { "tags": [ "Creative API" ], "summary": "Update creative details", "description": " This API endpoint allows authorized users to update the details of an existing creative. \n The creative's attributes can be modified by advertisers, workspaces, or super users. \n The creative can be updated with a name, external creative ID, rejection reason, and remarks. \n Additionally, ownership and edit permissions are validated to ensure the request is authorized.\n---\n\n#### Request Body Detail\n\n| **Field** | **Type** | **Description** |\n| --- | --- | --- |\n| creativeName | String | Represents name of the creative |\n| externalCreativeId | String | Represents 3rd party id |\n| creativeRejectionReason | String | Represents reason for rejecting the creative if applicable |\n| creativeRemarks | String | Represents remarks to be added for this creative |\n| trackingData | Object | Represents the tracking URLs for video, audio and native video creatives. This can only be updated for video, audio and native video creative types. \u003Cbr\u003E Please pass the url key with empty string explicitly in order to remove the value of that url. It is an object having below mentioned fields - \u003Cbr\u003E startUrl: String - Represents the start URL for the video \u003Cbr\u003E firstQuartileURL: String - Represents the tracking URL for first quartile \u003Cbr\u003E midPointURL: String - Represents the tracking URL for mid point \u003Cbr\u003E thirdQuartileURL: String - Represents the tracking URL for third quartile \u003Cbr\u003E completeURL: String - Represents the tracking URL for complete \u003Cbr\u003E impressionURL: String - Represents the tracking URL for impression |\n", "operationId": "updateCreative", "parameters": [ { "name": "creativeId", "in": "path", "description": "id of the creative (primary key) to update details", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "creativeName": { "maxLength": 255, "minLength": 1, "type": "string" }, "externalCreativeId": { "maxLength": 200, "minLength": 1, "type": "string" }, "clickUrl": { "type": "string" }, "pixelUrls": { "type": "array", "items": { "type": "string" } }, "pixelUrl": { "type": "string", "deprecated": true }, "creativeRemarks": { "type": "string" }, "creativeSource": { "type": "string" }, "htmlDetails": { "type": "object", "properties": { "creativeWidth": { "type": "integer", "format": "int32" }, "creativeHeight": { "type": "integer", "format": "int32" }, "pixelUrls": { "type": "array", "items": { "type": "string" } } } }, "title": { "type": "string" }, "description": { "type": "string" }, "cta": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "ctaText": { "type": "string" }, "defaultCta": { "type": "boolean" } } }, "brandName": { "type": "string" }, "brandIconSourceUrl": { "type": "string" }, "brandIconHeight": { "type": "integer", "format": "int32" }, "brandIconWidth": { "type": "integer", "format": "int32" }, "thumbnailSourceUrl": { "type": "string" }, "thumbnailWidth": { "type": "integer", "format": "int32" }, "thumbnailHeight": { "type": "integer", "format": "int32" }, "trackingData": { "type": "object", "properties": { "startUrl": { "type": "string" }, "firstQuartileURL": { "type": "string" }, "midPointURL": { "type": "string" }, "thirdQuartileURL": { "type": "string" }, "completeURL": { "type": "string" }, "impressionURL": { "type": "string" } } } } }, "examples": { "Edit existing creative by Advertiser": { "description": "Edit existing creative by Advertiser", "value": { "creativeName": "New creative name", "externalCreativeId": "3rd party id", "trackingData": { "startUrl": "", "firstQuartileURL": "http://firstquartileurl.com" } } }, "Edit existing creative by workspace/super user ": { "description": "Edit existing creative by workspace/super user ", "value": { "creativeName": "New creative name", "externalCreativeId": "3rd party id", "creativeRejectionReason": "rejection", "creativeRemarks": "remarks" } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Creative updated successfully": { "description": "Creative updated successfully", "value": { "success": true, "data": { "id": 68798, "message": "New creative name updated successfully" } } } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "examples": { "Invalid creative id passed for update": { "description": "Invalid creative id passed for update", "value": { "success": false, "errorObjects": [ { "error": "No creative details found for creativeId: 6897989" } ] } }, "Invalid fields passed for update": { "description": "Invalid fields passed for update", "value": { "success": false, "errorObjects": [ { "error": "Tracking URLs can only be updated for video, audio and native video creative types", "field": "trackingData" } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/crt/creatives/update-status": { "patch": { "tags": [ "Creative API" ], "summary": "Update creative details", "description": " This API endpoint allows authorized users to update the status of an existing creative. \n The creative's attributes can be modified by advertisers, workspaces, or super users. \n Additionally, ownership and edit permissions are validated to ensure the request is authorized.\n\n---\n\n#### Request Body Detail\n\n| **Field** | **Type** | **Description** |\n| --- | --- | --- |\n| creativeIds | List\u003CInteger\u003E | Represents list of creative ids |\n| creativeStatusId | Integer | Represents creative status id |\n| creativeRejectionReason | String | Represents the reason for rejecting a creative |\n", "operationId": "updateCreativeStatus", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "content": { "application/json": { "schema": { "required": [ "creativeIds", "creativeStatusId" ], "type": "object", "properties": { "creativeIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "creativeStatusId": { "type": "integer", "format": "int32" }, "creativeRejectionReason": { "maxLength": 255, "minLength": 0, "type": "string" } } }, "examples": { "Delete creative": { "description": "Delete creative", "value": { "creativeIds": [688549], "creativeStatusId": 4 } }, "Reject creative": { "description": "Reject creative", "value": { "creativeIds": [688549], "creativeStatusId": 5, "creativeRejectionReason": "Harmful content found!" } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Single Creative updated successfully": { "description": "Single Creative updated successfully", "value": { "success": true, "data": { "message": "asdf creative updated successfully" } } }, "Multiple creatives updated successfully": { "description": "Multiple creatives updated successfully", "value": { "success": true, "data": { "message": "3 Creatives updated successfully" } } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "examples": { "Rejection reason not provided while rejecting the creative": { "description": "Rejection reason not provided while rejecting the creative", "value": { "success": false, "errorObjects": [ { "error": "Rejection reason not provided. Please provide the reason for rejecting the creative/s." } ] } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "examples": { "Forbidden to update the status of the creative": { "description": "Forbidden to update the status of the creative", "value": { "success": false, "errorObjects": [ { "error": "Logged in user does not have access to reject/approve/pause/delete/restore the creative" } ] } } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "examples": { "Invalid/Unaccessible creative id/s passed for update status": { "description": "Invalid/Unaccessible creative id/s passed for update status", "value": { "success": false, "errorObjects": [ { "error": "Invalid creative ids found. Please provide valid creative ids" } ] } }, "Creative with invalid status is passed for update status": { "description": "Creative with invalid status is passed for update status", "value": { "success": false, "errorObjects": [ { "error": "Creative/s not in running/pending/paused/rejected state. Please pass valid creative/s." } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/crt/creatives/pixel-url": { "patch": { "tags": [ "Creative API" ], "summary": "Update pixel URL API", "description": "This API endpoint allows authorized users to update the pixel URL for a creatives.\nThe request includes the creative IDs and the new pixel URL to update.\n", "operationId": "UpdatePixelUrl", "requestBody": { "content": { "application/json": { "schema": { "required": [ "creativeIds" ], "type": "object", "properties": { "pixelUrls": { "type": "array", "items": { "type": "string" } }, "pixelUrl": { "type": "string", "deprecated": true }, "creativeIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } } } }, "examples": { "Bulk update pixel URL": { "description": "Bulk update pixel URL", "value": { "creativeIds": [1, 2], "pixelUrls": [ "http://app.example.com" ] } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Multiple creatives pixel URL updated successfully": { "description": "Multiple creatives pixel URL updated successfully", "value": { "success": true, "data": { "message": "Pixel URL updated successfully for 2 creatives" } } }, "Single creative pixel URL updated successfully": { "description": "Single creative pixel URL updated successfully", "value": { "success": true, "data": { "message": "Pixel URL updated successfully for file_example creative" } } } } } } } } } }, "/api/v3/crt/creatives/groups/{creativeGroupId}": { "patch": { "tags": [ "Creative API" ], "summary": "Update creative group name", "description": "Update the name of the creative group. The creative group ID and new name of the group are required.", "operationId": "updateCreativeGroupName", "parameters": [ { "name": "creativeGroupId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "content": { "application/json": { "schema": { "required": [ "creativeGroupName" ], "type": "object", "properties": { "creativeGroupName": { "maxLength": 255, "minLength": 1, "type": "string" } } }, "examples": { "Update Creative Group Name Request": { "description": "Update Creative Group Name Request", "value": { "creativeGroupName": "Group1" } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Group name updated successfully": { "description": "Group name updated successfully", "value": { "success": true, "data": { "message": "Group1 group renamed successfully" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden !" } ] } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "examples": { "Invalid creative group id": { "description": "Invalid creative group id", "value": { "success": false, "errorObjects": [ { "error": "Invalid creative group id found. Please provide valid creative group id" } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/crt/creatives/click-url": { "patch": { "tags": [ "Creative API" ], "summary": "Update creative click Url API", "operationId": "updateCreativeClickUrl", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "creativeIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "clickUrl": { "type": "string" } } }, "examples": { "Update click url of single creative": { "description": "Update click url of single creative", "value": { "creativeIds": [639021], "clickUrl": "http://www.iqm.com" } }, "Update click url of multiple creatives": { "description": "Update click url of multiple creatives", "value": { "creativeIds": [639021, 682608], "clickUrl": "http://www.iqm.com" } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Update click url of single creative": { "description": "Update click url of single creative", "value": { "success": true, "data": { "message": "Click URL updated successfully for TEST creative" } } }, "Update click url of multiple creatives": { "description": "Update click url of multiple creatives", "value": { "success": true, "data": { "message": "Click URL updated successfully for 2 creatives" } } } } } } } } } }, "/api/v3/crt/master/static/creative-types": { "get": { "tags": [ "Creative API" ], "summary": "Static api for fetching creative type.", "description": "This API fetches a static list of creative type from the database, sorted in ascending order by the default order ascending", "operationId": "creativeTypeList", "parameters": [ { "name": "displayAllType", "in": "query", "description": "Flag to add 'ALL' creative type in the list.", "required": false, "schema": { "type": "boolean" }, "example": false }, { "name": "searchField", "in": "query", "description": "Search field to filter creative type details.", "required": false, "schema": { "type": "string" }, "example": "Image" }, { "name": "creativeTypeIds", "in": "query", "description": "Set of creative type ids to filter creative type details.", "required": false, "schema": { "type": "string" }, "example": "1,2,3" }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "creative type list", "content": { "application/json": { "examples": { "Success response with displayAllStatusOption flag false": { "description": "Success response with displayAllStatusOption flag false", "value": { "success": true, "data": { "totalRecords": 6, "creativeTypeList": [ { "id": 0, "name": "all", "order": 0, "displayName": "All", "rtbCreativeTypeId": null }, { "id": 11, "name": "Image", "order": 100, "displayName": "Image", "rtbCreativeTypeId": 1 }, { "id": 13, "name": "HTML", "order": 100, "displayName": "HTML", "rtbCreativeTypeId": 1 }, { "id": 14, "name": "Video", "order": 100, "displayName": "Video", "rtbCreativeTypeId": 3 }, { "id": 15, "name": "Native", "order": 100, "displayName": "Native", "rtbCreativeTypeId": 4 }, { "id": 17, "name": "Audio", "order": 100, "displayName": "Audio", "rtbCreativeTypeId": 2 } ], "filteredRecords": 6 } } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/crt/master/static/creative-status": { "get": { "tags": [ "Creative API" ], "summary": "Static api for fetching creative status.", "description": "This API fetches a static list of creative status from the database, sorted in ascending order by the default display_order column", "operationId": "creativeStatusList", "parameters": [ { "name": "displayAllStatusOption", "in": "query", "description": "Flag to add 'ALL' creative status in the list.", "required": false, "schema": { "type": "boolean" }, "example": false }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "creative status list", "content": { "application/json": { "examples": { "Success response with displayAllStatusOption flag false": { "description": "Success response with displayAllStatusOption flag false", "value": { "success": true, "data": { "creativeStatusList": [ { "id": 1, "name": "pending", "order": 1, "displayName": "Pending" }, { "id": 2, "name": "running", "order": 2, "displayName": "Running" }, { "id": 3, "name": "paused", "order": 3, "displayName": "Paused" }, { "id": 5, "name": "rejected", "order": 4, "displayName": "Rejected" }, { "id": 4, "name": "deleted", "order": 5, "displayName": "Deleted" } ], "totalRecords": 7, "filteredRecords": 7 } } }, "Success response with displayAllStatusOption flag true": { "description": "Success response with displayAllStatusOption flag true", "value": { "success": true, "data": { "creativeStatusList": [ { "id": 0, "name": "all", "order": 0, "displayName": "All" }, { "id": 1, "name": "pending", "order": 1, "displayName": "Pending" }, { "id": 2, "name": "running", "order": 2, "displayName": "Running" }, { "id": 3, "name": "paused", "order": 3, "displayName": "Paused" }, { "id": 5, "name": "rejected", "order": 4, "displayName": "Rejected" }, { "id": 4, "name": "deleted", "order": 5, "displayName": "Deleted" } ], "totalRecords": 7, "filteredRecords": 7 } } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/crt/master/cta/list": { "get": { "tags": [ "Creative API" ], "summary": "Api for fetching CTA details.", "description": "This API fetches a list of CTA details from the database base on the showOnlyDefault flag.", "operationId": "ctaDetailsList", "parameters": [ { "name": "showOnlyDefault", "in": "query", "description": "If true then show only default(true) cta else show all cta", "required": true, "schema": { "type": "string" } }, { "name": "searchField", "in": "query", "description": "Search field to filter the CTA details", "required": false, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "cta details list", "content": { "application/json": { "examples": { "Success response": { "description": "Success response", "value": { "success": true, "data": { "ctaDetailsList": [ { "id": 1, "ctaText": "Learn More", "defaultCta": true }, { "id": 2, "ctaText": "Buy Now", "defaultCta": false }, { "id": 3, "ctaText": "Sign Up", "defaultCta": false } ], "totalRecords": 3, "filteredRecords": 3 } } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/crt/creatives/{creativeId}/creative-campaign-details": { "get": { "tags": [ "Creative API" ], "summary": "Fetch creative and associated campaigns", "description": "Retrieve details of a specific creative along with its associated campaigns. Includes an option to fetch modeling details if requested.", "operationId": "getCreativeAndCampaignDetails", "parameters": [ { "name": "creativeId", "in": "path", "description": "Unique ID of the creative whose associated campaigns are to be retrieved", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "includeModelingInfo", "in": "query", "description": "Flag indicating whether modeling details should be included (default: false)", "required": false, "schema": { "type": "boolean" } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "Creative and associated campaigns retrieved successfully", "content": { "application/json": { "examples": { "Response with modeling info": { "description": "Response with modeling info", "value": { "success": true, "data": { "creativeId": 604675, "creativeName": "ad-45s", "rtbCreativeTypeId": 3, "platformCreativeTypeId": 14, "creativeStatusId": 2, "creativeSource": "VAST...", "creativeCardSource": "https://d3jme5si7t6llb.cloudfront.net/Screenshots/201427/278x220/fgx01xo_1701846672033.jpg", "clickUrl": "https://iqm.com/?utm_medium=rtb&utm_campaign=wreckathon-2022-play-4", "videoDetails": { "duration": 45, "xmlType": "inline", "creativeSourceUrl": "https://cdn-cfy-p0.iqm.com/wreckathon/Videos/iqm-video-202206-45s-720p.mp4", "availableXmlVersions": "2.0,3.0,4.0,4.1", "transformed": true }, "creativeSourceType": "vast-xml", "creativePreviewFlag": 1, "createdAt": 1701846671694, "modifiedAt": "2023-12-13T02:23:26.000+00:00", "userDetails": { "uowId": 9483, "userName": "Hardik Vagadia", "userEmail": "hardik.v+stageadv@iqm.com" }, "organizationDetails": { "owId": 201427, "organizationName": "Stage Shared Advertiser" }, "approvalRequiredPostUrlUpdate": true, "campaignDetails": [ { "id": 452308, "name": "Test Campaign - Pre-bid segment not attched", "status": "pending", "totalCreativesCount": 3, "isModelled": false }, { "id": 452330, "name": "checking video campaign", "status": "expired", "totalCreativesCount": 7, "isModelled": true } ] } } }, "Response without modeling info": { "description": "Response without modeling info", "value": { "success": true, "data": { "creativeId": 604675, "creativeName": "ad-45s", "rtbCreativeTypeId": 3, "platformCreativeTypeId": 14, "creativeStatusId": 2, "creativeSource": "VAST...", "creativeCardSource": "https://d3jme5si7t6llb.cloudfront.net/Screenshots/201427/278x220/fgx01xo_1701846672033.jpg", "clickUrl": "https://iqm.com/?utm_medium=rtb&utm_campaign=wreckathon-2022-play-4", "videoDetails": { "duration": 45, "xmlType": "inline", "creativeSourceUrl": "https://cdn-cfy-p0.iqm.com/wreckathon/Videos/iqm-video-202206-45s-720p.mp4", "availableXmlVersions": "2.0,3.0,4.0,4.1", "transformed": true }, "creativeSourceType": "vast-xml", "creativePreviewFlag": 1, "createdAt": 1701846671694, "modifiedAt": "2023-12-13T02:23:26.000+00:00", "userDetails": { "uowId": 9483, "userName": "Hardik Vagadia", "userEmail": "hardik.v+stageadv@iqm.com" }, "organizationDetails": { "owId": 201427, "organizationName": "Stage Shared Advertiser" }, "approvalRequiredPostUrlUpdate": true, "campaignDetails": [ { "id": 452308, "name": "Test Campaign - Pre-bid segment not attched", "status": "pending", "totalCreativesCount": 3 }, { "id": 452330, "name": "checking video campaign", "status": "expired", "totalCreativesCount": 7 } ] } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden !" } ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/crt/creatives/submit": { "get": { "tags": [ "Creative API" ], "summary": "Submits creatives for validation", "description": "Fetches eligible creatives and submits them for validation based on the provided limit. Invoked by external clients; clientId is derived from the authenticated principal. A limit of -1 means all available creatives are fetched. Requires authority `creative.submit`.", "operationId": "submitCreative", "parameters": [ { "name": "limit", "in": "query", "description": "Maximum number of creatives to submit (0 means no explicit cap)", "required": false, "schema": { "type": "integer", "format": "int32", "default": -1 } }, { "name": "clientId", "in": "query", "description": "Client identifier whose creatives will be submitted" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Successful submission": { "description": "Successful submission", "value": { "success": true, "data": [ { "creativeId": 636912, "creativeName": "Creative - 1", "creativeSource": "https://d3jme5si7t6llb.cloudfront.net/image/202318/wqh1afg_1709622657169.png", "advertiserDetails": { "advertiserName": "Political Advertiser", "website": "https://iqm.com", "chiefName": "IQM", "contactNumber": "1234567890", "address": "IQM Corporation", "politicalIdentifier": "fec_123", "advertiserId": 3278, "legalInfo": "Other info added", "links": [ "www.google.com" ] } }, { "creativeId": 636912, "creativeName": "Creative-2", "creativeSource": "https://d3jme5si7t6llb.cloudfront.net/image/202318/wqh1afg_1709622657169.png", "advertiserDetails": { "advertiserName": "POlitical ", "website": "http://iqm.com", "chiefName": "political", "contactNumber": "1234352452345", "address": "asfasfa", "politicalIdentifier": "fec_456", "advertiserId": 4574, "legalInfo": "jksdasd", "links": [ "google.com" ] } } ] } } } } } }, "401": { "description": "Unauthorized (invalid or missing token)", "content": { "application/json": { "examples": { "Unauthorized example": { "description": "Unauthorized example", "value": { "error": "invalid_token", "error_description": "Invalid token" } } } } } }, "403": { "description": "Forbidden (missing authority `creative.submit`)", "content": { "application/json": { "examples": { "Forbidden example": { "description": "Forbidden example", "value": { "statusCode": 403, "responseObject": { "errorMsg": "Access Denied", "errorCode": 403 } } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v2/inv/inventories/list": { "get": { "tags": [ "Inventory API" ], "summary": "Inventory - Search", "description": "This API can be used to get all inventory or search inventory that matches specific criteria.", "operationId": "Inventory-Search", "parameters": [ { "name": "groupId", "in": "query", "description": "This parameter is optional. If provided, the response will have `isExistInGroup` flag to indicate whether the inventory exists in the given inventory group or not.", "required": true, "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32", "example": 100514 } }, { "name": "keywords", "in": "query", "description": "Search any inventory that matches provided comma separated keywords", "required": true, "style": "form", "explode": true, "schema": { "type": "string", "example": "Happy Color™ – Color by Number" } }, { "name": "countries", "in": "query", "description": "To filter inventories by countries. Provide comma separated country ids.", "required": true, "style": "form", "explode": true, "schema": { "type": "string", "example": "30100001,30100002" } }, { "name": "categories", "in": "query", "description": "To filter inventories by IAB categories. Provide comma separated IAB categories.", "required": true, "style": "form", "explode": true, "schema": { "type": "string", "example": "IAB1,IAB14" } }, { "name": "inventoryTypes", "in": "query", "description": "To filter inventories by inventory types. Provide comma separated inventory type Ids.", "required": true, "style": "form", "explode": true, "schema": { "type": "string", "example": "1,2,3" } }, { "name": "creativeSizes", "in": "query", "description": "To filter inventories by creative sizes. Provide comma separated creative sizes.", "required": true, "style": "form", "explode": true, "schema": { "type": "string", "example": "574x323,288x162" } }, { "name": "creativeTypes", "in": "query", "description": "To filter inventories by creative types. Provide comma separated creative type Ids.", "required": true, "style": "form", "explode": true, "schema": { "type": "string", "example": "1,2,3" } }, { "name": "creativeDurations", "in": "query", "description": "To filter inventories by creative durations. Provide comma separated creative duration Ids.", "required": true, "style": "form", "explode": true, "schema": { "type": "string", "example": "1,2,-1" } }, { "name": "trafficTypes", "in": "query", "description": "To filter inventories by traffic types. Provide comma separated traffic type Ids.", "required": true, "style": "form", "explode": true, "schema": { "type": "string", "example": "11,12" } }, { "name": "deviceTypes", "in": "query", "description": "To filter inventories by device types. Provide comma separated device type Ids.", "required": true, "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32", "example": 20300001 } }, { "name": "exchanges", "in": "query", "description": "To filter inventories by exchanges. Provide comma separated exchange Ids.", "required": true, "style": "form", "explode": true, "schema": { "type": "string", "example": "47,48" } }, { "name": "videoPlayerSizes", "in": "query", "description": "To filter inventories by video player sizes. Provide comma separated video player size Ids.", "required": true, "style": "form", "explode": true, "schema": { "type": "string", "example": "1,3,4,-1" } }, { "name": "noOfEntries", "in": "query", "description": "Nomber of entries required per page", "required": true, "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32", "example": 10 } }, { "name": "pageNo", "in": "query", "description": "Page Number", "required": true, "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32", "example": 1 } }, { "name": "X-IAA-OW-ID", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32", "example": 2 } }, { "name": "Authorization", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "{{bearer_token}}" } } ], "responses": { "default": { "description": "", "headers": { }, "content": { "application/json": { "schema": { "title": "Inventory-Search", "required": [ "statusCode", "responseObject", "isCached" ], "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "responseObject": { "type": "array", "items": { "title": "ResponseObject", "required": [ "id", "name", "publisher", "appId", "inventoryType", "impressions", "uniques", "videoPercentage", "displayPercentage" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "publisher": { "type": "string" }, "appId": { "type": "string" }, "inventoryType": { "type": "string" }, "impressions": { "type": "integer", "format": "int32" }, "uniques": { "type": "integer", "format": "int32" }, "videoPercentage": { "oneOf": [ { "type": "number" }, { "type": "integer", "format": "int32" } ] }, "displayPercentage": { "oneOf": [ { "type": "number" }, { "type": "integer", "format": "int32" } ] } }, "example": { "id": 2085, "name": "yahoo.com", "publisher": "UNKNOWN", "appId": "yahoo.com", "inventoryType": "Site", "impressions": 544857607, "uniques": 269603996, "videoPercentage": 78.75, "displayPercentage": 21.25 } }, "description": "" }, "isCached": { "type": "boolean" } } } } } } }, "deprecated": false, "security": [], "servers": [ { "url": "http://example.com/api/v2/inv", "variables": { } } ] } }, "/api/v2/inv/inventories/count": { "get": { "tags": [ "Inventory API" ], "summary": "Inventory - Count", "description": "This API can be used to get inventories overall counts or counts for given filter criteria.", "operationId": "Inventory-Count", "parameters": [ { "name": "keywords", "in": "query", "description": "Search any inventory that matches provided comma separated keywords", "required": true, "style": "form", "explode": true, "schema": { "type": "string", "example": "foxnews,CNN,com.sleeeeepfly.knife.io" } }, { "name": "countries", "in": "query", "description": "To filter inventories by countries. Provide comma separated country ids.", "required": true, "style": "form", "explode": true, "schema": { "type": "string", "example": "30100001,30100002" } }, { "name": "categories", "in": "query", "description": "To filter inventories by IAB categories. Provide comma separated IAB categories.", "required": true, "style": "form", "explode": true, "schema": { "type": "string", "example": "IAB1,IAB14" } }, { "name": "inventoryTypes", "in": "query", "description": "To filter inventories by inventory types. Provide comma separated inventory type Ids.", "required": true, "style": "form", "explode": true, "schema": { "type": "string", "example": "1,2,3" } }, { "name": "creativeSizes", "in": "query", "description": "To filter inventories by creative sizes. Provide comma separated creative sizes.", "required": true, "style": "form", "explode": true, "schema": { "type": "string", "example": "574x323,288x162" } }, { "name": "creativeTypes", "in": "query", "description": "To filter inventories by creative types. Provide comma separated creative type Ids.", "required": true, "style": "form", "explode": true, "schema": { "type": "string", "example": "1,2,3" } }, { "name": "creativeDurations", "in": "query", "description": "To filter inventories by creative durations. Provide comma separated creative duration Ids.", "required": true, "style": "form", "explode": true, "schema": { "type": "string", "example": "1,2,-1" } }, { "name": "trafficTypes", "in": "query", "description": "To filter inventories by traffic types. Provide comma separated traffic type Ids.", "required": true, "style": "form", "explode": true, "schema": { "type": "string", "example": "11,12" } }, { "name": "deviceTypes", "in": "query", "description": "To filter inventories by device types. Provide comma separated device type Ids.", "required": true, "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32", "example": 20300001 } }, { "name": "exchanges", "in": "query", "description": "To filter inventories by exchanges. Provide comma separated exchange Ids.", "required": true, "style": "form", "explode": true, "schema": { "type": "string", "example": "47,48" } }, { "name": "videoPlayerSizes", "in": "query", "description": "To filter inventories by video player sizes. Provide comma separated video player size Ids.", "required": true, "style": "form", "explode": true, "schema": { "type": "string", "example": "1,3,4,-1" } }, { "name": "X-IAA-OW-ID", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32", "example": 2 } }, { "name": "Authorization", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "{{bearer_token}}" } } ], "responses": { "default": { "description": "", "headers": { }, "content": { "application/json": { "schema": { "title": "Success", "required": [ "statusCode", "responseObject", "isCached" ], "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "responseObject": { "title": "ResponseObject1", "required": [ "inventories", "publishers", "impressions", "uniques" ], "type": "object", "properties": { "inventories": { "type": "integer", "format": "int32" }, "publishers": { "type": "integer", "format": "int32" }, "impressions": { "type": "integer", "format": "int32" }, "uniques": { "type": "integer", "format": "int32" } }, "example": { "inventories": 557, "publishers": 43, "impressions": 1325799374, "uniques": 664016723 } }, "isCached": { "type": "boolean" } }, "example": { "statusCode": 200, "responseObject": { "inventories": 557, "publishers": 43, "impressions": 1325799374, "uniques": 664016723 }, "isCached": false } }, "example": { "statusCode": 200, "responseObject": { "inventories": 557, "publishers": 43, "impressions": 1325799374, "uniques": 664016723 }, "isCached": false } } } } }, "deprecated": false, "security": [], "servers": [ { "url": "http://example.com/api/v2/inv", "variables": { } } ] } }, "/api/v2/inv/inventories/distributions": { "get": { "tags": [ "Inventory API" ], "summary": "Inventory - Distribution", "description": "This API can be used to get Inventories overall distribution or distribution for given filter criteria for geography, device type, Creative type etc.", "operationId": "Inventory-Distribution", "parameters": [ { "name": "keywords", "in": "query", "description": "Search any inventory that matches provided comma separated keywords", "required": true, "style": "form", "explode": true, "schema": { "type": "string", "example": "foxnews,CNN,com.sleeeeepfly.knife.io" } }, { "name": "countries", "in": "query", "description": "To filter inventories by countries. Provide comma separated country ids.", "required": true, "style": "form", "explode": true, "schema": { "type": "string", "example": "30100001,30100002" } }, { "name": "categories", "in": "query", "description": "To filter inventories by IAB categories. Provide comma separated IAB categories.", "required": true, "style": "form", "explode": true, "schema": { "type": "string", "example": "IAB1,IAB14" } }, { "name": "inventoryTypes", "in": "query", "description": "To filter inventories by inventory types. Provide comma separated inventory type Ids.", "required": true, "style": "form", "explode": true, "schema": { "type": "string", "example": "1,2,3" } }, { "name": "creativeSizes", "in": "query", "description": "To filter inventories by creative sizes. Provide comma separated creative sizes.", "required": true, "style": "form", "explode": true, "schema": { "type": "string", "example": "574x323,288x162" } }, { "name": "creativeTypes", "in": "query", "description": "To filter inventories by creative types. Provide comma separated creative type Ids.", "required": true, "style": "form", "explode": true, "schema": { "type": "string", "example": "1,2,3" } }, { "name": "creativeDurations", "in": "query", "description": "To filter inventories by creative durations. Provide comma separated creative duration Ids.", "required": true, "style": "form", "explode": true, "schema": { "type": "string", "example": "1,2,-1" } }, { "name": "trafficTypes", "in": "query", "description": "To filter inventories by traffic types. Provide comma separated traffic type Ids.", "required": true, "style": "form", "explode": true, "schema": { "type": "string", "example": "11,12" } }, { "name": "deviceTypes", "in": "query", "description": "To filter inventories by device types. Provide comma separated device type Ids.", "required": true, "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32", "example": 20300001 } }, { "name": "exchanges", "in": "query", "description": "To filter inventories by exchanges. Provide comma separated exchange Ids.", "required": true, "style": "form", "explode": true, "schema": { "type": "string", "example": "47,48" } }, { "name": "videoPlayerSizes", "in": "query", "description": "To filter inventories by video player sizes. Provide comma separated video player size Ids.", "required": true, "style": "form", "explode": true, "schema": { "type": "string", "example": "1,3,4,-1" } }, { "name": "X-IAA-OW-ID", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32", "example": 2 } }, { "name": "Authorization", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "{{bearer_token}}" } } ], "responses": { "default": { "description": "", "headers": { }, "content": { "application/json": { "schema": { "title": "Success1", "required": [ "statusCode", "responseObject", "isCached" ], "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "responseObject": { "title": "ResponseObject2", "required": [ "countries", "deviceTypes", "creativeTypes", "trafficTypes" ], "type": "object", "properties": { "countries": { "type": "array", "items": { "title": "Country", "required": [ "label", "value" ], "type": "object", "properties": { "label": { "type": "string" }, "value": { "type": "integer", "format": "int32" } }, "example": { "label": "United States", "value": 100 } }, "description": "" }, "deviceTypes": { "type": "array", "items": { "title": "DeviceType", "required": [ "label", "value" ], "type": "object", "properties": { "label": { "type": "string" }, "value": { "type": "number" } }, "example": { "label": "Desktop", "value": 86.88 } }, "description": "" }, "creativeTypes": { "type": "array", "items": { "title": "CreativeType", "required": [ "label", "value" ], "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number" }, { "type": "integer", "format": "int32" } ] } }, "example": { "label": "Video", "value": 55.04 } }, "description": "" }, "trafficTypes": { "type": "array", "items": { "title": "TrafficType", "required": [ "label", "value" ], "type": "object", "properties": { "label": { "type": "string" }, "value": { "type": "integer", "format": "int32" } }, "example": { "label": "Web", "value": 100 } }, "description": "" } } }, "isCached": { "type": "boolean" } } } } } } }, "deprecated": false, "security": [], "servers": [ { "url": "http://example.com/api/v2/inv", "variables": { } } ] } }, "/api/v2/inv/inventories/includeExclude": { "post": { "tags": [ "Inventory API" ], "summary": "Inventory - Add Include/Exclude", "description": "This API can be used to include or exclude specific inventories for given campaigns.\n\n`isExcluded` = 0 denotes that given inventories will be included for the given campaign whereas `isExcluded` = 1 denotes that given inventories will be excluded for the given campaign.", "operationId": "Inventory-AddInclude/Exclude", "parameters": [ { "name": "X-IAA-OW-ID", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32", "example": 2 } }, { "name": "Authorization", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "{{bearer_token}}" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "title": "Inventory-AddIncludeExcludeRequest", "required": [ "campaignId", "ids", "isExcluded" ], "type": "object", "properties": { "campaignId": { "type": "integer", "format": "int32" }, "ids": { "type": "string" }, "isExcluded": { "type": "integer", "format": "int32" } }, "example": { "campaignId": 168622, "ids": "1,2,3,4", "isExcluded": 0 } }, "example": { "campaignId": 168622, "ids": "1,2,3,4", "isExcluded": 0 } } }, "required": true }, "responses": { "200": { "description": "OK", "headers": { "Date": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "Wed, 24 Feb 2021 05:06:56 GMT" } } }, "Transfer-Encoding": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "chunked" } } }, "Connection": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "keep-alive" } } } }, "content": { "application/json;charset=UTF-8": { "schema": { "title": "InventoryIncludeExcludeSuccessResponse", "required": [ "statusCode", "responseObject" ], "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "responseObject": { "title": "ResponseObject3", "required": [ "message" ], "type": "object", "properties": { "message": { "type": "string" } }, "example": { "message": "Inventories Excluded." } } }, "example": { "statusCode": 200, "responseObject": { "message": "Inventories Excluded." } } }, "example": { "statusCode": 200, "responseObject": { "message": "Inventories Excluded." } } } } } }, "deprecated": false, "security": [], "servers": [ { "url": "http://example.com/api/v2/inv", "variables": { } } ] } }, "/api/v2/inv/group/list/statistics": { "get": { "tags": [ "Inventory API" ], "summary": "Inventory Group - Get Statistics", "description": "This API will get all available inventory groups for the user.", "operationId": "InventoryGroup-GetStatistics", "parameters": [ { "name": "authorization", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "{{bearer_token}}" } }, { "name": "x-iaa-ow-id", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32", "example": 200001 } } ], "responses": { "200": { "description": "OK", "headers": { "Cache-Control": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "no-cache, no-store, max-age=0, must-revalidate" } } }, "Content-Length": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "117" } } }, "Date": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "Wed, 13 Oct 2021 11:56:32 GMT" } } }, "Expires": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "0" } } }, "Pragma": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "no-cache" } } }, "Server": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "Caddy" } } }, "X-Content-Type-Options": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "nosniff" } } }, "X-Frame-Options": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "DENY" } } }, "X-Xss-Protection": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "1; mode=block" } } } }, "content": { "application/json;charset=UTF-8": { "schema": { "title": "OK7", "required": [ "statusCode", "responseObject" ], "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "responseObject": { "title": "ResponseObject11", "required": [ "totalInventoryGroups", "includedGroups", "excludedGroups", "unUsedGroups" ], "type": "object", "properties": { "totalInventoryGroups": { "type": "integer", "format": "int32" }, "includedGroups": { "type": "integer", "format": "int32" }, "excludedGroups": { "type": "integer", "format": "int32" }, "unUsedGroups": { "type": "integer", "format": "int32" } }, "example": { "totalInventoryGroups": 5, "includedGroups": 3, "excludedGroups": 1, "unUsedGroups": 2 } } }, "example": { "statusCode": 200, "responseObject": { "totalInventoryGroups": 5, "includedGroups": 3, "excludedGroups": 1, "unUsedGroups": 2 } } }, "example": { "statusCode": 200, "responseObject": { "totalInventoryGroups": 5, "includedGroups": 3, "excludedGroups": 1, "unUsedGroups": 2 } } } } } }, "deprecated": false, "security": [], "servers": [ { "url": "http://example.com/api/v2/inv", "variables": { } } ] } }, "/api/v2/inv/group/109101/distributions": { "get": { "tags": [ "Inventory API" ], "summary": "Inventory Group - Get Distributions", "description": "This API can be used to get inventories distribution for the given inventory group.", "operationId": "InventoryGroup-GetDistributions", "parameters": [ { "name": "searchField", "in": "query", "description": "This parameter is optional. API will provide total distribution without filter if not provided.", "required": true, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "x-iaa-ow-id", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32", "example": 200001 } }, { "name": "authorization", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "{{bearer_token}}" } } ], "responses": { "200": { "description": "OK", "headers": { "Cache-Control": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "no-cache, no-store, max-age=0, must-revalidate" } } }, "Content-Length": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "570" } } }, "Date": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "Wed, 13 Oct 2021 12:10:25 GMT" } } }, "Expires": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "0" } } }, "Pragma": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "no-cache" } } }, "Server": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "Caddy" } } }, "X-Content-Type-Options": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "nosniff" } } }, "X-Frame-Options": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "DENY" } } }, "X-Xss-Protection": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "1; mode=block" } } } }, "content": { "application/json;charset=UTF-8": { "schema": { "title": "OK8", "required": [ "statusCode", "responseObject" ], "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "responseObject": { "title": "ResponseObject12", "required": [ "countries", "deviceTypes", "creativeTypes", "trafficTypes" ], "type": "object", "properties": { "countries": { "type": "array", "items": { "title": "Country1", "required": [ "label", "value" ], "type": "object", "properties": { "label": { "type": "string" }, "value": { "type": "number" } }, "example": { "label": "United States", "value": 96.7 } }, "description": "" }, "deviceTypes": { "type": "array", "items": { "title": "DeviceType", "required": [ "label", "value" ], "type": "object", "properties": { "label": { "type": "string" }, "value": { "type": "number" } }, "example": { "label": "Desktop", "value": 86.88 } }, "description": "" }, "creativeTypes": { "type": "array", "items": { "title": "CreativeType", "required": [ "label", "value" ], "type": "object", "properties": { "label": { "type": "string" }, "value": { "oneOf": [ { "type": "number" }, { "type": "integer", "format": "int32" } ] } }, "example": { "label": "Video", "value": 55.04 } }, "description": "" }, "trafficTypes": { "type": "array", "items": { "title": "TrafficType", "required": [ "label", "value" ], "type": "object", "properties": { "label": { "type": "string" }, "value": { "type": "integer", "format": "int32" } }, "example": { "label": "Web", "value": 100 } }, "description": "" } } } } } } } } }, "deprecated": false, "security": [], "servers": [ { "url": "http://example.com/api/v2/inv", "variables": { } } ] } }, "/api/v2/inv/group/109101/inventories": { "get": { "tags": [ "Inventory API" ], "summary": "Inventory Group - Get Inventories", "description": "This API can be used to get inventories available in the inventory group.", "operationId": "InventoryGroup-GetInventories", "parameters": [ { "name": "searchField", "in": "query", "description": "This parameter is optional. API will provide all inventories of the group without filter if not provided.", "required": true, "style": "form", "explode": true, "schema": { "type": "string", "example": "cnn" } }, { "name": "pageNo", "in": "query", "description": "Default value is 10", "required": true, "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32", "example": 1 } }, { "name": "noOfEntries", "in": "query", "description": "Default value is 1 \n**Note:** -1 can be passed to get all available inventories", "required": true, "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32", "example": 50 } }, { "name": "x-iaa-ow-id", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32", "example": 200001 } }, { "name": "authorization", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "{{bearer_token}}" } } ], "responses": { "200": { "description": "OK", "headers": { "Cache-Control": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "no-cache, no-store, max-age=0, must-revalidate" } } }, "Content-Length": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "3127" } } }, "Date": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "Wed, 13 Oct 2021 12:11:32 GMT" } } }, "Expires": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "0" } } }, "Pragma": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "no-cache" } } }, "Server": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "Caddy" } } }, "X-Content-Type-Options": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "nosniff" } } }, "X-Frame-Options": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "DENY" } } }, "X-Xss-Protection": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "1; mode=block" } } } }, "content": { "application/json;charset=UTF-8": { "schema": { "title": "OK9", "required": [ "statusCode", "responseObject" ], "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "responseObject": { "type": "array", "items": { "title": "ResponseObject", "required": [ "id", "name", "publisher", "appId", "inventoryType", "impressions", "uniques", "videoPercentage", "displayPercentage" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "publisher": { "type": "string" }, "appId": { "type": "string" }, "inventoryType": { "type": "string" }, "impressions": { "type": "integer", "format": "int32" }, "uniques": { "type": "integer", "format": "int32" }, "videoPercentage": { "oneOf": [ { "type": "number" }, { "type": "integer", "format": "int32" } ] }, "displayPercentage": { "oneOf": [ { "type": "number" }, { "type": "integer", "format": "int32" } ] } }, "example": { "id": 2085, "name": "yahoo.com", "publisher": "UNKNOWN", "appId": "yahoo.com", "inventoryType": "Site", "impressions": 544857607, "uniques": 269603996, "videoPercentage": 78.75, "displayPercentage": 21.25 } }, "description": "" } } } } } } }, "deprecated": false, "security": [], "servers": [ { "url": "http://example.com/api/v2/inv", "variables": { } } ] } }, "/api/v2/inv/group/inventory": { "get": { "tags": [ "Inventory API" ], "summary": "Inventory Group - Get Inventory", "description": "This API can be used to get the mapping of inventories and inventory groups. This API will return all associated groups for given inventories.", "operationId": "InventoryGroup-GetInventory", "parameters": [ { "name": "inventoryIds", "in": "query", "description": "", "required": true, "style": "form", "explode": true, "schema": { "type": "string", "example": "1162,2085,1064,87,37,432,33020,1432,1388,7983,646,332,87,332,4376710,37,4695741,1833,1979,592,1451,37,6599,1541,1162,1979,1162,545,4695741,759,545,14799,1162,565,33046,33326,785,1806,32789,1339,1332,33135,2098,1063,32894,284,1427,1917,1280,33168" } }, { "name": "authorization", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "{{bearer_token}}" } }, { "name": "x-iaa-ow-id", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32", "example": 200001 } } ], "responses": { "200": { "description": "OK", "headers": { "Cache-Control": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "no-cache, no-store, max-age=0, must-revalidate" } } }, "Content-Length": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "481" } } }, "Date": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "Wed, 13 Oct 2021 12:13:39 GMT" } } }, "Expires": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "0" } } }, "Pragma": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "no-cache" } } }, "Server": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "Caddy" } } }, "X-Content-Type-Options": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "nosniff" } } }, "X-Frame-Options": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "DENY" } } }, "X-Xss-Protection": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "1; mode=block" } } } }, "content": { "application/json;charset=UTF-8": { "schema": { "title": "OK10", "required": [ "statusCode", "responseObject" ], "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "responseObject": { "type": "object", "additionalProperties": { "type": "integer", "format": "int32" } } } } } } } }, "deprecated": false, "security": [], "servers": [ { "url": "http://example.com/api/v2/inv", "variables": { } } ] } }, "/api/v2/inv/group/109358/deals": { "get": { "tags": [ "Inventory API" ], "summary": "Inventory Group - Get Deals", "description": "This API can be used to get all deals associated with the inventory group.", "operationId": "InventoryGroup-GetDeals", "parameters": [ { "name": "pageNo", "in": "query", "description": "Default value is 1", "required": true, "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32", "example": 1 } }, { "name": "noOfEntries", "in": "query", "description": "Default value is 10", "required": true, "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32", "example": 50 } }, { "name": "sortBy", "in": "query", "description": "Default value is id", "required": true, "style": "form", "explode": true, "schema": { "type": "string", "example": "id" } }, { "name": "sortOrder", "in": "query", "description": "Default value is asc", "required": true, "style": "form", "explode": true, "schema": { "type": "string", "example": "desc" } }, { "name": "searchField", "in": "query", "description": "This parameter is optional. API will provide all deals for the group without filter if not provided. Search will happen for deal id and deal name.", "required": true, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "x-iaa-ow-id", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32", "example": 200001 } }, { "name": "authorization", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "{{bearer_token}}" } } ], "responses": { "200": { "description": "OK", "headers": { "Cache-Control": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "no-cache, no-store, max-age=0, must-revalidate" } } }, "Content-Length": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "371" } } }, "Date": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "Wed, 13 Oct 2021 18:59:27 GMT" } } }, "Expires": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "0" } } }, "Pragma": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "no-cache" } } }, "Server": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "Caddy" } } }, "X-Content-Type-Options": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "nosniff" } } }, "X-Frame-Options": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "DENY" } } }, "X-Xss-Protection": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "1; mode=block" } } } }, "content": { "application/json;charset=UTF-8": { "schema": { "title": "OK13", "required": [ "statusCode", "responseObject" ], "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "responseObject": { "title": "ResponseObject16", "required": [ "data", "totalRecords", "filteredRecords" ], "type": "object", "properties": { "data": { "type": "array", "items": { "title": "Datum1", "required": [ "id", "dealId", "dealName", "description", "suggestedCPM", "dealTypeId", "creativeTypes", "exchanges", "active", "created", "modifiedDate", "applicableTo", "userName", "isPublic" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "dealId": { "type": "string" }, "dealName": { "type": "string" }, "description": { "type": "string" }, "suggestedCPM": { "type": "integer", "format": "int32" }, "dealTypeId": { "type": "integer", "format": "int32" }, "creativeTypes": { "type": "array", "items": { "type": "string" }, "description": "" }, "exchanges": { "type": "array", "items": { "type": "string" }, "description": "" }, "active": { "type": "boolean" }, "created": { "type": "integer", "format": "int32" }, "modifiedDate": { "type": "string" }, "applicableTo": { "type": "array", "items": { "type": "string" }, "description": "" }, "userName": { "type": "string", "nullable": true }, "isPublic": { "type": "boolean" } }, "example": { "id": 417, "dealId": "Deal180821_1", "dealName": "Deal180821 Edit", "description": "2", "suggestedCPM": 2, "dealTypeId": 1, "creativeTypes": [ "Image" ], "exchanges": [], "active": true, "created": 1629295398, "modifiedDate": "2021-10-13T07:21:08.121+0000", "applicableTo": [], "userName": null, "isPublic": true } }, "description": "" }, "totalRecords": { "type": "integer", "format": "int32" }, "filteredRecords": { "type": "integer", "format": "int32" } }, "example": { "data": [ { "id": 417, "dealId": "Deal180821_1", "dealName": "Deal180821 Edit", "description": "2", "suggestedCPM": 2, "dealTypeId": 1, "creativeTypes": [ "Image" ], "exchanges": [], "active": true, "created": 1629295398, "modifiedDate": "2021-10-13T07:21:08.121+0000", "applicableTo": [], "userName": null, "isPublic": true } ], "totalRecords": 1, "filteredRecords": 1 } } }, "example": { "statusCode": 200, "responseObject": { "data": [ { "id": 417, "dealId": "Deal180821_1", "dealName": "Deal180821 Edit", "description": "2", "suggestedCPM": 2, "dealTypeId": 1, "creativeTypes": [ "Image" ], "exchanges": [], "active": true, "created": 1629295398, "modifiedDate": "2021-10-13T07:21:08.121+0000", "applicableTo": [], "userName": null, "isPublic": true } ], "totalRecords": 1, "filteredRecords": 1 } } }, "example": { "statusCode": 200, "responseObject": { "data": [ { "id": 417, "dealId": "Deal180821_1", "dealName": "Deal180821 Edit", "description": "2", "suggestedCPM": 2, "dealTypeId": 1, "creativeTypes": [ "Image" ], "exchanges": [], "active": true, "created": 1629295398, "modifiedDate": "2021-10-13T07:21:08.121+0000", "applicableTo": [], "userName": null, "isPublic": true } ], "totalRecords": 1, "filteredRecords": 1 } } } } } }, "deprecated": false, "security": [], "servers": [ { "url": "http://example.com/api/v2/inv", "variables": { } } ] } }, "/api/v2/inv/group/109101/edit": { "post": { "tags": [ "Inventory API" ], "summary": "Inventory Group - Edit", "description": "This API can be used to rename the inventory group.", "operationId": "InventoryGroup-Edit", "parameters": [ { "name": "x-iaa-ow-id", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32", "example": 200001 } }, { "name": "authorization", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "{{bearer_token}}" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "title": "InventoryGroup-EditRequest", "required": [ "groupName" ], "type": "object", "properties": { "groupName": { "type": "string" } }, "example": { "groupName": "Second New System Group_edit" } }, "example": { "groupName": "Second New System Group_edit" } } }, "required": true }, "responses": { "200": { "description": "OK", "headers": { "Cache-Control": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "no-cache, no-store, max-age=0, must-revalidate" } } }, "Content-Length": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "269" } } }, "Date": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "Thu, 14 Oct 2021 11:18:03 GMT" } } }, "Expires": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "0" } } }, "Pragma": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "no-cache" } } }, "Server": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "Caddy" } } }, "X-Content-Type-Options": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "nosniff" } } }, "X-Frame-Options": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "DENY" } } }, "X-Xss-Protection": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "1; mode=block" } } } }, "content": { "application/json;charset=UTF-8": { "schema": { "title": "OK15", "required": [ "statusCode", "responseObject" ], "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "responseObject": { "title": "ResponseObject14", "required": [ "created", "modifiedDate", "inventories", "deals", "publishers", "uniques", "impressions", "accountLevelExcluded", "id", "name" ], "type": "object", "properties": { "created": { "type": "integer", "format": "int32" }, "modifiedDate": { "type": "string" }, "inventories": { "type": "integer", "format": "int32" }, "deals": { "type": "integer", "format": "int32" }, "publishers": { "type": "integer", "format": "int32" }, "uniques": { "type": "integer", "format": "int32" }, "impressions": { "type": "integer", "format": "int32" }, "accountLevelExcluded": { "type": "boolean" }, "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" } }, "example": { "created": 1632213876, "modifiedDate": "2021-09-21T14:14:35.584+0000", "inventories": 0, "deals": 1, "publishers": 0, "uniques": 0, "impressions": 0, "accountLevelExcluded": false, "id": 109358, "name": "First New System Group Group" } } }, "example": { "statusCode": 200, "responseObject": { "created": 1631886526, "modifiedDate": "2021-10-14T11:18:03.311+0000", "inventories": 4, "deals": 0, "publishers": 13, "uniques": 317691146, "impressions": 618838017, "accountLevelExcluded": false, "id": 109101, "name": "Second New System Group_edit" } } }, "example": { "statusCode": 200, "responseObject": { "created": 1631886526, "modifiedDate": "2021-10-14T11:18:03.311+0000", "inventories": 4, "deals": 0, "publishers": 13, "uniques": 317691146, "impressions": 618838017, "accountLevelExcluded": false, "id": 109101, "name": "Second New System Group_edit" } } } } } }, "deprecated": false, "security": [], "servers": [ { "url": "http://example.com/api/v2/inv", "variables": { } } ] } }, "/api/v2/inv/group/109101/remove": { "delete": { "tags": [ "Inventory API" ], "summary": "Inventory Group - Revove", "description": "This API can be used to delete the inventory group.", "operationId": "InventoryGroup-Revove", "parameters": [ { "name": "x-iaa-ow-id", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32", "example": 200001 } }, { "name": "authorization", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "{{bearer_token}}" } } ], "responses": { "400": { "description": "Bad Request", "headers": { "Cache-Control": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "no-cache, no-store, max-age=0, must-revalidate" } } }, "Content-Length": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "166" } } }, "Date": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "Thu, 14 Oct 2021 11:21:02 GMT" } } }, "Expires": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "0" } } }, "Pragma": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "no-cache" } } }, "Server": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "Caddy" } } }, "X-Content-Type-Options": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "nosniff" } } }, "X-Frame-Options": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "DENY" } } }, "X-Xss-Protection": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "1; mode=block" } } } }, "content": { "application/json;charset=UTF-8": { "schema": { "title": "BadRequest1", "required": [ "statusCode", "responseObject" ], "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "responseObject": { "title": "ResponseObject19", "required": [ "errorMsg", "errorCode" ], "type": "object", "properties": { "errorMsg": { "type": "string" }, "errorCode": { "type": "integer", "format": "int32" } }, "example": { "errorMsg": "The inventory group cannot be deleted as it is in use in campaigns with ids 214228, 215903, 213309.", "errorCode": 400 } } }, "example": { "statusCode": 400, "responseObject": { "errorMsg": "The inventory group cannot be deleted as it is in use in campaigns with ids 214228, 215903, 213309.", "errorCode": 400 } } }, "example": { "statusCode": 400, "responseObject": { "errorMsg": "The inventory group cannot be deleted as it is in use in campaigns with ids 214228, 215903, 213309.", "errorCode": 400 } } } } } }, "deprecated": false, "security": [], "servers": [ { "url": "http://example.com/api/v2/inv", "variables": { } } ] } }, "/api/v2/inv/group/109212/removeMappings": { "post": { "tags": [ "Inventory API" ], "summary": "Inventory Group - Remove Mappings", "description": "This API can be used to remove inventories or private deals from an inventory group.\n\n`inventoryTypeId=1` can be used to remove inventories and `inventoryTypeId=2` can be used to remove private deals.", "operationId": "InventoryGroup-RemoveMappings", "parameters": [ { "name": "x-iaa-ow-id", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32", "example": 200001 } }, { "name": "authorization", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "{{bearer_token}}" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "title": "InventoryGroup-RemoveMappingsRequest", "required": [ "inventoryTypeId", "dealIds" ], "type": "object", "properties": { "inventoryTypeId": { "type": "integer", "format": "int32" }, "dealIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "" } }, "example": { "inventoryTypeId": 2, "dealIds": [415] } }, "example": { "inventoryTypeId": 2, "dealIds": [415] } } }, "required": true }, "responses": { "200": { "description": "OK", "headers": { "Cache-Control": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "no-cache, no-store, max-age=0, must-revalidate" } } }, "Content-Length": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "238" } } }, "Date": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "Thu, 14 Oct 2021 11:38:34 GMT" } } }, "Expires": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "0" } } }, "Pragma": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "no-cache" } } }, "Server": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "Caddy" } } }, "X-Content-Type-Options": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "nosniff" } } }, "X-Frame-Options": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "DENY" } } }, "X-Xss-Protection": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "1; mode=block" } } } }, "content": { "application/json;charset=UTF-8": { "schema": { "title": "OK15", "required": [ "statusCode", "responseObject" ], "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "responseObject": { "title": "ResponseObject14", "required": [ "created", "modifiedDate", "inventories", "deals", "publishers", "uniques", "impressions", "accountLevelExcluded", "id", "name" ], "type": "object", "properties": { "created": { "type": "integer", "format": "int32" }, "modifiedDate": { "type": "string" }, "inventories": { "type": "integer", "format": "int32" }, "deals": { "type": "integer", "format": "int32" }, "publishers": { "type": "integer", "format": "int32" }, "uniques": { "type": "integer", "format": "int32" }, "impressions": { "type": "integer", "format": "int32" }, "accountLevelExcluded": { "type": "boolean" }, "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" } }, "example": { "created": 1632213876, "modifiedDate": "2021-09-21T14:14:35.584+0000", "inventories": 0, "deals": 1, "publishers": 0, "uniques": 0, "impressions": 0, "accountLevelExcluded": false, "id": 109358, "name": "First New System Group Group" } } }, "example": { "statusCode": 200, "responseObject": { "created": 1631886526, "modifiedDate": "2021-10-14T11:18:03.311+0000", "inventories": 4, "deals": 0, "publishers": 13, "uniques": 317691146, "impressions": 618838017, "accountLevelExcluded": false, "id": 109101, "name": "Second New System Group_edit" } } }, "example": { "statusCode": 200, "responseObject": { "created": 1632031658, "modifiedDate": "2021-09-19T06:07:38.486+0000", "inventories": 0, "deals": 3, "publishers": 0, "uniques": 0, "impressions": 0, "accountLevelExcluded": false, "id": 109212, "name": "New Deal Group" } } } } } }, "deprecated": false, "security": [], "servers": [ { "url": "http://example.com/api/v2/inv", "variables": { } } ] } }, "/api/v2/inv/group/\u003CGROUP_ID\u003E": { "get": { "tags": [ "Inventory API" ], "summary": "Inventory Group - Get group", "description": "This API will get inventory group details for the provided inventory group id.", "operationId": "InventoryGroup-Getgroup", "parameters": [ { "name": "{{ow_id_header_key}}", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "{{ow_id}}" } }, { "name": "Authorization", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "{{bearer_token}}" } } ], "responses": { "200": { "description": "OK", "headers": { "Server": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "nginx" } } }, "Date": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "Tue, 02 Feb 2021 04:11:25 GMT" } } }, "Transfer-Encoding": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "chunked" } } }, "Connection": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "keep-alive" } } }, "Access-Control-Allow-Origin": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "*" } } }, "Access-Control-Allow-Methods": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "GET, POST, OPTIONS, PUT, DELETE" } } }, "Access-Control-Allow-Headers": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "Base-Url,DNT,X-CustomHeader,Keep-Alive,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type,x-iaa-api-token" } } }, "Access-Control-Expose-Headers": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "Content-Type,X-IAA-ADMIN-API-TOKEN,x-iaa-admin-api-token,x-iaa-api-token" } } }, "Access-Control-Max-Age": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "5" } } }, "Cache-Control": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "max-age=5" } } } }, "content": { "application/json;charset=UTF-8": { "schema": { "title": "200OK", "required": [ "statusCode", "responseObject" ], "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "responseObject": { "title": "ResponseObject22", "required": [ "created", "modifiedDate", "inventories", "deals", "contextualInventories", "publishers", "uniques", "impressions", "campaignWhitelistCount", "campaignBlacklistCount", "runningCampaignCount", "pendingCampaignCount", "pausedCampaignCount", "expiredCampaignCount", "sharedCount", "owId", "accountLevelExcluded", "id", "name", "isShared" ], "type": "object", "properties": { "created": { "type": "integer", "format": "int32" }, "modifiedDate": { "type": "string" }, "inventories": { "type": "integer", "format": "int32" }, "deals": { "type": "integer", "format": "int32" }, "contextualInventories": { "type": "integer", "format": "int32" }, "publishers": { "type": "integer", "format": "int32" }, "uniques": { "type": "integer", "format": "int64" }, "impressions": { "type": "integer", "format": "int64" }, "campaignWhitelistCount": { "type": "integer", "format": "int32" }, "campaignBlacklistCount": { "type": "integer", "format": "int32" }, "runningCampaignCount": { "type": "integer", "format": "int32" }, "pendingCampaignCount": { "type": "integer", "format": "int32" }, "pausedCampaignCount": { "type": "integer", "format": "int32" }, "expiredCampaignCount": { "type": "integer", "format": "int32" }, "sharedCount": { "type": "integer", "format": "int32" }, "owId": { "type": "integer", "format": "int32" }, "accountLevelExcluded": { "type": "boolean" }, "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "isShared": { "type": "boolean" } }, "example": { "created": 1632234232, "modifiedDate": "2022-06-10T12:58:45.937+0000", "inventories": 16, "deals": 0, "contextualInventories": 0, "publishers": 141, "uniques": 2310141992, "impressions": 6758994190, "campaignWhitelistCount": 2, "campaignBlacklistCount": 0, "runningCampaignCount": 0, "pendingCampaignCount": 1, "pausedCampaignCount": 0, "expiredCampaignCount": 0, "sharedCount": 0, "owId": 200002, "accountLevelExcluded": true, "id": 109384, "name": "First IG", "isShared": false } } }, "example": { "statusCode": 200, "responseObject": { "created": 1632234232, "modifiedDate": "2022-06-10T12:58:45.937+0000", "inventories": 16, "deals": 0, "contextualInventories": 0, "publishers": 141, "uniques": 2310141992, "impressions": 6758994190, "campaignWhitelistCount": 2, "campaignBlacklistCount": 0, "runningCampaignCount": 0, "pendingCampaignCount": 1, "pausedCampaignCount": 0, "expiredCampaignCount": 0, "sharedCount": 0, "owId": 200002, "accountLevelExcluded": true, "id": 109384, "name": "First IG", "isShared": false } } }, "example": { "statusCode": 200, "responseObject": { "created": 1632234232, "modifiedDate": "2022-06-10T12:58:45.937+0000", "inventories": 16, "deals": 0, "contextualInventories": 0, "publishers": 141, "uniques": 2310141992, "impressions": 6758994190, "campaignWhitelistCount": 2, "campaignBlacklistCount": 0, "runningCampaignCount": 0, "pendingCampaignCount": 1, "pausedCampaignCount": 0, "expiredCampaignCount": 0, "sharedCount": 0, "owId": 200002, "accountLevelExcluded": true, "id": 109384, "name": "First IG", "isShared": false } } } } } }, "deprecated": false, "security": [], "servers": [ { "url": "http://example.com/api/v2/inv", "variables": { } } ] } }, "/api/v3/inv/pmp/deals/list": { "post": { "tags": [ "Inventory API" ], "summary": "It will provide list of PMP deals available for user.", "description": "This API provides paginated list of PMP deals based on requested filters along with total filtered count.\n**Request Body Details:**\n\n| **Field** | **Type** | **Description** |\n| --- | --- | --- |\n| groupId | Integer | groupId to filter pmp deals inside group. |\n| active | Boolean | boolean field to filter active and inactive deals. |\n| searchKeywords | List\u003CString\u003E | list of search strings used to search deals by dealId, dealName and description. |\n| creativeTypes | List\u003CInteger\u003E | list of creative type ids to filter. |\n| exchanges | List\u003CInteger\u003E | list of exchange ids to filter. |\n| ids | List\u003CInteger\u003E | list of pmp deal ids(primary key) to filter. |\n| dealStatuses | List\u003CString\u003E | list of deal status to filter. valid values are inUse, unUsed and inActive. |\n| owIds | List\u003CInteger\u003E | list of owIds to filter deals accessible by provided owIds |\n| pageNo | int | page number to retrieve deals. default value is 1. |\n| noOfEntries | int | number of deals to retrieve. default value is 50. |\n| sortBy | String | sort by string supporting multiple sorting. |\n", "operationId": "getPMPDealList", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "sortCriteriaMap": { "type": "object", "additionalProperties": { "type": "string" } }, "groupId": { "type": "integer", "format": "int32" }, "active": { "type": "boolean" }, "owIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "pageNo": { "type": "integer", "format": "int32" }, "noOfEntries": { "type": "integer", "format": "int32" }, "sortBy": { "type": "string" }, "searchField": { "type": "string" }, "order": { "type": "string", "enum": [ "SortOrderEnum[id=1, name='asc', symbol='+']", "SortOrderEnum[id=2, name='desc', symbol='-']" ] }, "ids": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "searchKeywords": { "type": "array", "items": { "type": "string" } }, "creativeTypes": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "exchanges": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "dealStatuses": { "type": "array", "items": { "type": "string" } } } }, "examples": { "Get PMP deal list": { "description": "Get PMP deal list", "value": { "groupId": 1, "active": true, "searchKeywords": [ "keyword1", "keyword2" ], "creativeTypes": [1, 2, 3], "exchanges": [1, 2, 3, 4], "ids": [1, 2, 3, 4], "dealStatuses": [ "inUse", "unUsed", "inActive" ], "sortBy": "-dealId", "noOfEntries": 2, "pageNo": 1 } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "success": true, "data": { "filteredRecords": 1, "filteredList": [ { "id": 115, "dealId": "1476907757380667148", "dealName": "85%+ Completion", "description": "85%+ Completion", "cpm": 20, "dealCurationTypeId": 1, "creativeTypes": [ "video" ], "exchanges": [ "Oath" ], "active": true, "shared": false, "created": 1597658148, "assignedToCustomers": [1, 2], "assignedToCampaigns": [11223, 65333], "avails": 500, "inventoriesCount": 250 } ] } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Invalid sortBy value." } ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/inv/pmp/deals/add": { "post": { "tags": [ "Inventory API" ], "summary": "Create PMP deal", "description": "This API can be used by advertiser, workspace or super to create pmp deals as well as assignation of deal to customers along with deal creation.\n**Request Body Details:**\n\n| **Field** | **Type** | **Description** |\n| --- | --- | --- |\n| dealId | String | Deal id of the given PMP deal|\n| dealName | String | Deal name of the given PMP deal.|\n| description | String | Description of the PMP deal|\n| cpm | double | CPM value of PMP deal|\n| dealCurationTypeId | int | Id of the deal curation type |\n| creativeTypes | List\u003CInteger\u003E | List of creative type ids |\n| exchangeId | int | Id of exchange associated with PMP deal [Exchanges List](?path=/Master%20API/getExchanges)|\n| assignToCustomers | List\u003CInteger\u003E | List of customer ow ids |\n| active | boolean | Boolean value representing deal status. |\n", "operationId": "addPMPDeal", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "content": { "application/json": { "schema": { "required": [ "active", "dealId", "dealName", "exchangeId" ], "type": "object", "properties": { "dealId": { "maxLength": 500, "minLength": 0, "type": "string" }, "dealName": { "maxLength": 500, "minLength": 0, "type": "string" }, "description": { "maxLength": 1000, "minLength": 0, "type": "string" }, "cpm": { "maximum": 1000, "exclusiveMaximum": false, "minimum": 0.1, "exclusiveMinimum": false, "type": "number", "format": "double" }, "dealCurationTypeId": { "type": "integer", "format": "int32" }, "creativeTypes": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "exchangeId": { "type": "integer", "format": "int32" }, "assignToCustomers": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "active": { "type": "boolean" } } }, "examples": { "Create new PMP deal by advertiser user": { "description": "Create new PMP deal by advertiser user", "value": { "dealId": "DIewkFZALX1taoLjQg6Gge1dD6YvZYO4RChUKmOLk", "dealName": "demo_test deal name", "description": "test deal description", "cpm": 10, "creativeTypes": [11, 12], "exchangeId": 39, "active": true } }, "Create new PMP deal by super/workspace user": { "description": "Create new PMP deal by super/workspace user", "value": { "dealId": "DIewkFZALX1taoLjQg6Gge1dD6YvZYO4RChUKmOLk", "dealName": "demo_test deal name", "description": "test deal description", "cpm": 10, "dealCurationTypeId": 6, "creativeTypes": [11, 12], "exchangeId": 39, "assignToCustomers": [1224, 1546], "active": true } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Deal creation success message": { "description": "Deal creation success message", "value": { "success": true, "data": { "id": 461, "message": "Deal test123 created successfully" } } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "examples": { "Invalid deal description for PMP deal creation": { "description": "Invalid deal description for PMP deal creation", "value": "{{ \"success\": false, \"errorObjects\": [ { \"error\": \"Deal description can not be longer than 1000 characters\", \"field\": \"description\" } ]}" }, "Invalid deal id for PMP deal creation": { "description": "Invalid deal id for PMP deal creation", "value": { "success": false, "errorObjects": [ { "error": "Deal id can not be longer than 500 characters", "field": "dealId" } ] } } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "examples": { "Invalid exchange id passed for PMP deal creation": { "description": "Invalid exchange id passed for PMP deal creation", "value": { "success": false, "errorObjects": [ { "error": "Invalid exchange id/ids provided" } ] } }, "Invalid deal curation type id passed for PMP deal creation": { "description": "Invalid deal curation type id passed for PMP deal creation", "value": { "success": false, "errorObjects": [ { "error": "Invalid deal curation type id/ids provided" } ] } }, "Invalid creative type id passed for PMP deal creation": { "description": "Invalid creative type id passed for PMP deal creation", "value": { "success": false, "errorObjects": [ { "error": "Invalid creative type id/ids provided" } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/inv/pg/deals/add": { "post": { "tags": [ "Inventory API" ], "summary": "It will Create the new PG deal for advertiser.", "description": "Given API will Create the new PG deal for advertiser User.\n**Request Body Details:**\n\n| **Field** | **Type** | **Description** |\n| --- | --- | --- |\n| dealId | String | Deal id of the given PG deal|\n| dealName | String | Deal name of the given PG deal.|\n| exchangeId | int | Id of exchange associated with PG deal [Exchanges List](?path=/Master%20API/getExchanges)|\n| cpm | double | CPM value of PG deal|\n| statusId | int | Id of status for PG deal |\n| paymentTypeId | int | Id of payment type of PG deal|\n| description | String | Description of the PG deal|\n| owId | int | OWId of the advertiser User if super/workspace create the deal |\n", "operationId": "addPGDeal", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "content": { "application/json": { "schema": { "required": [ "dealId", "dealName", "exchangeId", "statusId" ], "type": "object", "properties": { "dealId": { "maxLength": 500, "minLength": 0, "type": "string" }, "dealName": { "maxLength": 500, "minLength": 0, "type": "string" }, "exchangeId": { "type": "integer", "format": "int32" }, "statusId": { "type": "integer", "format": "int32" }, "description": { "maxLength": 1000, "minLength": 0, "type": "string" }, "owId": { "type": "integer", "format": "int32" }, "paymentTypeId": { "type": "integer", "format": "int32" } } }, "examples": { "Create new PG deal by advertiser user": { "description": "Create new PG deal by advertiser user", "value": { "dealId": "YT-Test-1234", "dealName": "Test deal YT31", "exchangeId": 11, "statusId": 2, "paymentTypeId": 1, "description": "Test Deal" } }, "Create new PG deal by super/workspace user": { "description": "Create new PG deal by super/workspace user", "value": { "dealId": "YT-Test-1234", "dealName": "Test deal YT31", "exchangeId": 11, "statusId": 2, "paymentTypeId": 1, "description": "Test Deal", "owId": "12345" } } } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "examples": { "Successful creation of new PG Deal": { "description": "Successful creation of new PG Deal", "value": { "success": true, "data": { "message": "Deal Test deal YT31 created successfully", "id": 2 } } } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "examples": { "PG Deal is already exist": { "description": "PG Deal is already exist", "value": { "success": false, "errorObjects": [ { "error": "Unable to create a new Deal ID. The record already exists for Deal ID ( Test deal YT56 ) with given exchange." } ] } }, "PG Deal exchange is not supported": { "description": "PG Deal exchange is not supported", "value": { "success": false, "errorObjects": [ { "error": "Given exchange is not supported" } ] } }, "PG Deal payment type is not supported": { "description": "PG Deal payment type is not supported", "value": { "success": false, "errorObjects": [ { "error": "Given payment type is not supported" } ] } }, "PG Deal advertiser is not available": { "description": "PG Deal advertiser is not available", "value": { "success": false, "errorObjects": [ { "error": "Given advertiser user is not available" } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/inv/inventories/open-exchange/download": { "post": { "tags": [ "Inventory API" ], "summary": "It will provide csv/xlsx file for inventory list", "description": "This API provides csv/xlsx file for inventory list based on requested filters and searching parameters", "operationId": "downloadOpenExchangeInventoryDetails", "parameters": [ { "name": "keywords", "in": "query", "description": "List of search keywords to Search inventory list", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "countries", "in": "query", "description": "Filter to fetch inventory list based on countries", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "categories", "in": "query", "description": "Filter to fetch inventory list based on categories of inventory", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "inventoryTypes", "in": "query", "description": "Filter to fetch inventory list based on inventory type", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "creativeSizes", "in": "query", "description": "Filter to fetch inventory list based on creative size", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "creativeTypes", "in": "query", "description": "Filter to fetch inventory list based on creative type", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "creativeDurations", "in": "query", "description": "Filter to fetch inventory list based on creative duration for video/audio type", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "trafficTypes", "in": "query", "description": "Filter to fetch inventory list based on traffic type", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "deviceTypes", "in": "query", "description": "Filter to fetch inventory list based on device type", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "exchanges", "in": "query", "description": "Filter to fetch inventory list based on exchanges", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "videoPlayerSizes", "in": "query", "description": "Filter to fetch inventory list based on video player size", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "isCsvSearch", "in": "query", "required": true, "schema": { "type": "boolean" } }, { "name": "fileType", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "multipartFile": { "type": "string", "format": "binary" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "success": true, "data": "https://sample-download-url.com" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/inv/inventories/csv/list": { "post": { "tags": [ "Inventory API" ], "summary": "It will provide list of inventory available for user based on provided csv file", "description": "This API provides paginated list of inventory based on provided csv file", "operationId": "getInventoriesByCSV", "parameters": [ { "name": "domainsFile", "in": "query", "description": "CSV file contains search parameters" }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "domainsFile" ], "type": "object", "properties": { "domainsFile": { "type": "string", "format": "binary" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "success": true, "data": { "matchedInventories": [ { "id": 3510, "name": "Test Inv 1234", "publisher": "UNKNOWN", "appId": "INVENTORY", "inventoryType": "Other App", "impressions": 7397885, "reach": 5257, "videoPercentage": 100, "displayPercentage": 0 }, { "id": 4746, "name": "Test Old TV 345", "publisher": "UNKNOWN", "appId": "INVENTORY", "inventoryType": "Other App", "impressions": 428882, "reach": 31291, "videoPercentage": 100, "displayPercentage": 0 } ] } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/inv/inventories/csv/distributions": { "post": { "tags": [ "Inventory API" ], "summary": "It will provide distribution of inventory available for user across countries, creativeTypes, deviceTypes, trafficTypes based on csv ", "description": "It will provide distribution of inventory available for user across countries, creativeTypes, deviceTypes, trafficTypes based on csv search", "operationId": "getInventoriesDistributionsByCSV", "parameters": [ { "name": "domainsFile", "in": "query", "description": "CSV file contains search parameters" }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "domainsFile" ], "type": "object", "properties": { "domainsFile": { "type": "string", "format": "binary" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "success": true, "data": { "countries": [ { "label": "United States", "value": 90.58 }, { "label": "Brazil", "value": 1.23 }, { "label": "Germany", "value": 0.79 }, { "label": "France", "value": 0.75 }, { "label": "United Kingdom", "value": 0.62 } ], "trafficTypes": [ { "label": "App", "value": 62.85 }, { "label": "Web", "value": 37.15 } ], "creativeTypes": [ { "label": "Video", "value": 47.47 }, { "label": "Banner", "value": 40.96 }, { "label": "Native", "value": 6.38 }, { "label": "Audio", "value": 5.19 } ], "deviceTypes": [ { "label": "Mobile", "value": 43.53 }, { "label": "Connected TV", "value": 37.69 }, { "label": "Desktop", "value": 15.08 }, { "label": "Tablet", "value": 3.57 }, { "label": "Unknown", "value": 0.13 } ] } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/inv/inventories/csv/count": { "post": { "tags": [ "Inventory API" ], "summary": "It will provide count of inventory available for user based on provided csv file", "description": "This API provides count of inventory based on provided csv file", "operationId": "getInventoriesCountByCSV", "parameters": [ { "name": "domainsFile", "in": "query", "description": "CSV file contains search parameters" }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "domainsFile" ], "type": "object", "properties": { "domainsFile": { "type": "string", "format": "binary" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "success": true, "data": { "reach": 7983863253, "impressions": 119273056646, "inventories": 1387184 } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/inv/inventories/block": { "post": { "tags": [ "Inventory API" ], "description": "This API blocks the inventoryIDs based on the inventoryIds passed or searching parameters", "operationId": "addInventoriesToBlockedList", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "properties": { "searchField": { "type": "string" }, "inventoryIds": { "type": "array", "items": { "type": "integer", "format": "int32" } } } } ] } } }, "required": true }, "responses": { "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden !" } ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } }, "default": { "description": "default response" } } } }, "/api/v3/inv/groups": { "post": { "tags": [ "Inventory API" ], "summary": "Adds a new inventory group based on the provided request body.", "operationId": "addInventoryGroup", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "content": { "application/json": { "schema": { "required": [ "groupName" ], "type": "object", "properties": { "groupTypeId": { "type": "integer", "format": "int32" }, "isAllInventories": { "type": "boolean" }, "groupName": { "maxLength": 255, "minLength": 0, "type": "string" }, "isEmptyGroup": { "type": "boolean" }, "inventoryTypeId": { "type": "integer", "format": "int32", "deprecated": true }, "inventoryIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "dealIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "contextualUrls": { "type": "array", "items": { "type": "string" } }, "contextualKeywords": { "type": "array", "items": { "type": "string" } } } }, "examples": { "Create an Open Exchange inventory group with inventoryIds": { "description": "Create an Open Exchange inventory group with inventoryIds", "value": { "groupName": "Inventory Group - Open exchange", "groupTypeId": 1, "inventoryIds": [35132, 4107192] } }, "Create an Open Exchange inventory group with search filters (Select all scenario)": { "description": "Create an Open Exchange inventory group with search filters (Select all scenario)", "value": { "groupTypeId": 1, "groupName": "Inventory Group - Open exchange - search", "excludedInventoryIds": [], "countries": [30100001], "categories": [ "IAB1-1", "IAB1-2", "IAB1-3", "IAB1-4", "IAB1-5", "IAB1-6" ], "inventoryTypes": [2, 3], "creativeTypes": [1], "trafficTypes": [11], "deviceTypes": [20300001], "exchanges": [71, 75, 41, 80, 39, 47, 76, 1, 78, 69, 88, 19, 73] } }, "Create a PMP Inventory group with deals": { "description": "Create a PMP Inventory group with deals", "value": { "groupName": "Inventory Group - PMP", "groupTypeId": 2, "inventoryIds": [], "dealIds": [204], "contextualUrls": [], "contextualKeywords": [] } }, "Create a Contextual Inventory group with keywords": { "description": "Create a Contextual Inventory group with keywords", "value": { "groupName": "Inventory Group - Contextual keywords", "groupTypeId": 3, "inventoryIds": [], "dealIds": [], "contextualUrls": [], "contextualKeywords": [ "mcd" ] } }, "Create a Contextual Inventory group with urls": { "description": "Create a Contextual Inventory group with urls", "value": { "groupName": "Inventory Group - Contextual URLs", "groupTypeId": 3, "inventoryIds": [], "dealIds": [], "contextualUrls": [ "https://mcdindia.com/", "https://www.coca-colacompany.com/" ] } }, "Create a Contextual Inventory group with keywords and urls both": { "description": "Create a Contextual Inventory group with keywords and urls both", "value": { "groupName": "Inventory Group - Contextual keywords and URLs", "groupTypeId": 3, "inventoryIds": [], "dealIds": [], "contextualKeywords": [ "mcd", "coke", "cola" ], "contextualUrls": [ "https://mcdindia.com/", "https://www.coca-colacompany.com/" ] } }, "groupName field validations": { "description": "groupName field validations", "value": { "groupTypeId": 1 } }, "groupTypeId field validations": { "description": "groupTypeId field validations", "value": { "groupName": "Inventory Group - Contextual URLs" } }, "validations when it is an Inventory group": { "description": "validations when it is an Inventory group", "value": { "groupName": "Inventory Group - Open exchange", "groupTypeId": 1 } }, "dealIds field validations when it is a PMP Inventory group": { "description": "dealIds field validations when it is a PMP Inventory group", "value": { "groupName": "Inventory Group - PMP", "groupTypeId": 2 } }, "contextualUrls and contextualKeywords field validations when it is a Contextual Inventory group": { "description": "contextualUrls and contextualKeywords field validations when it is a Contextual Inventory group", "value": { "groupName": "Inventory Group - Contextual keywords and URLs", "groupTypeId": 3 } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Create an Open Exchange inventory group with inventoryIds": { "description": "Create an Open Exchange inventory group with inventoryIds", "value": { "success": true, "data": { "groupTypeId": 1, "created": 1719836234, "modifiedDate": "2024-07-01T12:17:20.295+0000", "owId": 201427, "impressions": 2334725782, "isAccountLevelExcluded": false, "campaignWhitelistCount": 0, "campaignBlacklistCount": 0, "whiteListedCampaignIds": [], "blackListedCampaignIds": [], "sharedCount": 0, "uniques": 0, "reach": 154976228, "inventories": 0, "deals": 0, "contextualInventories": 0, "count": 2, "id": 174594, "name": "Inventory Group - Open exchange", "isShared": false } } }, "Create an Open Exchange inventory group with search filters (Select all scenario)": { "description": "Create an Open Exchange inventory group with search filters (Select all scenario)", "value": { "success": true, "data": { "groupTypeId": 1, "created": 1720030003, "modifiedDate": "2024-07-03T18:06:45.627+0000", "owId": 201427, "impressions": 5298817, "isAccountLevelExcluded": false, "campaignWhitelistCount": 0, "campaignBlacklistCount": 0, "whiteListedCampaignIds": [], "blackListedCampaignIds": [], "sharedCount": 0, "uniques": 0, "reach": 458855, "inventories": 0, "deals": 0, "contextualInventories": 0, "count": 24, "id": 176177, "name": "Inventory Group - Open exchange - search", "isShared": false } } }, "Create a PMP Inventory group with deals": { "description": "Create a PMP Inventory group with deals", "value": { "success": true, "data": { "groupTypeId": 2, "created": 1719836290, "modifiedDate": "2024-07-01T12:18:10.397+0000", "owId": 201427, "impressions": 0, "isAccountLevelExcluded": false, "campaignWhitelistCount": 0, "campaignBlacklistCount": 0, "whiteListedCampaignIds": [], "blackListedCampaignIds": [], "sharedCount": 0, "uniques": 0, "reach": 0, "inventories": 0, "deals": 0, "contextualInventories": 0, "count": 1, "id": 174599, "name": "Inventory Group - PMP", "isShared": false } } }, "Create a Contextual Inventory group with keywords": { "description": "Create a Contextual Inventory group with keywords", "value": { "success": true, "data": { "groupTypeId": 3, "created": 1719836518, "modifiedDate": "2024-07-01T12:21:57.521+0000", "owId": 201427, "impressions": 0, "isAccountLevelExcluded": false, "campaignWhitelistCount": 0, "campaignBlacklistCount": 0, "whiteListedCampaignIds": [], "blackListedCampaignIds": [], "sharedCount": 0, "uniques": 0, "reach": 0, "inventories": 0, "deals": 0, "contextualInventories": 0, "count": 1, "id": 174768, "name": "Inventory Group - Contextual keywords", "isShared": false } } }, "Create a Contextual Inventory group with urls": { "description": "Create a Contextual Inventory group with urls", "value": { "success": true, "data": { "groupTypeId": 3, "created": 1719836561, "modifiedDate": "2024-07-01T12:22:40.692+0000", "owId": 201427, "impressions": 0, "isAccountLevelExcluded": false, "campaignWhitelistCount": 0, "campaignBlacklistCount": 0, "whiteListedCampaignIds": [], "blackListedCampaignIds": [], "sharedCount": 0, "uniques": 0, "reach": 0, "inventories": 0, "deals": 0, "contextualInventories": 0, "count": 2, "id": 174823, "name": "Inventory Group - Contextual URLs", "isShared": false } } }, "Create a Contextual Inventory group with keywords and urls both": { "description": "Create a Contextual Inventory group with keywords and urls both", "value": { "success": true, "data": { "groupTypeId": 3, "created": 1719836633, "modifiedDate": "2024-07-01T12:23:52.829+0000", "owId": 201427, "impressions": 0, "isAccountLevelExcluded": false, "campaignWhitelistCount": 0, "campaignBlacklistCount": 0, "whiteListedCampaignIds": [], "blackListedCampaignIds": [], "sharedCount": 0, "uniques": 0, "reach": 0, "inventories": 0, "deals": 0, "contextualInventories": 0, "count": 5, "id": 174880, "name": "Inventory Group - Contextual keywords and URLs", "isShared": false } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden !" } ] } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "examples": { "groupName field validations": { "description": "groupName field validations", "value": { "success": false, "errorObjects": [ { "error": "Group name is required", "field": "groupName" } ] } }, "groupTypeId field validations": { "description": "groupTypeId field validations", "value": { "success": false, "errorObjects": [ { "error": "Missing or invalid group type ID: null", "field": "groupTypeId" } ] } }, "validations when it is an Inventory group": { "description": "validations when it is an Inventory group" }, "dealIds field validations when it is a PMP Inventory group": { "description": "dealIds field validations when it is a PMP Inventory group", "value": { "success": false, "errorObjects": [ { "error": "Deal IDs cannot be empty for PMP group type", "field": "dealIds" } ] } }, "No inventory found from the search filter or the inventory IDs mentioned in the request body": { "description": "No inventory found from the search filter or the inventory IDs mentioned in the request body", "value": { "success": false, "errorObjects": [ { "error": "No inventory found from the search filter or the inventory IDs mentioned in the request body, hence no group will be created" } ] } }, "contextualUrls and contextualKeywords field validations when it is a Contextual Inventory group": { "description": "contextualUrls and contextualKeywords field validations when it is a Contextual Inventory group", "value": { "success": false, "errorObjects": [ { "error": "Either keywords or URLs must be provided for CONTEXTUAL group type" } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/inv/group/{groupId}/open-exchange/download": { "post": { "tags": [ "Inventory API" ], "summary": "Downloads the list of open exchange inventories for an inventory group based on various filters and parameters.", "operationId": "downloadOpenExchangeInventoryDetailsByGroupId", "parameters": [ { "name": "searchField", "in": "query", "description": "Search inventory group by name", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "fileType", "in": "query", "description": "File Type", "required": true, "schema": { "type": "string" } }, { "name": "groupId", "in": "path", "description": "Inventory Group ID", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "Successful Download of open exchange inventory details list in an inventory group", "content": { "application/json": { "example": { "success": true, "data": "https://iqm-ephemeral-2aca615e13f8-stage.s3.amazonaws.com/inventory/download/csv/Yash%20org%202_1720435555550.csv?response-expires-Amz-Credential" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden !" } ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/inv/group/removeMappings": { "post": { "tags": [ "Inventory API" ], "summary": "It will remove inventories (Open Exchange, Private Deals, Contextual) to group", "operationId": "removeMappingsOfInventoryGroup", "parameters": [ { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "inventoryTypeId": { "type": "integer", "format": "int32", "deprecated": true }, "searchField": { "type": "string" }, "excludedInventoryIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "groupTypeId": { "maximum": 3, "minimum": 1, "type": "integer", "format": "int32" }, "groupId": { "type": "integer", "format": "int32" }, "inventoryIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "dealIds": { "type": "array", "items": { "type": "integer", "format": "int32" } } } }, "examples": { "Remove inventories from group using searching": { "description": "Remove inventories from group using searching", "value": { "groupId": 100462, "searchField": "foxnews", "isAllInventories": true } }, "Remove pmp deals from group": { "description": "Remove pmp deals from group", "value": { "groupId": 100462, "dealIds": [10] } }, "Remove Contextual Inventories from group": { "description": "Remove Contextual Inventories from group", "value": { "groupId": 100462, "contextualKeywords": [ "testing1", "testing2" ], "contextualUrls": [ "http://google.com", "http://google1.com" ] } }, "Remove specific inventories to group": { "description": "Remove specific inventories to group", "value": { "groupId": 100462, "inventoryIds": [52983] } } } } }, "required": true }, "responses": { "200": { "description": "Ok", "content": { "application/json": { "examples": { "Return the inventory group details": { "description": "Return the inventory group details", "value": { "success": true, "data": [ { "groupTypeId": 1, "created": 1719983099, "modifiedDate": "2024-07-03T07:35:45.800+0000", "owId": 202017, "impressions": 7927783118, "isAccountLevelExcluded": false, "whiteListedCampaignIds": null, "blackListedCampaignIds": null, "sharedCount": 1, "uniques": 0, "reach": 558137549, "inventories": 0, "deals": 0, "contextualInventories": 0, "count": 2, "id": 176130, "name": "Open Exchange Inventories Group", "isShared": true } ] } } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "examples": { "Deal(s) are modelled": { "description": "Deal(s) are modelled", "value": { "success": false, "errorObjects": [ { "error": "Deal can't be deleted from group as it is modeled in assigned campaign(s)" } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/inv/group/addMappings": { "post": { "tags": [ "Inventory API" ], "summary": "It will add inventories (Open Exchange, Private Deals, Contextual) to group", "operationId": "addMappingsToInventoryGroups", "parameters": [ { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" } ], "requestBody": { "content": { "application/json": { "schema": { "required": [ "groupName" ], "type": "object", "properties": { "groupName": { "maxLength": 255, "minLength": 0, "type": "string" } } }, "examples": { "Add inventories to group using filters": { "description": "Add inventories to group using filters", "value": { "groupIds": [100462], "keywords": [ "foxnews", "CNN", "com.sleeeeepfly.knife.io" ], "countries": [30100001, 30100002], "categories": [ "IAB1", "IAB14" ], "inventoryTypes": [1, 2, 3], "creativeSizes": [ "574x323", "288x162" ], "creativeTypes": [1, 2, 3], "creativeDurations": [1, 2, -1], "trafficTypes": [11, 12], "deviceTypes": [20300001], "exchanges": [47, 48], "videoPlayerSizes": [1, 3, 4, -1], "isAllInventories": true } }, "Add private deals to group": { "description": "Add private deals to group", "value": { "groupIds": [100462, 100463], "dealIds": [10] } }, "Add Contextual Inventories to group": { "description": "Add Contextual Inventories to group", "value": { "groupIds": [100462, 100463], "contextualKeywords": [ "testing1", "testing2" ], "contextualUrls": [ "http://google.com", "http://google1.com" ] } }, "Add inventories to group": { "description": "Add inventories to group", "value": { "groupIds": [100462, 100463], "inventoryIds": [52983] } } } } }, "required": true }, "responses": { "200": { "description": "Ok", "content": { "application/json": { "examples": { "Add inventories to group using filters": { "description": "Add inventories to group using filters", "value": { "success": true, "data": [ { "groupTypeId": 1, "created": 1719983099, "modifiedDate": "2024-07-03T07:35:45.800+0000", "owId": 202017, "impressions": 7927783118, "isAccountLevelExcluded": false, "whiteListedCampaignIds": null, "blackListedCampaignIds": null, "sharedCount": 1, "uniques": 0, "reach": 558137549, "inventories": 0, "deals": 0, "contextualInventories": 0, "count": 2, "id": 176130, "name": "Open Exchange Inventories Group", "isShared": true } ] } } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "example": { "statusCode": 422, "responseObject": { "errorMsg": "This Inventory is already added in the group.", "errorCode": 422 } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/inv/deals/list": { "post": { "tags": [ "Inventory API" ], "summary": "Retrieves a list of PG and PMP deals used for report filter.", "description": "This api retrieves a list of PG and PMP deals for report filter and also supports filters through request body.\n**Request Body Details:**\n\n| **Field** | **Type** | **Description** |\n| --- | --- | --- |\n| deal | Map\u003CString, Set\u003CInteger\u003E\u003E | Map of dealType and list of deal ids(primary key) for filtering |\n| dealStatus | List\u003CString\u003E | deal status to filter deals. Valid values are Active and Inactive |\n| searchField | String | search string used to search deals by search columns |\n| searchBy | List\u003CString\u003E | search columns to perform search on. Valid values are dealId, dealName and exchangeName |\n| pageNo | int | page number to view deal. default value is 1. |\n| noOfEntries | int | number of deals to retrieve. default value is 50. |\n| sortBy | String | sort by string supporting multiple sorting. |\n| owIds | Set\u003CInteger\u003E | set of owIds to filter deals accessible by provided owIds |\n", "operationId": "getPMPAndPGDeals", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "sortCriteriaMap": { "type": "object", "additionalProperties": { "type": "string" } }, "owIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "deal": { "type": "object", "additionalProperties": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } } }, "dealStatus": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "searchBy": { "type": "array", "items": { "type": "string" } }, "pageNo": { "type": "integer", "format": "int32" }, "noOfEntries": { "type": "integer", "format": "int32" }, "sortBy": { "type": "string" }, "searchField": { "type": "string" }, "order": { "type": "string", "enum": [ "SortOrderEnum[id=1, name='asc', symbol='+']", "SortOrderEnum[id=2, name='desc', symbol='-']" ] } } }, "examples": { "Get PG and PMP deal list": { "description": "Get PG and PMP deal list", "value": { "deal": { "PG": [3], "PMP": [378] }, "owIds": [201427], "dealStatus": [ "Active" ], "searchField": "Smaato ", "searchBy": [ "dealId", "dealName", "exchangeName" ], "pageNo": 1, "noOfEntries": 50, "sortBy": "dealId" } } } } }, "required": true }, "responses": { "200": { "description": "Successful retrieval of deal list", "content": { "application/json": { "examples": { "Get PG and PMP deal list": { "description": "Get PG and PMP deal list", "value": { "success": true, "data": { "totalRecords": 2511, "filteredRecords": 2, "dealList": [ { "id": 3, "dealId": "PM-Ny3ey3-2", "dealStatus": "Active", "dealName": "Test deal IV91", "exchangeName": "Smaato", "dealType": "PG", "campaignCount": 3 }, { "id": 378, "dealId": "gp8n", "dealStatus": "Active", "dealName": "Smaato CTV Deal", "exchangeName": "Smaato", "dealType": "PMP", "campaignCount": 22 } ] } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden !" } ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/inv/blocked-inventories/block-file": { "post": { "tags": [ "Inventory API" ], "description": "This API blocks the Inventories based on the file uploaded. The files should be in CSV format with domains and bundles as columns. ", "operationId": "blockInventoriesToBlockedListViaFile", "parameters": [ { "name": "blocklistFile", "in": "query", "description": "CSV file contains search parameters" }, { "name": "fileTypeId", "in": "query", "description": "ID of file type", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "content": { "application/json": { "schema": { "required": [ "blocklistFile" ], "type": "object", "properties": { "blocklistFile": { "type": "string", "format": "binary" } } } } } }, "responses": { "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden !" } ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } }, "default": { "description": "default response", "content": { "*/*": { "example": { "success": true, "data": { "message": "{numberOfInventoryIds} inventories blocked successfully" } } } } } } } }, "/api/v3/internal/inv/contextual/{groupId}": { "get": { "tags": [ "Inventory API" ], "summary": "It will get contextual inventory backend table values.", "operationId": "getContextualInventoryBackendData", "parameters": [ { "name": "groupId", "in": "path", "description": "Inventory Group Id", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "success": true, "data": { "id": 123234, "urls": [ "https://www.cricbuzz.com/", "https://www.espn.in/" ], "keywords": [ "covid", "covid 19" ] } } } } }, "204": { "description": "No Content" }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "examples": { "Group id doesn't exist": { "description": "Group id doesn't exist", "value": { "success": false, "errorObjects": [ { "error": "Provided group id doesn't exist." } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } }, "post": { "tags": [ "Inventory API" ], "summary": "It will add or update contextual inventory backend table values.", "operationId": "addContextualInventoryBackendData", "parameters": [ { "name": "groupId", "in": "path", "description": "Inventory Group Id", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "urls": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "keywords": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "removeExisting": { "type": "boolean" } } }, "examples": { "Append values": { "description": "Append values", "value": { "urls": [ "https:www.cricbuzz.com", "https:www.espn.in" ], "keywords": [ "covid", "covid 19" ] } }, "Replace values": { "description": "Replace values", "value": { "urls": [ "https:www.cricbuzz.com", "https:www.espn.in" ], "keywords": [ "covid", "covid 19" ], "removeExisting": true } }, "Empty values": { "description": "Empty values", "value": { "urls": [], "keywords": [] } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Append values": { "description": "Append values", "value": { "success": true, "data": { "id": 123234, "urls": [ "https://www.cricbuzz.com/", "https://www.espn.in/" ], "keywords": [ "covid", "covid 19" ] } } }, "Replace values": { "description": "Replace values", "value": { "success": true, "data": { "id": 123234, "urls": [ "https://www.google.com/", "https://www.cricbuzz.com/", "https://www.espn.in/" ], "keywords": [ "vaccine", "covid", "covid 19" ] } } } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "examples": { "Empty values": { "description": "Empty values", "value": { "success": false, "errorObjects": [ { "error": "urls or keywords is required." } ] } }, "Group id doesn't exist": { "description": "Group id doesn't exist", "value": { "success": false, "errorObjects": [ { "error": "Provided group id doesn't exist." } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } }, "delete": { "tags": [ "Inventory API" ], "summary": "It will remove contextual inventory backend table values.", "operationId": "removeContextualInventoryBackendData", "parameters": [ { "name": "groupId", "in": "path", "description": "Inventory Group Id", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "urls": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "keywords": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "removeExisting": { "type": "boolean" } } }, "examples": { "Remove all values": { "description": "Remove all values", "value": { "urls": [], "keywords": [] } }, "Remove specified values": { "description": "Remove specified values", "value": { "urls": [ "https:www.cricbuzz.com", "https:www.espn.in" ], "keywords": [ "covid" ] } }, "Empty values": { "description": "Empty values", "value": { "urls": null, "keywords": null } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Remove all values": { "description": "Remove all values", "value": { "success": true, "data": { "id": 123234, "urls": [], "keywords": [] } } }, "Remove specified values": { "description": "Remove specified values", "value": { "success": true, "data": { "id": 123234, "urls": [ "https://www.google.com/" ], "keywords": [ "vaccine", "covid 19" ] } } } } } } }, "204": { "description": "No Content" }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "examples": { "Empty values": { "description": "Empty values", "value": { "success": false, "errorObjects": [ { "error": "urls or keywords is required." } ] } }, "Group id doesn't exist": { "description": "Group id doesn't exist", "value": { "success": false, "errorObjects": [ { "error": "Provided group id doesn't exist." } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/inv/pmp/deals/{id}": { "get": { "tags": [ "Inventory API" ], "summary": "Get PMP deal details", "description": "This API can be used by advertiser, workspace or super to get pmp deal details including campaign ids in which deal is assigned", "operationId": "getPMPDealDetails", "parameters": [ { "name": "id", "in": "path", "description": "id of the pmp deal (primary key) to retrieve details", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "PMP deal fetched successfully": { "description": "PMP deal fetched successfully", "value": { "success": true, "data": { "id": 459, "dealId": "BySuper_toAdvertiser", "dealName": "BySuper_toAdvertiser_stageSharedOnly", "description": "BySuper_toAdvertiser", "cpm": 10, "dealCurationTypeId": 2, "creativeTypes": [ "html", "video", "native" ], "exchanges": [ "Equativ" ], "active": true, "created": 1716877559, "assignedToCustomers": [201427], "assignedToCampaigns": [2046372, 2053221] } } } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "examples": { "Invalid pmp deal id passed": { "description": "Invalid pmp deal id passed", "value": { "success": false, "errorObjects": [ { "error": "PMP deal Id is invalid or not accessible for logged-in user" } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } }, "patch": { "tags": [ "Inventory API" ], "summary": "Edit PMP deal", "description": "This API can be used by advertiser, workspace or super to edit pmp deal\n**Request Body Details:**\n\n| **Field** | **Type** | **Description** |\n| --- | --- | --- |\n| dealId | String | Deal id of the given PMP deal|\n| dealName | String | Deal name of the given PMP deal.|\n| description | String | Description of the PMP deal|\n| cpm | double | CPM value of PMP deal|\n| creativeTypes | List\u003CInteger\u003E | List of creative type ids |\n| exchangeId | int | Id of exchange associated with PMP deal [Exchanges List](?path=/Master%20API/getExchanges)|\n| active | boolean | Boolean value representing deal status. |\n| assignToCustomers | List\u003CInteger\u003E | List of customer ow ids. This field is only allowed for workspace and super user. |\n", "operationId": "editPMPDeal", "parameters": [ { "name": "id", "in": "path", "description": "id of the pmp deal (primary key) to update details", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "dealId": { "maxLength": 500, "minLength": 0, "type": "string" }, "dealName": { "maxLength": 500, "minLength": 0, "type": "string" }, "description": { "maxLength": 1000, "minLength": 0, "type": "string" }, "cpm": { "maximum": 1000, "exclusiveMaximum": false, "minimum": 0.1, "exclusiveMinimum": false, "type": "number", "format": "double" }, "creativeTypes": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "exchangeId": { "type": "integer", "format": "int32" }, "assignToCustomers": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "active": { "type": "boolean" } } }, "examples": { "Edit existing PMP deal by advertiser": { "description": "Edit existing PMP deal by advertiser", "value": { "dealId": "DIewkFZALX1taoLjQg6Gge1dD6YvZYO4RChUKmOLk", "dealName": "demo_test deal name", "description": "test deal description", "cpm": 10, "creativeTypes": [11, 12], "exchangeId": 39, "active": true } }, "Edit existing PMP deal by workspace/super user ": { "description": "Edit existing PMP deal by workspace/super user ", "value": { "dealId": "DIewkFZALX1taoLjQg6Gge1dD6YvZYO4RChUKmOLk", "dealName": "demo_test deal name", "description": "test deal description", "cpm": 10, "creativeTypes": [11, 12], "exchangeId": 39, "active": true, "assignToCustomers": [2013445, 201344] } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Deal update success message": { "description": "Deal update success message", "value": { "success": true, "data": { "id": 461, "message": "Deal test123 updated successfully" } } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "examples": { "Invalid deal description for PMP deal update": { "description": "Invalid deal description for PMP deal update", "value": "{{ \"success\": false, \"errorObjects\": [ { \"error\": \"Deal description can not be longer than 1000 characters\", \"field\": \"description\" } ]}" }, "Invalid deal id for PMP deal update": { "description": "Invalid deal id for PMP deal update", "value": { "success": false, "errorObjects": [ { "error": "Deal id can not be longer than 500 characters", "field": "dealId" } ] } } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "examples": { "Invalid exchange id passed for PMP deal update": { "description": "Invalid exchange id passed for PMP deal update", "value": { "success": false, "errorObjects": [ { "error": "Invalid exchange id/ids provided" } ] } }, "Invalid creative type id passed for PMP deal update": { "description": "Invalid creative type id passed for PMP deal update", "value": { "success": false, "errorObjects": [ { "error": "Invalid creative type id/ids provided" } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/inv/pg/deals/{id}": { "get": { "tags": [ "Inventory API" ], "summary": "Retrieves PG Deal details with associated campaign IDs", "description": "Returns detailed information about a PG Deal including its associated campaign IDs", "operationId": "getPGDealById", "parameters": [ { "name": "id", "in": "path", "description": "PG Deal ID to retrieve details", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "Successfully retrieved PG Deal details", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "errorObjects": { "type": "array", "items": { "type": "object", "properties": { "error": { "type": "string" }, "reason": { "type": "string" }, "field": { "type": "string" } } } }, "data": { "type": "object" } } }, "examples": { "Response including PG Deal details": { "description": "Response including PG Deal details", "value": { "success": true, "data": { "id": 872, "dealId": "PM-QWE-54321", "dealName": "Sample Deal C3", "statusId": 1, "description": "Sample deal description C3", "paymentTypeId": 2, "exchangeId": 78, "created": 1719722247192, "activeCampaignIds": [506160, 506161, 506162], "otherCampaignIds": [506163, 506164, 506165, 506166] } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden !" } ] } } } }, "422": { "description": "PG Deal request error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "errorObjects": { "type": "array", "items": { "type": "object", "properties": { "error": { "type": "string" }, "reason": { "type": "string" }, "field": { "type": "string" } } } }, "data": { "type": "object" } } }, "examples": { "Invalid PG Deal data": { "description": "Invalid PG Deal data", "value": { "success": false, "errorObjects": [ { "error": "No PG Deal found for ID: [123456]" } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } }, "patch": { "tags": [ "Inventory API" ], "summary": "Update PG Deal details by ID", "description": "Updates specific details of a PG Deal identified by its ID. Allows modification of fields like deal ID, deal name, exchange ID, CPM, status ID, description, payment type ID and handles validations & restrictions.\n\n**Request Body Detail**:\n| Field | Type | Description |\n|---------------|---------|-----------------------------------------------------|\n| dealId | String | Updated Deal ID |\n| dealName | String | Updated name of the PG Deal |\n| exchangeId | Integer | Updated ID of the exchange associated with the deal |\n| cpm | Double | Updated Cost Per Mille (CPM) rate |\n| statusId | Integer | Updated status ID indicating deal's current state |\n| description | String | Updated description or notes about the deal |\n| paymentTypeId | Integer | Updated ID indicating the payment type for the deal |\n\n", "operationId": "updatePGDeal", "parameters": [ { "name": "id", "in": "query", "description": "ID of the PG Deal to be updated", "required": true }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "description": "Contains details for updating a PG Deal using a PATCH request.\nThis is a PATCH request, so only the fields being updated need to be included.\nThe example below shows all possible fields.\n", "content": { "application/json": { "schema": { "type": "object", "properties": { "dealId": { "maxLength": 500, "minLength": 0, "type": "string" }, "dealName": { "maxLength": 500, "minLength": 0, "type": "string" }, "exchangeId": { "type": "integer", "format": "int32" }, "statusId": { "type": "integer", "format": "int32" }, "description": { "maxLength": 1000, "minLength": 0, "type": "string" }, "paymentTypeId": { "type": "integer", "format": "int32" } } }, "examples": { "Update PG Deal Request Example": { "description": "Update PG Deal Request Example", "value": { "dealId": "PM-ABC-12345", "dealName": "Premium Advertising Package", "statusId": 2, "description": "Comprehensive advertising package including display, video, and social media placements for maximum exposure.", "cpm": 40, "paymentTypeId": 2, "exchangeId": 11 } } } } }, "required": true }, "responses": { "200": { "description": "Successfully updated the PG Deal", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "errorObjects": { "type": "array", "items": { "type": "object", "properties": { "error": { "type": "string" }, "reason": { "type": "string" }, "field": { "type": "string" } } } }, "data": { "type": "object" } } }, "examples": { "Response after successfully updating PG Deal": { "description": "Response after successfully updating PG Deal", "value": { "success": true, "data": "PG deal updated successfully" } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden !" } ] } } } }, "422": { "description": "PG Deal request error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "errorObjects": { "type": "array", "items": { "type": "object", "properties": { "error": { "type": "string" }, "reason": { "type": "string" }, "field": { "type": "string" } } } }, "data": { "type": "object" } } }, "examples": { "Invalid PG Deal data": { "description": "Invalid PG Deal data", "value": { "success": false, "errorObjects": [ { "error": "No PG Deal found for ID: [123456]" } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/inv/groups/{groupId}": { "delete": { "tags": [ "Inventory API" ], "summary": "Deletes an existing inventory group based on the provided group ID.", "operationId": "deleteInventoryGroup", "parameters": [ { "name": "groupId", "in": "path", "description": "Inventory Group ID", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Delete an Inventory group": { "description": "Delete an Inventory group", "value": { "success": true, "data": "Inventory group deleted successfully." } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden !" } ] } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "examples": { "Invalid groupId validation": { "description": "Invalid groupId validation", "value": { "success": false, "errorObjects": [ { "error": "Unauthorized user or invalid inventory group." } ] } }, "A group with campaigns attached cannot be deleted validation": { "description": "A group with campaigns attached cannot be deleted validation", "value": { "success": false, "errorObjects": [ { "error": "The inventory group cannot be deleted as it is currently used in campaigns with the following IDs: 503885, 486112, 478890." } ] } }, "Global blocklist group cannot be deleted validation": { "description": "Global blocklist group cannot be deleted validation", "value": { "success": false, "errorObjects": [ { "error": "The inventory group cannot be deleted as it is a global blocklist group." } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } }, "patch": { "tags": [ "Inventory API" ], "summary": "Edits an existing inventory group based on the provided request body.", "operationId": "editInventoryGroup", "parameters": [ { "name": "groupId", "in": "path", "description": "Inventory Group ID", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "content": { "application/json": { "schema": { "required": [ "groupName" ], "type": "object", "properties": { "groupName": { "maxLength": 255, "minLength": 0, "type": "string" } } }, "examples": { "Edit an Inventory group": { "description": "Edit an Inventory group", "value": { "groupName": "Open exchange Group - updated" } }, "groupName field validations": { "description": "groupName field validations", "value": { } }, "groupName field validations for more than 255 characters": { "description": "groupName field validations for more than 255 characters", "value": { "groupName": "Open Exchange Inventory Group - Optimizing Ad Spaces Across Diverse Platforms for Maximum Reach and Engagement in Q3 2024, Targeting Premium Digital Inventory, Ensuring High Impressions and Unique User Reach for Enhanced Campaign Performance, utilizing the best ad spaces available across multiple digital platforms." } }, "Global blocklist group cannot be edited validation": { "description": "Global blocklist group cannot be edited validation", "value": { "groupName": "Updated Global blocklist group" } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Edit an Inventory group": { "description": "Edit an Inventory group", "value": { "success": true, "data": { "groupTypeId": null, "created": null, "modifiedDate": null, "owId": 0, "impressions": 0, "isAccountLevelExcluded": null, "campaignWhitelistCount": 0, "campaignBlacklistCount": 0, "whiteListedCampaignIds": null, "blackListedCampaignIds": null, "sharedCount": 0, "uniques": 0, "reach": 0, "inventories": 0, "deals": 0, "contextualInventories": 0, "count": 0, "id": 176168, "name": "Open exchange Group - updated", "isShared": false } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden !" } ] } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "examples": { "groupName field validations": { "description": "groupName field validations", "value": { "success": false, "errorObjects": [ { "error": "Group name is required", "field": "groupName" } ] } }, "groupName field validations for more than 255 characters": { "description": "groupName field validations for more than 255 characters", "value": { "success": false, "errorObjects": [ { "error": "Inventory group name can not have more than 255 characters.", "field": "groupName" } ] } }, "Global blocklist group cannot be edited validation": { "description": "Global blocklist group cannot be edited validation", "value": { "success": false, "errorObjects": [ { "error": "The inventory group cannot be edited as it is a global blocklist group." } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/inv/group/{groupId}/shared/customers/edit": { "patch": { "tags": [ "Inventory API" ], "summary": "It will add or remove customers from shared inventory group.", "operationId": "editSharedGroupMapping", "parameters": [ { "name": "groupId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "addOWIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "removeOWIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } } } }, "examples": { "Add and remove shared group mapping": { "description": "Add and remove shared group mapping", "value": { "addOWIds": [200425, 200495, 200496], "removeOWIds": [200929, 200931, 200963, 200964] } }, "ow ids are required": { "description": "ow ids are required", "value": { } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Add and remove shared group mapping": { "description": "Add and remove shared group mapping", "value": { "success": true, "data": "Your changes have been successfully saved." } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "examples": { "Not authorized to access group": { "description": "Not authorized to access group", "value": { "success": false, "errorObjects": [ { "error": "Unauthorized" } ] } } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "examples": { "ow ids are required": { "description": "ow ids are required", "value": { "success": false, "errorObjects": [ { "error": "One or more ow ids are required in addOWIds or removeOWIds." } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/inv/static/rtb-creative-types": { "get": { "tags": [ "Inventory API" ], "summary": "This API fetches a static list of RTB creative types with ctv supported flag support.", "description": "This API fetches a static list of RTB creative types, including id, name, displayName, order and ctvSupported flag.This API is intentionally made separate despite having master RTB creative type API for Inventory App specific use case to support ctvSupported flag.", "operationId": "getRTBCreativeTypes", "parameters": [ { "name": "ctvSupported", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "RTB Creative Type list with ctv supported": { "description": "RTB Creative Type list with ctv supported", "value": { "success": true, "data": [ { "id": 1, "name": "banner", "order": 1, "displayName": "Banner" }, { "id": 2, "name": "audio", "order": 2, "displayName": "Audio" }, { "id": 3, "name": "video", "order": 3, "displayName": "Video" } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } }, "deprecated": true } }, "/api/v3/inv/static/deal-types": { "get": { "tags": [ "Inventory API" ], "summary": "This API fetches a static list of deal types.", "description": "This API fetches a static list of deal types, including name, id, display name and order, sorted in ascending order by the order column.", "operationId": "getDealTypes", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "DealType list": { "description": "DealType list", "value": { "success": true, "data": { "totalRecords": 2, "filteredRecords": 2, "dealTypeList": [ { "displayName": "PMP Deal", "name": "PMP deal", "id": 1, "order": 1 }, { "displayName": "PG Deal", "name": "PG deal", "id": 2, "order": 2 } ] } } } } } } }, "204": { "description": "No Content" }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/inv/static/deal-status": { "get": { "tags": [ "Inventory API" ], "summary": "This API fetches a static list of deal status.", "description": "This API fetches a static list of deal status including name, id, label and order", "operationId": "getDealStatuses", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Deal status list": { "description": "Deal status list", "value": { "success": true, "data": { "dealStatuses": [ { "name": "active", "id": 1, "label": "Active", "order": 1 }, { "name": "inactive", "id": 2, "label": "Inactive", "order": 2 } ], "totalRecords": 2, "filteredRecords": 2 } } } } } } }, "204": { "description": "No Content" }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/inv/pmp/deals/{dealId}/inventories/list": { "get": { "tags": [ "Inventory API" ], "summary": "Get inventories associated with a specific PMP deal", "description": "This API retrieves paginated list of inventories associated with a specific PMP (Private Marketplace) deal. Returns deal information along with the list of inventories linked to the given deal ID.The deal ID required is the internal primary key (integer) of the deal not the external deal identifier.", "operationId": "getPMPDealInventoriesByDealId", "parameters": [ { "name": "dealId", "in": "path", "description": "Unique identifier of the PMP deal for which inventories are to be retrieved", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNo", "in": "query", "description": "Page number for pagination (default: 1)", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "noOfEntries", "in": "query", "description": "Number of inventory entries per page (default: 50)", "required": false, "schema": { "type": "integer", "format": "int32", "default": 50 } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "PMP deal inventories retrieved successfully": { "description": "PMP deal inventories retrieved successfully", "value": { "success": true, "data": { "dealId": "IQM-12345", "dealName": "Sample PMP Deal", "totalRecords": 1234, "filteredRecords": 1234, "data": [ "inv1", "inv2", "inv3" ] } } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/inv/pmp/deals/{dealId}/inventories/download": { "get": { "tags": [ "Inventory API" ], "summary": "Download inventories associated with a specific PMP deal", "description": "This API allows downloading the list of inventories associated with a specific PMP (Private Marketplace) deal. Returns the downloadable URL for the csv file.The deal ID required is the internal primary key (integer) of the deal not the external deal identifier.", "operationId": "downloadCSVForPMPDealInventoriesByDealId", "parameters": [ { "name": "dealId", "in": "path", "description": "Unique identifier of the PMP deal for which inventories are to be downloaded", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "PMP deal inventories download initiated successfully": { "description": "PMP deal inventories download initiated successfully", "value": { "success": true, "data": { "fileUrl": "https://sample.csv" } } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/inv/pmp/deals/{dealId}/associated-customers": { "get": { "tags": [ "Inventory API" ], "summary": "Fetches customers associated with campaigns for a PMP deal", "description": "Retrieves campaigns linked to the specified PMP deal and subsequently fetches customers associated with those campaigns", "operationId": "fetchAssociatedCustomersForPMPDeal", "parameters": [ { "name": "dealId", "in": "path", "description": "ID of the PMP deal to fetch associated customers", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "owIds", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "Successfully retrieved customers associated with campaigns for a PMP deal", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "errorObjects": { "type": "array", "items": { "type": "object", "properties": { "error": { "type": "string" }, "reason": { "type": "string" }, "field": { "type": "string" } } } }, "data": { "type": "object" } } }, "examples": { "Associated customers response for PMP deal": { "description": "Associated customers response for PMP deal", "value": { "success": true, "data": [201427] } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden !" } ] } } } }, "422": { "description": "PMP Deal request error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "errorObjects": { "type": "array", "items": { "type": "object", "properties": { "error": { "type": "string" }, "reason": { "type": "string" }, "field": { "type": "string" } } } }, "data": { "type": "object" } } }, "examples": { "Invalid PMP Deal data": { "description": "Invalid PMP Deal data", "value": { "success": false, "errorObjects": [ { "error": "No PMP Deal found for ID: [45626]" } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/inv/pmp/deals/count-by-status": { "get": { "tags": [ "Inventory API" ], "summary": "It will provide count of PMP deals for all the statuses", "description": "This API provides count of PMP deals by status. It includes inUse, unUsed and inActive status count along with All as total count of all deals", "operationId": "getPMPDealsCountByStatus", "parameters": [ { "name": "searchKeywords", "in": "query", "description": "Search PMP deals by passing list of search keywords for deal id, name and description", "required": false, "schema": { "type": "array", "items": { "type": "string" }, "default": [] } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "success": true, "data": { "All": 351, "inActive": 48, "inUse": 266, "unUsed": 37 } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "User is not super-user!" } ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/inv/pg/deals/list": { "get": { "tags": [ "Inventory API" ], "summary": "It will provide list of PG deals available for user.", "description": "This API will provide PG deals details list based on requested search and pagination data. ", "operationId": "fetchPGDealList", "parameters": [ { "name": "searchField", "in": "query", "description": "Search the result by provided keyword in the searchField. Search insights by insights name and id.", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "noOfEntries", "in": "query", "description": "The maximum number of returned results per page. ", "required": false, "schema": { "type": "integer", "format": "int32", "default": 20 } }, { "name": "pageNo", "in": "query", "description": "Page number for the required data. ", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "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, dealName, cpm", "required": false, "schema": { "type": "string", "default": "-id" } }, { "name": "exchangeId", "in": "query", "description": "Ids of the exchange associated with PG deal provided for filter" }, { "name": "ids", "in": "query", "description": "Ids of the Primary key of Pg deals for filter", "required": false, "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } }, { "name": "paymentTypeIds", "in": "query", "description": "Ids of payment type for filter", "required": false, "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } }, { "name": "statusIds", "in": "query", "description": "Ids of status for filter", "required": false, "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } }, { "name": "exchangeIds", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "success": true, "data": { "totalRecords": 61, "filteredRecords": 4, "pgDealData": [ { "id": 873, "dealId": "PM-RTY-98765", "dealName": "Demo Deal D4", "statusId": 1, "description": "Demo deal description D4", "paymentTypeId": 2, "exchangeId": 11, "created": 1719723041347, "activeCampaignIds": [], "otherCampaignIds": [506172, 506173, 506174, 506175, 506176, 506177, 506178], "deleteAllowed": true }, { "id": 872, "dealId": "PM-QWE-54321", "dealName": "Sample Deal C3", "statusId": 1, "description": "Sample deal description C3", "paymentTypeId": 2, "exchangeId": 78, "created": 1719722247192, "activeCampaignIds": [506162, 506161, 506160], "otherCampaignIds": [506163, 506166, 506165, 506164], "deleteAllowed": false }, { "id": 412, "dealId": "PM-DEF-12345", "dealName": "Premium Advertising Package", "statusId": 1, "description": "Comprehensive advertising package including display, video, and social media placements for maximum exposure.", "paymentTypeId": 2, "exchangeId": 11, "created": 1718794413912, "activeCampaignIds": [], "otherCampaignIds": [], "deleteAllowed": true }, { "id": 382, "dealId": "PM-NSMI-72345", "dealName": "Sample Deal XZ34", "statusId": 1, "description": "Sample deal for testing purposes", "paymentTypeId": 2, "exchangeId": 1, "created": 1718617653948, "activeCampaignIds": [502776, 502777, 502778, 502779, 502780, 502781, 502775], "otherCampaignIds": [], "deleteAllowed": false } ] } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Unauthorized" } ] } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Invalid sortBy value." } ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/inv/inventory-group-types": { "get": { "tags": [ "Inventory API" ], "summary": "This API fetches a static list of Inventory group types.", "description": "This API fetches a static list of Inventory group types, including name, id, and order, sorted in ascending order by the order column.", "operationId": "getInventoryGroupTypes", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Inventory GroupType list": { "description": "Inventory GroupType list", "value": { "success": true, "data": { "inventoryGroupTypeList": [ { "name": "Open Exchange", "id": 1, "order": 1 }, { "name": "PMP Deals", "id": 1, "order": 1 }, { "name": "Contextual Inventory", "id": 2, "order": 2 } ], "totalRecords": 3, "filteredRecords": 3 } } } } } } }, "204": { "description": "No Content" }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/inv/inventories/list": { "get": { "tags": [ "Inventory API" ], "summary": "It will provide list of inventory available for user", "description": "This API provides paginated list of inventory based on requested filters", "operationId": "getInventoriesDetails", "parameters": [ { "name": "keywords", "in": "query", "description": "List of search keywords to Search inventory list", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "countries", "in": "query", "description": "Filter to fetch inventory list based on countries", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "categories", "in": "query", "description": "Filter to fetch inventory list based on categories of inventory", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "inventoryTypes", "in": "query", "description": "Filter to fetch inventory list based on inventory type", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "creativeSizes", "in": "query", "description": "Filter to fetch inventory list based on creative size", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "creativeTypes", "in": "query", "description": "Filter to fetch inventory list based on creative type", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "creativeDurations", "in": "query", "description": "Filter to fetch inventory list based on creative duration for video/audio type", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "trafficTypes", "in": "query", "description": "Filter to fetch inventory list based on traffic type", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "deviceTypes", "in": "query", "description": "Filter to fetch inventory list based on device type", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "exchanges", "in": "query", "description": "Filter to fetch inventory list based on exchanges", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "videoPlayerSizes", "in": "query", "description": "Filter to fetch inventory list based on video player size", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "ctvOnly", "in": "query", "description": "Filter to fetch only CTV inventory list. This flag will override deviceTypes with CTV when passed as true.", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "noOfEntries", "in": "query", "description": "The maximum number of returned results per page. ", "required": false, "schema": { "type": "integer", "format": "int32", "default": 10 } }, { "name": "pageNo", "in": "query", "description": "Page number for the required data. ", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "groupId", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Get Inventory List API": { "description": "Get Inventory List API", "value": { "success": true, "data": { "inventoryDataList": [ { "id": 467664, "name": "Phlo: Live & On-Demand TV", "appId": "b07bkpfxtj", "inventoryType": "Android App", "impressions": 1439665, "reach": 19747, "videoPercentage": 100, "displayPercentage": 0, "ctv": false }, { "id": 102010, "name": "Word Explorer", "appId": "in.pimple.wordsearch", "inventoryType": "Android App", "impressions": 1042378, "reach": 26035, "videoPercentage": 1.567266, "displayPercentage": 44.9402, "ctv": false } ] } } }, "Get Inventory list with ctvOnly true": { "description": "Get Inventory list with ctvOnly true", "value": { "success": true, "data": { "inventoryDataList": [ { "id": 10035129, "name": "HISTORY Vault", "publisherName": "A&E (A+E Networks)", "appId": "com.svod", "inventoryType": "Android App", "impressions": 120, "reach": 180, "videoPercentage": 100, "displayPercentage": 0, "inventoryLogoUrl": "https://cdn.com/adhoc/ctv-logos/1003514129", "ctv": true }, { "id": 10014132, "name": "FYI", "publisherName": "ATC", "appId": "com.watch", "inventoryType": "Android App", "impressions": 1100, "reach": 1079, "videoPercentage": 100, "displayPercentage": 0, "inventoryLogoUrl": "https://cdn.com/adhoc/ctv-logos/1003514132", "ctv": true } ] } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "User is not allowed to access provided inventory group." } ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/inv/inventories/distributions": { "get": { "tags": [ "Inventory API" ], "summary": "It will provide distribution of inventory available for user across countries, creativeTypes, deviceTypes, trafficTypes", "description": "It will provide distribution of inventory available for user across countries, creativeTypes, deviceTypes, trafficTypes based on requested filters", "operationId": "getInventoriesDistributionDetails", "parameters": [ { "name": "keywords", "in": "query", "description": "List of search keywords to Search inventory list", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "countries", "in": "query", "description": "Filter to fetch inventory list based on countries", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "categories", "in": "query", "description": "Filter to fetch inventory list based on categories of inventory", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "inventoryTypes", "in": "query", "description": "Filter to fetch inventory list based on inventory type", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "creativeSizes", "in": "query", "description": "Filter to fetch inventory list based on creative size", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "creativeTypes", "in": "query", "description": "Filter to fetch inventory list based on creative type", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "creativeDurations", "in": "query", "description": "Filter to fetch inventory list based on creative duration for video/audio type", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "trafficTypes", "in": "query", "description": "Filter to fetch inventory list based on traffic type", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "deviceTypes", "in": "query", "description": "Filter to fetch inventory list based on device type", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "exchanges", "in": "query", "description": "Filter to fetch inventory list based on exchanges", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "videoPlayerSizes", "in": "query", "description": "Filter to fetch inventory list based on video player size", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "success": true, "data": { "countries": [ { "label": "United States", "value": 90.58 }, { "label": "Brazil", "value": 1.23 }, { "label": "Germany", "value": 0.79 }, { "label": "France", "value": 0.75 }, { "label": "United Kingdom", "value": 0.62 } ], "trafficTypes": [ { "label": "App", "value": 62.85 }, { "label": "Web", "value": 37.15 } ], "creativeTypes": [ { "label": "Video", "value": 47.47 }, { "label": "Banner", "value": 40.96 }, { "label": "Native", "value": 6.38 }, { "label": "Audio", "value": 5.19 } ], "deviceTypes": [ { "label": "Mobile", "value": 43.53 }, { "label": "Connected TV", "value": 37.69 }, { "label": "Desktop", "value": 15.08 }, { "label": "Tablet", "value": 3.57 }, { "label": "Unknown", "value": 0.13 } ] } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/inv/inventories/count": { "get": { "tags": [ "Inventory API" ], "summary": "It will provide count of inventory available for user", "description": "This API provides count of inventory based on requested filters as mentioned in the parameters. It provides the count of unique inventories, total number of impressions and total reach of all inventories ", "operationId": "getInventoriesCountDetails", "parameters": [ { "name": "keywords", "in": "query", "description": "List of search keywords to Search inventory list", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "countries", "in": "query", "description": "Filter to fetch inventory list based on countries", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "categories", "in": "query", "description": "Filter to fetch inventory list based on IAB categories of inventory", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "inventoryTypes", "in": "query", "description": "Filter to fetch inventory list based on inventory type", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "creativeSizes", "in": "query", "description": "Filter to fetch inventory list based on creative size", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "creativeTypes", "in": "query", "description": "Filter to fetch inventory list based on creative type", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "creativeDurations", "in": "query", "description": "Filter to fetch inventory list based on creative duration for video/audio type", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "trafficTypes", "in": "query", "description": "Filter to fetch inventory list based on traffic type", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "deviceTypes", "in": "query", "description": "Filter to fetch inventory list based on device type", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "exchanges", "in": "query", "description": "Filter to fetch inventory list based on exchanges", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "videoPlayerSizes", "in": "query", "description": "Filter to fetch inventory list based on video player size", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "ctvOnly", "in": "query", "description": "Filter to fetch only CTV inventory list. This flag will override deviceTypes with CTV when passed as true.", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "success": true, "data": { "reach": 7983863253, "impressions": 119273056646, "inventories": 1387184 } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "User is not allowed to access provided inventory group." } ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/inv/groups/statistics": { "get": { "tags": [ "Inventory API" ], "summary": "Retrieves statistics for inventory groups", "operationId": "getInventoryGroupsStatistics", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Get inventory groups statistics": { "description": "Get inventory groups statistics", "value": { "success": true, "data": { "totalInventoryGroups": 371, "includedGroups": 296, "excludedGroups": 92, "unUsedGroups": 75 } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden !" } ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/inv/groups/list": { "get": { "tags": [ "Inventory API" ], "summary": "Retrieves a list of inventory groups based on various filters and parameters.", "operationId": "getInventoryGroups", "parameters": [ { "name": "groupFilterId", "in": "query", "description": "This parameter can be used to filter groups list. Below are the valid values for this filter parameter: 0 - All Groups 1 - Share by Admin 2 - Own Groups", "required": false, "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "groupTypeIds", "in": "query", "description": "This parameter can be used to filter groups list. Below are the valid values for this filter parameter: 1 - Open Exchange 2 - PMP 3 - Contextual", "required": false, "schema": { "type": "string", "default": "1,2,3" } }, { "name": "ids", "in": "query", "description": "Comma separated group ids", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "provideAccountLevelExcludedGroup", "in": "query", "description": "Flag to indicate whether to include account-level excluded group in response or not", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "includeStatistics", "in": "query", "description": "Flag to indicate whether to include statistics in response or not", "required": false, "schema": { "type": "boolean", "default": true } }, { "name": "excludeEmptyGroups", "in": "query", "description": "Flag to indicate whether to include empty groups in response or not", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "searchField", "in": "query", "description": "Search inventory group by name", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "pageSize", "in": "query", "description": "Page size", "required": false, "schema": { "type": "integer", "format": "int32", "default": 50 } }, { "name": "pageNo", "in": "query", "description": "Page number", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "owId", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "sortBy", "in": "query", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "201": { "description": "Successful retrieval of inventory group list", "content": { "application/json": { "examples": { "Get inventory group list - searchField=Inventory Group - Open exchange&pageSize=1": { "description": "Get inventory group list - searchField=Inventory Group - Open exchange&pageSize=1", "value": { "success": true, "data": { "totalRecords": 371, "filteredRecords": 6, "inventoryGroupList": [ { "groupTypeId": 1, "created": 1720032375, "modifiedDate": "2024-07-03T13:18:26.9350000", "owId": 201427, "impressions": 0, "isAccountLevelExcluded": null, "distribution": { "countries": [ { "label": "United States", "value": 99.49 }, { "label": "Canada", "value": 0.19 }, { "label": "Mexico", "value": 0.07 }, { "label": "United Kingdom", "value": 0.07 }, { "label": "India", "value": 0.07 } ], "deviceTypes": [ { "label": "Mobile", "value": 44.17 }, { "label": "Connected TV", "value": 36.12 }, { "label": "Desktop", "value": 12.8 }, { "label": "Unknown", "value": 4.81 }, { "label": "Tablet", "value": 2.1 } ], "trafficTypes": [ { "label": "App", "value": 69.58 }, { "label": "Web", "value": 30.42 } ], "creativeTypes": [ { "label": "Video", "value": 60.07 }, { "label": "Banner", "value": 26.75 }, { "label": "Native", "value": 8.18 }, { "label": "Audio", "value": 5 } ] }, "campaignWhitelistCount": 0, "campaignBlacklistCount": 0, "whiteListedCampaignIds": [503885, 486112, 478890], "blackListedCampaignIds": [], "sharedCount": 0, "uniques": 0, "reach": 0, "inventories": 0, "deals": 0, "contextualInventories": 0, "count": 0, "id": 176178, "name": "Inventory Group - Open exchange - 3 campaign", "isShared": false } ] } } }, "Get inventory group list without statistics - includeStatistics=false&searchField=Inventory Group - Open exchange&pageSize=1": { "description": "Get inventory group list without statistics - includeStatistics=false&searchField=Inventory Group - Open exchange&pageSize=1", "value": { "success": true, "data": { "totalRecords": 371, "filteredRecords": 6, "inventoryGroupList": [ { "groupTypeId": 3, "created": null, "modifiedDate": null, "owId": 0, "impressions": 0, "isAccountLevelExcluded": null, "distribution": { }, "campaignWhitelistCount": 0, "campaignBlacklistCount": 0, "whiteListedCampaignIds": null, "blackListedCampaignIds": null, "sharedCount": 0, "uniques": 0, "reach": 0, "inventories": 0, "deals": 0, "contextualInventories": 0, "count": 0, "id": 170302, "name": "Inventory Group - Open exchange - editByNisha", "isShared": false } ] } } }, "Get inventory group list with provideAccountLevelExcludedGroup as true -includeStatistics=false&provideAccountLevelExcludedGroup=true&pageSize=1&ids=127583": { "description": "Get inventory group list with provideAccountLevelExcludedGroup as true -includeStatistics=false&provideAccountLevelExcludedGroup=true&pageSize=1&ids=127583", "value": { "success": true, "data": { "totalRecords": 1, "filteredRecords": 1, "inventoryGroupList": [ { "groupTypeId": 1, "created": null, "modifiedDate": null, "owId": 0, "impressions": 0, "isAccountLevelExcluded": null, "distribution": { }, "campaignWhitelistCount": 0, "campaignBlacklistCount": 0, "whiteListedCampaignIds": null, "blackListedCampaignIds": null, "sharedCount": 0, "uniques": 0, "reach": 0, "inventories": 0, "deals": 0, "contextualInventories": 0, "count": 0, "id": 127583, "name": "My clothes", "isShared": false } ] } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden !" } ] } } } }, "422": { "description": "Erroneous retrieval of inventory group list", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "errorObjects": { "type": "array", "items": { "type": "object", "properties": { "error": { "type": "string" }, "reason": { "type": "string" }, "field": { "type": "string" } } } }, "data": { "type": "object" } } }, "examples": { "Invalid sortBy data": { "description": "Invalid sortBy data", "value": { "success": false, "errorObjects": [ { "error": "Invalid sortBy value.", "field": "sortBy" } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/inv/groups/count": { "get": { "tags": [ "Inventory API" ], "summary": "Retrieves a count of Inventory Groups for an Organisation", "operationId": "getInventoryGroupsCount", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "Successful retrieval of count of inventory group for an Organisation", "content": { "application/json": { "examples": { "Get inventory group count": { "description": "Get inventory group count", "value": { "success": true, "data": { "inventoryGroupsCount": 26 } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden !" } ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/inv/group/{groupId}/shared/campaign/list": { "get": { "tags": [ "Inventory API" ], "summary": "It will provide campaigns attached to the inventory group.", "operationId": "getSharedGroupCampaignList", "parameters": [ { "name": "groupId", "in": "path", "description": "Inventory group id", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Attached Campaigns": { "description": "Attached Campaigns", "value": { "success": true, "data": [286107, 284229, 287201, 287202] } }, "No campaigns attached": { "description": "No campaigns attached", "value": { "success": true, "data": [] } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "examples": { "Not authorized to access group": { "description": "Not authorized to access group", "value": { "success": false, "errorObjects": [ { "error": "Unauthorized" } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/inv/group/{groupId}/pmp-deals": { "get": { "tags": [ "Inventory API" ], "summary": "Retrieves a list of PMP Deals in an inventory group based on various filters and parameters.", "operationId": "getGroupPMPDeals", "parameters": [ { "name": "searchField", "in": "query", "description": "Search inventory group by name", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "noOfEntries", "in": "query", "description": "Page size", "required": false, "schema": { "type": "integer", "format": "int32", "default": 50 } }, { "name": "pageNo", "in": "query", "description": "Page number", "required": false, "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "groupId", "in": "path", "description": "Inventory Group ID", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "sortBy", "in": "query", "description": "Sorting parameter", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "Successful retrieval of PMP deals details list in an inventory group", "content": { "application/json": { "examples": { "Get PMP deals list for an inventory group": { "description": "Get PMP deals list for an inventory group", "value": { "success": true, "data": { "pmpDealData": [ { "id": 345, "dealId": "070621-Test Deal-MS@15", "dealName": "0670621 Test Deal 15", "description": "test desc", "cpm": 2, "dealTypeId": 2, "creativeTypes": [ "HTML", "Audio" ], "exchanges": [ "Rubicon" ], "active": true, "created": 1623076958, "modifiedDate": "2021-06-08T11:27:30.549+0000", "applicableTo": [], "userName": null, "isPublic": true } ], "totalRecords": 6, "filteredRecords": 6 } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden !" } ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/inv/group/{groupId}/pmp-deals/csv": { "get": { "tags": [ "Inventory API" ], "summary": "Retrieves a list of PMP Deals in an inventory group based on various filters and parameters.", "operationId": "generateGroupPMPDealsFile", "parameters": [ { "name": "searchField", "in": "query", "description": "Search inventory group", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "sortOrder", "in": "query", "description": "Sorting Order", "required": false, "schema": { "type": "string", "default": "desc" } }, { "name": "groupId", "in": "path", "description": "Inventory Group ID", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "sortBy", "in": "query", "description": "Sorting parameter", "required": false, "schema": { "type": "string", "default": "avails" } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "Successful retrieval of PMP deals details list in an inventory group", "content": { "application/json": { "examples": { "Get PMP deals list for an inventory group": { "description": "Get PMP deals list for an inventory group", "value": "Deal ID,Name,Status,Deal Curation,Exchange,CPM,Created,Creative Type,Description\nTestPMPDeal-Standard-220,demo_test_PMP Standard Deal Name,Active,Standard,Verve,10.0,1720539410367,image,test PMP Standard deal description\nTestPMPDeal-Standard-150,demo_test_PMP Standard Deal Name,Active,Standard,Verve,10.0,1720539066479,image,test PMP Standard deal description\nTestPMPDeal-Standard-783,demo_test_PMP Standard Deal Name,Active,Standard,Verve,10.0,1720538941646,image,test PMP Standard deal description\nUpdate-PMPDeal-123456789012999,Update-PMPDeal 1,Active,Standard,Verve,10.0,1720538429779,image,test Update PMP deal\nUpdate OpenExchange-PMPDeal-123456789012,Update-PMPOpenExchangeDeal 1,Active,Open Exchange,Verve,10.0,1720538428172,image,test Update PMP deal\nTestPMPDeal-Standard-134,demo_test_PMP Standard Deal Name,Active,Standard,Index Exchange,10.0,1720535724643,image,test PMP Standard deal description\nUpdate-PMPDeal-123456789012999,Update-PMPDeal 1,Active,Standard,Index Exchange,10.0,1720535538603,image,test Update PMP deal\nTestPMPDeal-Standard-840,demo_test_PMP Standard Deal Name,Active,Open Exchange,SpotXchange,10.0,1720510341373,html,test PMP Standard deal description\n" } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden !" } ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/inv/group/{groupId}/open-exchange-inventories": { "get": { "tags": [ "Inventory API" ], "summary": "Retrieves a list of open exchange inventories for an inventory group based on various filters and parameters.", "operationId": "getGroupInventories", "parameters": [ { "name": "searchField", "in": "query", "description": "Search inventory group by name", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "noOfEntries", "in": "query", "description": "Page size", "required": false, "schema": { "type": "integer", "format": "int32", "default": 50 } }, { "name": "pageNo", "in": "query", "description": "Page number", "required": false, "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "groupId", "in": "path", "description": "Inventory Group ID", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "Successful retrieval of open exchange inventory details list in an inventory group", "content": { "application/json": { "examples": { "Get open exchange inventory list for an inventory group": { "description": "Get open exchange inventory list for an inventory group", "value": { "success": true, "data": { "totalRecords": 30564800, "filteredRecords": 2, "inventoryDataList": [ { "id": 119, "name": "metro.co", "appId": "metro.co", "inventoryType": "Site", "impressions": 31607, "reach": 15302, "videoPercentage": 42.9309, "displayPercentage": 53.992257, "ctv": false }, { "id": 1004129, "name": "Vault TV", "appId": "com.aetnd.svod", "inventoryType": "Android App", "impressions": 120, "reach": 180, "videoPercentage": 100, "displayPercentage": 0, "inventoryLogoUrl": "https://cdn.com/adhoc/ctv-logos/1003514129", "ctv": true } ] } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden !" } ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/inv/group/{groupId}/open-exchange-inventories/distributions": { "get": { "tags": [ "Inventory API" ], "summary": "Retrieves a distribution of open exchange inventories in an inventory group based on various filters and parameters.", "operationId": "getGroupInventoriesDistributions", "parameters": [ { "name": "searchField", "in": "query", "description": "Search inventory group by name", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "groupId", "in": "path", "description": "Inventory Group ID", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "Successful retrieval of open exchange inventory distributions in an inventory group", "content": { "application/json": { "examples": { "Get open exchange inventory distributions for an inventory group": { "description": "Get open exchange inventory distributions for an inventory group", "value": { "success": true, "data": { "trafficTypes": [ { "label": "Web", "value": 100 } ], "countries": [ { "label": "United States", "value": 98.86 }, { "label": "Netherlands", "value": 0.98 }, { "label": "Canada", "value": 0.08 }, { "label": "Ecuador", "value": 0.03 }, { "label": "Virgin Islands, U.S.", "value": 0.03 } ], "deviceTypes": [ { "label": "Desktop", "value": 87.68 }, { "label": "Mobile", "value": 9.27 }, { "label": "Tablet", "value": 3.06 } ], "creativeTypes": [ { "label": "Banner", "value": 81.26 }, { "label": "Video", "value": 15.49 }, { "label": "Native", "value": 3.25 } ] } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden !" } ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/inv/group/{groupId}/open-exchange-inventories/count": { "get": { "tags": [ "Inventory API" ], "summary": "Retrieves a statistics/count of open exchange inventories in an inventory group based on various filters and parameters.", "operationId": "getGroupInventoriesStatistics", "parameters": [ { "name": "searchField", "in": "query", "description": "Search inventory group by name", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "groupId", "in": "path", "description": "Inventory Group ID", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "Successful retrieval of open exchange inventory statistics in an inventory group", "content": { "application/json": { "examples": { "Get open exchange inventory statistics for an inventory group": { "description": "Get open exchange inventory statistics for an inventory group", "value": { "success": true, "data": { "inventories": 3, "reach": 2689, "impressions": 30569 } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden !" } ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/inv/group/{groupId}/contextual/inventories/csv": { "get": { "tags": [ "Inventory API" ], "summary": "Download csv for contextual inventory", "operationId": "generateGroupContextualInventoriesFile", "parameters": [ { "name": "searchField", "in": "query", "description": "Search inventory group", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "groupId", "in": "path", "description": "Inventory Group ID", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" } ], "responses": { "200": { "description": "Successfully downloaded", "content": { "application/json": { "examples": { "Successfully downloaded": { "description": "Successfully downloaded", "value": "Name,Type \nkid,Keyword \nsports nfl,Keyword \nconstitutional,Keyword \nhttps://www.espn.in/,Url \nhttps://www.cricbuzz.com/,Url\n" } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden !" } ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/inv/group/{groupId}/contextual-inventories": { "get": { "tags": [ "Inventory API" ], "summary": "Fetch contextual inventories for a specific group", "operationId": "getContextualInventoriesForGroup", "parameters": [ { "name": "groupId", "in": "path", "description": "ID of the group", "required": true, "schema": { "type": "integer", "format": "int32" }, "example": 163922 }, { "name": "searchField", "in": "query", "description": "Field to search within the inventories", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "noOfEntries", "in": "query", "description": "Number of entries per page", "required": false, "schema": { "type": "string" } }, { "name": "pageNo", "in": "query", "description": "Page number to retrieve", "required": false, "schema": { "type": "string" } }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" } ], "responses": { "200": { "description": "Successfully fetched contextual inventories", "content": { "application/json": { "example": { "success": true, "data": { "data": [ { "id": 42486, "inventory": "law business", "contextualType": 1 } ], "totalRecords": 2, "filteredRecords": 1 } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden !" } ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/inv/group/{groupId}/contextual-inventories/count": { "get": { "tags": [ "Inventory API" ], "summary": "Fetch count of keywords and urls", "operationId": "getContextualInventoriesForGroupCount", "parameters": [ { "name": "groupId", "in": "path", "description": "ID of the group", "required": true, "schema": { "type": "integer", "format": "int32" }, "example": 170800 }, { "name": "searchField", "in": "query", "description": "provide search field", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" } ], "responses": { "200": { "description": "Successfully fetched count of keywords and urls", "content": { "application/json": { "example": { "success": true, "data": { "contextualUrlCount": 0, "contextualKeywordCount": 1 } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden !" } ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/inv/contextual/recommend": { "get": { "tags": [ "Inventory API" ], "summary": "Fetch recommended keywords for a keyword", "operationId": "getRecommendedKeywords", "parameters": [ { "name": "keyword", "in": "query", "description": "recommendation will be done based on this keyword", "required": true, "schema": { "type": "string" } }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" } ], "responses": { "200": { "description": "Successfully fetched recommended keywords", "content": { "application/json": { "example": { "success": true, "data": [ "sport", "business", "play" ] } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden !" } ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/inv/contextual/autosuggest": { "get": { "tags": [ "Inventory API" ], "summary": "Fetch auto suggest keywords for a keyword", "operationId": "getAutoSuggestKeywords", "parameters": [ { "name": "keyword", "in": "query", "description": "suggestion will be done based on this keyword", "required": true, "schema": { "type": "string" } }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" } ], "responses": { "200": { "description": "Successfully fetched auto suggest keywords", "content": { "application/json": { "example": { "success": true, "data": [ "law business", "law business ar" ] } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden !" } ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/inv/blocked-inventories": { "get": { "tags": [ "Inventory API" ], "description": "This API will provide the list of globally blocked open exchange inventories.", "operationId": "getBlockedInventories", "parameters": [ { "name": "searchField", "in": "query", "description": "Search the result by provided keyword in the searchField. ", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "inventoryIds", "in": "query", "description": "Filter the inventories by inventoryIds" }, { "name": "noOfEntries", "in": "query", "description": "The maximum number of returned results per page. ", "required": false, "schema": { "type": "integer", "format": "int32", "default": 200 } }, { "name": "pageNo", "in": "query", "description": "Page number for the required data. The default value is 1. ", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "success": true, "data": { "globalBlockedInventoryData": [ { "id": 35109, "name": "Pluto TV - It's Free TV", "publisher": "UNKNOWN", "appId": "74519", "inventoryType": "Other App", "comment": "This is the comment for this inventory", "impressions": 0, "uniques": 0, "videoPercentage": 0, "displayPercentage": 0 } ] }, "globalBlockedInventoryIds": 1, "filteredRecords": 13 } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden !" } ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/internal/inv/pg/deals/details": { "get": { "tags": [ "Inventory API" ], "summary": "It will provide list of PG deals available for user.", "description": "This API will provide PG deals details list based on requested search data. ", "operationId": "fetchPGDealDetails", "parameters": [ { "name": "searchField", "in": "query", "description": "Search the result by provided keyword in the searchField. Search insights by insights name and id.", "required": false, "schema": { "type": "string", "default": "" } }, { "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, dealName, cpm", "required": false, "schema": { "type": "string", "default": "-id" } }, { "name": "exchangeId", "in": "query", "description": "Ids of the exchange associated with PG deal provided for filter" }, { "name": "ids", "in": "query", "description": "Ids of the Primary key of Pg deals for filter", "required": false, "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } }, { "name": "paymentTypeIds", "in": "query", "description": "Ids of payment type for filter", "required": false, "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } }, { "name": "statusIds", "in": "query", "description": "Ids of status for filter", "required": false, "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } }, { "name": "owId", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "exchangeIds", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } }, { "name": "provideAttachedCampaigns", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "success": true, "data": { "pgDealData": [ { "id": 2, "dealId": "PM-Nyty3-2", "dealName": "Test deal IV91", "statusId": 2, "description": "Test Deal", "cpm": 25.12, "paymentTypeId": 2, "exchangeId": 11, "created": 1716800879555, "campaignIds": [] }, { "id": 1, "dealId": "PM-NytyM-2", "dealName": "Test deal IV91", "statusId": 2, "description": "Test Deal", "cpm": 25.12, "paymentTypeId": 2, "exchangeId": 11, "created": 1716800860560, "campaignIds": [473874, 474041, 474610, 474953] } ] } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Unauthorized" } ] } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Invalid sortBy value." } ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/internal/inv/inventory-deal/details": { "get": { "tags": [ "Inventory API" ], "summary": "It will provide details of deal and inventories for the given group ids and deal ids.", "description": "This API will provide fetch the PG and PMP deals details as well as inventory group id details based on the requested parameters. ", "operationId": "getInventoryAndDealDetails", "parameters": [ { "name": "inventoryGroupIds", "in": "query", "description": "Inventory group ids attached with campaign", "required": false, "schema": { "type": "string" } }, { "name": "pmpDealIds", "in": "query", "description": "PMP deal ids attached to campaign", "required": false, "schema": { "type": "string" } }, { "name": "pgDealIds", "in": "query", "description": "PG Deal Ids attached to campaign", "required": false, "schema": { "type": "string" } }, { "name": "bidModelExcludedPlatformDealIds", "in": "query", "description": "platform Deal Ids for pmp deal excluded from bid model", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "success": true, "data": { "whitelistInventoryGroupIds": { "133700": { "type": "PMP", "dealIds": [ "IOA-IQM-Political-MIA-20191106-108329-ED", "549644393847328788", "549644393847501941", "Mk1", "5ENk", "wvK" ] }, "133703": { "type": "PMP", "dealIds": [ "Mk1", "wvK" ] }, "133704": { "type": "PMP", "dealIds": [ "PM-VYWS-5371" ] }, "177225": { "keywords": [ "football" ], "count": 0, "type": "Contextual" }, "178330": { "keywords": [ "president", "government", "mn", "minn.", "mo.", "mich.", "pa." ], "count": 0, "type": "Contextual" }, "181388": { "keywords": [ "fd" ], "count": 0, "type": "Contextual" } }, "pmpDealIds": [ "Test", "Test002", "Test003" ], "bidModelExcludedDealIds": [ "Test", "Test002", "Test003" ], "pgDealIds": [ "Test", "Test2", "Test3" ] } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/inv/pmp/deals": { "delete": { "tags": [ "Inventory API" ], "summary": "Delete PMP deals", "description": "This API can be used by advertiser, workspace or super to delete one or more pmp deals", "operationId": "deletePMPDeal", "parameters": [ { "name": "ids", "in": "query", "description": "list of pmp deal ids for deletion", "required": true, "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "PMP deal deleted successfully": { "description": "PMP deal deleted successfully", "value": { "success": true, "data": { "id": [470, 471], "message": "Deal/s deleted successfully" } } } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "examples": { "Invalid/Inaccessible pmp deal id passed": { "description": "Invalid/Inaccessible pmp deal id passed", "value": { "success": false, "errorObjects": [ { "error": "PMP deal id/s is/are invalid or not accessible for logged-in user" } ] } }, "Multiple active pmp deal ids passed": { "description": "Multiple active pmp deal ids passed", "value": { "success": false, "errorObjects": [ { "error": "Active deals are not allowed for bulk delete operation" } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/inv/pg/deals": { "delete": { "tags": [ "Inventory API" ], "summary": "Deletes multiple PG Deals by their IDs", "description": "Deletes multiple PG Deals identified by their IDs. Supports comma-separated list of PG Deal IDs.", "operationId": "deletePGDeals", "parameters": [ { "name": "ids", "in": "query", "description": "Comma-separated list of PG Deal IDs to delete", "required": true, "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "Successful response indicating deletion of PG Deal(s)", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "errorObjects": { "type": "array", "items": { "type": "object", "properties": { "error": { "type": "string" }, "reason": { "type": "string" }, "field": { "type": "string" } } } }, "data": { "type": "object" } } }, "examples": { "Single PG Deal Deletion": { "description": "Single PG Deal Deletion", "value": { "success": true, "data": "PG Deal deleted successfully" } }, "Bulk PG Deals Deletion": { "description": "Bulk PG Deals Deletion", "value": { "success": true, "data": "2 PG Deals deleted successfully" } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden !" } ] } } } }, "422": { "description": "PG Deal request error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "errorObjects": { "type": "array", "items": { "type": "object", "properties": { "error": { "type": "string" }, "reason": { "type": "string" }, "field": { "type": "string" } } } }, "data": { "type": "object" } } }, "examples": { "Unable to delete PG Deals": { "description": "Unable to delete PG Deals", "value": { "success": false, "errorObjects": [ { "error": "Unable to delete some PG Deals. The following PG Deals are associated with active campaigns and cannot be deleted: [382]", "field": "pgDealIds" } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/inv/contextual/inventories/group/remove": { "delete": { "tags": [ "Inventory API" ], "summary": "Delete Inventory", "operationId": "removeMappingsFromInventoryGroup", "parameters": [ { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "contextualInventoryIds": { "type": "array", "items": { "type": "integer", "format": "int32" } } } }, "examples": { "Remove": { "description": "Remove", "value": { "groupId": 170800, "contextualIds": [42386] } } } } }, "required": true }, "responses": { "200": { "description": "Successfully deleted", "content": { "application/json": { "example": { "success": true, "data": "Contextual Inventories removed from group successfully." } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden !" } ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v2/master/segment/creativeSizes": { "get": { "tags": [ "Master API" ], "summary": "Get Segment Creative Sizes", "description": "Get list of creative standard dimensions, video player sizes and creative durations.\n\n* * *", "operationId": "GetSegmentCreativeSizes", "parameters": [ { "name": "X-IAA-OW-ID", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32", "example": 200002 } }, { "name": "Authorization", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "{{bearer_token}}" } } ], "responses": { "200": { "description": "OK", "headers": { "Cache-Control": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "public, max-age=86400" } } }, "Date": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "Thu, 14 Oct 2021 08:02:03 GMT" } } }, "Server": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "Caddy" } } }, "X-Content-Type-Options": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "nosniff" } } }, "X-Frame-Options": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "DENY" } } }, "X-Xss-Protection": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "1; mode=block" } } }, "Transfer-Encoding": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "chunked" } } } }, "content": { "application/json;charset=UTF-8": { "schema": { "title": "OK1", "required": [ "statusCode", "responseObject" ], "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "responseObject": { "title": "ResponseObject1", "required": [ "videoPlayerSizes", "standardDimensions", "creativeDurations" ], "type": "object", "properties": { "videoPlayerSizes": { "type": "array", "items": { "title": "VideoPlayerSize", "required": [ "id", "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" } }, "example": { "id": 1, "name": "Small" } }, "description": "" }, "standardDimensions": { "type": "array", "items": { "type": "string" }, "description": "" }, "creativeDurations": { "type": "array", "items": { "title": "CreativeDuration", "required": [ "id", "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" } }, "example": { "id": 1, "name": "Below 15s" } }, "description": "" } }, "example": { "videoPlayerSizes": [ { "id": 1, "name": "Small" }, { "id": 3, "name": "Large" }, { "id": 4, "name": "HD" } ], "standardDimensions": [ "320x50", "300x250", "728x90", "250x250", "336x280", "300x50", "320x100", "300x600", "300x100", "240x133", "970x90", "160x600", "320x480", "970x250", "360x50", "480x320", "200x200", "300x31", "120x600", "234x60", "468x60", "300x1050", "320x568", "970x66", "320x30" ], "creativeDurations": [ { "id": 1, "name": "Below 15s" }, { "id": 2, "name": "Upto 15s" }, { "id": 3, "name": "Upto 30s" }, { "id": 4, "name": "Upto 45s" }, { "id": 5, "name": "Upto 60s" }, { "id": 6, "name": "Upto 90s" }, { "id": 7, "name": "Upto 120s" }, { "id": 8, "name": "Above 120s" } ] } } }, "example": { "statusCode": 200, "responseObject": { "videoPlayerSizes": [ { "id": 1, "name": "Small" }, { "id": 3, "name": "Large" }, { "id": 4, "name": "HD" } ], "standardDimensions": [ "320x50", "300x250", "728x90", "250x250", "336x280", "300x50", "320x100", "300x600", "300x100", "240x133", "970x90", "160x600", "320x480", "970x250", "360x50", "480x320", "200x200", "300x31", "120x600", "234x60", "468x60", "300x1050", "320x568", "970x66", "320x30" ], "creativeDurations": [ { "id": 1, "name": "Below 15s" }, { "id": 2, "name": "Upto 15s" }, { "id": 3, "name": "Upto 30s" }, { "id": 4, "name": "Upto 45s" }, { "id": 5, "name": "Upto 60s" }, { "id": 6, "name": "Upto 90s" }, { "id": 7, "name": "Upto 120s" }, { "id": 8, "name": "Above 120s" } ] } } }, "example": { "statusCode": 200, "responseObject": { "videoPlayerSizes": [ { "id": 1, "name": "Small" }, { "id": 3, "name": "Large" }, { "id": 4, "name": "HD" } ], "standardDimensions": [ "320x50", "300x250", "728x90", "250x250", "336x280", "300x50", "320x100", "300x600", "300x100", "240x133", "970x90", "160x600", "320x480", "970x250", "360x50", "480x320", "200x200", "300x31", "120x600", "234x60", "468x60", "300x1050", "320x568", "970x66", "320x30" ], "creativeDurations": [ { "id": 1, "name": "Below 15s" }, { "id": 2, "name": "Upto 15s" }, { "id": 3, "name": "Upto 30s" }, { "id": 4, "name": "Upto 45s" }, { "id": 5, "name": "Upto 60s" }, { "id": 6, "name": "Upto 90s" }, { "id": 7, "name": "Upto 120s" }, { "id": 8, "name": "Above 120s" } ] } } } } } }, "deprecated": false, "security": [] } }, "/api/adcategories": { "get": { "tags": [ "Master API" ], "summary": "Ad Categories", "description": "List all Ad categories for targeting drop down.\n***\n#### Response Body Detail\n| **Field** \t\t| **Type** \t| **Description** |\n|-----------------------|---------------|---------------------------------------------------|\n| id \t\t\t\t| number \t| adcategory id \t\t\t\t\t\t\t\t\t|\t\n| name \t\t\t\t\t| string \t\t| adcategory name \t\t\t\t\t\t\t\t\t|\n| group \t\t\t\t| string \t\t| adcategory group name \t\t\t\t\t\t\t|\n| iab_id \t\t\t\t| string \t\t| IAB Id\t\t\t\t\t\t\t\t\t\t\t|\n| parent_id \t\t\t| number \t\t| parent adcategory id\t\t\t\t\t\t\t\t|", "operationId": "AdCategories", "parameters": [ { "name": "X-IAA-OW-ID", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "{{ow_id}}" } }, { "name": "Authorization", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "{{bearer_token}}" } } ], "responses": { "200": { "description": "OK", "headers": { "Content-Length": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "40688" } } }, "Date": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "Thu, 21 Oct 2021 18:24:42 GMT" } } }, "Log_message": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "None" } } }, "Server": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "Caddy" } } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "title": "AdCategory", "required": [ "id", "name", "group", "iab_id", "parent_id" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "group": { "type": "string" }, "iab_id": { "type": "string" }, "parent_id": { "type": "integer", "format": "int32" } }, "example": { "id": 12, "name": "Books & Literature (IAB1-1)", "group": "Arts & Entertainment", "iab_id": "IAB1-1", "parent_id": 11 } }, "description": "", "example": [ { "id": 12, "name": "Books & Literature (IAB1-1)", "group": "Arts & Entertainment", "iab_id": "IAB1-1", "parent_id": 11 } ] }, "example": [ { "id": 12, "name": "Books & Literature (IAB1-1)", "group": "Arts & Entertainment", "iab_id": "IAB1-1", "parent_id": 11 } ] } } } }, "deprecated": false, "security": [] } }, "/api/v2/adv/static/timezones": { "get": { "tags": [ "Master API" ], "summary": "Timezones", "description": "List all timezone for targeting.\n***\n#### Response Body Detail\n| **Field** \t\t| **Type** \t| **Description** |\n|-----------------------|---------------|---------------------------------------------------|\n| id \t\t\t\t| number \t| id \t\t\t\t\t\t\t\t\t\t\t\t|\t\n| name \t\t\t\t\t| string \t\t| name \t\t\t\t\t\t\t\t\t\t\t\t|\n| label \t\t\t\t| string \t\t| Used to show on UI \t\t\t\t\t\t\t\t|", "operationId": "Timezones", "parameters": [ { "name": "X-IAA-OW-ID", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "{{ow_id}}" } }, { "name": "Authorization", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "{{bearer_token}}" } } ], "responses": { "200": { "description": "OK", "headers": { "Cache-Control": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "public, max-age=86400" } } }, "Date": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "Thu, 21 Oct 2021 18:36:46 GMT" } } }, "Server": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "Caddy" } } }, "X-Content-Type-Options": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "nosniff" } } }, "X-Frame-Options": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "DENY" } } }, "X-Xss-Protection": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "1; mode=block" } } }, "Transfer-Encoding": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "chunked" } } } }, "content": { "application/json;charset=UTF-8": { "schema": { "title": "Timezones", "required": [ "statusCode", "responseObject" ], "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "responseObject": { "type": "array", "items": { "title": "ResponseObject9", "required": [ "name", "id", "label" ], "type": "object", "properties": { "name": { "type": "string" }, "id": { "type": "integer", "format": "int32" }, "label": { "type": "string" } }, "example": { "name": "US/Central", "id": 423, "label": "US/Central" } }, "description": "" } }, "example": { "statusCode": 200, "responseObject": [ { "name": "US/Central", "id": 423, "label": "US/Central" } ] } }, "example": { "statusCode": 200, "responseObject": [ { "name": "US/Central", "id": 423, "label": "US/Central" } ] } } } } }, "deprecated": false, "security": [] } }, "/api/dma_codes": { "get": { "tags": [ "Master API" ], "summary": "DMA-Codes", "description": "List all DMA for targeting.\n***\n#### Response Body Detail\n| **Field** \t\t| **Type** \t| **Description** |\n|-----------------------|---------------|---------------------------------------------------|\n| id \t\t\t\t| number \t| id \t\t\t\t\t\t\t\t\t\t\t\t|\t\n| dma_code \t\t\t\t| string \t\t| DMA code \t\t\t\t\t\t\t\t\t\t\t|\n| dma_region \t\t\t| string \t\t| DMA region \t\t\t\t\t\t\t\t\t\t|\n| dma_source \t\t\t| string \t\t| DMA source \t\t\t\t\t\t\t\t\t\t|", "operationId": "DMA-Codes", "parameters": [ { "name": "X-IAA-OW-ID", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "{{ow_id}}" } }, { "name": "Authorization", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "{{bearer_token}}" } } ], "responses": { "200": { "description": "OK", "headers": { "Content-Length": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "19496" } } }, "Date": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "Thu, 21 Oct 2021 18:50:38 GMT" } } }, "Log_message": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "None" } } }, "Server": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "Caddy" } } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "title": "DMA-Code", "required": [ "id", "dma_code", "dma_region", "dma_source" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "dma_code": { "type": "string" }, "dma_region": { "type": "string" }, "dma_source": { "type": "string" } }, "example": { "id": 1, "dma_code": "500", "dma_region": "Portland-Auburn, ME", "dma_source": "google" } }, "description": "", "example": [ { "id": 1, "dma_code": "500", "dma_region": "Portland-Auburn, ME", "dma_source": "google" } ] }, "example": [ { "id": 1, "dma_code": "500", "dma_region": "Portland-Auburn, ME", "dma_source": "google" } ] } } } }, "deprecated": false, "security": [] } }, "/api/source_traffic_types": { "get": { "tags": [ "Master API" ], "summary": "Traffic-Types-Source", "description": "List all Traffic-Types-Source for targeting.\n***\n#### Response Body Detail\n| **Field** \t\t| **Type** \t| **Description** |\n|-----------------------|---------------|---------------------------------------------------|\n| id \t\t\t\t| number \t| id \t\t\t\t\t\t\t\t\t\t\t\t|\t\n| name \t\t\t\t\t| string \t\t| name \t\t\t\t\t\t\t\t\t\t\t\t|", "operationId": "Traffic-Types-Source", "parameters": [ { "name": "X-IAA-OW-ID", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "{{ow_id}}" } }, { "name": "Authorization", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "{{bearer_token}}" } } ], "responses": { "200": { "description": "OK", "headers": { "Content-Length": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "54" } } }, "Date": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "Thu, 21 Oct 2021 18:57:36 GMT" } } }, "Log_message": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "None" } } }, "Server": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "Caddy" } } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "title": "Traffic-Types-Source", "required": [ "name", "id" ], "type": "object", "properties": { "name": { "type": "string" }, "id": { "type": "integer", "format": "int32" } }, "example": { "name": "App", "id": 11 } }, "description": "", "example": [ { "name": "App", "id": 11 }, { "name": "Web", "id": 12 } ] }, "example": [ { "name": "App", "id": 11 }, { "name": "Web", "id": 12 } ] } } } }, "deprecated": false, "security": [] } }, "/api/device_types": { "get": { "tags": [ "Master API" ], "summary": "Device Types", "description": "List all Device Types for targeting.\n***\n#### Response Body Detail\n| **Field** \t\t| **Type** \t| **Description** |\n|-----------------------|---------------|---------------------------------------------------|\n| id \t\t\t\t| number \t| id \t\t\t\t\t\t\t\t\t\t\t\t|\t\n| name \t\t\t\t\t| string \t\t| name \t\t\t\t\t\t\t\t\t\t\t\t|", "operationId": "DeviceTypes", "parameters": [ { "name": "X-IAA-OW-ID", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "{{ow_id}}" } }, { "name": "Authorization", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "{{bearer_token}}" } } ], "responses": { "200": { "description": "OK", "headers": { "Content-Length": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "54" } } }, "Date": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "Thu, 21 Oct 2021 18:57:36 GMT" } } }, "Log_message": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "None" } } }, "Server": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "Caddy" } } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "title": "DeviceType", "required": [ "name", "id" ], "type": "object", "properties": { "name": { "type": "string" }, "id": { "type": "integer", "format": "int32" } }, "example": { "name": "Connected TV", "id": 13 } }, "description": "", "example": [ { "name": "Connected TV", "id": 13 }, { "name": "Desktop", "id": 15 }, { "name": "Mobile", "id": 11 }, { "name": "Set-top box", "id": 16 }, { "name": "Tablet", "id": 12 } ] }, "example": [ { "name": "Connected TV", "id": 13 }, { "name": "Desktop", "id": 15 }, { "name": "Mobile", "id": 11 }, { "name": "Set-top box", "id": 16 }, { "name": "Tablet", "id": 12 } ] } } } }, "deprecated": false, "security": [] } }, "/api/network_types": { "get": { "tags": [ "Master API" ], "summary": "Network Types", "description": "List all Network Types for targeting.\n***\n#### Response Body Detail\n| **Field** \t\t| **Type** \t| **Description** |\n|-----------------------|---------------|---------------------------------------------------|\n| id \t\t\t\t| number \t| id \t\t\t\t\t\t\t\t\t\t\t\t|\t\n| name \t\t\t\t\t| string \t\t| name \t\t\t\t\t\t\t\t\t\t\t\t|", "operationId": "NetworkTypes", "parameters": [ { "name": "X-IAA-OW-ID", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "{{ow_id}}" } }, { "name": "Authorization", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "{{bearer_token}}" } } ], "responses": { "200": { "description": "OK", "headers": { "Content-Length": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "54" } } }, "Date": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "Thu, 21 Oct 2021 18:57:36 GMT" } } }, "Log_message": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "None" } } }, "Server": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "Caddy" } } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "title": "NetworkType", "required": [ "name", "id" ], "type": "object", "properties": { "name": { "type": "string" }, "id": { "type": "integer", "format": "int32" } }, "example": { "name": "Mobile", "id": 13 } }, "description": "", "example": [ { "name": "Mobile", "id": 13 }, { "name": "WIFI", "id": 12 } ] }, "example": [ { "name": "Mobile", "id": 13 }, { "name": "WIFI", "id": 12 } ] } } } }, "deprecated": false, "security": [] } }, "/api/device_os": { "get": { "tags": [ "Master API" ], "summary": "Device-OS", "description": "List all Device OS for targeting.\n***\n#### Response Body Detail\n| **Field** \t\t| **Type** \t| **Description** |\n|-----------------------|---------------|---------------------------------------------------|\n| id \t\t\t\t| number \t| id \t\t\t\t\t\t\t\t\t\t\t\t|\t\n| name \t\t\t\t\t| string \t\t| name \t\t\t\t\t\t\t\t\t\t\t\t|", "operationId": "Device-OS", "parameters": [ { "name": "X-IAA-OW-ID", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "{{ow_id}}" } }, { "name": "Authorization", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "{{bearer_token}}" } } ], "responses": { "200": { "description": "OK", "headers": { "Content-Length": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "54" } } }, "Date": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "Thu, 21 Oct 2021 18:57:36 GMT" } } }, "Log_message": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "None" } } }, "Server": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "Caddy" } } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "title": "Device-O", "required": [ "name", "id" ], "type": "object", "properties": { "name": { "type": "string" }, "id": { "type": "integer", "format": "int32" } }, "example": { "name": "Android", "id": 11 } }, "description": "", "example": [ { "name": "Android", "id": 11 }, { "name": "BlackBerry", "id": 14 }, { "name": "Desktop", "id": 17 }, { "name": "iOS", "id": 12 }, { "name": "IPTV", "id": 16 }, { "name": "Roku", "id": 15 }, { "name": "Windows", "id": 13 } ] }, "example": [ { "name": "Android", "id": 11 }, { "name": "BlackBerry", "id": 14 }, { "name": "Desktop", "id": 17 }, { "name": "iOS", "id": 12 }, { "name": "IPTV", "id": 16 }, { "name": "Roku", "id": 15 }, { "name": "Windows", "id": 13 } ] } } } }, "deprecated": false, "security": [] } }, "/api/manufacturers": { "get": { "tags": [ "Master API" ], "summary": "Manufacturers", "description": "List all Manufacturers for targeting.\n***\n#### Response Body Detail\n| **Field** \t\t| **Type** \t| **Description** |\n|-----------------------|---------------|---------------------------------------------------|\n| id \t\t\t\t| number \t| id \t\t\t\t\t\t\t\t\t\t\t\t|\t\n| name \t\t\t\t\t| string \t\t| name \t\t\t\t\t\t\t\t\t\t\t\t|", "operationId": "Manufacturers", "parameters": [ { "name": "X-IAA-OW-ID", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "{{ow_id}}" } }, { "name": "Authorization", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "{{bearer_token}}" } } ], "responses": { "200": { "description": "OK", "headers": { "Content-Length": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "54" } } }, "Date": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "Thu, 21 Oct 2021 18:57:36 GMT" } } }, "Log_message": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "None" } } }, "Server": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "Caddy" } } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "title": "Manufacturer", "required": [ "name", "id" ], "type": "object", "properties": { "name": { "type": "string" }, "id": { "type": "integer", "format": "int32" } }, "example": { "name": "3Q", "id": 317 } }, "description": "", "example": [ { "name": "3Q", "id": 317 } ] }, "example": [ { "name": "3Q", "id": 317 } ] } } } }, "deprecated": false, "security": [] } }, "/api/countries/{country_id}/carriers": { "get": { "tags": [ "Master API" ], "summary": "Carriers By Country", "operationId": "CarriersByCountry", "parameters": [ { "name": "X-IAA-OW-ID", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "{{ow_id}}" } }, { "name": "Authorization", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "{{bearer_token}}" } }, { "name": "country_id", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": { "Content-Length": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "1806" } } }, "Date": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "Thu, 21 Oct 2021 19:40:10 GMT" } } }, "Log_message": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "None" } } }, "Server": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "Caddy" } } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "title": "OK9", "required": [ "id", "name", "country_id" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "country_id": { "type": "integer", "format": "int32" } }, "example": { "id": 292, "name": "AT&T Mobility", "country_id": 246 } }, "description": "", "example": [ { "id": 292, "name": "AT&T Mobility", "country_id": 246 }, { "id": 293, "name": "AT&T WiFi", "country_id": 246 }, { "id": 294, "name": "Cable Vision WiFi", "country_id": 246 }, { "id": 295, "name": "Cellular One", "country_id": 246 }, { "id": 296, "name": "Cellular South", "country_id": 246 }, { "id": 297, "name": "Charter WiFi", "country_id": 246 }, { "id": 298, "name": "Cincinnati Bell US", "country_id": 246 }, { "id": 299, "name": "Cox Communications", "country_id": 246 }, { "id": 300, "name": "Cricket", "country_id": 246 }, { "id": 301, "name": "Earthlink", "country_id": 246 }, { "id": 302, "name": "Metro PCS", "country_id": 246 }, { "id": 303, "name": "Nextel", "country_id": 246 }, { "id": 304, "name": "Qwest WiFi", "country_id": 246 }, { "id": 305, "name": "Qwest Wireless", "country_id": 246 }, { "id": 306, "name": "Sprint WiFi", "country_id": 246 }, { "id": 307, "name": "Sprint Wireless", "country_id": 246 }, { "id": 308, "name": "T-Mobile", "country_id": 246 }, { "id": 309, "name": "TracFone", "country_id": 246 }, { "id": 310, "name": "U.S. Cellular", "country_id": 246 }, { "id": 311, "name": "Verizon WiFi", "country_id": 246 }, { "id": 312, "name": "Verizon Wireless", "country_id": 246 }, { "id": 313, "name": "XO Communications", "country_id": 246 }, { "id": 346, "name": "Alaska Communications System", "country_id": 246 }, { "id": 349, "name": "ALLTEL Corporation", "country_id": 246 }, { "id": 352, "name": "BATELCO", "country_id": 246 }, { "id": 353, "name": "Bell Mobility", "country_id": 246 }, { "id": 355, "name": "Bluegrass Cellular", "country_id": 246 }, { "id": 358, "name": "Centennial", "country_id": 246 }, { "id": 361, "name": "Clearwire", "country_id": 246 }, { "id": 363, "name": "Dobson", "country_id": 246 }, { "id": 365, "name": "Essar", "country_id": 246 }, { "id": 400, "name": "Choice Phone LLC", "country_id": 246 } ] }, "example": [ { "id": 292, "name": "AT&T Mobility", "country_id": 246 }, { "id": 293, "name": "AT&T WiFi", "country_id": 246 }, { "id": 294, "name": "Cable Vision WiFi", "country_id": 246 }, { "id": 295, "name": "Cellular One", "country_id": 246 }, { "id": 296, "name": "Cellular South", "country_id": 246 }, { "id": 297, "name": "Charter WiFi", "country_id": 246 }, { "id": 298, "name": "Cincinnati Bell US", "country_id": 246 }, { "id": 299, "name": "Cox Communications", "country_id": 246 }, { "id": 300, "name": "Cricket", "country_id": 246 }, { "id": 301, "name": "Earthlink", "country_id": 246 }, { "id": 302, "name": "Metro PCS", "country_id": 246 }, { "id": 303, "name": "Nextel", "country_id": 246 }, { "id": 304, "name": "Qwest WiFi", "country_id": 246 }, { "id": 305, "name": "Qwest Wireless", "country_id": 246 }, { "id": 306, "name": "Sprint WiFi", "country_id": 246 }, { "id": 307, "name": "Sprint Wireless", "country_id": 246 }, { "id": 308, "name": "T-Mobile", "country_id": 246 }, { "id": 309, "name": "TracFone", "country_id": 246 }, { "id": 310, "name": "U.S. Cellular", "country_id": 246 }, { "id": 311, "name": "Verizon WiFi", "country_id": 246 }, { "id": 312, "name": "Verizon Wireless", "country_id": 246 }, { "id": 313, "name": "XO Communications", "country_id": 246 }, { "id": 346, "name": "Alaska Communications System", "country_id": 246 }, { "id": 349, "name": "ALLTEL Corporation", "country_id": 246 }, { "id": 352, "name": "BATELCO", "country_id": 246 }, { "id": 353, "name": "Bell Mobility", "country_id": 246 }, { "id": 355, "name": "Bluegrass Cellular", "country_id": 246 }, { "id": 358, "name": "Centennial", "country_id": 246 }, { "id": 361, "name": "Clearwire", "country_id": 246 }, { "id": 363, "name": "Dobson", "country_id": 246 }, { "id": 365, "name": "Essar", "country_id": 246 }, { "id": 400, "name": "Choice Phone LLC", "country_id": 246 } ] } } } }, "deprecated": false, "security": [] } }, "/api/countries/{country_id}/states": { "get": { "tags": [ "Master API" ], "summary": "States By Country", "operationId": "StatesByCountry", "parameters": [ { "name": "X-IAA-OW-ID", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "{{ow_id}}" } }, { "name": "Authorization", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "{{bearer_token}}" } }, { "name": "country_id", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": { "Content-Length": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "1806" } } }, "Date": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "Thu, 21 Oct 2021 19:40:10 GMT" } } }, "Log_message": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "None" } } }, "Server": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "Caddy" } } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "title": "OK10", "required": [ "name", "id", "country_id", "abbreviation", "is_active", "is_territory", "state_code", "tblm_iqm_segment_id" ], "type": "object", "properties": { "name": { "type": "string" }, "id": { "type": "integer", "format": "int32" }, "country_id": { "type": "integer", "format": "int32" }, "abbreviation": { "type": "string" }, "is_active": { "type": "integer", "format": "int32" }, "is_territory": { "type": "integer", "format": "int32" }, "state_code": { "type": "string" }, "tblm_iqm_segment_id": { "type": "integer", "format": "int32" } }, "example": { "name": "Alabama", "id": 4660, "country_id": 246, "abbreviation": "AL", "is_active": 1, "is_territory": 0, "state_code": "01", "tblm_iqm_segment_id": 30200002 } }, "description": "", "example": [ { "name": "Alabama", "id": 4660, "country_id": 246, "abbreviation": "AL", "is_active": 1, "is_territory": 0, "state_code": "01", "tblm_iqm_segment_id": 30200002 } ] }, "example": [ { "name": "Alabama", "id": 4660, "country_id": 246, "abbreviation": "AL", "is_active": 1, "is_territory": 0, "state_code": "01", "tblm_iqm_segment_id": 30200002 } ] } } } }, "deprecated": false, "security": [] } }, "/api/v2/master/segment/inventoryTypes": { "get": { "tags": [ "Master API" ], "summary": "Get Inventory Types", "description": "This api fetches all inventory types. It can be consumed by all users.", "operationId": "GetInventoryTypes", "parameters": [ { "name": "X-IAA-OW-ID", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32", "example": 200002 } }, { "name": "Authorization", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "{{bearer_token}}" } } ], "responses": { "200": { "description": "OK", "headers": { "Cache-Control": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "public, max-age=86400" } } }, "Date": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "Thu, 14 Oct 2021 07:57:58 GMT" } } }, "Server": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "Caddy" } } }, "X-Content-Type-Options": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "nosniff" } } }, "X-Frame-Options": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "DENY" } } }, "X-Xss-Protection": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "1; mode=block" } } }, "Transfer-Encoding": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "chunked" } } } }, "content": { "application/json;charset=UTF-8": { "schema": { "title": "OK12", "required": [ "statusCode", "responseObject" ], "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "responseObject": { "type": "array", "items": { "title": "ResponseObject10", "required": [ "id", "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" } }, "example": { "id": 1, "name": "Site" } }, "description": "" } }, "example": { "statusCode": 200, "responseObject": [ { "id": 1, "name": "Site" }, { "id": 2, "name": "Android App" }, { "id": 3, "name": "IOS App" }, { "id": 99, "name": "Other App" } ] } }, "example": { "statusCode": 200, "responseObject": [ { "id": 1, "name": "Site" }, { "id": 2, "name": "Android App" }, { "id": 3, "name": "IOS App" }, { "id": 99, "name": "Other App" } ] } } } } }, "deprecated": false, "security": [] } }, "/api/v3/master/segment/zip": { "post": { "tags": [ "Master API" ], "summary": "This API provides list of zip codes.", "description": "Get the list of zip codes with state ids for given filters.", "operationId": "getMasterSegmentZipCode", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "description": "\n**Request Body Details:**\n\n| **Field** | **Type** | **Description** |\n| --- | --- | --- |\n| pageNo `[optional]` | Number | Page number for the required data. The default value is 1. |\n| noOfEntries `[optional]` | Number | The maximum number of returned results per page. Default value is 300.|\n| sortBy `[optional]` | String | Sort the result set by specific field. For ascending use plus(+) sign(ascii value '%2B') and for descending use minus(-) sign. Sorting supported on `id`, `name` fields.|\n| searchField `[optional]` | String | Search the result by provided keyword in the searchField. Search zips by `name` or `id`.|\n| ids `[optional]` | Array of Integer | selected zip (segmented id) List, zip (segmented id) with provided ids will be returned first compared to other records. |\n| parentSegmentIds `[optional]` | Array of Integer | Filter a list of zip codes based on their associated state id, where the state is considered the parent of each zip code. The state id should be taken from [states](?path=/Master%20API/getStatesSegmentDetails) |\n| segmentIds `[optional]` | Array of Integer | zip list filter by segmented ids. |\n| zipCodes `[optional]` | Array of String | zip list filter by zip codes. |\n", "content": { "application/json": { "schema": { "type": "object", "properties": { "sortCriteriaMap": { "type": "object", "additionalProperties": { "type": "string" } }, "segmentIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "parentSegmentIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "ids": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "campaignId": { "type": "integer", "format": "int32" }, "segmentGroupId": { "type": "integer", "format": "int32" }, "segmentNames": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "compressionMode": { "type": "string" }, "zipCodes": { "type": "array", "items": { "type": "string" } }, "pageNo": { "type": "integer", "format": "int32" }, "noOfEntries": { "type": "integer", "format": "int32" }, "sortBy": { "type": "string" }, "searchField": { "type": "string" }, "order": { "type": "string", "enum": [ "SortOrderEnum[id=1, name='asc', symbol='+']", "SortOrderEnum[id=2, name='desc', symbol='-']" ] } } }, "examples": { "Get all zips": { "description": "Get all zips", "value": { "pageNo": 1, "noOfEntries": 2, "sortBy": "id", "searchField": "", "parentSegmentIds": [], "segmentIds": [], "ids": [], "zipIds": [] } }, "No record found": { "description": "No record found", "value": { "pageNo": 1, "noOfEntries": 2, "sortBy": "+id", "searchField": "", "parentSegmentIds": [], "segmentIds": [9], "ids": [], "zipIds": [] } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Get all zips": { "description": "Get all zips", "value": { "success": true, "data": { "data": [ { "id": 30501001, "name": "1001", "parentId": 30200020, "geojsonUrl": "https://sample-domain/30501001.geojson" }, { "id": 30501002, "name": "1002", "parentId": 30200020, "geojsonUrl": "https://sample-domain/30501002.geojson" } ], "totalRecords": 3, "filteredRecords": 2 } } }, "No record found": { "description": "No record found", "value": { "success": true, "data": { "data": [], "totalRecords": 0, "filteredRecords": 0 } } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/master/segment/state": { "post": { "tags": [ "Master API" ], "summary": "This API provides list of states.", "description": "Get a paginated list of state segment based on the provided filters.", "operationId": "getStatesSegmentDetails", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "description": "\n**Request Body Details:**\n\n| **Field** | **Type** | **Description** |\n| --- | --- | --- |\n|\n| pageNo `[optional]` | Number | Page number for the required data. The default value is 1. |\n| noOfEntries `[optional]` | Number | The maximum number of returned results per page. Default value is 300.|\n| sortBy `[optional]` | String | Sort the result set by specific field. For ascending use plus(+) sign(ascii value '%2B') and for descending use minus(-) sign. Default value is -id.|\n| searchField `[optional]` | String | Search the result by provided keyword in the searchField. search state records by `name` |\n| campaignId `[optional]` | Number | State records associated with the provided campaign will be returned first, prioritized over other state records.|\n| parentSegmentIds `[optional]` | Array of Integer | state list filter by country id. country is parent of state.|\n| ids `[optional]` | Array of Integer | selected state id List, states with provided ids will be returned first compared to other records.\n| segmentIds `[optional]` | Array of Integer | state list filter by state ids.\n", "content": { "application/json": { "schema": { "type": "object", "properties": { "sortCriteriaMap": { "type": "object", "additionalProperties": { "type": "string" } }, "segmentIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "parentSegmentIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "ids": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "campaignId": { "type": "integer", "format": "int32" }, "segmentGroupId": { "type": "integer", "format": "int32" }, "segmentNames": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "compressionMode": { "type": "string" }, "pageNo": { "type": "integer", "format": "int32" }, "noOfEntries": { "type": "integer", "format": "int32" }, "sortBy": { "type": "string" }, "searchField": { "type": "string" }, "order": { "type": "string", "enum": [ "SortOrderEnum[id=1, name='asc', symbol='+']", "SortOrderEnum[id=2, name='desc', symbol='-']" ] } } }, "examples": { "Get all states": { "description": "Get all states", "value": { "pageNo": 1, "noOfEntries": 2, "sortBy": "+id", "searchField": "", "parentSegmentIds": [], "segmentIds": [], "ids": [] } }, "No record found": { "description": "No record found", "value": { "pageNo": 1, "noOfEntries": 2, "sortBy": "+id", "searchField": "", "parentSegmentIds": [], "segmentIds": [9], "ids": [] } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Get all states": { "description": "Get all states", "value": { "success": true, "data": { "data": [ { "id": 30200001, "name": "Alaska", "abbreviation": "AK", "parentId": 30100001, "geojsonUrl": "https://sample-domain/30200001.geojson" }, { "id": 30200001, "name": "Alabama", "abbreviation": "AL", "parentId": 30100001, "geojsonUrl": "https://sample-domain/30200001.geojson" } ], "totalRecords": 2, "filteredRecords": 2 } } }, "No record found": { "description": "No record found", "value": { "success": true, "data": { "data": [], "totalRecords": 0, "filteredRecords": 0 } } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/master/segment/senate-district": { "post": { "tags": [ "Master API" ], "summary": "This API provides list of senate districts.", "description": "Get a paginated list of senate districts segment based on the provided filters.", "operationId": "getSenateDistrictSegmentDetails", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "description": "\n**Request Body Details:**\n\n| **Field** | **Type** | **Description** |\n| --- | --- | --- |\n|\n| pageNo `[optional]` | Number | Page number for the required data. The default value is 1. |\n| noOfEntries `[optional]` | Number | The maximum number of returned results per page. Default value is 300.|\n| sortBy `[optional]` | String | Sort the result set by specific field. For ascending use plus(+) sign(ascii value '%2B') and for descending use minus(-) sign. Default value is -id.|\n| searchField `[optional]` | String | Search the result by provided keyword in the searchField. search senate district records by `name` |\n| campaignId `[optional]` | Number | Senate district records associated with the provided campaign will be returned first, prioritized over other senate district records.|\n| parentSegmentIds `[optional]` | Array of Integer | Filter a list of senate district based on their associated state id, where the state is considered the parent of each senate district. The state id should be taken from [states](?path=/Master%20API/getStatesSegmentDetails) |\n| ids `[optional]` | Array of Integer | Selected senate district id List, senate district with provided ids will be returned first compared to other records.\n| segmentIds `[optional]` | Array of Integer | senate district list filter by senate district ids.\n", "content": { "application/json": { "schema": { "type": "object", "properties": { "sortCriteriaMap": { "type": "object", "additionalProperties": { "type": "string" } }, "segmentIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "parentSegmentIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "ids": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "campaignId": { "type": "integer", "format": "int32" }, "segmentGroupId": { "type": "integer", "format": "int32" }, "segmentNames": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "compressionMode": { "type": "string" }, "pageNo": { "type": "integer", "format": "int32" }, "noOfEntries": { "type": "integer", "format": "int32" }, "sortBy": { "type": "string" }, "searchField": { "type": "string" }, "order": { "type": "string", "enum": [ "SortOrderEnum[id=1, name='asc', symbol='+']", "SortOrderEnum[id=2, name='desc', symbol='-']" ] } } }, "examples": { "Get all senate districts": { "description": "Get all senate districts", "value": { "pageNo": 1, "noOfEntries": 2, "sortBy": "id", "searchField": "", "campaignId": null, "segmentIds": [], "parentSegmentIds": [], "ids": [] } }, "No record found": { "description": "No record found", "value": { "pageNo": 1, "noOfEntries": 2, "sortBy": "+id", "searchField": "", "campaignId": null, "segmentIds": [9], "parentSegmentIds": [], "ids": [] } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Get all senate districts": { "description": "Get all senate districts", "value": { "success": true, "data": { "data": [ { "id": 30700001, "name": "Alaska-A", "abbreviation": "AK-A", "parentId": 30200001, "geojsonUrl": "https://sample-domain/30700001.geojson" }, { "id": 30700002, "name": "Alaska-B", "abbreviation": "AK-B", "parentId": 30200001, "geojsonUrl": "https://sample-domain/30700002.geojson" } ], "totalRecords": 2, "filteredRecords": 2 } } }, "No record found": { "description": "No record found", "value": { "success": true, "data": { "data": [], "totalRecords": 0, "filteredRecords": 0 } } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/master/segment/house-district": { "post": { "tags": [ "Master API" ], "summary": "This API provides list of house districts.", "description": "Get a paginated list of house districts segment based on the provided filters.", "operationId": "getHouseDistrictSegmentDetails", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "description": "\n**Request Body Details:**\n\n| **Field** | **Type** | **Description** |\n| --- | --- | --- |\n|\n| pageNo `[optional]` | Number | Page number for the required data. The default value is 1. |\n| noOfEntries `[optional]` | Number | The maximum number of returned results per page. Default value is 300.|\n| sortBy `[optional]` | String | Sort the result set by specific field. For ascending use plus(+) sign(ascii value '%2B') and for descending use minus(-) sign. Default value is -id.|\n| searchField `[optional]` | String | Search the result by provided keyword in the searchField. search house district records by `name` |\n| campaignId `[optional]` | Number | House district records associated with the provided campaign will be returned first, prioritized over other house district records.|\n| parentSegmentIds `[optional]` | Array of Integer | Filter a list of house district based on their associated state id, where the state is considered the parent of each house district. The state id should be taken from [states](?path=/Master%20API/getStatesSegmentDetails) |\n| ids `[optional]` | Array of Integer | Selected house district id List, house district with provided ids will be returned first compared to other records.\n| segmentIds `[optional]` | Array of Integer | house district list filter by house district ids.\n", "content": { "application/json": { "schema": { "type": "object", "properties": { "sortCriteriaMap": { "type": "object", "additionalProperties": { "type": "string" } }, "segmentIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "parentSegmentIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "ids": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "campaignId": { "type": "integer", "format": "int32" }, "segmentGroupId": { "type": "integer", "format": "int32" }, "segmentNames": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "compressionMode": { "type": "string" }, "pageNo": { "type": "integer", "format": "int32" }, "noOfEntries": { "type": "integer", "format": "int32" }, "sortBy": { "type": "string" }, "searchField": { "type": "string" }, "order": { "type": "string", "enum": [ "SortOrderEnum[id=1, name='asc', symbol='+']", "SortOrderEnum[id=2, name='desc', symbol='-']" ] } } }, "examples": { "Get all house districts": { "description": "Get all house districts", "value": { "pageNo": 1, "noOfEntries": 2, "sortBy": "id", "searchField": "", "campaignId": null, "segmentIds": [], "parentSegmentIds": [], "ids": [] } }, "No record found": { "description": "No record found", "value": { "pageNo": 1, "noOfEntries": 2, "sortBy": "+id", "searchField": "", "campaignId": null, "segmentIds": [9], "parentSegmentIds": [], "ids": [] } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Get all house districts": { "description": "Get all house districts", "value": { "success": true, "data": { "data": [ { "id": 30800073, "name": "Alaska-1", "abbreviation": "AK-01", "parentId": 30200001, "geojsonUrl": "https://sample-domain/30800073.geojson" }, { "id": 30800074, "name": "Alaska-2", "abbreviation": "AK-02", "parentId": 30200001, "geojsonUrl": "https://sample-domain/30800074.geojson" } ], "totalRecords": 2, "filteredRecords": 2 } } }, "No record found": { "description": "No record found", "value": { "success": true, "data": { "data": [], "totalRecords": 0, "filteredRecords": 0 } } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/master/segment/geo-jsons": { "post": { "tags": [ "Master API" ], "summary": "This API provides geo-json data for segments provided in the request.", "description": "Get a map of segment-id and its corresponding geo-json data from S3. It fetches data from S3 based on the compression level if zip segments are provided else it simply fetches data from S3 for segments provided.", "operationId": "getGeoJsons", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "description": "\n**Request Body Details:**\n\n| **Field** | **Type** | **Description** |\n| --- | --- | --- |\n|\n| segmentIds | Array of Integer | Segment Ids for which geo-json data needs to be fetched.\n| compressionMode `[optional]` | String | Compression mode to be used to fetch data from S3 for zip segments. Default value is `low`. It's value can be low or medium or high.\n", "content": { "application/json": { "schema": { "type": "object", "properties": { "sortCriteriaMap": { "type": "object", "additionalProperties": { "type": "string" } }, "segmentIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "parentSegmentIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "ids": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "campaignId": { "type": "integer", "format": "int32" }, "segmentGroupId": { "type": "integer", "format": "int32" }, "segmentNames": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "compressionMode": { "type": "string" }, "pageNo": { "type": "integer", "format": "int32" }, "noOfEntries": { "type": "integer", "format": "int32" }, "sortBy": { "type": "string" }, "searchField": { "type": "string" }, "order": { "type": "string", "enum": [ "SortOrderEnum[id=1, name='asc', symbol='+']", "SortOrderEnum[id=2, name='desc', symbol='-']" ] } } }, "examples": { "Get geo-json data": { "description": "Get geo-json data", "value": { "segmentIds": [2013304, 2013305], "compressionMode": "LOW" } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Get geo-json data": { "description": "Get geo-json data", "value": "{\n \"success\": true,\n \"data\": {\n 2013304: \"{\"type\": \"FeatureCollection\", \"features\": [{\"id\": \"6\", \"type\": \"Feature\", \"properties\": {\"AFFGEOID\": \"1600000US0201420\", \"ALAND\": 68757785, \"AWATER\": 43954223, \"GEOID\": \"0201420\", \"ID\": 30400007, \"LSAD\": \"25\", \"NAME\": \"Aleknagik\", \"PARENT_SEGMENT_ID\": 30200001, \"PLACEFP\": \"01420\", \"PLACENS\": \"02419351\", \"SEGMENT_GROUP_ID\": 304, \"STATE\": \"AK\", \"STATEFP\": \"02\"}, \"geometry\": {\"type\": \"Polygon\", \"coordinates\": [[[-158.819361, 59.367815], [-158.764089, 59.353368], [-158.707325, 59.332674], [-158.665025, 59.317253], [-158.595514, 59.317251], [-158.595393, 59.288358], [-158.53892, 59.288359], [-158.538846, 59.259466], [-158.622631, 59.259465], [-158.62263, 59.247293], [-158.622629, 59.230571], [-158.679008, 59.23057], [-158.707271, 59.259463], [-158.735531, 59.273909], [-158.791057, 59.288355], [-158.791058, 59.310029], [-158.819325, 59.32447], [-158.819361, 59.367815]]]}}]}\",\n 2013305: \"{\"type\": \"FeatureCollection\", \"features\": [{\"id\": \"2\", \"type\": \"Feature\", \"properties\": {\"AFFGEOID\": \"1600000US0200760\", \"ALAND\": 18156821, \"AWATER\": 0, \"GEOID\": \"0200760\", \"ID\": 30400003, \"LSAD\": \"57\", \"NAME\": \"Akiachak\", \"PARENT_SEGMENT_ID\": 30200001, \"PLACEFP\": \"00760\", \"PLACENS\": \"02418756\", \"SEGMENT_GROUP_ID\": 304, \"STATE\": \"AK\", \"STATEFP\": \"02\"}, \"geometry\": {\"type\": \"Polygon\", \"coordinates\": [[[-161.45954, 60.916497], [-161.449924, 60.917946], [-161.449847, 60.92056], [-161.449551, 60.923677], [-161.447209, 60.925379], [-161.446521, 60.92761], [-161.440842, 60.925681], [-161.435322, 60.921348], [-161.433304, 60.923977], [-161.433749, 60.926259], [-161.429593, 60.926895], [-161.426863, 60.928181], [-161.429445, 60.92951], [-161.428672, 60.931041], [-161.426417, 60.931142], [-161.424397, 60.932789], [-161.420361, 60.931228], [-161.417006, 60.931459], [-161.419024, 60.93416], [-161.415796, 60.936466], [-161.419547, 60.938222], [-161.418605, 60.940632], [-161.423892, 60.94267], [-161.416013, 60.946144], [-161.411385, 60.946669], [-161.406485, 60.946134], [-161.404974, 60.94271], [-161.401174, 60.94164], [-161.398531, 60.941798], [-161.396776, 60.944239], [-161.394571, 60.944641], [-161.392176, 60.943741], [-161.387008, 60.942835], [-161.380504, 60.942919], [-161.375306, 60.943755], [-161.375639, 60.940086], [-161.37377, 60.939059], [-161.371424, 60.939289], [-161.373298, 60.937456], [-161.370304, 60.935316], [-161.367364, 60.935387], [-161.355283, 60.91957], [-161.35501, 60.915367], [-161.354128, 60.914211], [-161.349611, 60.911804], [-161.349194, 60.910767], [-161.354521, 60.909551], [-161.357966, 60.910219], [-161.364056, 60.909837], [-161.365951, 60.907978], [-161.363662, 60.906071], [-161.364973, 60.904546], [-161.367476, 60.90476], [-161.369192, 60.906405], [-161.369717, 60.909289], [-161.371473, 60.911932], [-161.374469, 60.912859], [-161.380842, 60.91147], [-161.385007, 60.909623], [-161.381694, 60.906083], [-161.376897, 60.905756], [-161.374919, 60.905279], [-161.369526, 60.903092], [-161.367869, 60.901447], [-161.371296, 60.898647], [-161.377922, 60.89592], [-161.378286, 60.89637], [-161.380723, 60.897496], [-161.388553, 60.904051], [-161.394723, 60.907072], [-161.397726, 60.907821], [-161.404141, 60.908228], [-161.410203, 60.906647], [-161.414534, 60.903503], [-161.418231, 60.901751], [-161.424941, 60.900704], [-161.430464, 60.901021], [-161.439634, 60.902852], [-161.44321, 60.904201], [-161.446987, 60.907173], [-161.442167, 60.907591], [-161.43814, 60.906583], [-161.432282, 60.906524], [-161.436794, 60.907887], [-161.441323, 60.907902], [-161.443355, 60.908986], [-161.448077, 60.908096], [-161.4563, 60.910602], [-161.458711, 60.910763], [-161.45954, 60.916497]]]}}]}\"\n }\n}\n" }, "No record found": { "description": "No record found", "value": { "success": true, "data": { } } } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "examples": { "More than 1000 segment-names provided or not provided at all": { "description": "More than 1000 segment-names provided or not provided at all", "value": { "success": false, "errorObjects": [ { "error": "Maximum of 1000 segment IDs are allowed." } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/master/segment/gender": { "post": { "tags": [ "Master API" ], "summary": "This API provides list of gender.", "description": "Get a paginated list of gender segment based on the provided filters.", "operationId": "getGenderSegmentDetails", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "description": "\n**Request Body Details:**\n\n| **Field** | **Type** | **Description** |\n| --- | --- | --- |\n|\n| pageNo `[optional]` | Number | Page number for the required data. The default value is 1. |\n| noOfEntries `[optional]` | Number | The maximum number of returned results per page. Default value is 300.|\n| sortBy `[optional]` | String | Sort the result set by specific field. For ascending use plus(+) sign(ascii value '%2B') and for descending use minus(-) sign. Default value is -id.|\n| searchField `[optional]` | String | Search the result by provided keyword in the searchField. search gender records by `name` |\n| campaignId `[optional]` | Number | Gender records associated with the provided campaign will be returned first, prioritized over other gender records.|\n| ids `[optional]` | Array of Integer | Selected gender id List, genders with provided ids will be returned first compared to other records.\n| segmentIds `[optional]` | Array of Integer | Gender list filter by gender segment ids.\n", "content": { "application/json": { "schema": { "type": "object", "properties": { "sortCriteriaMap": { "type": "object", "additionalProperties": { "type": "string" } }, "segmentIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "parentSegmentIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "ids": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "campaignId": { "type": "integer", "format": "int32" }, "segmentGroupId": { "type": "integer", "format": "int32" }, "segmentNames": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "compressionMode": { "type": "string" }, "pageNo": { "type": "integer", "format": "int32" }, "noOfEntries": { "type": "integer", "format": "int32" }, "sortBy": { "type": "string" }, "searchField": { "type": "string" }, "order": { "type": "string", "enum": [ "SortOrderEnum[id=1, name='asc', symbol='+']", "SortOrderEnum[id=2, name='desc', symbol='-']" ] } } }, "examples": { "Get all genders": { "description": "Get all genders", "value": { "pageNo": 1, "noOfEntries": 2, "sortBy": "id", "searchField": "", "campaignId": null, "segmentIds": [], "ids": [] } }, "No record found": { "description": "No record found", "value": { "pageNo": 1, "noOfEntries": 2, "sortBy": "+id", "searchField": "", "campaignId": null, "segmentIds": [9], "ids": [] } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Get all genders": { "description": "Get all genders", "value": { "success": true, "data": { "data": [ { "id": 10200001, "name": "Male" }, { "id": 10200002, "name": "Female" } ], "totalRecords": 3, "filteredRecords": 2 } } }, "No record found": { "description": "No record found", "value": { "success": true, "data": { "data": [], "totalRecords": 0, "filteredRecords": 0 } } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/master/segment/dma": { "post": { "tags": [ "Master API" ], "summary": "This API provides list of DMA codes.", "description": "Get a paginated list of DMA code segment based on the provided filters.", "operationId": "getDMACodeDetails", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "description": "\n**Request Body Details:**\n\n| **Field** | **Type** | **Description** |\n| --- | --- | --- |\n|\n| pageNo `[optional]` | Number | Page number for the required data. The default value is 1. |\n| noOfEntries `[optional]` | Number | The maximum number of returned results per page. Default value is 300.|\n| sortBy `[optional]` | String | Sort the result set by specific field. For ascending use plus(+) sign(ascii value '%2B') and for descending use minus(-) sign. Default value is -id.|\n| searchField `[optional]` | String | Search the result by provided keyword in the searchField. search DMA codes records by `name` or `abbreviation`. |\n| parentSegmentIds `[optional]` | Array of Integer | Filter a list of DMA code based on their associated state id, where the state is considered the parent of each DMA code. The state id should be taken from [states](?path=/Master%20API/getStatesSegmentDetails) |\n| ids `[optional]` | Array of Integer | Selected DMA codes id List, DMA codes with provided ids will be returned first compared to other records.\n| segmentIds `[optional]` | Array of Integer | DMA codes list filter by DMA codes ids.\n", "content": { "application/json": { "schema": { "type": "object", "properties": { "sortCriteriaMap": { "type": "object", "additionalProperties": { "type": "string" } }, "segmentIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "parentSegmentIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "ids": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "campaignId": { "type": "integer", "format": "int32" }, "segmentGroupId": { "type": "integer", "format": "int32" }, "segmentNames": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "compressionMode": { "type": "string" }, "pageNo": { "type": "integer", "format": "int32" }, "noOfEntries": { "type": "integer", "format": "int32" }, "sortBy": { "type": "string" }, "searchField": { "type": "string" }, "order": { "type": "string", "enum": [ "SortOrderEnum[id=1, name='asc', symbol='+']", "SortOrderEnum[id=2, name='desc', symbol='-']" ] } } }, "examples": { "Get all DMA codes": { "description": "Get all DMA codes", "value": { "pageNo": 1, "noOfEntries": 2, "sortBy": "id", "searchField": "", "segmentIds": [], "parentSegmentIds": [], "ids": [] } }, "No record found": { "description": "No record found", "value": { "pageNo": 1, "noOfEntries": 2, "sortBy": "+id", "searchField": "", "segmentIds": [9], "parentSegmentIds": [], "ids": [] } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Get all DMA codes": { "description": "Get all DMA codes", "value": { "success": true, "data": { "data": [ { "id": 30900001, "name": "Portland-Auburn, ME", "abbreviation": "500", "parentId": 30200022, "geojsonUrl": "https://sample-domain/500.geojson" }, { "id": 30900002, "name": "New York, NY", "abbreviation": "501", "parentId": 30200035, "geojsonUrl": "https://sample-domain/501.geojson" } ], "totalRecords": 2, "filteredRecords": 2 } } }, "No record found": { "description": "No record found", "value": { "success": true, "data": { "data": [], "totalRecords": 0, "filteredRecords": 0 } } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/master/segment/device-type": { "post": { "tags": [ "Master API" ], "summary": "This API provides list of device-type.", "description": "Get a paginated list of device-type based on the provided filters.", "operationId": "getDeviceSegmentType", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "description": "\n**Request Body Details:**\n\n| **Field** | **Type** | **Description** |\n| --- | --- | --- |\n|\n| pageNo `[optional]` | Number | Page number for the required data. The default value is 1. |\n| noOfEntries `[optional]` | Number | The maximum number of returned results per page. Default value is 300.|\n| sortBy `[optional]` | String | Sort the result set by specific field. For ascending use plus(+) sign(ascii value '%2B') and for descending use minus(-) sign. Default value is -id.|\n| searchField `[optional]` | String | Search the result by provided keyword in the searchField. search device type records by `name` |\n| ids `[optional]` | Array of Integer | Selected device-type id List, device-type with provided ids will be returned first compared to other records.\n| segmentIds `[optional]` | Array of Integer | device-type list filter by device-type ids.\n", "content": { "application/json": { "schema": { "type": "object", "properties": { "sortCriteriaMap": { "type": "object", "additionalProperties": { "type": "string" } }, "segmentIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "parentSegmentIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "ids": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "campaignId": { "type": "integer", "format": "int32" }, "segmentGroupId": { "type": "integer", "format": "int32" }, "segmentNames": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "compressionMode": { "type": "string" }, "pageNo": { "type": "integer", "format": "int32" }, "noOfEntries": { "type": "integer", "format": "int32" }, "sortBy": { "type": "string" }, "searchField": { "type": "string" }, "order": { "type": "string", "enum": [ "SortOrderEnum[id=1, name='asc', symbol='+']", "SortOrderEnum[id=2, name='desc', symbol='-']" ] } } }, "examples": { "Get all device type": { "description": "Get all device type", "value": { "pageNo": 1, "noOfEntries": 2, "sortBy": "id", "searchField": "", "segmentIds": [], "ids": [] } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Get all device-type": { "description": "Get all device-type", "value": { "success": true, "data": { "data": [ { "id": 20399999, "name": "Unknown" }, { "id": 20300004, "name": "Tablet" }, { "id": 20300003, "name": "Connected TV" }, { "id": 20300002, "name": "Desktop" }, { "id": 20300001, "name": "Mobile" } ], "totalRecords": 5, "filteredRecords": 5 } } }, "No record found": { "description": "No record found", "value": { "success": true, "data": { "data": [], "totalRecords": 0, "filteredRecords": 0 } } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/master/segment/county": { "post": { "tags": [ "Master API" ], "summary": "This API provides list of counties.", "description": "Get a paginated list of county segment based on the provided filters.", "operationId": "getCountySegmentDetails", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "description": "\n**Request Body Details:**\n\n| **Field** | **Type** | **Description** |\n| --- | --- | --- |\n|\n| pageNo `[optional]` | Number | Page number for the required data. The default value is 1. |\n| noOfEntries `[optional]` | Number | The maximum number of returned results per page. Default value is 300.|\n| sortBy `[optional]` | String | Sort the result set by specific field. For ascending use plus(+) sign(ascii value '%2B') and for descending use minus(-) sign. Default value is -id.|\n| searchField `[optional]` | String | Search the result by provided keyword in the searchField. search county records by `name` |\n| campaignId `[optional]` | Number | County records associated with the provided campaign will be returned first, prioritized over other county records.|\n| parentSegmentIds `[optional]` | Array of Integer | Filter a list of county based on their associated state id, where the state is considered the parent of each county. The state id should be taken from [states](?path=/Master%20API/getStatesSegmentDetails) |\n| ids `[optional]` | Array of Integer | Selected county id List, counties with provided ids will be returned first compared to other records.\n| segmentIds `[optional]` | Array of Integer | county list filter by county ids.\n", "content": { "application/json": { "schema": { "type": "object", "properties": { "sortCriteriaMap": { "type": "object", "additionalProperties": { "type": "string" } }, "segmentIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "parentSegmentIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "ids": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "campaignId": { "type": "integer", "format": "int32" }, "segmentGroupId": { "type": "integer", "format": "int32" }, "segmentNames": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "compressionMode": { "type": "string" }, "pageNo": { "type": "integer", "format": "int32" }, "noOfEntries": { "type": "integer", "format": "int32" }, "sortBy": { "type": "string" }, "searchField": { "type": "string" }, "order": { "type": "string", "enum": [ "SortOrderEnum[id=1, name='asc', symbol='+']", "SortOrderEnum[id=2, name='desc', symbol='-']" ] } } }, "examples": { "Get all counties": { "description": "Get all counties", "value": { "pageNo": 1, "noOfEntries": 2, "sortBy": "id", "searchField": "", "campaignId": null, "segmentIds": [], "parentSegmentIds": [], "ids": [] } }, "No record found": { "description": "No record found", "value": { "pageNo": 1, "noOfEntries": 2, "sortBy": "+id", "searchField": "", "campaignId": null, "segmentIds": [9], "parentSegmentIds": [], "ids": [] } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Get all counties": { "description": "Get all counties", "value": { "success": true, "data": { "data": [ { "id": 30300001, "name": "Aleutians East, AK", "parentId": 30200001, "geojsonUrl": "https://sample-domain/30300001.geojson" }, { "id": 30300002, "name": "Aleutians West, AK", "parentId": 30200001, "geojsonUrl": "https://sample-domain/30300002.geojson" } ], "totalRecords": 2, "filteredRecords": 2 } } }, "No record found": { "description": "No record found", "value": { "success": true, "data": { "data": [], "totalRecords": 0, "filteredRecords": 0 } } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/master/segment/country": { "post": { "tags": [ "Master API" ], "summary": "This API provides a list of countries.", "description": "Get a paginated list of country segment based on the provided filters.", "operationId": "getCountrySegmentDetails", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "description": "\n**Request Body Details:**\n\n| **Field** | **Type** | **Description** |\n| --- | --- | --- |\n|\n| pageNo `[optional]` | Number | Page number for the required data. The default value is 1. |\n| noOfEntries `[optional]` | Number | The maximum number of returned results per page. Default value is 300.|\n| sortBy `[optional]` | String | Sort the result set by specific field. For ascending use plus(+) sign(ascii value '%2B') and for descending use minus(-) sign. Default value is -id.|\n| searchField `[optional]` | String | Search the result by provided keyword in the searchField. search country records by `name` |\n| campaignId `[optional]` | Number | Country records associated with the provided campaign will be returned first, prioritized over other country records.|\n| ids `[optional]` | Array of Integer | Selected country id List, countries with provided ids will be returned first compared to other records.\n| segmentIds `[optional]` | Array of Integer | country list filter by country ids.\n", "content": { "application/json": { "schema": { "type": "object", "properties": { "sortCriteriaMap": { "type": "object", "additionalProperties": { "type": "string" } }, "segmentIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "parentSegmentIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "ids": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "campaignId": { "type": "integer", "format": "int32" }, "segmentGroupId": { "type": "integer", "format": "int32" }, "segmentNames": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "compressionMode": { "type": "string" }, "pageNo": { "type": "integer", "format": "int32" }, "noOfEntries": { "type": "integer", "format": "int32" }, "sortBy": { "type": "string" }, "searchField": { "type": "string" }, "order": { "type": "string", "enum": [ "SortOrderEnum[id=1, name='asc', symbol='+']", "SortOrderEnum[id=2, name='desc', symbol='-']" ] } } }, "examples": { "Get all country": { "description": "Get all country", "value": { "pageNo": 1, "noOfEntries": 2, "sortBy": "id", "searchField": "", "segmentIds": [], "ids": [] } }, "No record found": { "description": "No record found", "value": { "pageNo": 1, "noOfEntries": 2, "sortBy": "+id", "searchField": "", "segmentIds": [9], "ids": [] } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Country List": { "description": "Country List", "value": { "success": true, "data": { "data": [ { "id": 30100001, "name": "United States", "abbreviation": "US" }, { "id": 30100002, "name": "India", "abbreviation": "IN" } ], "totalRecords": 2, "filteredRecords": 2 } } }, "No record found": { "description": "No record found", "value": { "success": true, "data": { "data": [], "totalRecords": 0, "filteredRecords": 0 } } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/master/segment/congressional-district": { "post": { "tags": [ "Master API" ], "summary": "This API provides list of congressional districts.", "description": "Get a paginated list of congressional districts segment based on the provided filters.", "operationId": "getCongressionalDistrictSegmentDetails", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "description": "\n**Request Body Details:**\n\n| **Field** | **Type** | **Description** |\n| --- | --- | --- |\n|\n| pageNo `[optional]` | Number | Page number for the required data. The default value is 1. |\n| noOfEntries `[optional]` | Number | The maximum number of returned results per page. Default value is 300.|\n| sortBy `[optional]` | String | Sort the result set by specific field. For ascending use plus(+) sign(ascii value '%2B') and for descending use minus(-) sign. Default value is -id.|\n| searchField `[optional]` | String | Search the result by provided keyword in the searchField. search congressional district records by `name` |\n| campaignId `[optional]` | Number | Congressional district records associated with the provided campaign will be returned first, prioritized over other congressional district records.|\n| parentSegmentIds `[optional]` | Array of Integer | Filter a list of congressional district based on their associated state id, where the state is considered the parent of each congressional district. The state id should be taken from [states](?path=/Master%20API/getStatesSegmentDetails) |\n| ids `[optional]` | Array of Integer | Selected congressional district id List, congressional districts with provided ids will be returned first compared to other records.\n| segmentIds `[optional]` | Array of Integer | congressional district list filter by congressional district ids.\n", "content": { "application/json": { "schema": { "type": "object", "properties": { "sortCriteriaMap": { "type": "object", "additionalProperties": { "type": "string" } }, "segmentIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "parentSegmentIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "ids": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "campaignId": { "type": "integer", "format": "int32" }, "segmentGroupId": { "type": "integer", "format": "int32" }, "segmentNames": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "compressionMode": { "type": "string" }, "pageNo": { "type": "integer", "format": "int32" }, "noOfEntries": { "type": "integer", "format": "int32" }, "sortBy": { "type": "string" }, "searchField": { "type": "string" }, "order": { "type": "string", "enum": [ "SortOrderEnum[id=1, name='asc', symbol='+']", "SortOrderEnum[id=2, name='desc', symbol='-']" ] } } }, "examples": { "Get all congressional districts": { "description": "Get all congressional districts", "value": { "pageNo": 1, "noOfEntries": 2, "sortBy": "id", "searchField": "", "campaignId": null, "segmentIds": [], "parentSegmentIds": [], "ids": [] } }, "No record found": { "description": "No record found", "value": { "pageNo": 1, "noOfEntries": 2, "sortBy": "+id", "searchField": "", "campaignId": null, "segmentIds": [9], "parentSegmentIds": [], "ids": [] } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Get all congressional districts": { "description": "Get all congressional districts", "value": { "success": true, "data": { "data": [ { "id": 30600502, "name": "Alabama-1", "abbreviation": "AL-1", "parentId": 30200002, "geojsonUrl": "https://sample-domain/30600502.geojson" }, { "id": 30600503, "name": "Alabama-2", "abbreviation": "AL-2", "parentId": 30200002, "geojsonUrl": "https://sample-domain30600503.geojson" } ], "totalRecords": 2, "filteredRecords": 2 } } }, "No record found": { "description": "No record found", "value": { "success": true, "data": { "data": [], "totalRecords": 0, "filteredRecords": 0 } } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/master/segment/city": { "post": { "tags": [ "Master API" ], "summary": "This API provides list of city.", "description": "Get a paginated list of city segment based on the provided filters.", "operationId": "getCitySegmentDetails", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "description": "\n**Request Body Details:**\n\n| **Field** | **Type** | **Description** |\n| --- | --- | --- |\n|\n| pageNo `[optional]` | Number | Page number for the required data. The default value is 1. |\n| noOfEntries `[optional]` | Number | The maximum number of returned results per page. Default value is 300.|\n| sortBy `[optional]` | String | Sort the result set by specific field. For ascending use plus(+) sign(ascii value '%2B') and for descending use minus(-) sign. Default value is -id.|\n| searchField `[optional]` | String | Search the result by provided keyword in the searchField. search city records by `name` |\n| campaignId `[optional]` | Number | City records associated with the provided campaign will be returned first, prioritized over other city records.|\n| parentSegmentIds `[optional]` | Array of Integer | Filter a list of city based on their associated state id, where the state is considered the parent of each city. The state id should be taken from [states](?path=/Master%20API/getStatesSegmentDetails) |\n| ids `[optional]` | Array of Integer | Selected city id List, cities with provided ids will be returned first compared to other records.\n| segmentIds `[optional]` | Array of Integer | City list filter by city ids.\n", "content": { "application/json": { "schema": { "type": "object", "properties": { "sortCriteriaMap": { "type": "object", "additionalProperties": { "type": "string" } }, "segmentIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "parentSegmentIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "ids": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "campaignId": { "type": "integer", "format": "int32" }, "segmentGroupId": { "type": "integer", "format": "int32" }, "segmentNames": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "compressionMode": { "type": "string" }, "pageNo": { "type": "integer", "format": "int32" }, "noOfEntries": { "type": "integer", "format": "int32" }, "sortBy": { "type": "string" }, "searchField": { "type": "string" }, "order": { "type": "string", "enum": [ "SortOrderEnum[id=1, name='asc', symbol='+']", "SortOrderEnum[id=2, name='desc', symbol='-']" ] } } }, "examples": { "Get all cities": { "description": "Get all cities", "value": { "pageNo": 1, "noOfEntries": 2, "sortBy": "+id", "searchField": "", "parentSegmentIds": [], "segmentIds": [], "ids": [] } }, "No record found": { "description": "No record found", "value": { "pageNo": 1, "noOfEntries": 2, "sortBy": "+id", "searchField": "", "parentSegmentIds": [], "segmentIds": [9], "ids": [] } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Get all cities": { "description": "Get all cities", "value": { "success": true, "data": { "data": [ { "id": 30400001, "name": "Adak, AK", "parentId": 30200001, "geojsonUrl": "https://sample-domain/30400001.geojson" }, { "id": 30400002, "name": "Akhiok, AK", "parentId": 30200001, "geojsonUrl": "https://sample-domain/30400002.geojson" } ], "totalRecords": 2, "filteredRecords": 2 } } }, "No record found": { "description": "No record found", "value": { "success": true, "data": { "data": [], "totalRecords": 0, "filteredRecords": 0 } } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/master/inventory": { "post": { "tags": [ "Master API" ], "summary": "This API provides list of inventory.", "description": "Get a paginated list of inventory based on the provided filters.", "operationId": "getInventoryDetails", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "description": "\n**Request Body Details:**\n\n| **Field** | **Type** | **Description** |\n| --- | --- | --- |\n|\n| pageNo `[optional]` | Number | Page number for the required data. The default value is 1. Setting the page number to -1 will disable pagination and return all data in a single page.|\n| noOfEntries `[optional]` | Number | The maximum number of returned results per page. Default value is 300.|\n| sortBy `[optional]` | String | Sort the result set by specific field. For ascending use plus(+) sign(ascii value '%2B') and for descending use minus(-) sign. Default value is -id.|\n| searchField `[optional]` | String | Search the result by provided keyword in the searchField. search inventory records by `id`, `name` |\n| ids `[optional]` | Array of Integer | Selected inventory id List, inventories with provided ids will be returned first compared to other records.|\n| publisherIds `[optional]` | Array of Integer | Filter inventory list by publisher ids. |\n| inventoryIds `[optional]` | Array of Integer | Filter inventory list by inventory ids. |\n", "content": { "application/json": { "schema": { "type": "object", "properties": { "sortCriteriaMap": { "type": "object", "additionalProperties": { "type": "string" } }, "inventoryIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "publisherIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "ids": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "pageNo": { "type": "integer", "format": "int32" }, "noOfEntries": { "type": "integer", "format": "int32" }, "sortBy": { "type": "string" }, "searchField": { "type": "string" }, "order": { "type": "string", "enum": [ "SortOrderEnum[id=1, name='asc', symbol='+']", "SortOrderEnum[id=2, name='desc', symbol='-']" ] } } }, "examples": { "Get all inventories": { "description": "Get all inventories", "value": { "inventoryIds": [], "publisherIds": [], "ids": [], "pageNo": 1, "noOfEntries": 20, "sortBy": "id", "searchField": "" } }, "No record found": { "description": "No record found", "value": { "inventoryIds": [], "publisherIds": [], "ids": [], "pageNo": 1, "noOfEntries": 20, "sortBy": "id", "searchField": "a1234a" } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Get all inventories": { "description": "Get all inventories", "value": { "success": true, "data": { "data": [ { "id": 18, "publisherId": 18, "trafficType": "web", "bundleDomain": "90min.com", "name": "90min.com" }, { "id": 19, "publisherId": 19, "trafficType": "web", "bundleDomain": "90minut.pl", "name": "90minut.pl" } ], "totalRecords": 4, "filteredRecords": 2 } } }, "No record found": { "description": "No record found", "value": { "success": true, "data": { "data": [], "totalRecords": 0, "filteredRecords": 0 } } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/master/adcategories": { "post": { "tags": [ "Master API" ], "summary": "This API provides list of publisher ad categories.", "description": "Get a paginated list of publisher ad category based on the provided filters.", "operationId": "getPublisherAdCategoriesDetails", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "description": "\n**Request Body Details:**\n\n| **Field** | **Type** | **Description** |\n| --- | --- | --- |\n|\n| pageNo `[optional]` | Number | Page number for the required data. The default value of -1 will return all records..|\n| noOfEntries `[optional]` | Number | The maximum number of returned results per page. Default value is 300.|\n| sortBy `[optional]` | String | Sort the result set by specific field. For ascending use plus(+) sign(ascii value '%2B') and for descending use minus(-) sign. Default value is -id.|\n| searchField `[optional]` | String | Search the result by provided keyword in the searchField. search publisher ad-categories by publisher ad category or publisher parent ad category. |\n| ids `[optional]` | Array of Integer | Selected publisher ad-categories List, publisher ad-category with provided ids will be returned first compared to other records.\n| adCategoryIds `[optional]` | Array of Integer | publisher ad-categories list filter by publisher ad-category ids.\n", "content": { "application/json": { "schema": { "type": "object", "properties": { "sortCriteriaMap": { "type": "object", "additionalProperties": { "type": "string" } }, "adCategoryIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "ids": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "pageNo": { "type": "integer", "format": "int32" }, "noOfEntries": { "type": "integer", "format": "int32" }, "sortBy": { "type": "string" }, "searchField": { "type": "string" }, "order": { "type": "string", "enum": [ "SortOrderEnum[id=1, name='asc', symbol='+']", "SortOrderEnum[id=2, name='desc', symbol='-']" ] } } }, "examples": { "Get all Publisher ad-categories": { "description": "Get all Publisher ad-categories", "value": { "pageNo": 1, "noOfEntries": 1, "sortBy": "id", "searchField": "", "adCategoryIds": [], "ids": [] } }, "No record found": { "description": "No record found", "value": { "pageNo": 1, "noOfEntries": 1, "sortBy": "+id", "searchField": "", "adCategoryIds": [9], "ids": [] } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Get all Publisher ad-categories": { "description": "Get all Publisher ad-categories", "value": { "success": true, "data": { "data": [ { "id": 340, "name": "Adventure Travel (IAB20-1)", "parentId": 339, "iabCategoryId": "IAB20-1", "parentName": "Travel" } ], "totalRecords": 2, "filteredRecords": 1 } } }, "No record found": { "description": "No record found", "value": { "success": true, "data": { "data": [], "totalRecords": 0, "filteredRecords": 0 } } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/master/traffic-types": { "get": { "tags": [ "Master API" ], "summary": "This API fetches a static list of traffic types(channel List) for the inventory app.", "operationId": "getTrafficTypes", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "List of traffic Type": { "description": "List of traffic Type", "value": { "success": true, "data": { "data": [ { "name": "App", "isTvAd": false, "id": 11 }, { "name": "CTV", "isTvAd": true, "id": 14 }, { "name": "OTT", "isTvAd": true, "id": 13 }, { "name": "Web", "isTvAd": false, "id": 12 } ], "totalRecords": 4, "filteredRecords": 4 } } } } } } }, "204": { "description": "No Content" }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/master/timezones": { "get": { "tags": [ "Master API" ], "summary": "This API fetches a static list of time zone", "description": "This API fetches a static list of time zones, sorted by the order and name columns in ascending order.", "operationId": "getTimezones", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Timezone List": { "description": "Timezone List", "value": { "success": true, "data": { "data": [ { "name": "US/Central", "id": 423, "label": "US/Central" }, { "name": "US/Eastern", "id": 29, "label": "US/Eastern" }, { "name": "Africa/Addis_Ababa", "id": 149, "label": "Africa/Addis Ababa" }, { "name": "US/Alaska", "id": 420, "label": "US/Alaska" }, { "name": "US/Arizona", "id": 421, "label": "US/Arizona" } ], "totalRecords": 5, "filteredRecords": 5 } } }, "No record found": { "description": "No record found", "value": { "success": true, "data": { "data": [], "totalRecords": 0, "filteredRecords": 0 } } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/master/segment/locationtype": { "get": { "tags": [ "Master API" ], "summary": "It will provide location type filters.", "operationId": "getMasterSegmentLocationTypes", "parameters": [ { "name": "isZipRequired", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "List of location type filters": { "description": "List of location type filters", "value": { "success": true, "data": [ { "id": 302, "name": "State", "order": 1 }, { "id": 304, "name": "City", "order": 2 }, { "id": 309, "name": "DMA", "order": 3 }, { "id": 303, "name": "County", "order": 4 }, { "id": 306, "name": "Congressional District", "order": 5 }, { "id": 307, "name": "State Senate", "order": 6 }, { "id": 308, "name": "State House", "order": 7 }, { "id": 305, "name": "Zip", "order": 8 } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/master/segment/locationtype-details": { "get": { "tags": [ "Master API" ], "summary": "It will provide list of location details by location type", "operationId": "getMasterSegmentLocationTypeDetails", "parameters": [ { "name": "searchField", "in": "query", "description": "Search the result by provided keyword in the searchField. ", "required": false, "schema": { "type": "string" } }, { "name": "locationTypeIds", "in": "query", "description": "Comma separated location type ids. It will filter location by location type ids. \nLocation type id should be from [location-type](?path=/Master%20API/getMasterSegmentLocationTypes)", "required": false, "schema": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } } }, { "name": "countryIds", "in": "query", "description": "Comma separated country ids. It will filter location by country ids", "required": false, "schema": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Filter location by countryIds": { "description": "Filter location by countryIds", "value": { "success": true, "data": { "302": [ { "id": 30200001, "name": "Alaska", "abbreviation": "AK", "parentId": 30100001, "geojsonUrl": "https://sample-domain/AK.geojson" }, { "id": 30200002, "name": "Alabama", "abbreviation": "AL", "parentId": 30100001, "geojsonUrl": "https://sample-domain/AL.geojson" } ], "303": [ { "id": 30300001, "name": "Aleutians East, AK", "parentId": 30200001, "geojsonUrl": "https://sample-domain/30300001.geojson" }, { "id": 30300002, "name": "Aleutians West, AK", "parentId": 30200001, "geojsonUrl": "https://sample-domain/30300002.geojson" } ] } } } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "examples": { "Invalid location type ids passed": { "description": "Invalid location type ids passed", "value": { "success": false, "errorObjects": [ { "error": "Invalid location type ids" } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/master/segment/channel": { "get": { "tags": [ "Master API" ], "summary": "It will provide list of Channel", "operationId": "getMasterSegmentChannel", "parameters": [ { "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. Sorting supported on `id`, `name` fields.", "required": false, "schema": { "type": "string", "default": "+id" } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 }, { "name": "segmentIds", "in": "query", "description": " [optional] segment list filter by segmented ids. ", "example": 1 }, { "name": "ids", "in": "query", "description": " [optional] selected segmented id List, segments with provided ids will be returned first compared to other records. ", "example": "1,2,3" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Get list of Channel": { "description": "Get list of Channel", "value": { "success": true, "data": { "data": [ { "id": 21100001, "name": "App" }, { "id": 21100002, "name": "OTT App" }, { "id": 21100003, "name": "Web" }, { "id": 21199999, "name": "Unknown" } ], "totalRecords": 4, "filteredRecords": 4 } } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/master/rtb-creative-types": { "get": { "tags": [ "Master API" ], "summary": "This API fetches a static list of creative RTB type", "description": "Get a list of RTB creative types available.", "operationId": "getCreativeRTBTypes", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Creative RTB types": { "description": "Creative RTB types", "value": { "success": true, "data": { "data": [ { "id": 1, "name": "Banner" }, { "id": 2, "name": "Audio" }, { "id": 3, "name": "Video" }, { "id": 4, "name": "Native" } ], "totalRecords": 4, "filteredRecords": 4 } } }, "No record found": { "description": "No record found", "value": { "success": true, "data": { "data": [], "totalRecords": 0, "filteredRecords": 0 } } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/master/inventory-types": { "get": { "tags": [ "Master API" ], "summary": "This API provides list of Inventory Type.", "description": "Get a list of inventory Types with id and name", "operationId": "getInventoryTypes", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Inventory Type list": { "description": "Inventory Type list", "value": { "success": true, "data": { "data": [ { "id": 1, "name": "Site" }, { "id": 2, "name": "Android App" }, { "id": 3, "name": "IOS App" }, { "id": 99, "name": "Other App" } ], "totalRecords": 4, "filteredRecords": 4 } } }, "No record found": { "description": "No record found", "value": { "success": true, "data": { "data": [], "totalRecords": 0, "filteredRecords": 0 } } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/master/exchanges": { "get": { "tags": [ "Master API" ], "summary": "Get list of exchanges.", "operationId": "getExchanges", "parameters": [ { "name": "exchangeIds", "in": "query", "description": " [optional] Result will be filtered with provided exchange ids.", "required": false, "schema": { "type": "string" }, "example": 1 }, { "name": "ids", "in": "query", "description": " [optional] Result will have provided exchange ids on top followed by other matching records. ", "required": false, "schema": { "type": "string" }, "example": "1,2,3" }, { "name": "pageNo", "in": "query", "description": "[optional] Page number for the required data. The default value is 1. ", "required": false, "schema": { "type": "integer", "format": "int32" }, "example": 1 }, { "name": "noOfEntries", "in": "query", "description": " [optional] The maximum number of returned results per page. The default value is 20 and the maximum value is 500.", "required": false, "schema": { "type": "integer", "format": "int32" }, "example": 20 }, { "name": "sortBy", "in": "query", "description": " [optional] Sort the result set by specific field.", "required": false, "schema": { "type": "string" }, "example": "id" }, { "name": "order", "in": "query", "description": " [optional] Sorting order Supported values: `asc` or `desc`. The default value is `asc`.", "required": false, "schema": { "type": "string" }, "example": "asc" }, { "name": "searchField", "in": "query", "description": " [optional] Search the result by provided keyword in the searchField. It filters records by id, name.", "required": false, "schema": { "type": "string" }, "example": 1 }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "List of exchanges": { "description": "List of exchanges", "value": { "success": true, "data": { "data": [ { "id": 84, "name": "Vidazoo", "urlName": "vidazoo" }, { "id": 80, "name": "Equativ", "urlName": "equativ" }, { "id": 78, "name": "Magnite", "urlName": "magnite" }, { "id": 1, "name": "iQM", "urlName": "test" } ], "totalRecords": 4, "filteredRecords": 22 } } } } } } }, "204": { "description": "No Content" }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "examples": { "Invalid ids ": { "description": "Invalid ids ", "value": { "success": false, "errorObjects": [ { "error": "invalid arguments ids!", "field": "ids" } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/master/deal-curation-type": { "get": { "tags": [ "Master API" ], "summary": "This API fetches a static list of deal curation type.", "description": "This API fetches a static list of deal curation type includes id and name", "operationId": "getDealCurationTypes", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "List of deal curation type": { "description": "List of deal curation type", "value": { "success": true, "data": { "data": [ { "id": 4, "name": "Standard" }, { "id": 5, "name": "Tailored" }, { "id": 6, "name": "Open Exchange" } ], "totalRecords": 3, "filteredRecords": 3 } } } } } } }, "204": { "description": "No Content" }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/master/creative/video/skippability": { "get": { "tags": [ "Master API" ], "summary": "This API returns video skip ability parameter segments.", "operationId": "getVideoTargetingSkippability", "parameters": [ { "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. Sorting supported on `id`, `name` fields. Default value is `+id`.", "required": false, "schema": { "type": "string", "default": "+id" } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "List of skipp ability segments": { "description": "List of skipp ability segments", "value": { "success": true, "data": { "data": [ { "id": 20900001, "name": "Skippable" }, { "id": 20900002, "name": "Non-Skippable" }, { "id": 20999999, "name": "Unknown" } ], "totalRecords": 3, "filteredRecords": 3 } } } } } } }, "204": { "description": "No Content" }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Invalid sortBy value." } ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/master/creative/video/roll-position": { "get": { "tags": [ "Master API" ], "summary": "This API returns video roll-position parameter segments.", "operationId": "getVideoTargetingRollPosition", "parameters": [ { "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. Sorting supported on `id`, `name` fields. Default value is `+id`.", "required": false, "schema": { "type": "string", "default": "+id" } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "List of roll-position segments": { "description": "List of roll-position segments", "value": { "success": true, "data": { "data": [ { "id": 20700001, "name": "Pre-Roll" }, { "id": 20700002, "name": "Mid-Roll" }, { "id": 20700003, "name": "Post-Roll" }, { "id": 20799999, "name": "Unknown" } ], "totalRecords": 4, "filteredRecords": 4 } } } } } } }, "204": { "description": "No Content" }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Invalid sortBy value." } ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/master/creative/video/player-size": { "get": { "tags": [ "Master API" ], "summary": "This API returns video player-size parameter segments.", "operationId": "getVideoTargetingPlayerSize", "parameters": [ { "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. Sorting supported on `id`, `name` fields. Default value is `+id`.", "required": false, "schema": { "type": "string", "default": "+id" } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "List of player-size segments": { "description": "List of player-size segments", "value": { "success": true, "data": { "data": [ { "id": 20800001, "name": "Medium & Big" }, { "id": 20800002, "name": "Small" }, { "id": 20899999, "name": "Unknown" } ], "totalRecords": 3, "filteredRecords": 3 } } } } } } }, "204": { "description": "No Content" }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Invalid sortBy value." } ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/master/creative/video/playback-method": { "get": { "tags": [ "Master API" ], "summary": "This API returns video playback-method parameter segments.", "operationId": "getVideoTargetingPlaybackMethod", "parameters": [ { "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. Sorting supported on `id`, `name` fields. Default value is `+id`.", "required": false, "schema": { "type": "string", "default": "+id" } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "List of playback-method segments": { "description": "List of playback-method segments", "value": { "success": true, "data": { "data": [ { "id": 21000001, "name": "Sound On" }, { "id": 21000002, "name": "Mute" }, { "id": 21099999, "name": "Unknown" } ], "totalRecords": 3, "filteredRecords": 3 } } } } } } }, "204": { "description": "No Content" }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Invalid sortBy value." } ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/master/creative/video/placement-type": { "get": { "tags": [ "Master API" ], "summary": "This API returns video placement-type parameter segments.", "operationId": "getVideoTargetingPlacementTypes", "parameters": [ { "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. Sorting supported on `id`, `name` fields. Default value is `+id`.", "required": false, "schema": { "type": "string", "default": "+id" } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "List of placement-type segments": { "description": "List of placement-type segments", "value": { "success": true, "data": { "data": [ { "id": 20600002, "name": "Out-Stream" }, { "id": 20600001, "name": "In-Stream" }, { "id": 20699999, "name": "Unknown" } ], "totalRecords": 3, "filteredRecords": 3 } } } } } } }, "204": { "description": "No Content" }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Invalid sortBy value." } ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/master/creative-sizes": { "get": { "tags": [ "Master API" ], "summary": "This API fetches a static list of creative sizes.", "description": "This API fetches a static list of creative sizes includes standardDimensions, creativeDurations, and videoPlayerSizes. The `ctvOnly` flag can be used to fetch only CTV-supported creative sizes.", "operationId": "getCreativeSizes", "parameters": [ { "name": "ctvOnly", "in": "query", "description": "Flag to indicate if only CTV-supported creative sizes are required.", "required": false, "schema": { "type": "boolean", "default": false }, "example": true }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Creative sizes List with ctvOnly as false": { "description": "Creative sizes List with ctvOnly as false", "value": { "success": true, "data": { "standardDimensions": [ { "id": 1, "name": "320x50" }, { "id": 131, "name": "320x30" } ], "creativeDurations": [ { "id": 1, "name": "Below 15s" }, { "id": 2, "name": "Upto 15s" }, { "id": 8, "name": "Above 120s" } ], "videoPlayerSizes": [ { "id": 1, "name": "Small" }, { "id": 4, "name": "HD" } ] } } }, "Creative sizes List with ctvOnly as true": { "description": "Creative sizes List with ctvOnly as true", "value": { "success": true, "data": { "creativeDurations": [ { "id": 1, "name": "Below 15s" }, { "id": 2, "name": "Upto 15s" }, { "id": 8, "name": "Above 120s" } ], "videoPlayerSizes": [ { "id": 1, "name": "Small" }, { "id": 4, "name": "HD" } ] } } } } } } }, "204": { "description": "No Content" }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v2/master/segment/states": { "get": { "tags": [ "Master API" ], "summary": "Get list of states.", "operationId": "getMasterSegmentState", "parameters": [ { "name": "countryIds", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "pageNo", "in": "query", "description": "[optional] Page number for the required data. The default value is 1. ", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 }, "example": 1 }, { "name": "noOfEntries", "in": "query", "description": " [optional] The maximum number of returned results per page. The default value is 20 and the maximum value is 500.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 300 }, "example": 20 }, { "name": "sortBy", "in": "query", "description": " [optional] Sort the result set by specific field.", "required": false, "schema": { "type": "string" }, "example": "id" }, { "name": "order", "in": "query", "description": " [optional] Sorting order Supported values: `asc` or `desc`. The default value is `asc`.", "required": false, "schema": { "type": "string", "default": "asc" }, "example": "asc" }, { "name": "searchField", "in": "query", "description": " [optional] Search the result by provided keyword in the searchField. It filters records by id, name.", "required": false, "schema": { "type": "string" }, "example": 1 }, { "name": "segmentIds", "in": "query", "description": " [optional] segment list filter by segmented ids. ", "required": false, "schema": { "type": "string" }, "example": 1 }, { "name": "ids", "in": "query", "description": " [optional] selected segmented id List, segments with provided ids will be returned first compared to other records. ", "required": false, "schema": { "type": "string" }, "example": "1,2,3" }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 }, { "name": "campaignId", "in": "query", "description": " [optional] segment list associated with campaign id. ", "example": 1 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "List of states segments": { "description": "List of states segments", "value": { "statusCode": 200, "responseObject": { "data": [ { "id": 30200001, "name": "AK" }, { "id": 30200002, "name": "AL" } ], "totalRecords": 4879, "filteredRecords": 2 } } } } } } }, "204": { "description": "No Content" }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } }, "deprecated": true } }, "/api/v2/master/segment/senate-district": { "get": { "tags": [ "Master API" ], "summary": "Get list of senate-district.", "operationId": "getMasterSegmentSenateDistrict", "parameters": [ { "name": "pageNo", "in": "query", "description": "[optional] Page number for the required data. The default value is 1. ", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 }, "example": 1 }, { "name": "noOfEntries", "in": "query", "description": " [optional] The maximum number of returned results per page. The default value is 20 and the maximum value is 500.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 300 }, "example": 20 }, { "name": "sortBy", "in": "query", "description": " [optional] Sort the result set by specific field.", "required": false, "schema": { "type": "string" }, "example": "id" }, { "name": "order", "in": "query", "description": " [optional] Sorting order Supported values: `asc` or `desc`. The default value is `asc`.", "required": false, "schema": { "type": "string", "default": "asc" }, "example": "asc" }, { "name": "searchField", "in": "query", "description": " [optional] Search the result by provided keyword in the searchField. It filters records by id, name.", "required": false, "schema": { "type": "string" }, "example": 1 }, { "name": "stateIds", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "campaignId", "in": "query", "description": " [optional] segment list associated with campaign id. ", "required": false, "schema": { "type": "integer", "format": "int32" }, "example": 1 }, { "name": "segmentIds", "in": "query", "description": " [optional] segment list filter by segmented ids. ", "required": false, "schema": { "type": "string" }, "example": 1 }, { "name": "ids", "in": "query", "description": " [optional] selected segmented id List, segments with provided ids will be returned first compared to other records. ", "required": false, "schema": { "type": "string" }, "example": "1,2,3" }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "List of senate district segments": { "description": "List of senate district segments", "value": { "statusCode": 200, "responseObject": { "data": [ { "id": 30600001, "name": "1, AK" }, { "id": 30699999, "name": "Unknown" } ], "totalRecords": 439, "filteredRecords": 2 } } } } } } }, "204": { "description": "No Content" }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } }, "deprecated": true } }, "/api/v2/master/segment/language": { "get": { "tags": [ "Master API" ], "summary": "Get list of language.", "operationId": "getMasterSegmentLanguage", "parameters": [ { "name": "pageNo", "in": "query", "description": "[optional] Page number for the required data. The default value is 1. ", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 }, "example": 1 }, { "name": "noOfEntries", "in": "query", "description": " [optional] The maximum number of returned results per page. The default value is 20 and the maximum value is 500.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 300 }, "example": 20 }, { "name": "sortBy", "in": "query", "description": " [optional] Sort the result set by specific field.", "required": false, "schema": { "type": "string" }, "example": "id" }, { "name": "order", "in": "query", "description": " [optional] Sorting order Supported values: `asc` or `desc`. The default value is `asc`.", "required": false, "schema": { "type": "string", "default": "asc" }, "example": "asc" }, { "name": "searchField", "in": "query", "description": " [optional] Search the result by provided keyword in the searchField. It filters records by id, name.", "required": false, "schema": { "type": "string" }, "example": 1 }, { "name": "campaignId", "in": "query", "description": " [optional] segment list associated with campaign id. ", "required": false, "schema": { "type": "integer", "format": "int32" }, "example": 1 }, { "name": "segmentIds", "in": "query", "description": " [optional] segment list filter by segmented ids. ", "required": false, "schema": { "type": "string" }, "example": 1 }, { "name": "ids", "in": "query", "description": " [optional] selected segmented id List, segments with provided ids will be returned first compared to other records. ", "required": false, "schema": { "type": "string" }, "example": "1,2,3" }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "List of language segments": { "description": "List of language segments", "value": { "statusCode": 200, "responseObject": { "data": [ { "id": 10500007, "name": "Arabic" }, { "id": 10500034, "name": "Chinese" } ], "totalRecords": 12, "filteredRecords": 2 } } } } } } }, "204": { "description": "No Content" }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v2/master/segment/interest": { "get": { "tags": [ "Master API" ], "summary": "Get list of interest.", "operationId": "getMasterSegmentInterest", "parameters": [ { "name": "pageNo", "in": "query", "description": "[optional] Page number for the required data. The default value is 1. ", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 }, "example": 1 }, { "name": "noOfEntries", "in": "query", "description": " [optional] The maximum number of returned results per page. The default value is 20 and the maximum value is 500.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 300 }, "example": 20 }, { "name": "sortBy", "in": "query", "description": " [optional] Sort the result set by specific field.", "required": false, "schema": { "type": "string" }, "example": "id" }, { "name": "order", "in": "query", "description": " [optional] Sorting order Supported values: `asc` or `desc`. The default value is `asc`.", "required": false, "schema": { "type": "string", "default": "asc" }, "example": "asc" }, { "name": "searchField", "in": "query", "description": " [optional] Search the result by provided keyword in the searchField. It filters records by id, name.", "required": false, "schema": { "type": "string" }, "example": 1 }, { "name": "campaignId", "in": "query", "description": " [optional] segment list associated with campaign id. ", "required": false, "schema": { "type": "integer", "format": "int32" }, "example": 1 }, { "name": "segmentIds", "in": "query", "description": " [optional] segment list filter by segmented ids. ", "required": false, "schema": { "type": "string" }, "example": 1 }, { "name": "ids", "in": "query", "description": " [optional] selected segmented id List, segments with provided ids will be returned first compared to other records. ", "required": false, "schema": { "type": "string" }, "example": "1,2,3" }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "List of interest segments": { "description": "List of interest segments", "value": { "statusCode": 200, "responseObject": { "data": [ { "id": 10800011, "name": "Coloring" }, { "id": 10800012, "name": "Computer programming" } ], "totalRecords": 379, "filteredRecords": 2 } } } } } } }, "204": { "description": "No Content" }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v2/master/segment/income": { "get": { "tags": [ "Master API" ], "summary": "Get list of income.", "operationId": "getMasterSegmentIncome", "parameters": [ { "name": "pageNo", "in": "query", "description": "[optional] Page number for the required data. The default value is 1. ", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 }, "example": 1 }, { "name": "noOfEntries", "in": "query", "description": " [optional] The maximum number of returned results per page. The default value is 20 and the maximum value is 500.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 300 }, "example": 20 }, { "name": "sortBy", "in": "query", "description": " [optional] Sort the result set by specific field.", "required": false, "schema": { "type": "string" }, "example": "id" }, { "name": "order", "in": "query", "description": " [optional] Sorting order Supported values: `asc` or `desc`. The default value is `asc`.", "required": false, "schema": { "type": "string", "default": "asc" }, "example": "asc" }, { "name": "searchField", "in": "query", "description": " [optional] Search the result by provided keyword in the searchField. It filters records by id, name.", "required": false, "schema": { "type": "string" }, "example": 1 }, { "name": "campaignId", "in": "query", "description": " [optional] segment list associated with campaign id. ", "required": false, "schema": { "type": "integer", "format": "int32" }, "example": 1 }, { "name": "segmentIds", "in": "query", "description": " [optional] segment list filter by segmented ids. ", "required": false, "schema": { "type": "string" }, "example": 1 }, { "name": "ids", "in": "query", "description": " [optional] selected segmented id List, segments with provided ids will be returned first compared to other records. ", "required": false, "schema": { "type": "string" }, "example": "1,2,3" }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "List of income segments": { "description": "List of income segments", "value": { "statusCode": 200, "responseObject": { "data": [ { "id": 10300001, "name": "Less than $25000" }, { "id": 10300002, "name": "$25001 - $50000" } ], "totalRecords": 7, "filteredRecords": 2 } } } } } } }, "204": { "description": "No Content" }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v2/master/segment/house-district": { "get": { "tags": [ "Master API" ], "summary": "Get list of house-district.", "operationId": "getMasterSegmentHouseDistrict", "parameters": [ { "name": "pageNo", "in": "query", "description": "[optional] Page number for the required data. The default value is 1. ", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 }, "example": 1 }, { "name": "noOfEntries", "in": "query", "description": " [optional] The maximum number of returned results per page. The default value is 20 and the maximum value is 500.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 300 }, "example": 20 }, { "name": "sortBy", "in": "query", "description": " [optional] Sort the result set by specific field.", "required": false, "schema": { "type": "string" }, "example": "id" }, { "name": "order", "in": "query", "description": " [optional] Sorting order Supported values: `asc` or `desc`. The default value is `asc`.", "required": false, "schema": { "type": "string", "default": "asc" }, "example": "asc" }, { "name": "searchField", "in": "query", "description": " [optional] Search the result by provided keyword in the searchField. It filters records by id, name.", "required": false, "schema": { "type": "string" }, "example": 1 }, { "name": "stateIds", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "campaignId", "in": "query", "description": " [optional] segment list associated with campaign id. ", "required": false, "schema": { "type": "integer", "format": "int32" }, "example": 1 }, { "name": "segmentIds", "in": "query", "description": " [optional] segment list filter by segmented ids. ", "required": false, "schema": { "type": "string" }, "example": 1 }, { "name": "ids", "in": "query", "description": " [optional] selected segmented id List, segments with provided ids will be returned first compared to other records. ", "required": false, "schema": { "type": "string" }, "example": "1,2,3" }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "List of house-district segments": { "description": "List of house-district segments", "value": { "statusCode": 200, "responseObject": { "data": [ { "id": 30700001, "name": "A, AK" }, { "id": 30700002, "name": "B, AK" }, { "id": 30700003, "name": "C, AK" } ], "totalRecords": 1971, "filteredRecords": 3 } } } } } } }, "204": { "description": "No Content" }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } }, "deprecated": true } }, "/api/v2/master/segment/gender": { "get": { "tags": [ "Master API" ], "summary": "Get list of gender.", "operationId": "getMasterSegmentGender", "parameters": [ { "name": "pageNo", "in": "query", "description": "[optional] Page number for the required data. The default value is 1. ", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 }, "example": 1 }, { "name": "noOfEntries", "in": "query", "description": " [optional] The maximum number of returned results per page. The default value is 20 and the maximum value is 500.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 300 }, "example": 20 }, { "name": "sortBy", "in": "query", "description": " [optional] Sort the result set by specific field.", "required": false, "schema": { "type": "string" }, "example": "id" }, { "name": "order", "in": "query", "description": " [optional] Sorting order Supported values: `asc` or `desc`. The default value is `asc`.", "required": false, "schema": { "type": "string", "default": "asc" }, "example": "asc" }, { "name": "searchField", "in": "query", "description": " [optional] Search the result by provided keyword in the searchField. It filters records by id, name.", "required": false, "schema": { "type": "string" }, "example": 1 }, { "name": "campaignId", "in": "query", "description": " [optional] segment list associated with campaign id. ", "required": false, "schema": { "type": "integer", "format": "int32" }, "example": 1 }, { "name": "segmentIds", "in": "query", "description": " [optional] segment list filter by segmented ids. ", "required": false, "schema": { "type": "string" }, "example": 1 }, { "name": "ids", "in": "query", "description": " [optional] selected segmented id List, segments with provided ids will be returned first compared to other records. ", "required": false, "schema": { "type": "string" }, "example": "1,2,3" }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "List of gender segments": { "description": "List of gender segments", "value": { "statusCode": 200, "responseObject": { "data": [ { "id": 10200001, "name": "Male" }, { "id": 10200002, "name": "Female" }, { "id": 10299999, "name": "Unknown" } ], "totalRecords": 3, "filteredRecords": 0 } } } } } } }, "204": { "description": "No Content" }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } }, "deprecated": true } }, "/api/v2/master/segment/ethnicity": { "get": { "tags": [ "Master API" ], "summary": "Get list of ethnicity.", "operationId": "getMasterSegmentEthnicity", "parameters": [ { "name": "pageNo", "in": "query", "description": "[optional] Page number for the required data. The default value is 1. ", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 }, "example": 1 }, { "name": "noOfEntries", "in": "query", "description": " [optional] The maximum number of returned results per page. The default value is 20 and the maximum value is 500.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 300 }, "example": 20 }, { "name": "sortBy", "in": "query", "description": " [optional] Sort the result set by specific field.", "required": false, "schema": { "type": "string" }, "example": "id" }, { "name": "order", "in": "query", "description": " [optional] Sorting order Supported values: `asc` or `desc`. The default value is `asc`.", "required": false, "schema": { "type": "string", "default": "asc" }, "example": "asc" }, { "name": "searchField", "in": "query", "description": " [optional] Search the result by provided keyword in the searchField. It filters records by id, name.", "required": false, "schema": { "type": "string" }, "example": 1 }, { "name": "campaignId", "in": "query", "description": " [optional] segment list associated with campaign id. ", "required": false, "schema": { "type": "integer", "format": "int32" }, "example": 1 }, { "name": "segmentIds", "in": "query", "description": " [optional] segment list filter by segmented ids. ", "required": false, "schema": { "type": "string" }, "example": 1 }, { "name": "ids", "in": "query", "description": " [optional] selected segmented id List, segments with provided ids will be returned first compared to other records. ", "required": false, "schema": { "type": "string" }, "example": "1,2,3" }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "List of ethnicity segments": { "description": "List of ethnicity segments", "value": { "statusCode": 200, "responseObject": { "data": [ { "id": 10600001, "name": "Afghan", "parentId": 10799998 }, { "id": 10600002, "name": "African/American", "parentId": 10700003 } ], "totalRecords": 219, "filteredRecords": 2 } } } } } } }, "204": { "description": "No Content" }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v2/master/segment/ethnicity-group": { "get": { "tags": [ "Master API" ], "summary": "Get list of ethnicity-group.", "operationId": "getMasterSegmentEthnicityGroup", "parameters": [ { "name": "pageNo", "in": "query", "description": "[optional] Page number for the required data. The default value is 1. ", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 }, "example": 1 }, { "name": "noOfEntries", "in": "query", "description": " [optional] The maximum number of returned results per page. The default value is 20 and the maximum value is 500.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 300 }, "example": 20 }, { "name": "sortBy", "in": "query", "description": " [optional] Sort the result set by specific field.", "required": false, "schema": { "type": "string" }, "example": "id" }, { "name": "order", "in": "query", "description": " [optional] Sorting order Supported values: `asc` or `desc`. The default value is `asc`.", "required": false, "schema": { "type": "string", "default": "asc" }, "example": "asc" }, { "name": "searchField", "in": "query", "description": " [optional] Search the result by provided keyword in the searchField. It filters records by id, name.", "required": false, "schema": { "type": "string" }, "example": 1 }, { "name": "campaignId", "in": "query", "description": " [optional] segment list associated with campaign id. ", "required": false, "schema": { "type": "integer", "format": "int32" }, "example": 1 }, { "name": "segmentIds", "in": "query", "description": " [optional] segment list filter by segmented ids. ", "required": false, "schema": { "type": "string" }, "example": 1 }, { "name": "ids", "in": "query", "description": " [optional] selected segmented id List, segments with provided ids will be returned first compared to other records. ", "required": false, "schema": { "type": "string" }, "example": "1,2,3" }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "List of ethnicity-group segments": { "description": "List of ethnicity-group segments", "value": { "statusCode": 200, "responseObject": { "data": [ { "id": 10700001, "name": "European" }, { "id": 10700002, "name": "Hispanic" }, { "id": 10700003, "name": "African-American" }, { "id": 10700004, "name": "Asian" }, { "id": 10799998, "name": "Other" }, { "id": 10799999, "name": "Unknown" } ], "totalRecords": 6, "filteredRecords": 0 } } } } } } }, "204": { "description": "No Content" }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v2/master/segment/device-type": { "get": { "tags": [ "Master API" ], "summary": "Get list of device-type.", "operationId": "getMasterSegmentDeviceType", "parameters": [ { "name": "pageNo", "in": "query", "description": "[optional] Page number for the required data. The default value is 1. ", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 }, "example": 1 }, { "name": "noOfEntries", "in": "query", "description": " [optional] The maximum number of returned results per page. The default value is 20 and the maximum value is 500.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 300 }, "example": 20 }, { "name": "sortBy", "in": "query", "description": " [optional] Sort the result set by specific field.", "required": false, "schema": { "type": "string" }, "example": "id" }, { "name": "order", "in": "query", "description": " [optional] Sorting order Supported values: `asc` or `desc`. The default value is `asc`.", "required": false, "schema": { "type": "string", "default": "asc" }, "example": "asc" }, { "name": "searchField", "in": "query", "description": " [optional] Search the result by provided keyword in the searchField. It filters records by id, name.", "required": false, "schema": { "type": "string" }, "example": 1 }, { "name": "segmentIds", "in": "query", "description": " [optional] segment list filter by segmented ids. ", "required": false, "schema": { "type": "string" }, "example": 1 }, { "name": "ids", "in": "query", "description": " [optional] selected segmented id List, segments with provided ids will be returned first compared to other records. ", "required": false, "schema": { "type": "string" }, "example": "1,2,3" }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 }, { "name": "campaignId", "in": "query", "description": " [optional] segment list associated with campaign id. ", "example": 1 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "List of device-type segments": { "description": "List of device-type segments", "value": { "statusCode": 200, "responseObject": { "data": [ { "id": 20300001, "name": "Mobile" }, { "id": 20300002, "name": "Desktop" }, { "id": 20300003, "name": "Connected TV" }, { "id": 20300004, "name": "Tablet" }, { "id": 20399999, "name": "Unknown" } ], "totalRecords": 5, "filteredRecords": 5 } } } } } } }, "204": { "description": "No Content" }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } }, "deprecated": true } }, "/api/v2/master/segment/device-os": { "get": { "tags": [ "Master API" ], "summary": "Get list of device-os.", "operationId": "getMasterSegmentOS", "parameters": [ { "name": "pageNo", "in": "query", "description": "[optional] Page number for the required data. The default value is 1. ", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 }, "example": 1 }, { "name": "noOfEntries", "in": "query", "description": " [optional] The maximum number of returned results per page. The default value is 20 and the maximum value is 500.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 300 }, "example": 20 }, { "name": "sortBy", "in": "query", "description": " [optional] Sort the result set by specific field.", "required": false, "schema": { "type": "string" }, "example": "id" }, { "name": "order", "in": "query", "description": " [optional] Sorting order Supported values: `asc` or `desc`. The default value is `asc`.", "required": false, "schema": { "type": "string", "default": "asc" }, "example": "asc" }, { "name": "searchField", "in": "query", "description": " [optional] Search the result by provided keyword in the searchField. It filters records by id, name.", "required": false, "schema": { "type": "string" }, "example": 1 }, { "name": "segmentIds", "in": "query", "description": " [optional] segment list filter by segmented ids. ", "required": false, "schema": { "type": "string" }, "example": 1 }, { "name": "ids", "in": "query", "description": " [optional] selected segmented id List, segments with provided ids will be returned first compared to other records. ", "required": false, "schema": { "type": "string" }, "example": "1,2,3" }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 }, { "name": "campaignId", "in": "query", "description": " [optional] segment list associated with campaign id. ", "example": 1 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "List of device-os segments": { "description": "List of device-os segments", "value": { "statusCode": 200, "responseObject": { "data": [ { "id": 20200001, "name": "Android" }, { "id": 20200002, "name": "Chrome OS" } ], "totalRecords": 28, "filteredRecords": 2 } } } } } } }, "204": { "description": "No Content" }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v2/master/segment/device-manufacturer": { "get": { "tags": [ "Master API" ], "summary": "Get list of device-manufacturer.", "operationId": "getMasterSegmentDeviceManufacture", "parameters": [ { "name": "pageNo", "in": "query", "description": "[optional] Page number for the required data. The default value is 1. ", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 }, "example": 1 }, { "name": "noOfEntries", "in": "query", "description": " [optional] The maximum number of returned results per page. The default value is 20 and the maximum value is 500.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 300 }, "example": 20 }, { "name": "sortBy", "in": "query", "description": " [optional] Sort the result set by specific field.", "required": false, "schema": { "type": "string" }, "example": "id" }, { "name": "order", "in": "query", "description": " [optional] Sorting order Supported values: `asc` or `desc`. The default value is `asc`.", "required": false, "schema": { "type": "string", "default": "asc" }, "example": "asc" }, { "name": "searchField", "in": "query", "description": " [optional] Search the result by provided keyword in the searchField. It filters records by id, name.", "required": false, "schema": { "type": "string" }, "example": 1 }, { "name": "segmentIds", "in": "query", "description": " [optional] segment list filter by segmented ids. ", "required": false, "schema": { "type": "string" }, "example": 1 }, { "name": "ids", "in": "query", "description": " [optional] selected segmented id List, segments with provided ids will be returned first compared to other records. ", "required": false, "schema": { "type": "string" }, "example": "1,2,3" }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 }, { "name": "campaignId", "in": "query", "description": " [optional] segment list associated with campaign id. ", "example": 1 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "List of device-manufacturer segments": { "description": "List of device-manufacturer segments", "value": { "statusCode": 200, "responseObject": { "data": [ { "id": 20100001, "name": "AT&T" }, { "id": 20100002, "name": "Alcatel" } ], "totalRecords": 535, "filteredRecords": 2 } } } } } } }, "204": { "description": "No Content" }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v2/master/segment/device-carrier": { "get": { "tags": [ "Master API" ], "summary": "Get list of device-carrier.", "operationId": "getMasterSegmentDeviceCarrier", "parameters": [ { "name": "pageNo", "in": "query", "description": "[optional] Page number for the required data. The default value is 1. ", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 }, "example": 1 }, { "name": "noOfEntries", "in": "query", "description": " [optional] The maximum number of returned results per page. The default value is 20 and the maximum value is 500.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 300 }, "example": 20 }, { "name": "sortBy", "in": "query", "description": " [optional] Sort the result set by specific field.", "required": false, "schema": { "type": "string" }, "example": "id" }, { "name": "order", "in": "query", "description": " [optional] Sorting order Supported values: `asc` or `desc`. The default value is `asc`.", "required": false, "schema": { "type": "string", "default": "asc" }, "example": "asc" }, { "name": "searchField", "in": "query", "description": " [optional] Search the result by provided keyword in the searchField. It filters records by id, name.", "required": false, "schema": { "type": "string" }, "example": 1 }, { "name": "segmentIds", "in": "query", "description": " [optional] segment list filter by segmented ids. ", "required": false, "schema": { "type": "string" }, "example": 1 }, { "name": "ids", "in": "query", "description": " [optional] selected segmented id List, segments with provided ids will be returned first compared to other records. ", "required": false, "schema": { "type": "string" }, "example": "1,2,3" }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 }, { "name": "campaignId", "in": "query", "description": " [optional] segment list associated with campaign id. ", "example": 1 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "List of device-carrier segments": { "description": "List of device-carrier segments", "value": { "statusCode": 200, "responseObject": { "data": [ { "id": 20400002, "name": "AT&T Internet Services" }, { "id": 20400003, "name": "Comcast Cable" } ], "totalRecords": 123, "filteredRecords": 2 } } } } } } }, "204": { "description": "No Content" }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v2/master/segment/county": { "get": { "tags": [ "Master API" ], "summary": "Get list of county.", "operationId": "getMasterSegmentCounty", "parameters": [ { "name": "pageNo", "in": "query", "description": "[optional] Page number for the required data. The default value is 1. ", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 }, "example": 1 }, { "name": "noOfEntries", "in": "query", "description": " [optional] The maximum number of returned results per page. The default value is 20 and the maximum value is 500.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 300 }, "example": 20 }, { "name": "sortBy", "in": "query", "description": " [optional] Sort the result set by specific field.", "required": false, "schema": { "type": "string" }, "example": "id" }, { "name": "order", "in": "query", "description": " [optional] Sorting order Supported values: `asc` or `desc`. The default value is `asc`.", "required": false, "schema": { "type": "string", "default": "asc" }, "example": "asc" }, { "name": "searchField", "in": "query", "description": " [optional] Search the result by provided keyword in the searchField. It filters records by id, name.", "required": false, "schema": { "type": "string" }, "example": 1 }, { "name": "stateIds", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "campaignId", "in": "query", "description": " [optional] segment list associated with campaign id. ", "required": false, "schema": { "type": "integer", "format": "int32" }, "example": 1 }, { "name": "segmentIds", "in": "query", "description": " [optional] segment list filter by segmented ids. ", "required": false, "schema": { "type": "string" }, "example": 1 }, { "name": "ids", "in": "query", "description": " [optional] selected segmented id List, segments with provided ids will be returned first compared to other records. ", "required": false, "schema": { "type": "string" }, "example": "1,2,3" }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "List of county segments": { "description": "List of county segments", "value": { "statusCode": 200, "responseObject": { "data": [ { "id": 30300003, "name": "Anchorage, AK", "stateId": 30200001 }, { "id": 30300004, "name": "Bethel, AK", "stateId": 30200001 } ], "totalRecords": 3142, "filteredRecords": 2 } } } } } } }, "204": { "description": "No Content" }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } }, "deprecated": true } }, "/api/v2/master/segment/country": { "get": { "tags": [ "Master API" ], "summary": "Get list of country.", "operationId": "getMasterSegmentCountry", "parameters": [ { "name": "pageNo", "in": "query", "description": "[optional] Page number for the required data. The default value is 1. ", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 }, "example": 1 }, { "name": "noOfEntries", "in": "query", "description": " [optional] The maximum number of returned results per page. The default value is 20 and the maximum value is 500.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 300 }, "example": 20 }, { "name": "sortBy", "in": "query", "description": " [optional] Sort the result set by specific field.", "required": false, "schema": { "type": "string" }, "example": "id" }, { "name": "order", "in": "query", "description": " [optional] Sorting order Supported values: `asc` or `desc`. The default value is `asc`.", "required": false, "schema": { "type": "string", "default": "asc" }, "example": "asc" }, { "name": "searchField", "in": "query", "description": " [optional] Search the result by provided keyword in the searchField. It filters records by id, name.", "required": false, "schema": { "type": "string" }, "example": 1 }, { "name": "segmentIds", "in": "query", "description": " [optional] segment list filter by segmented ids. ", "required": false, "schema": { "type": "string" }, "example": 1 }, { "name": "ids", "in": "query", "description": " [optional] selected segmented id List, segments with provided ids will be returned first compared to other records. ", "required": false, "schema": { "type": "string" }, "example": "1,2,3" }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 }, { "name": "campaignId", "in": "query", "description": " [optional] segment list associated with campaign id. ", "example": 1 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "List of country segments": { "description": "List of country segments", "value": { "statusCode": 200, "responseObject": { "data": [ { "id": 30100001, "name": "United States" }, { "id": 30100002, "name": "India" } ], "totalRecords": 210, "filteredRecords": 2 } } } } } } }, "204": { "description": "No Content" }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } }, "deprecated": true } }, "/api/v2/master/segment/connection-type": { "get": { "tags": [ "Master API" ], "summary": "Get list of connection-type.", "operationId": "getMasterSegmentConnectionType", "parameters": [ { "name": "pageNo", "in": "query", "description": "[optional] Page number for the required data. The default value is 1. ", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 }, "example": 1 }, { "name": "noOfEntries", "in": "query", "description": " [optional] The maximum number of returned results per page. The default value is 20 and the maximum value is 500.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 300 }, "example": 20 }, { "name": "sortBy", "in": "query", "description": " [optional] Sort the result set by specific field.", "required": false, "schema": { "type": "string" }, "example": "id" }, { "name": "order", "in": "query", "description": " [optional] Sorting order Supported values: `asc` or `desc`. The default value is `asc`.", "required": false, "schema": { "type": "string", "default": "asc" }, "example": "asc" }, { "name": "searchField", "in": "query", "description": " [optional] Search the result by provided keyword in the searchField. It filters records by id, name.", "required": false, "schema": { "type": "string" }, "example": 1 }, { "name": "segmentIds", "in": "query", "description": " [optional] segment list filter by segmented ids. ", "required": false, "schema": { "type": "string" }, "example": 1 }, { "name": "ids", "in": "query", "description": " [optional] selected segmented id List, segments with provided ids will be returned first compared to other records. ", "required": false, "schema": { "type": "string" }, "example": "1,2,3" }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 }, { "name": "campaignId", "in": "query", "description": " [optional] segment list associated with campaign id. ", "example": 1 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "List of connection-type segments": { "description": "List of connection-type segments", "value": { "statusCode": 200, "responseObject": { "data": [ { "id": 20500002, "name": "Broadband" }, { "id": 20500003, "name": "Cellular" }, { "id": 20599999, "name": "Unknown" } ], "totalRecords": 3, "filteredRecords": 3 } } } } } } }, "204": { "description": "No Content" }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v2/master/segment/congressional-district": { "get": { "tags": [ "Master API" ], "summary": "Get list of Congressional-district.", "operationId": "getMasterSegmentCongressionalDistrict", "parameters": [ { "name": "pageNo", "in": "query", "description": "[optional] Page number for the required data. The default value is 1. ", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 }, "example": 1 }, { "name": "noOfEntries", "in": "query", "description": " [optional] The maximum number of returned results per page. The default value is 20 and the maximum value is 500.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 300 }, "example": 20 }, { "name": "sortBy", "in": "query", "description": " [optional] Sort the result set by specific field.", "required": false, "schema": { "type": "string" }, "example": "id" }, { "name": "order", "in": "query", "description": " [optional] Sorting order Supported values: `asc` or `desc`. The default value is `asc`.", "required": false, "schema": { "type": "string", "default": "asc" }, "example": "asc" }, { "name": "searchField", "in": "query", "description": " [optional] Search the result by provided keyword in the searchField. It filters records by id, name.", "required": false, "schema": { "type": "string" }, "example": 1 }, { "name": "stateIds", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "campaignId", "in": "query", "description": " [optional] segment list associated with campaign id. ", "required": false, "schema": { "type": "integer", "format": "int32" }, "example": 1 }, { "name": "segmentIds", "in": "query", "description": " [optional] segment list filter by segmented ids. ", "required": false, "schema": { "type": "string" }, "example": 1 }, { "name": "ids", "in": "query", "description": " [optional] selected segmented id List, segments with provided ids will be returned first compared to other records. ", "required": false, "schema": { "type": "string" }, "example": "1,2,3" }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "List of Congressional-district segments": { "description": "List of Congressional-district segments", "value": { "statusCode": 200, "responseObject": { "data": [ { "id": 30600001, "name": "1, AK" }, { "id": 30699999, "name": "Unknown" } ], "totalRecords": 439, "filteredRecords": 2 } } } } } } }, "204": { "description": "No Content" }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } }, "deprecated": true } }, "/api/v2/master/segment/city": { "get": { "tags": [ "Master API" ], "summary": "Get list of city.", "operationId": "getMasterSegmentCity", "parameters": [ { "name": "pageNo", "in": "query", "description": "[optional] Page number for the required data. The default value is 1. ", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 }, "example": 1 }, { "name": "noOfEntries", "in": "query", "description": " [optional] The maximum number of returned results per page. The default value is 20 and the maximum value is 500.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 300 }, "example": 20 }, { "name": "sortBy", "in": "query", "description": " [optional] Sort the result set by specific field.", "required": false, "schema": { "type": "string" }, "example": "id" }, { "name": "order", "in": "query", "description": " [optional] Sorting order Supported values: `asc` or `desc`. The default value is `asc`.", "required": false, "schema": { "type": "string", "default": "asc" }, "example": "asc" }, { "name": "searchField", "in": "query", "description": " [optional] Search the result by provided keyword in the searchField. It filters records by id, name.", "required": false, "schema": { "type": "string" }, "example": 1 }, { "name": "stateIds", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "campaignId", "in": "query", "description": " [optional] segment list associated with campaign id. ", "required": false, "schema": { "type": "integer", "format": "int32" }, "example": 1 }, { "name": "segmentIds", "in": "query", "description": " [optional] segment list filter by segmented ids. ", "required": false, "schema": { "type": "string" }, "example": 1 }, { "name": "ids", "in": "query", "description": " [optional] selected segmented id List, segments with provided ids will be returned first compared to other records. ", "required": false, "schema": { "type": "string" }, "example": "1,2,3" }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "List of city segments": { "description": "List of city segments", "value": { "statusCode": 200, "responseObject": { "data": [ { "id": 30400001, "name": "Adak, AK", "stateId": 30200001 }, { "id": 30400002, "name": "Akhiok, AK", "stateId": 30200001 } ], "totalRecords": 36563, "filteredRecords": 2 } } } } } } }, "204": { "description": "No Content" }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } }, "deprecated": true } }, "/api/v2/master/segment/age": { "get": { "tags": [ "Master API" ], "summary": "Get list of age.", "operationId": "getMasterSegmentAge", "parameters": [ { "name": "pageNo", "in": "query", "description": "[optional] Page number for the required data. The default value is 1. ", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 }, "example": 1 }, { "name": "noOfEntries", "in": "query", "description": " [optional] The maximum number of returned results per page. The default value is 20 and the maximum value is 500.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 300 }, "example": 20 }, { "name": "sortBy", "in": "query", "description": " [optional] Sort the result set by specific field.", "required": false, "schema": { "type": "string", "default": "name" }, "example": "id" }, { "name": "order", "in": "query", "description": " [optional] Sorting order Supported values: `asc` or `desc`. The default value is `asc`.", "required": false, "schema": { "type": "string", "default": "asc" }, "example": "asc" }, { "name": "searchField", "in": "query", "description": " [optional] Search the result by provided keyword in the searchField. It filters records by id, name.", "required": false, "schema": { "type": "string" }, "example": 1 }, { "name": "campaignId", "in": "query", "description": " [optional] segment list associated with campaign id. ", "required": false, "schema": { "type": "integer", "format": "int32" }, "example": 1 }, { "name": "segmentIds", "in": "query", "description": " [optional] segment list filter by segmented ids. ", "required": false, "schema": { "type": "string" }, "example": 1 }, { "name": "ids", "in": "query", "description": " [optional] selected segmented id List, segments with provided ids will be returned first compared to other records. ", "required": false, "schema": { "type": "string" }, "example": "1,2,3" }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "List of age segments": { "description": "List of age segments", "value": { "statusCode": 200, "responseObject": { "data": [ { "id": 10100001, "name": "13-17" }, { "id": 10100002, "name": "18-24" } ], "totalRecords": 8, "filteredRecords": 2 } } } } } } }, "204": { "description": "No Content" }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v2/master/district/list": { "get": { "tags": [ "Master API" ], "summary": "Get Districts by States", "description": "This endpoint is used to fetch the list of districts by states. It supports filtering by state IDs and district type.", "operationId": "getDistrictsByStates", "parameters": [ { "name": "stateIds", "in": "query", "description": "Ids of states used to filter the districts data", "required": true, "schema": { "type": "string" } }, { "name": "type", "in": "query", "description": "Type of districts to be fetched. It can be from `congressional`, `senate`, and `house`", "required": true, "schema": { "type": "string" } }, { "name": "searchStr", "in": "query", "description": "Search the result by provided keyword in the searchField. ", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Successfully fetched district list": { "description": "Successfully fetched district list", "value": { "statusCode": 200, "responseObject": { "4660": { "id": 4660, "stateCode": "01", "stateName": "Alabama", "districtList": [ { "id": 350, "geoCode": "101", "districtName": "Alabama-1", "districtId": "AL-1" }, { "id": 78, "geoCode": "102", "districtName": "Alabama-2", "districtId": "AL-2" } ] }, "4664": { "id": 4664, "stateCode": "05", "stateName": "Arkansas", "districtList": [ { "id": 88, "geoCode": "501", "districtName": "Arkansas-1", "districtId": "AR-1" }, { "id": 425, "geoCode": "502", "districtName": "Arkansas-2", "districtId": "AR-2" } ] } } } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "examples": { "Bad Request": { "description": "Bad Request", "value": { "error": "Invalid request parameters" } } } } } } } } }, "/api/v3/ra/reports/list": { "get": { "tags": [ "Report API" ], "summary": "Get List of Reports", "description": "This API fetches list of reports as per the given filters", "operationId": "getReportList", "parameters": [ { "name": "customerIds", "in": "query", "description": "Comma separated Customer Ids for filtering. Passing `all` will fetch all eligible customer's report. Default value is `all`", "required": false, "schema": { "type": "string", "default": "all" } }, { "name": "sortBy", "in": "query", "description": "Response will be sorted on the given field. Allowed sorting values needs to be specified with `-` and `+` prefix.", "required": false, "schema": { "type": "string", "default": "-modifyDate" } }, { "name": "searchField", "in": "query", "description": "Search keyword", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "limit", "in": "query", "description": "Limit defines the number of records returned in the response.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 20 } }, { "name": "pageNo", "in": "query", "description": "Page number defines which page entries will be fetched in response. Pagination will not be applied with value -1", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Report data": { "description": "Report data", "value": { "success": true, "data": { "data": [ { "id": 1, "reportName": "Campaign by Gender by Device type", "startDate": 1650177200, "endDate": 1666938296, "dimensions": "[{\"filter\":\"campaign\",\"value\":[123,234,345,456]},{\"filter\":\"gender\",\"value\":[10200002]},{\"filter\":\"device_type\",\"value\":[20300001,20300003]}]", "customerIds": null, "customerDetails": null, "timezoneId": 11, "reportSchedulingEventDetails": { "eventId": 29, "deliveryFrequency": 3, "fileType": 2, "subscriberEmails": [ "demoUser1@gmail.com", "demoUser2@iqm.com" ], "eventEndDate": 1671148799999, "deliveryDay": "Friday" } }, { "id": 2, "reportName": "Campaigns by Zip Codes with filters", "startDate": 1660521600, "endDate": 1668470399, "dimensions": "[{\"filter\": \"campaign\"}, {\"value\": [123, 234, 345, 456], \"filter\": \"zip5\"}]", "customerIds": null, "customerDetails": null, "timezoneId": 12, "reportSchedulingEventDetails": { } }, { "id": 3, "reportName": "Creatives by Income Ranges and Operating System with filters", "startDate": 1660521600, "endDate": 1668470399, "timezoneId": 11, "dimensions": "[{\"filter\": \"creative\"}, {\"value\": [10300002, 10300003], \"filter\": \"income_group\"}, {\"value\": [20200001, 20200002, 20200003], \"filter\": \"os\"}]", "customerIds": [200, 201], "customerDetails": [ { "owId": 200, "organizationName": "Test Organization", "organizationLogo": "https://iqm-web-assets-c92d6b6cbde1-stage.s3.amazonaws.com/organization-profile/200/1637314301025.png", "statusId": 1, "status": "Active", "supportEmail": "demoSupport@gmail.com", "timezone": 29 } ], "reportSchedulingEventDetails": { } } ], "totalRecords": 3, "filteredRecords": 3 } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden !" } ] } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Invalid sortBy value." } ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } }, "post": { "tags": [ "Report API" ], "summary": "Get List of Reports", "description": "This API fetches list of reports as per the given filters\n\n**Request Body Description:**\n\n| **Filed** | **Type** | **Description** |\n| --- | --- | --- |\n| customerIds | String | [Optional] - Comma separated String of Customer IDs for which Report's list is requested. Default value is `all` |\n| searchField | String | [Optional] - Search field for report listing data. Search is supported for Report ID and Report name |\n| sortBy | String | [Optional] - Sort the result set by specific field. For ascending use plus(asc) and for descending use minus(desc) string. \u003Cbr\u003EDefault value is `-modifyDate`|\n| pageNo | Integer | [Optional] - Page number for the required data. \u003Cbr\u003EDefault value is `1`|\n| noOfEntries | Integer | [Optional] - The maximum number of returned results per page. \u003Cbr\u003EDefault value is `20`|\n", "operationId": "fetchReportList", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "sortCriteriaMap": { "type": "object", "additionalProperties": { "type": "string" } }, "owId": { "type": "integer", "format": "int32" }, "customerIds": { "type": "string" }, "uowId": { "type": "integer", "format": "int32" }, "pageNo": { "type": "integer", "format": "int32" }, "noOfEntries": { "type": "integer", "format": "int32" }, "sortBy": { "type": "string" }, "searchField": { "type": "string" }, "order": { "type": "string", "enum": [ "SortOrderEnum[id=1, name='asc', symbol='+']", "SortOrderEnum[id=2, name='desc', symbol='-']" ] } } }, "examples": { "Report List": { "description": "Report List", "value": { "customerIds": "123,234,345", "pageNo": 1, "noOfEntries": 30, "sortBy": "+id", "searchField": "search field" } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Report data": { "description": "Report data", "value": { "success": true, "data": { "data": [ { "id": 1, "reportName": "Campaign by Gender by Device type", "startDate": 1650177200, "endDate": 1666938296, "dimensions": "[{\"filter\":\"campaign\",\"value\":[123,234,345,456]},{\"filter\":\"gender\",\"value\":[10200002]},{\"filter\":\"device_type\",\"value\":[20300001,20300003]}]", "customerIds": null, "customerDetails": null, "timezoneId": 11, "reportSchedulingEventDetails": { "eventId": 29, "deliveryFrequency": 3, "fileType": 2, "subscriberEmails": [ "demoUser1@gmail.com", "demoUser2@iqm.com" ], "eventEndDate": 1671148799999, "deliveryDay": "Friday" } }, { "id": 2, "reportName": "Campaigns by Zip Codes with filters", "startDate": 1660521600, "endDate": 1668470399, "dimensions": "[{\"filter\": \"campaign\"}, {\"value\": [123, 234, 345, 456], \"filter\": \"zip5\"}]", "customerIds": null, "customerDetails": null, "timezoneId": 12, "reportSchedulingEventDetails": { } }, { "id": 3, "reportName": "Creatives by Income Ranges and Operating System with filters", "startDate": 1660521600, "endDate": 1668470399, "timezoneId": 11, "dimensions": "[{\"filter\": \"creative\"}, {\"value\": [10300002, 10300003], \"filter\": \"income_group\"}, {\"value\": [20200001, 20200002, 20200003], \"filter\": \"os\"}]", "customerIds": [200, 201], "customerDetails": [ { "owId": 200, "organizationName": "Test Organization", "organizationLogo": "https://iqm-web-assets-c92d6b6cbde1-stage.s3.amazonaws.com/organization-profile/200/1637314301025.png", "statusId": 1, "status": "Active", "supportEmail": "demoSupport@gmail.com", "timezone": 29 } ], "reportSchedulingEventDetails": { } } ], "totalRecords": 3, "filteredRecords": 3 } } } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Invalid sortBy value." } ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/ra/report/execute": { "post": { "tags": [ "Report API" ], "summary": "Execute report and fetch serving data", "description": "This API runs a report and retrieves the corresponding served data.\n\n**Request Body Description:**\n\n| **Filed** | **Type** | **Description** |\n| --- | --- | --- |\n| id | Integer | [Optional] - This is report Id, report data will be fetched for this report id. |\n| dimensions | JSON String | [Optional] - JSON string representing dimension details. |\n| columns | Array of String | [Optional] - Metrics for showing serving result |\n| customerIds | Array of Integer | [Optional] - Customer IDs, report data will be fetched for these customers. |\n| filters | JSON String | [Optional] - JSON string supporting campaignId, creativeTypeId and campaignStatus filtering. |\n| searchField | String | [Optional] - Search field for report serving data. |\n| requestType | Integer | [Optional] - ID to identify if report request is of Daily or Aggregate. \u003Cbr\u003Esample : [1 - Daily, 2 - Aggregated, 3 - Weekly, 4 - Monthly] |\n| reportAggregated | String | [Optional] - Field to identify if report dimension is Aggregated or not. \u003Cbr\u003Esample : [0- Not aggregated, 1- Aggregated] |\n| startDate | Long | [Optional] - This should be a long, TIME EPOCH in UNIX format, in milliseconds. \u003Cbr\u003EThis is report start time.|\n| endDate | Long | [Optional] - This should be a long, TIME EPOCH in UNIX format, in milliseconds. \u003Cbr\u003EThis is report end time.|\n| timezoneId | Integer | [Optional] - Timezone ID|\n| timezoneName | String | [Optional] - Timezone Name|\n| sortBy | String | [Optional] - Sort the result set by specific field. For ascending use plus(asc) and for descending use minus(desc) string. \u003Cbr\u003EDefault value is '+impressions'|\n| pageNo | Integer | [Optional] - Page number for the required data. \u003Cbr\u003EDefault value is 1|\n| noOfEntries | Integer | [Optional] - The maximum number of returned results per page. \u003Cbr\u003EDefault value is 50|\n", "operationId": "executeReportData", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "reportName": { "type": "string" }, "startDate": { "type": "integer", "format": "int64" }, "endDate": { "type": "integer", "format": "int64" }, "dimensions": { "type": "string" }, "customerIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "columns": { "type": "array", "items": { "type": "string" } }, "timezoneId": { "type": "integer", "format": "int32" }, "requestType": { "type": "integer", "format": "int32" }, "reportAggregated": { "type": "string" }, "owId": { "type": "integer", "format": "int32" }, "createdByUOWId": { "type": "integer", "format": "int32" }, "modifiedByUOWId": { "type": "integer", "format": "int32" }, "timezoneName": { "type": "string" }, "organizationName": { "type": "string" }, "resultType": { "type": "string" }, "fileType": { "type": "integer", "format": "int32" }, "filters": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "object" } } }, "internalRequest": { "type": "boolean" }, "pageNo": { "type": "integer", "format": "int32" }, "noOfEntries": { "type": "integer", "format": "int32" }, "sortBy": { "type": "string" }, "searchField": { "type": "string" } } }, "examples": { "Execute Report (By Report ID)": { "description": "Execute Report (By Report ID)", "value": { "id": 3219 } }, "Execute Report (By Report Data)": { "description": "Execute Report (By Report Data)", "value": { "startDate": 1670410001000, "endDate": 1675766802000, "dimensions": "[{\"filter\":\"campaign\"},{\"filter\":\"gender\",\"value\":[10200002]},{\"filter\":\"deviceType\",\"value\":[20300001,20300003]}]", "columns": [ "campaignId", "campaignName", "deviceType", "completeCount", "gender", "startTime", "endTime", "maxBid", "budgetDay", "VCR", "eCPC", "totalECPC", "budgetTotal", "impressions", "clicks", "winRate", "reach" ], "customerIds": [201353, 201352], "filters": { "campaignIds": [123, 234, 345], "creativeTypeIds": [11], "campaignStatuses": [ "expired", "running" ] }, "searchField": "123", "requestType": 1, "reportAggregated": "0", "timezoneId": 11, "timezoneName": "UTC", "order": "desc", "sortBy": "impressions", "noOfEntries": 50, "pageNo": 1 } }, "Execute Report (Weekly)": { "description": "Execute Report (Weekly)", "value": { "customerIds": [], "startDate": 1749614400000, "endDate": 1757649599000, "dimensions": "[{\"filter\":\"campaign\"}]", "columns": [ "impressions", "clicks", "CTR", "VCR", "spent", "dataCost", "mediaSpent", "eCPM" ], "requestType": 3, "reportAggregated": "0", "timezoneName": "US/Eastern", "timezoneId": 29, "counter": 1, "pageNo": 1, "noOfEntries": 20, "sortBy": "-impressions" } }, "Invalid input sample": { "description": "Invalid input sample", "value": { "startDate": 1670410001000, "endDate": 1675766802000, "dimensions": "[{\"filter\":\"campaign\"}]", "requestType": 1 } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Execute Report (Daily)": { "description": "Execute Report (Daily)", "value": { "success": true, "data": { "total": { "CTR": 0.26809, "date": null, "deviceTypeId": null, "VCR": 51.452171, "budgetDay": null, "gender": null, "budgetPacing": null, "dataCost": 0, "totalRecords": 135, "campaignTimezone": null, "eCPM": 4.50311429853875, "totalECPM": 4.50311429853875, "bidImpressions": 4678583, "startTime": null, "mediaSpent": 8485.86672119556, "eCPC": 1.67970441828891, "totalECPC": 1.67970441828891, "deviceType": null, "startCount": 351095, "campaignType": null, "campaignId": null, "spent": 8485.86672119556, "impressions": 1884444, "eCPCV": 0.0215601437130939, "completeCount": 180646, "budgetTotal": null, "maxBid": null, "minBid": null, "clicks": 5052, "thirdPartyCost": 0.021, "endTime": null, "campaignName": null, "status": null }, "data": [ { "CTR": 0.2796, "date": "2022-01-30", "deviceTypeId": 20300001, "VCR": 0, "budgetDay": 0.07, "gender": "Unknown", "budgetPacing": true, "dataCost": 0, "totalRecords": null, "campaignTimezone": "America/Costa_Rica", "eCPM": 3, "totalECPM": 3, "bidImpressions": 628344, "startTime": 1643428296, "mediaSpent": 457.098, "eCPC": 1.073, "totalECPC": 1.073, "deviceType": "Mobile", "startCount": 0, "campaignType": "cpm", "campaignId": 15474, "spent": 457.098, "impressions": 152366, "eCPCV": 0, "completeCount": 0, "budgetTotal": 1549, "maxBid": 3, "minBid": 2, "clicks": 426, "thirdPartyCost": 0.021, "endTime": 1644192000, "campaignName": "Costa Rica MEMES COMPILADOS Profile: All Gender: All Ages: 18 to 45 Geo: Heredia, Alajuela, Cartago and San Jose", "status": "expired" }, { "CTR": 0.2122, "date": "2022-01-30", "deviceTypeId": 20300001, "VCR": 0, "budgetDay": 0.21, "gender": "Unknown", "budgetPacing": true, "dataCost": 0, "totalRecords": null, "campaignTimezone": "America/Costa_Rica", "eCPM": 3, "totalECPM": 3, "bidImpressions": 271620, "startTime": 1643423160, "mediaSpent": 418.488, "eCPC": 1.41381081081081, "totalECPC": 1.41381081081081, "deviceType": "Mobile", "startCount": 0, "campaignType": "cpm", "campaignId": 15472, "spent": 418.488, "impressions": 139496, "eCPCV": 0, "completeCount": 0, "budgetTotal": 1548, "maxBid": 3, "minBid": 2, "clicks": 296, "thirdPartyCost": 0.021, "endTime": 1644192000, "campaignName": "Costa Rica Universidad Latina Profile: All Gender: All Ages: 18 to 75 Geo: All Costa Rica", "status": "expired" }, { "CTR": 0.1065, "date": "2022-01-30", "deviceTypeId": 20300001, "VCR": 0, "budgetDay": 0.43, "gender": "Unknown", "budgetPacing": true, "dataCost": 0, "totalRecords": null, "campaignTimezone": "America/Costa_Rica", "eCPM": 3.00002495259008, "totalECPM": 3.00002495259008, "bidImpressions": 239865, "startTime": 1643431623, "mediaSpent": 360.687, "eCPC": 2.8178671875, "totalECPC": 2.8178671875, "deviceType": "Mobile", "startCount": 0, "campaignType": "cpm", "campaignId": 15477, "spent": 360.687, "impressions": 120228, "eCPCV": 0, "completeCount": 0, "budgetTotal": 1551, "maxBid": 3, "minBid": 2, "clicks": 128, "thirdPartyCost": 0.021, "endTime": 1644192000, "campaignName": "Costa Rica TICOS AL DIA 24-25 ENE Profile: All Gender: All Ages: 18 to 25 and 60+ and over Geo: Heredia, Alajuela, Cartago and San Jose", "status": "expired" }, { "CTR": 0.3118, "date": "2022-01-31", "deviceTypeId": 20300001, "VCR": 0, "budgetDay": 0.07, "gender": "Unknown", "budgetPacing": true, "dataCost": 0, "totalRecords": null, "campaignTimezone": "America/Costa_Rica", "eCPM": 3, "totalECPM": 3, "bidImpressions": 280562, "startTime": 1643428296, "mediaSpent": 219.363, "eCPC": 0.962118421052632, "totalECPC": 0.962118421052632, "deviceType": "Mobile", "startCount": 0, "campaignType": "cpm", "campaignId": 15474, "spent": 219.363, "impressions": 73121, "eCPCV": 0, "completeCount": 0, "budgetTotal": 1549, "maxBid": 3, "minBid": 2, "clicks": 228, "thirdPartyCost": 0.021, "endTime": 1644192000, "campaignName": "Costa Rica MEMES COMPILADOS Profile: All Gender: All Ages: 18 to 45 Geo: Heredia, Alajuela, Cartago and San Jose", "status": "expired" }, { "CTR": 0.3154, "date": "2022-01-30", "deviceTypeId": 20300001, "VCR": 0, "budgetDay": 1, "gender": "Unknown", "budgetPacing": true, "dataCost": 0, "totalRecords": null, "campaignTimezone": "America/Costa_Rica", "eCPM": 3, "totalECPM": 3, "bidImpressions": 233754, "startTime": 1643131598, "mediaSpent": 211.161, "eCPC": 0.951175675675676, "totalECPC": 0.951175675675676, "deviceType": "Mobile", "startCount": 0, "campaignType": "cpm", "campaignId": 15455, "spent": 211.161, "impressions": 70387, "eCPCV": 0, "completeCount": 0, "budgetTotal": 1749, "maxBid": 3, "minBid": 1, "clicks": 222, "thirdPartyCost": 0.021, "endTime": 1644192000, "campaignName": "Costa Rica MEMES COMPILADOS Profile: Undecided Gender: All Ages: 18 to 35 Geo: Heredia, Alajuela, Cartago, San Jose", "status": "expired" } ], "totalRecords": 135 } } }, "Execute report response with dateRange field (weekly OR monthly)": { "description": "Execute report response with dateRange field (weekly OR monthly)", "value": { "success": true, "data": { "total": { "CTR": 0.042882, "baseBid": null, "totalRecords": 4, "VCR": 0, "budgetTypeId": 1, "totalBudget": 8200, "dateRange": null, "dataCost": 0, "budgetMappingDataCost": null, "totalECPM": 2.42881646655232, "campaignTimezone": null, "eCPM": 2.42881646655232, "bidImpressions": 2352, "preBidCost": 0, "mediaSpent": 5.664, "startCount": 0, "campaignId": null, "spent": 5.664, "impressions": 2332, "completeCount": 0, "budgetMappingSpent": null, "dailyBudget": 30.25, "maxBid": null, "minBid": null, "clicks": 1, "thirdPartyCost": 0.021, "campaign": null, "budgetCompletion": 0.0835853658536585, "status": null, "reach": 2332, "frequency": 1 }, "totalRecords": 4, "data": [ { "CTR": 0, "baseBid": null, "totalRecords": null, "VCR": 0, "budgetTypeId": 1, "totalBudget": 5000, "dateRange": "08/31/2025 - 09/06/2025", "dataCost": 0, "budgetMappingDataCost": 0, "totalECPM": 2, "campaignTimezone": "US/Eastern", "eCPM": 2, "bidImpressions": 2214, "preBidCost": 0, "mediaSpent": 4.394, "startCount": 0, "campaignId": 562558, "spent": 4.394, "impressions": 2197, "completeCount": 0, "budgetMappingSpent": 4.394, "dailyBudget": 18.03, "maxBid": 2, "minBid": 1, "clicks": 0, "thirdPartyCost": 0.021, "campaign": "test campaign for aud vert 2", "budgetCompletion": 0.08788, "status": "running" }, { "CTR": 0, "baseBid": null, "totalRecords": null, "VCR": 0, "budgetTypeId": 1, "totalBudget": 1000, "dateRange": "08/31/2025 - 09/06/2025", "dataCost": 0, "budgetMappingDataCost": 0, "totalECPM": 10, "campaignTimezone": "US/Eastern", "eCPM": 10, "bidImpressions": 119, "preBidCost": 0, "mediaSpent": 1.18, "startCount": 0, "campaignId": 562797, "spent": 1.18, "impressions": 118, "completeCount": 0, "budgetMappingSpent": 1.19, "dailyBudget": 3.81, "maxBid": 10, "minBid": 1, "clicks": 0, "thirdPartyCost": 0.021, "campaign": "test campaign for aud vert 6", "budgetCompletion": 0.119, "status": "running" }, { "CTR": 6.25, "baseBid": null, "totalRecords": null, "VCR": 0, "budgetTypeId": 1, "totalBudget": 1200, "dateRange": "06/08/2025 - 06/14/2025", "dataCost": 0, "budgetMappingDataCost": 0, "totalECPM": 5, "campaignTimezone": "US/Eastern", "eCPM": 5, "bidImpressions": 16, "preBidCost": 0, "mediaSpent": 0.08, "startCount": 0, "campaignId": 562466, "spent": 0.08, "impressions": 16, "completeCount": 0, "budgetMappingSpent": 0.08, "dailyBudget": 4.6, "maxBid": 5, "minBid": 2, "clicks": 1, "thirdPartyCost": 0.021, "campaign": "test campaign for aud vert 1", "budgetCompletion": 0.00666666666666667, "status": "running" }, { "CTR": 0, "baseBid": null, "totalRecords": null, "VCR": 0, "budgetTypeId": 1, "totalBudget": 1000, "dateRange": "09/07/2025 - 09/13/2025", "dataCost": 0, "budgetMappingDataCost": 0, "totalECPM": 10, "campaignTimezone": "US/Eastern", "eCPM": 10, "bidImpressions": 3, "preBidCost": 0, "mediaSpent": 0.01, "startCount": 0, "campaignId": 562797, "spent": 0.01, "impressions": 1, "completeCount": 0, "budgetMappingSpent": 1.19, "dailyBudget": 3.81, "maxBid": 10, "minBid": 3, "clicks": 0, "thirdPartyCost": 0.021, "campaign": "test campaign for aud vert 6", "budgetCompletion": 0.119, "status": "running" } ], "filteredRecords": 4 } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden !" } ] } } } }, "422": { "description": "Un-Processable Entity", "content": { "application/json": { "examples": { "Invalid input": { "description": "Invalid input", "value": { "success": false, "errorObjects": [ { "error": "Please select columns for report creation", "field": "columns" } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/ra/report/email/schedule": { "post": { "tags": [ "Report API" ], "summary": "Save report scheduling event.", "description": "This API saves the report scheduling event.\n\n**Request Body Description:**\n\n| **Filed** | **Type** | **Description** |\n| --- | --- | --- |\n| reportId | Integer | [Required] - This is report Id, event will be created on this report id. |\n| subscriberEmails | Array of String | [Required] - List of the emails on which the report will be sent. |\n| fileType | Integer | [Required] - Report file type id. The report will be sent in the selected file format . \u003Cbr\u003Esample : [1 - CSV, 2 - XLS]|\n| deliveryFrequency | Integer | [Required] - Delivery frequency type id for the emails to be sent.\u003Cbr\u003Esample : [1 - ONCE, 2 - DAILY, 3 - WEEKLY, 4 - MONTHLY] |\n| deliveryDay | String | [Required, if deliveryFrequency is not ONCE] - Delivery day to specify the day-time when the report should be sent. \u003Cbr\u003EThis is related to Delivery frequency. \u003Cbr\u003E WEEKLY DELIVERY DAY: [\"SUNDAY\", \"MONDAY\", ...] \u003Cbr\u003EMONTHLY DELIVERY DAY: [\"FIRST\", \"LAST\", \"2\", \"3\", ..., \"29\"]|\n| eventEndDate | Long | [Required, if deliveryFrequency is not ONCE] - This should be a long, TIME EPOCH in UNIX format, in milliseconds. \u003Cbr\u003EThis is events end date, Scheduled report will be stopped after the eventEndDate is exceeded |\n| runningTotalEnabled | Boolean | [Optional] - Flag to indicate if the 'Total' Running is enabled for the report. This flag is supported only with 'Campaign' dimension.\u003Cbr\u003E If this is true the start-date for the report duration should be the EARLIEST campaign start date, \u003Cbr\u003Eso the report-time-period will be from the Earliest-campaign-start-date to the report-end-date |\n| earliestCampaignStartDate | Long | [Required with runningTotalEnabled as 'true'] - This should be a long, TIME EPOCH in UNIX format, in milliseconds. \u003Cbr\u003EThis is campaign's EARLIEST start date from the selected campaigns, which will be set as the start date of the report-time-period. |", "operationId": "saveReportScheduleEvent", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "earliestCampaignStartDate": { "type": "integer", "format": "int64" }, "reportId": { "type": "integer", "format": "int32" }, "deliveryFrequency": { "type": "integer", "format": "int32" }, "fileType": { "type": "integer", "format": "int32" }, "subscriberEmails": { "type": "array", "items": { "type": "string" } }, "eventEndDate": { "type": "integer", "format": "int64" }, "deliveryDay": { "type": "string" }, "runningTotalEnabled": { "type": "boolean" } } }, "examples": { "Save Report Scheduling Sample(Monthly)": { "description": "Save Report Scheduling Sample(Monthly)", "value": { "reportId": 1234, "subscriberEmails": [ "sample_email1@example.com", "sample_email2@example.com" ], "fileType": 2, "deliveryFrequency": 4, "eventEndDate": 1670674106000, "deliveryDay": "4", "runningTotalEnabled": true, "earliestCampaignStartDate": 1670674108900 } }, "Save Report Scheduling Sample(Weekly)": { "description": "Save Report Scheduling Sample(Weekly)", "value": { "reportId": 1235, "subscriberEmails": [ "sample_email1@example.com", "sample_email2@example.com" ], "fileType": 2, "deliveryFrequency": 3, "eventEndDate": 1670674106000, "deliveryDay": "MONDAY", "runningTotalEnabled": true, "earliestCampaignStartDate": 1670674108900 } }, "Invalid input sample": { "description": "Invalid input sample", "value": { "reportId": -1, "subscriberEmails": [ "sample_email1@example.com", "sample_email2@example.com" ], "fileType": 2, "deliveryFrequency": 3, "eventEndDate": 1670674106000, "deliveryDay": "MONDAY", "runningTotalEnabled": true, "earliestCampaignStartDate": 1670674108900 } }, "A few invalid email Example": { "description": "A few invalid email Example", "value": { "reportId": 1234, "subscriberEmails": [ "sample_email1@example.com", "sample_email2@invalid" ], "fileType": 2, "deliveryFrequency": 3, "eventEndDate": 1670674106000, "deliveryDay": "MONDAY", "runningTotalEnabled": true, "earliestCampaignStartDate": 1670674108900 } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Save Report Scheduling Sample(Monthly)": { "description": "Save Report Scheduling Sample(Monthly)", "value": { "success": true, "data": { "scheduledData": { "earliestCampaignStartDate": 0, "reportId": 1234, "deliveryFrequency": 4, "fileType": 1, "subscriberEmails": [ "sample_email@sample.com", "sample_email2@sample.com" ], "eventEndDate": 1696270980000, "deliveryDay": "5", "runningTotalEnabled": false }, "message": "Report schedule has been successfully updated." } } }, "Save Report Scheduling Sample(Weekly)": { "description": "Save Report Scheduling Sample(Weekly)", "value": { "success": true, "data": { "scheduledData": { "earliestCampaignStartDate": 0, "reportId": 12345, "deliveryFrequency": 3, "fileType": 1, "subscriberEmails": [ "sample_email@sample.com", "sample_email2@sample.com" ], "eventEndDate": 1696270980000, "deliveryDay": "MONDAY", "runningTotalEnabled": false }, "message": "Report schedule has been successfully updated." } } }, "A few invalid email Example": { "description": "A few invalid email Example", "value": { "success": true, "errorObjects": [ { "error": "Invalid email provided - invalid Emails : [sample_email2@invalid].", "reason": "One or more subscribers emails are empty or not provided as per the email format", "field": "subscriberEmails" } ], "data": { "scheduledData": { "earliestCampaignStartDate": 0, "reportId": 12345, "deliveryFrequency": 3, "fileType": 1, "subscriberEmails": [ "sample_email@sample.com" ], "eventEndDate": 1696270980000, "deliveryDay": "MONDAY", "runningTotalEnabled": false }, "message": "Report schedule has been successfully updated." } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden!" } ] } } } }, "422": { "description": "Un-Processable Entity", "content": { "application/json": { "examples": { "Invalid input": { "description": "Invalid input", "value": { "success": false, "errorObjects": { "error": "Report does not exists for the given id" } } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/ra/report/duplicate": { "post": { "tags": [ "Report API" ], "summary": "Duplicate Report", "description": "This API will duplicate Report based on given report ID", "operationId": "duplicateReport", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "reportName": { "type": "string" }, "startDate": { "type": "integer", "format": "int64" }, "endDate": { "type": "integer", "format": "int64" }, "dimensions": { "type": "string" }, "customerIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "columns": { "type": "array", "items": { "type": "string" } }, "timezoneId": { "type": "integer", "format": "int32" }, "requestType": { "type": "integer", "format": "int32" }, "reportAggregated": { "type": "string" }, "owId": { "type": "integer", "format": "int32" }, "createdByUOWId": { "type": "integer", "format": "int32" }, "modifiedByUOWId": { "type": "integer", "format": "int32" }, "timezoneName": { "type": "string" }, "organizationName": { "type": "string" }, "customerDetails": { "type": "array", "items": { "type": "object", "properties": { "owId": { "type": "integer", "format": "int32" }, "organizationName": { "type": "string" }, "organizationLogo": { "type": "string" }, "statusId": { "type": "integer", "format": "int32" }, "status": { "type": "string" }, "supportEmail": { "type": "string" }, "timezone": { "type": "integer", "format": "int32" }, "organizationType": { "type": "string" } } } }, "reportSchedulingEventDetails": { "type": "object", "properties": { "earliestCampaignStartDate": { "type": "integer", "format": "int64" }, "reportId": { "type": "integer", "format": "int32" }, "deliveryFrequency": { "type": "integer", "format": "int32" }, "fileType": { "type": "integer", "format": "int32" }, "subscriberEmails": { "type": "array", "items": { "type": "string" } }, "eventEndDate": { "type": "integer", "format": "int64" }, "deliveryDay": { "type": "string" }, "runningTotalEnabled": { "type": "boolean" } } } } }, "examples": { "Duplicate report with ID and Name": { "description": "Duplicate report with ID and Name", "value": { "id": 123, "reportName": "Report name" } }, "Duplicate report with just ID": { "description": "Duplicate report with just ID", "value": { "id": 123 } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Report Duplicated": { "description": "Report Duplicated", "value": { "success": true, "data": "Report duplicated successfully with id 124" } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden !" } ] } } } }, "422": { "description": "Un-Processable Entity", "content": { "application/json": { "examples": { "Invalid input": { "description": "Invalid input", "value": { "success": false, "errorObjects": [ { "error": "Report does not exists" } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/ra/report/download": { "post": { "tags": [ "Report API" ], "summary": "Download report serving data", "description": "This API runs a report and returns S3 file URL for downlaoding the report.\n\n**Request Body Details:**\n\n| **Field** | **Type** | **Description** |\n| --- | --- | --- |\n| id | Integer | [Optional] - This is report Id, report data will be fetched for this report id. |\n| dimensions | JSON String | [Optional] - JSON string representing dimension details. |\n| columns | Array of String | [Optional] - Metrics for showing serving result |\n| customerIds | Array of Integer | [Optional] - Customer IDs, report data will be fetched for these customers. |\n| requestType | Integer | [Optional] - ID to identify if report request is of Daily or Aggregate. \u003Cbr\u003Esample : [1 - Daily, 2 - Aggregated, 3 - Weekly, 4 - Monthly] |\n| reportAggregated | String | [Optional] - Field to identify if report dimension is Aggregated or not. \u003Cbr\u003Esample : [0- Not aggregated, 1- Aggregated] |\n| startDate | Long | [Optional] - This should be a long, TIME EPOCH in UNIX format, in milliseconds. \u003Cbr\u003EThis is report start time.|\n| endDate | Long | [Optional] - This should be a long, TIME EPOCH in UNIX format, in milliseconds. \u003Cbr\u003EThis is report end time.|\n| timezoneId | Integer | [Optional] - Timezone ID|\n| timezoneName | String | [Optional] - Timezone Name|\n| sortBy | String | [Optional] - Sort the result set by specific field. For ascending use plus(asc) and for descending use minus(desc) string. \u003Cbr\u003EDefault value is '+impressions'|\n| pageNo | Integer | [Optional] - Page number for the required data. \u003Cbr\u003EDefault value is 1|\n| noOfEntries | Integer | [Optional] - The maximum number of returned results per page. \u003Cbr\u003EDefault value is 50|\n", "operationId": "downloadReport", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "reportName": { "type": "string" }, "startDate": { "type": "integer", "format": "int64" }, "endDate": { "type": "integer", "format": "int64" }, "dimensions": { "type": "string" }, "customerIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "columns": { "type": "array", "items": { "type": "string" } }, "timezoneId": { "type": "integer", "format": "int32" }, "requestType": { "type": "integer", "format": "int32" }, "reportAggregated": { "type": "string" }, "owId": { "type": "integer", "format": "int32" }, "createdByUOWId": { "type": "integer", "format": "int32" }, "modifiedByUOWId": { "type": "integer", "format": "int32" }, "timezoneName": { "type": "string" }, "organizationName": { "type": "string" }, "resultType": { "type": "string" }, "fileType": { "type": "integer", "format": "int32" }, "filters": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "object" } } }, "internalRequest": { "type": "boolean" }, "pageNo": { "type": "integer", "format": "int32" }, "noOfEntries": { "type": "integer", "format": "int32" }, "sortBy": { "type": "string" }, "searchField": { "type": "string" } } }, "examples": { "Download Report (By Report ID)": { "description": "Download Report (By Report ID)", "value": { "id": 123 } }, "Download Report (By Report Data)": { "description": "Download Report (By Report Data)", "value": { "startDate": 1670410001000, "endDate": 1675766802000, "dimensions": "[{\"filter\":\"campaign\"},{\"filter\":\"gender\",\"value\":[10200002]},{\"filter\":\"deviceType\",\"value\":[20300001,20300003]}]", "columns": [ "campaignId", "campaignName", "deviceType", "completeCount", "gender", "startTime", "endTime", "maxBid", "budgetDay", "VCR", "eCPC", "totalECPC", "budgetTotal", "impressions", "clicks", "winRate" ], "customerIds": [201353, 201352], "requestType": 1, "reportAggregated": "0", "timezoneId": 11, "timezoneName": "UTC", "order": "desc", "sortBy": "impressions", "noOfEntries": 50, "pageNo": 1 } }, "Download Report (Weekly)": { "description": "Download Report (Weekly)", "value": { "fileType": 1, "dimensions": "[{\"filter\":\"campaignId\"},{\"filter\":\"campaign\"}]", "columns": [ "impressions", "clicks", "CTR", "VCR", "spent", "dataCost", "mediaSpent", "eCPM" ], "customerIds": [], "requestType": 3, "reportAggregated": "0", "startDate": 1749960000000, "endDate": 1757995199000, "timezoneId": 29, "timezoneName": "US/Eastern", "sortBy": "-impressions" } }, "Invalid input sample": { "description": "Invalid input sample", "value": { "startDate": 1670410001000, "endDate": 1675766802000, "dimensions": "[{\"filter\":\"campaign\"}]", "requestType": 1 } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Download Report": { "description": "Download Report", "value": { "success": true, "data": { "url": "https://www.sample.com/123.csv" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden !" } ] } } } }, "422": { "description": "Un-Processable Entity", "content": { "application/json": { "examples": { "Invalid input": { "description": "Invalid input", "value": { "success": false, "errorObjects": [ { "error": "Please select columns for report download", "field": "columns" } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/ra/report/add": { "post": { "tags": [ "Report API" ], "summary": "Create Report", "description": "This API will create new Report based on given fields", "operationId": "saveReport", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "reportName": { "type": "string" }, "startDate": { "type": "integer", "format": "int64" }, "endDate": { "type": "integer", "format": "int64" }, "dimensions": { "type": "string" }, "customerIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "columns": { "type": "array", "items": { "type": "string" } }, "timezoneId": { "type": "integer", "format": "int32" }, "requestType": { "type": "integer", "format": "int32" }, "reportAggregated": { "type": "string" }, "owId": { "type": "integer", "format": "int32" }, "createdByUOWId": { "type": "integer", "format": "int32" }, "modifiedByUOWId": { "type": "integer", "format": "int32" }, "timezoneName": { "type": "string" }, "organizationName": { "type": "string" }, "customerDetails": { "type": "array", "items": { "type": "object", "properties": { "owId": { "type": "integer", "format": "int32" }, "organizationName": { "type": "string" }, "organizationLogo": { "type": "string" }, "statusId": { "type": "integer", "format": "int32" }, "status": { "type": "string" }, "supportEmail": { "type": "string" }, "timezone": { "type": "integer", "format": "int32" }, "organizationType": { "type": "string" } } } }, "reportSchedulingEventDetails": { "type": "object", "properties": { "earliestCampaignStartDate": { "type": "integer", "format": "int64" }, "reportId": { "type": "integer", "format": "int32" }, "deliveryFrequency": { "type": "integer", "format": "int32" }, "fileType": { "type": "integer", "format": "int32" }, "subscriberEmails": { "type": "array", "items": { "type": "string" } }, "eventEndDate": { "type": "integer", "format": "int64" }, "deliveryDay": { "type": "string" }, "runningTotalEnabled": { "type": "boolean" } } } } }, "examples": { "Report with Scheduling": { "description": "Report with Scheduling", "value": { "reportName": "Campaign by Gender by Device type with customer and filtering", "customerIds": [200, 201], "startDate": 1650177200000, "endDate": 1666938296000, "dimensions": "[{\"filter\":\"campaign\",\"value\":[123,234,345,456]},{\"filter\":\"gender\",\"value\":[10200002]},{\"filter\":\"device_type\",\"value\":[20300001,20300003]}]", "columns": [ "gender", "deviceType", "campaignId", "campaignName", "startTime", "endTime", "maxBid", "minBid", "budgetDay", "budgetTotal", "impressions", "clicks" ], "requestType": 1, "reportAggregated": "0", "timezoneId": 29, "timezoneName": "US/Eastern", "reportSchedulingEventDetails": { "runningTotalEnabled": 0, "deliveryFrequency": 3, "deliveryDay": "Friday", "fileType": 2, "subscriberEmails": [ "demoUser1@gmail.com", "demoUser1@gmail.com" ], "eventEndDate": 1671148799999 } } }, "Create Report": { "description": "Create Report", "value": { "reportName": "Campaign by Gender by Device type ", "startDate": 1650177200000, "endDate": 1666938296000, "dimensions": "[{\"filter\":\"campaign\",\"value\":[287846,287610,278417,270798]},{\"filter\":\"gender\",\"value\":[10200002]},{\"filter\":\"device_type\",\"value\":[20300001,20300003]}]", "columns": [ "gender", "deviceType", "campaignId", "campaignName", "startTime", "endTime", "maxBid", "minBid", "budgetDay", "budgetTotal", "impressions", "clicks" ], "requestType": 1, "reportAggregated": "0", "timezoneId": 29, "timezoneName": "US/Eastern" } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Report with Scheduling": { "description": "Report with Scheduling", "value": { "success": true, "data": 1001 } }, "Create Report": { "description": "Create Report", "value": { "success": true, "data": 1002 } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden !" } ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/ra/conversion/custom-field/list": { "post": { "tags": [ "Report API" ], "summary": "Get the list of conversion custom fields.", "description": "This API fetches the list of conversion's custom fields based on the given filter parameters.\n\n**Request Body Description:**\n\n| **Filed** | **Type** | **Description** |\n| --- | --- | --- |\n| owIds | Array of integer | [Optional] - List of Customer IDs for which custom fields list to be fetched.. Default is all assigned customer list. |\n| searchField | String | [Optional] - Search field for custom fields listing data. Search is supported for ID and name of the pixel. |\n| sortBy | String | [Optional] - Sort the result set by specific field. For ascending use plus(asc) and for descending use minus(desc) string. \u003Cbr\u003EDefault value is `-id`|\n| pageNo | Integer | [Optional] - Page number for the required data. \u003Cbr\u003EDefault value is `1`|\n| noOfEntries | Integer | [Optional] - The maximum number of returned results per page. \u003Cbr\u003EDefault value is `20`|\n", "operationId": "getConversionCustomFieldsDetailsList", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "sortCriteriaMap": { "type": "object", "additionalProperties": { "type": "string" } }, "owIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "pageNo": { "type": "integer", "format": "int32" }, "noOfEntries": { "type": "integer", "format": "int32" }, "sortBy": { "type": "string" }, "searchField": { "type": "string" }, "order": { "type": "string", "enum": [ "SortOrderEnum[id=1, name='asc', symbol='+']", "SortOrderEnum[id=2, name='desc', symbol='-']" ] } } }, "examples": { "Custom Field list": { "description": "Custom Field list", "value": { "customerIds": [123, 234, 345], "pageNo": 1, "noOfEntries": 30, "sortBy": "+id", "searchField": "Pixel" } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "success": true, "data": { "totalRecords": 10, "filterRecords": 3, "customFieldData": [ { "id": 3114, "pixelName": "Pixel Conversion 1", "customFieldName": "sample_one" }, { "id": 3114, "pixelName": "Pixel Conversion 1", "customFieldName": "sample_two" }, { "id": 3221, "pixelName": "Pixel Conversion 2", "customFieldName": "product_sales" } ] } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden !" } ] } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Invalid sortBy value." } ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/internal/ra/report/execute": { "post": { "tags": [ "Report API" ], "summary": "Execute report and fetch serving data", "description": "This internal API runs a report and retrieves the corresponding served data.\n\n**Request Body Description:**\n\n| **Filed** | **Type** | **Description** |\n| --- | --- | --- |\n| id | Integer | [Optional] - This is report Id, report data will be fetched for this report id. |\n| dimensions | JSON String | [Optional] - JSON string representing dimension details. |\n| columns | Array of String | [Optional] - Metrics for showing serving result |\n| customerIds | Array of Integer | [Required] - Customer IDs, report data will be fetched for these customers. |\n| filters | JSON String | [Optional] - JSON string supporting campaignId, creativeTypeId and campaignStatus filtering. |\n| searchField | String | [Optional] - Search field for report serving data. |\n| requestType | Integer | [Optional] - ID to identify if report request is of Daily or Aggregate. \u003Cbr\u003Esample : [1- Daily, 2- Aggregated] |\n| reportAggregated | String | [Optional] - Field to identify if report dimension is Aggregated or not. \u003Cbr\u003Esample : [0- Not aggregated, 1- Aggregated] |\n| startDate | Long | [Optional] - This should be a long, TIME EPOCH in UNIX format, in milliseconds. \u003Cbr\u003EThis is report start time.|\n| endDate | Long | [Optional] - This should be a long, TIME EPOCH in UNIX format, in milliseconds. \u003Cbr\u003EThis is report end time.|\n| timezoneId | Integer | [Optional] - Timezone ID|\n| timezoneName | String | [Optional] - Timezone Name|\n| sortBy | String | [Optional] - Sort the result set by specific field. For ascending use plus(asc) and for descending use minus(desc) string. \u003Cbr\u003EDefault value is '+impressions'|\n| pageNo | Integer | [Optional] - Page number for the required data. \u003Cbr\u003EDefault value is 1|\n| noOfEntries | Integer | [Optional] - The maximum number of returned results per page. \u003Cbr\u003EDefault value is 50|\n| owId | Integer | [Required] - The Organization-Workspace ID for which the report is needed|\n", "operationId": "executeReportData_1", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "reportName": { "type": "string" }, "startDate": { "type": "integer", "format": "int64" }, "endDate": { "type": "integer", "format": "int64" }, "dimensions": { "type": "string" }, "customerIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "columns": { "type": "array", "items": { "type": "string" } }, "timezoneId": { "type": "integer", "format": "int32" }, "requestType": { "type": "integer", "format": "int32" }, "reportAggregated": { "type": "string" }, "owId": { "type": "integer", "format": "int32" }, "createdByUOWId": { "type": "integer", "format": "int32" }, "modifiedByUOWId": { "type": "integer", "format": "int32" }, "timezoneName": { "type": "string" }, "organizationName": { "type": "string" }, "resultType": { "type": "string" }, "fileType": { "type": "integer", "format": "int32" }, "filters": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "object" } } }, "internalRequest": { "type": "boolean" }, "pageNo": { "type": "integer", "format": "int32" }, "noOfEntries": { "type": "integer", "format": "int32" }, "sortBy": { "type": "string" }, "searchField": { "type": "string" } } }, "examples": { "Execute Report (By Report ID)": { "description": "Execute Report (By Report ID)", "value": { "id": 3219 } }, "Execute Report (By Report Data)": { "description": "Execute Report (By Report Data)", "value": { "startDate": 1670410001000, "endDate": 1675766802000, "dimensions": "[{\"filter\":\"campaign\"},{\"filter\":\"gender\",\"value\":[10200002]},{\"filter\":\"deviceType\",\"value\":[20300001,20300003]}]", "columns": [ "campaignId", "campaignName", "deviceType", "completeCount", "gender", "startTime", "endTime", "maxBid", "minBid", "budgetDay", "VCR", "eCPC", "totalECPC", "budgetTotal", "impressions", "clicks", "winRate", "reach" ], "customerIds": [201353, 201352], "filters": { "campaignIds": [123, 234, 345], "creativeTypeIds": [11], "campaignStatuses": [ "expired", "running" ] }, "searchField": "123", "requestType": 1, "reportAggregated": "0", "timezoneId": 11, "timezoneName": "UTC", "order": "desc", "sortBy": "impressions", "noOfEntries": 50, "pageNo": 1 } }, "Invalid input sample": { "description": "Invalid input sample", "value": { "startDate": 1670410001000, "endDate": 1675766802000, "dimensions": "[{\"filter\":\"campaign\"}]", "requestType": 1 } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Execute Report": { "description": "Execute Report", "value": { "success": true, "data": { "total": { "CTR": 0.26809, "date": null, "deviceTypeId": null, "VCR": 51.452171, "budgetDay": null, "gender": null, "budgetPacing": null, "dataCost": 0, "totalRecords": 135, "campaignTimezone": null, "eCPM": 4.50311429853875, "bidImpressions": 4678583, "startTime": null, "mediaSpent": 8485.86672119556, "eCPC": 1.67970441828891, "totalECPC": 1.67970441828891, "deviceType": null, "startCount": 351095, "campaignType": null, "campaignId": null, "spent": 8485.86672119556, "impressions": 1884444, "eCPCV": 0.0215601437130939, "completeCount": 180646, "budgetTotal": null, "maxBid": null, "minBid": null, "clicks": 5052, "endTime": null, "campaignName": null, "status": null }, "data": [ { "CTR": 0.2796, "date": "2022-01-30", "deviceTypeId": 20300001, "VCR": 0, "budgetDay": 0.07, "gender": "Unknown", "budgetPacing": true, "dataCost": 0, "totalRecords": null, "campaignTimezone": "America/Costa_Rica", "eCPM": 3, "bidImpressions": 628344, "startTime": 1643428296, "mediaSpent": 457.098, "eCPC": 1.073, "totalECPC": 1.073, "deviceType": "Mobile", "startCount": 0, "campaignType": "cpm", "campaignId": 15474, "spent": 457.098, "impressions": 152366, "eCPCV": 0, "completeCount": 0, "budgetTotal": 1549, "maxBid": 3, "minBid": 1, "clicks": 426, "endTime": 1644192000, "campaignName": "Costa Rica MEMES COMPILADOS Profile: All Gender: All Ages: 18 to 45 Geo: Heredia, Alajuela, Cartago and San Jose", "status": "expired" }, { "CTR": 0.2122, "date": "2022-01-30", "deviceTypeId": 20300001, "VCR": 0, "budgetDay": 0.21, "gender": "Unknown", "budgetPacing": true, "dataCost": 0, "totalRecords": null, "campaignTimezone": "America/Costa_Rica", "eCPM": 3, "bidImpressions": 271620, "startTime": 1643423160, "mediaSpent": 418.488, "eCPC": 1.41381081081081, "totalECPC": 1.41381081081081, "deviceType": "Mobile", "startCount": 0, "campaignType": "cpm", "campaignId": 15472, "spent": 418.488, "impressions": 139496, "eCPCV": 0, "completeCount": 0, "budgetTotal": 1548, "maxBid": 3, "minBid": 1, "clicks": 296, "endTime": 1644192000, "campaignName": "Costa Rica Universidad Latina Profile: All Gender: All Ages: 18 to 75 Geo: All Costa Rica", "status": "expired" }, { "CTR": 0.1065, "date": "2022-01-30", "deviceTypeId": 20300001, "VCR": 0, "budgetDay": 0.43, "gender": "Unknown", "budgetPacing": true, "dataCost": 0, "totalRecords": null, "campaignTimezone": "America/Costa_Rica", "eCPM": 3.00002495259008, "bidImpressions": 239865, "startTime": 1643431623, "mediaSpent": 360.687, "eCPC": 2.8178671875, "totalECPC": 2.8178671875, "deviceType": "Mobile", "startCount": 0, "campaignType": "cpm", "campaignId": 15477, "spent": 360.687, "impressions": 120228, "eCPCV": 0, "completeCount": 0, "budgetTotal": 1551, "maxBid": 3, "minBid": 1, "clicks": 128, "endTime": 1644192000, "campaignName": "Costa Rica TICOS AL DIA 24-25 ENE Profile: All Gender: All Ages: 18 to 25 and 60+ and over Geo: Heredia, Alajuela, Cartago and San Jose", "status": "expired" }, { "CTR": 0.3118, "date": "2022-01-31", "deviceTypeId": 20300001, "VCR": 0, "budgetDay": 0.07, "gender": "Unknown", "budgetPacing": true, "dataCost": 0, "totalRecords": null, "campaignTimezone": "America/Costa_Rica", "eCPM": 3, "bidImpressions": 280562, "startTime": 1643428296, "mediaSpent": 219.363, "eCPC": 0.962118421052632, "totalECPC": 0.962118421052632, "deviceType": "Mobile", "startCount": 0, "campaignType": "cpm", "campaignId": 15474, "spent": 219.363, "impressions": 73121, "eCPCV": 0, "completeCount": 0, "budgetTotal": 1549, "maxBid": 3, "minBid": 1, "clicks": 228, "endTime": 1644192000, "campaignName": "Costa Rica MEMES COMPILADOS Profile: All Gender: All Ages: 18 to 45 Geo: Heredia, Alajuela, Cartago and San Jose", "status": "expired" }, { "CTR": 0.3154, "date": "2022-01-30", "deviceTypeId": 20300001, "VCR": 0, "budgetDay": 1, "gender": "Unknown", "budgetPacing": true, "dataCost": 0, "totalRecords": null, "campaignTimezone": "America/Costa_Rica", "eCPM": 3, "bidImpressions": 233754, "startTime": 1643131598, "mediaSpent": 211.161, "eCPC": 0.951175675675676, "totalECPC": 0.951175675675676, "deviceType": "Mobile", "startCount": 0, "campaignType": "cpm", "campaignId": 15455, "spent": 211.161, "impressions": 70387, "eCPCV": 0, "completeCount": 0, "budgetTotal": 1749, "maxBid": 3, "minBid": 1, "clicks": 222, "endTime": 1644192000, "campaignName": "Costa Rica MEMES COMPILADOS Profile: Undecided Gender: All Ages: 18 to 35 Geo: Heredia, Alajuela, Cartago, San Jose", "status": "expired" } ], "totalRecords": 135 } } } } } } }, "422": { "description": "Un-Processable Entity", "content": { "application/json": { "examples": { "Invalid input": { "description": "Invalid input", "value": { "success": false, "errorObjects": [ { "error": "Please select columns for report creation", "field": "columns" } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/internal/ra/aggregated/campaign/report": { "post": { "tags": [ "Report API" ], "summary": "Execute report and fetch aggregated serving data for provided campaign ids", "description": "This API execute a report and retrieves the corresponding served data.\n\n---\n\n\n**Request Body Details:**\n\n| **Field** | **Type** | **Description** |\n| --- | --- | --- |\n| pageNo `[optional]` | Number | Page number for the required data. The default value is 1. |\n| noOfEntries `[optional]` | Number | The maximum number of returned results per page. The default value is 20 and the maximum value is 500. |\n| sortBy `[optional]` | String | Sort the result set by specific field. |\n| order `[optional]` | String | Sorting order Supported values: `asc` or `desc`. The default value is `asc`. |\n| campaignIds | Array of Integer | Campaign IDs, report data will be fetched for these campaigns. |\n| customerIds | Array of Integer | Customer IDs, report data will be fetched for these customers. |\n| startDate `[Optional]` | Long | This should be a long, TIME EPOCH in UNIX format, in milliseconds. \u003Cbr\u003EThis is report start time.|\n| endDate `[Optional]` | Long | This should be a long, TIME EPOCH in UNIX format, in milliseconds. \u003Cbr\u003EThis is report end time.|\n| timezoneId `[Optional]`| Integer | Timezone ID|\n| timezoneName `[Optional]` | String | Timezone Name|\n", "operationId": "executeCampaignReportData", "requestBody": { "content": { "application/json": { "schema": { "required": [ "campaignIds" ], "type": "object", "properties": { "campaignIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "customerIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "owId": { "minimum": 1, "type": "integer", "format": "int32" }, "uowId": { "type": "integer", "format": "int32" }, "ioIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "pageSize": { "minimum": 1, "type": "integer", "format": "int32" }, "startDate": { "type": "integer", "format": "int64" }, "endDate": { "type": "integer", "format": "int64" }, "timezoneId": { "type": "integer", "format": "int32" }, "timezoneName": { "type": "string" } } }, "examples": { "Execute Report for campaign ids": { "description": "Execute Report for campaign ids", "value": { "campaignIds": [333178], "customerIds": [1], "startDate": 1688270400000, "endDate": 1690948799999, "pageSize": 1 } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Execute Report for campaign ids": { "description": "Execute Report for campaign ids", "value": { "CTR": 0, "totalRecords": null, "VCR": 0, "totalBudget": 100, "dataCost": 0, "budgetMappingDataCost": 0, "campaignTimezone": "US/Eastern", "eCPM": 5, "totalECPM": 5, "bidImpressions": 21, "mediaSpent": 0.085, "startCount": 0, "campaignEndDate": "08/20/2023", "campaignType": "cpm", "campaignId": 333178, "spent": 0.085, "impressions": 17, "completeCount": 0, "budgetMappingSpent": 0.085, "dailyBudget": 5, "maxBid": 5, "clicks": 0, "campaign": "4500 - Test campaign with conversion attached", "budgetCompletion": 0.085, "status": "running", "campaignStartDate": "07/31/2023" } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/ra/report/{reportId}": { "get": { "tags": [ "Report API" ], "summary": "Get Report By ID", "description": "This API fetches report data by report ID", "operationId": "getReport", "parameters": [ { "name": "reportId", "in": "path", "description": "ID of report", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Report data": { "description": "Report data", "value": { "success": true, "data": { "id": 123, "reportName": "Campaign by Gender by Device type", "startDate": 1650177000, "endDate": 1666938000, "dimensions": "[{\"filter\":\"campaign\"},{\"filter\":\"gender\",\"value\":[10200002]},{\"filter\":\"device_type\",\"value\":[20300001,20300003]}]", "columns": [ "gender", "deviceType", "campaignId", "campaignName", "startTime", "endTime", "maxBid", "budgetDay", "budgetTotal", "impressions", "clicks" ], "timezoneId": 29, "requestType": 1, "reportSchedulingEventDetails": { "eventId": 18, "deliveryFrequency": 3, "fileType": 2, "subscriberEmails": [ "demoUser1@gmail.com", "demoUser2@iqm.com" ], "eventEndDate": 1671148799, "deliveryDay": "Friday", "runningTotalEnabled": 0, "earliestCampaignStartDate": 0 } } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden !" } ] } } } }, "422": { "description": "Un-Processable Entity", "content": { "application/json": { "examples": { "Invalid input": { "description": "Invalid input", "value": { "success": false, "errorObjects": [ { "error": "Report does not exists for the given id" } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } }, "delete": { "tags": [ "Report API" ], "summary": "Delete Report and Scheduling Data By ID", "description": "This API deletes report and it's scheduling data", "operationId": "deleteReport", "parameters": [ { "name": "reportId", "in": "path", "description": "ID of report", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Delete success": { "description": "Delete success", "value": { "success": true, "data": "Report with id 123 deleted successfully" } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden !" } ] } } } }, "422": { "description": "Un-Processable Entity", "content": { "application/json": { "examples": { "Invalid input": { "description": "Invalid input", "value": { "success": false, "errorObjects": [ { "error": "Report does not exists for the given id" } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } }, "patch": { "tags": [ "Report API" ], "summary": "Edit Report", "description": "This API will edit Report data based on given fields", "operationId": "updateReport", "parameters": [ { "name": "reportId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "reportName": { "type": "string" }, "startDate": { "type": "integer", "format": "int64" }, "endDate": { "type": "integer", "format": "int64" }, "dimensions": { "type": "string" }, "customerIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "columns": { "type": "array", "items": { "type": "string" } }, "timezoneId": { "type": "integer", "format": "int32" }, "requestType": { "type": "integer", "format": "int32" }, "reportAggregated": { "type": "string" }, "owId": { "type": "integer", "format": "int32" }, "createdByUOWId": { "type": "integer", "format": "int32" }, "modifiedByUOWId": { "type": "integer", "format": "int32" }, "timezoneName": { "type": "string" }, "organizationName": { "type": "string" }, "customerDetails": { "type": "array", "items": { "type": "object", "properties": { "owId": { "type": "integer", "format": "int32" }, "organizationName": { "type": "string" }, "organizationLogo": { "type": "string" }, "statusId": { "type": "integer", "format": "int32" }, "status": { "type": "string" }, "supportEmail": { "type": "string" }, "timezone": { "type": "integer", "format": "int32" }, "organizationType": { "type": "string" } } } }, "reportSchedulingEventDetails": { "type": "object", "properties": { "earliestCampaignStartDate": { "type": "integer", "format": "int64" }, "reportId": { "type": "integer", "format": "int32" }, "deliveryFrequency": { "type": "integer", "format": "int32" }, "fileType": { "type": "integer", "format": "int32" }, "subscriberEmails": { "type": "array", "items": { "type": "string" } }, "eventEndDate": { "type": "integer", "format": "int64" }, "deliveryDay": { "type": "string" }, "runningTotalEnabled": { "type": "boolean" } } } } }, "examples": { "Edit report": { "description": "Edit report", "value": { "startDate": 1642013200000, "reportName": "Updated report name 1", "timezoneId": 29, "timezoneName": "US/Eastern", "dimensions": "[{\"filter\": \"campaign\"}, {\"filter\": \"creative\"}]", "columns": [ "campaignId", "campaignName", "startTime", "endTime" ], "customerIds": [12345], "requestType": 1, "reportAggregated": "0" } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Edit Report": { "description": "Edit Report", "value": { "success": true, "data": "Report with id 123 updated successfully" } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden !" } ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/ra/report/email/schedule/{reportId}": { "delete": { "tags": [ "Report API" ], "summary": "Remove report scheduling event", "description": "This API removes the report scheduling event.", "operationId": "deleteReportScheduleEvent", "parameters": [ { "name": "reportId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "remove Report Scheduling": { "description": "remove Report Scheduling", "value": { "success": true, "data": { "message": "Report event is removed." } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden!" } ] } } } }, "422": { "description": "Un-Processable Entity", "content": { "application/json": { "examples": { "Invalid input": { "description": "Invalid input", "value": { "success": false, "errorObjects": { "error": "Report event does not exists for the given id" } } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } }, "patch": { "tags": [ "Report API" ], "summary": "Update report scheduling event", "description": "This API update the report scheduling event. Whichever field is to be updated, that can be sent in the request body.\n \n**Request Body Description:**\n| **Filed** | **Type** | **Description** |\n| --- | --- | --- |\n| subscriberEmails | Array of String | List of the emails on which the report will be sent. |\n| fileType | Integer | Report file type id. The report will be sent in the selected file format. \u003Cbr\u003Esample : [1 - CSV, 2 - XLS]|\n| deliveryFrequency | Integer | Delivery frequency type id for the emails to be sent. \u003Cbr\u003E sample : [1 - ONCE, 2 - DAILY, 3 - WEEKLY, 4 - MONTHLY] |\n| deliveryDay | String | [Required, if deliveryFrequency is not ONCE] - Delivery day to specify the day-time when the report should be sent. \u003Cbr\u003EThis is related to Delivery frequency. \u003Cbr\u003E WEEKLY DELIVERY DAY: [\"SUNDAY\", \"MONDAY\", ...] \u003Cbr\u003EMONTHLY DELIVERY DAY: [\"FIRST\", \"LAST\", \"2\", \"3\", ..., \"29\"]|\n| eventEndDate | Long | [Required, if deliveryFrequency updated and is not ONCE] - This should be a long, TIME EPOCH in UNIX format, in milliseconds. \u003Cbr\u003EThis is events end date, Scheduled report will be stopped after the eventEndDate is exceeded |\n| runningTotalEnabled | Boolean | [Optional] - Flag to indicate if the 'Total' Running is enabled for the report. This flag is supported only with 'Campaign' dimension.\u003Cbr\u003E If this is true the start-date for the report duration should be the EARLIEST campaign start date, \u003Cbr\u003Eso the report-time-period will be from the Earliest-campaign-start-date to the report-end-date |\n| earliestCampaignStartDate | Long | [Required with runningTotalEnabled as 'true'] - This should be a long, TIME EPOCH in UNIX format, in milliseconds. \u003Cbr\u003EThis is campaign's EARLIEST start date from the selected campaigns, which will be set as the start date of the report-time-period. |", "operationId": "updateReportScheduleEvent", "parameters": [ { "name": "reportId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "earliestCampaignStartDate": { "type": "integer", "format": "int64" }, "reportId": { "type": "integer", "format": "int32" }, "deliveryFrequency": { "type": "integer", "format": "int32" }, "fileType": { "type": "integer", "format": "int32" }, "subscriberEmails": { "type": "array", "items": { "type": "string" } }, "eventEndDate": { "type": "integer", "format": "int64" }, "deliveryDay": { "type": "string" }, "runningTotalEnabled": { "type": "boolean" } } }, "examples": { "update Report Scheduling": { "description": "update Report Scheduling", "value": { "subscriberEmails": [ "sample_email1@example.com", "sample_email2@example.com", "sample_email3@example.com" ] } }, "Invalid email Example": { "description": "Invalid email Example", "value": { "subscriberEmails": [ "sample_email1@invalid", "sample_email2@invalid", "sample_email3@example.com" ] } }, "Invalid input": { "description": "Invalid input", "value": { "fileType": 0 } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "update Report Scheduling": { "description": "update Report Scheduling", "value": { "success": true, "data": { "scheduledData": { "earliestCampaignStartDate": 0, "reportId": 1234, "deliveryFrequency": 4, "fileType": 1, "subscriberEmails": [ "sample_email1@example.com", "sample_email2@example.com", "sample_email3@example.com" ], "eventEndDate": 1696270980000, "deliveryDay": "4", "runningTotalEnabled": false }, "message": "Report schedule has been successfully updated." } } }, "Invalid email Example": { "description": "Invalid email Example", "value": { "success": true, "errorObjects": [ { "error": "Invalid email provided - invalid Emails : [sample_email1@invalid, sample_email2@invalid].", "reason": "One or more subscribers emails are empty or not provided as per the email format", "field": "subscriberEmails" } ], "data": { "scheduledData": { "earliestCampaignStartDate": 0, "reportId": 1234, "deliveryFrequency": 4, "fileType": 1, "subscriberEmails": [ "sample_email3@example.com" ], "eventEndDate": 1696270980000, "deliveryDay": "4", "runningTotalEnabled": false }, "message": "Report schedule has been successfully updated." } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden!" } ] } } } }, "422": { "description": "Un-Processable Entity", "content": { "application/json": { "examples": { "Invalid input": { "description": "Invalid input", "value": { "success": false, "errorObjects": { "error": "Invalid file type." } } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/rb/static/report-file-type": { "get": { "tags": [ "Report API" ], "summary": "Get Report File Types", "description": "This API fetches report File Types", "operationId": "getFileType", "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Report File Types": { "description": "Report File Types", "value": { "success": true, "data": [ { "name": "csv", "id": 1, "label": "CSV" }, { "name": "xlsx", "id": 2, "label": "XLS" } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/rb/static/report-delivery-frequency": { "get": { "tags": [ "Report API" ], "summary": "Get Report Delivery Frequency", "description": "This API fetches report delivery frequency", "operationId": "getDeliveryFrequency", "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Report Delivery Frequency": { "description": "Report Delivery Frequency", "value": { "success": true, "data": [ { "name": "One Time Now", "id": 1, "label": "One time now" }, { "name": "DAY", "id": 2, "label": "Daily until" }, { "name": "WEEK", "id": 3, "label": "Weekly until" }, { "name": "MONTH", "id": 4, "label": "Monthly until" } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/ra/static/report-request-types": { "get": { "tags": [ "Report API" ], "summary": "Get static report request types", "description": "This API will provide a list of static report request typesIt contains details such as ID, name, order, and display name. of the static report request typesIt is used while saving, executing or updating a report to define the id of type of the report request.The list is ordered based on the 'order' field in ascending order.", "operationId": "getStaticReportRequestTypes", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Report request types": { "description": "Report request types", "value": { "success": true, "data": [ { "id": 2, "name": "total", "order": 1, "displayName": "Aggregated" }, { "id": 1, "name": "daily", "order": 2, "displayName": "Daily" }, { "id": 3, "name": "weekly", "order": 3, "displayName": "Weekly" }, { "id": 4, "name": "monthly", "order": 4, "displayName": "Monthly" } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/ra/report/email/schedule/unsubscribe": { "get": { "tags": [ "Report API" ], "summary": "Unsubscribe an email from report email schedule events", "description": "This API unsubscribes an email from report email schedule event.", "operationId": "unsubscribeReportEmailSchedule", "parameters": [ { "name": "token", "in": "query", "required": false, "schema": { "type": "string", "default": "" } } ], "responses": { "200": { "description": "OK", "content": { "text/html": { } } }, "422": { "description": "Un-Processable Entity", "content": { "application/json": { "examples": { "Invalid input": { "description": "Invalid input", "value": { "success": false, "errorObjects": { "error": "Invalid event UUID or email." } } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/ra/report/email/schedule/unsubscribe-all": { "get": { "tags": [ "Report API" ], "summary": "Unsubscribe an email from ALL report email schedule events of an organization.", "description": "This API unsubscribes an email from ALL report email schedule event or an organization.", "operationId": "unsubscribeAllReportEmailSchedule", "parameters": [ { "name": "token", "in": "query", "required": false, "schema": { "type": "string", "default": "" } } ], "responses": { "200": { "description": "OK", "content": { "text/html": { } } }, "422": { "description": "Un-Processable Entity", "content": { "application/json": { "examples": { "Invalid input": { "description": "Invalid input", "value": { "success": false, "errorObjects": { "error": "Invalid email." } } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/ra/report/dimension-metrics/detail": { "get": { "tags": [ "Report API" ], "summary": "Get Dimension & Metrics Details", "description": "This API offers Dimension and Metrics information grouped by Category in predetermined order", "operationId": "getDimensionAndMetricDetails", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Get Dimension & Metrics Details": { "description": "Get Dimension & Metrics Details", "value": { "success": true, "data": { "metrics": [ { "Budget": [ { "id": 1, "label": "Daily Budget", "order": 1, "fieldDataType": "currencyUSD", "aggregationType": "sum", "description": "Amount up to which you allow platform to spend on average each day", "tooltipDescription": "Amount up to which you allow platform to spend on average each day", "defaultEnabled": false, "key": "dailyBudget", "dependentDimensions": [1, 2, 43, 44] }, { "id": 2, "label": "Total Budget", "order": 2, "fieldDataType": "currencyUSD", "aggregationType": "sum", "description": "Amount up to which you allow platform to spend", "tooltipDescription": null, "defaultEnabled": false, "key": "totalBudget", "dependentDimensions": [1, 2, 43, 44] } ] }, { "Counts": [ { "id": 5, "label": "Impressions", "order": 1, "fieldDataType": "number", "aggregationType": "sum", "description": "Number of times ad displayed on someone's screen", "tooltipDescription": null, "defaultEnabled": true, "key": "impressions", "dependentDimensions": null } ] } ], "dimensions": [ { "Campaign Specifics": [ { "id": 1, "label": "Campaign", "order": 1, "fieldDataType": "text", "description": "Campaign Name", "tooltipDescription": null, "groupId": 1, "key": "campaign", "isFilterSupported": true, "isCustomerDependent": true, "isRowToColumn": false }, { "id": 2, "label": "Campaign ID", "order": 4, "fieldDataType": "text", "description": "Unique system-generated number assigned to each Campaign", "tooltipDescription": null, "groupId": 1, "key": "campaignId", "isFilterSupported": true, "isCustomerDependent": true, "isRowToColumn": false } ] }, { "Locations": [ { "id": 34, "label": "Country", "order": 1, "fieldDataType": "country", "description": "Country the ad ran in", "tooltipDescription": null, "groupId": 29, "key": "country", "isFilterSupported": true, "isCustomerDependent": false, "isRowToColumn": false }, { "id": 35, "label": "State", "order": 2, "fieldDataType": "regionCode", "description": "State the ad ran in", "tooltipDescription": null, "groupId": 30, "key": "state", "isFilterSupported": true, "isCustomerDependent": false, "isRowToColumn": false } ] } ] } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden !" } ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/internal/ra/report/email/schedule/handle": { "get": { "tags": [ "Report API" ], "summary": "Handle the report scheduling event.", "description": "This handles report scheduling event.\nThis API works asynchronously, this execute the report and sends the email to the event subscribers.\n", "operationId": "eventHandlerReportSchedule", "parameters": [ { "name": "reportId", "in": "query", "description": "Id of the report to be executed. It is required.", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "owId", "in": "query", "description": "Ow id of the report to be executed. It is required.", "required": false, "schema": { "type": "string", "default": "" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "success": true, "data": { "message": "Request received." } } } } } } } }, "/api/v3/ua/user/invite": { "post": { "tags": [ "User Management API" ], "summary": "Send User Invitations", "description": "This API can be used by any customer (organization) to send invitations to one or more users by providing user names and emails detail.", "operationId": "SendUserInvitations", "parameters": [ { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32", "example": 2 } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "required": true, "style": "simple", "schema": { "type": "string", "example": "{{bearer_token}}" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "title": "SendUserInvitationsRequest", "required": [ "email", "name" ], "type": "object", "properties": { "email": { "type": "string" }, "name": { "type": "string" } }, "example": { "email": "shraddha.p@iqm.com", "name": "Shraddha Patel" } }, "description": "", "example": [ { "email": "shraddha.p@iqm.com", "name": "Shraddha Patel" } ] }, "example": [ { "email": "shraddha.p@iqm.com", "name": "Shraddha Patel" } ] } }, "required": true }, "responses": { "200": { "description": "", "headers": { }, "content": { "application/json": { "schema": { "title": "SuccessReponse200OK1", "required": [ "success", "data" ], "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "string" } }, "example": { "success": true, "data": "1 invitations sent successfully." } }, "example": { "success": true, "data": "1 invitations sent successfully." } } } } }, "deprecated": false, "security": [], "servers": [ { "url": "http://example.com", "variables": { } } ] } }, "/api/v3/ua/invite/validate": { "post": { "tags": [ "User Management API" ], "summary": "Validate Invite", "description": "When any customer or user is invited then an invitation link with a hash will be sent to provided emails. This hash can be validated by this API.\n\n| **Key** | **Description** |\n| --- | --- |\n| invitedToWorkspace | Workspace domain to which customer or user is invited. |\n| organizationName | New organization name in case of customer invitation hash & if it is user invitation hash then organization name where the user is invited. |\n| workspaceDomain | Workspace domain where user or customer is invited. If the customer is invited by a superuser then the workspace domain will be null as the customer will be creating a new workspace. |\n| isExpired | Flag to inform if the invitation is expired. |\n| isInviteProcessed | Flag to inform if the invitation is processed. |\n| isNewUser | Flag to inform is it is a new user. |\n| isIHPCustomer | Flag to inform if it is an IHP customer. |\n| isInviteCancelled | Flag to inform if the invite is cancelled. |\n| isInviteProcessing | Flag to inform if the invite is in processing status. |", "operationId": "ValidateInvite", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "title": "ValidateInviteRequest", "required": [ "inviteHash" ], "type": "object", "properties": { "inviteHash": { "type": "string" } }, "example": { "inviteHash": "8HQfsQcychjhvCmuuiFvVCIgqq9cJG/gh6HgmPZXxGE4od7a7tsMmh/O9+ia2Lw0FOelX3h8jTKJXR+0hUAkGXYA0cIITS13BxyrWoeBmRTnWTKxHtS+Ff41POwt/yDMY2iHXUsG86ehmWeeIi3HNMikhH5yY6BvNFnEfxq3zIdiouD3Fp/loPO9qazxU1qxZvNOOv8FZEZTzORVnJ8+ADjyZ/Zjs1dNhSFE" } }, "example": { "inviteHash": "8HQfsQcychjhvCmuuiFvVCIgqq9cJG/gh6HgmPZXxGE4od7a7tsMmh/O9+ia2Lw0FOelX3h8jTKJXR+0hUAkGXYA0cIITS13BxyrWoeBmRTnWTKxHtS+Ff41POwt/yDMY2iHXUsG86ehmWeeIi3HNMikhH5yY6BvNFnEfxq3zIdiouD3Fp/loPO9qazxU1qxZvNOOv8FZEZTzORVnJ8+ADjyZ/Zjs1dNhSFE" } } }, "required": true }, "responses": { "200": { "description": "OK", "headers": { }, "content": { "application/json": { "schema": { "title": "InviteExpired", "required": [ "success", "data" ], "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "title": "Data1", "required": [ "isExpired" ], "type": "object", "properties": { "isExpired": { "type": "boolean" } }, "example": { "isExpired": true } } }, "example": { "success": true, "data": { "isExpired": true } } }, "example": { "success": true, "data": { "isExpired": true } } } } }, "422": { "description": "Unprocessable Entity (WebDAV) (RFC 4918)", "headers": { }, "content": { "application/json": { "schema": { "title": "InvalidInviteHash4221", "required": [ "success", "errorObjects" ], "type": "object", "properties": { "success": { "type": "boolean" }, "errorObjects": { "type": "array", "items": { "title": "ErrorObject", "required": [ "error", "field" ], "type": "object", "properties": { "error": { "type": "string" }, "field": { "type": "string" } }, "example": { "error": "Provided invitation hash is incorrect.", "field": "inviteHash" } }, "description": "" } }, "example": { "success": false, "errorObjects": [ { "error": "Provided invitation hash is incorrect.", "field": "inviteHash" } ] } }, "example": { "success": false, "errorObjects": [ { "error": "Provided invitation hash is incorrect.", "field": "inviteHash" } ] } } } } }, "deprecated": false, "servers": [ { "url": "https://app.stage.inhousebuying.com/api/v3/ua/invite", "variables": { } } ], "security": [] } }, "/api/v3/ua/customer/invite/cancel": { "delete": { "tags": [ "User Management API" ], "summary": "Cancel Invite", "description": "This API can be used to cancel user invitation.", "operationId": "CancelInvite", "parameters": [ { "name": "owId", "in": "query", "description": "", "required": true, "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32", "example": 361 } }, { "name": "Authorization", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "{{bearer_token}}" } }, { "name": "X-IAA-OW-ID", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32", "example": 2 } } ], "responses": { "200": { "description": "OK", "headers": { }, "content": { "application/json": { "schema": { "title": "SuccessResponse200OK", "required": [ "success", "data" ], "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "string" } }, "example": { "success": true, "data": "Invitation cancelled successfully." } }, "example": { "success": true, "data": "Invitation cancelled successfully." } } } }, "422": { "description": "Unprocessable Entity (WebDAV) (RFC 4918)", "headers": { }, "content": { "application/json": { "schema": { "title": "CancelProcessedInvitationError1", "required": [ "success", "errorObjects" ], "type": "object", "properties": { "success": { "type": "boolean" }, "errorObjects": { "type": "array", "items": { "title": "ErrorObject2", "required": [ "error" ], "type": "object", "properties": { "error": { "type": "string" } }, "example": { "error": "Only active invitations can be cancelled." } }, "description": "" } }, "example": { "success": false, "errorObjects": [ { "error": "Only active invitations can be cancelled." } ] } }, "example": { "success": false, "errorObjects": [ { "error": "Only active invitations can be cancelled." } ] } } } } }, "deprecated": false, "security": [], "servers": [ { "url": "http://example.com", "variables": { } } ] } }, "/api/v3/ua/customer/invite/re-send": { "post": { "tags": [ "User Management API" ], "summary": "Customer Re-Invite", "description": "This API can be used to re-invite the customer.", "operationId": "CustomerRe-Invite", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "title": "CustomerRe-InviteRequest", "required": [ "inviteHash" ], "type": "object", "properties": { "inviteHash": { "type": "string" } }, "example": { "inviteHash": "M7JoA2hYIUcKdVDM3g2KD/7+4FcOi9+slNVCW4NhEJgPMIxdvrj6ObD+gmCo6uikWqH6+LnHXnqXa7z2WVfw2FUI8ppsFOd8Ai1rnC0+gQiZWcgffqv2lggi0FZ3KiVERgAIFyJPIuV7fhi7AZksDka0VWHhNqHhX4R108psN73muXEaOrsf5uXlyQwzyYPpIeBq9eixIK+ytPQWBNMVKQBCczILN9l3MDheiiV94Jud1Tg/jrALspnF7KytcsfkgA5sQqWvK0K/LEl2TwAjMFl8fftW6d4xnwDb5Z0H" } }, "example": { "inviteHash": "M7JoA2hYIUcKdVDM3g2KD/7+4FcOi9+slNVCW4NhEJgPMIxdvrj6ObD+gmCo6uikWqH6+LnHXnqXa7z2WVfw2FUI8ppsFOd8Ai1rnC0+gQiZWcgffqv2lggi0FZ3KiVERgAIFyJPIuV7fhi7AZksDka0VWHhNqHhX4R108psN73muXEaOrsf5uXlyQwzyYPpIeBq9eixIK+ytPQWBNMVKQBCczILN9l3MDheiiV94Jud1Tg/jrALspnF7KytcsfkgA5sQqWvK0K/LEl2TwAjMFl8fftW6d4xnwDb5Z0H" } } }, "required": true }, "responses": { "200": { "description": "OK", "headers": { }, "content": { "application/json": { "schema": { "title": "SuccessResponse200OK", "required": [ "success", "data" ], "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "string" } }, "example": { "success": true, "data": "Invitation cancelled successfully." } }, "example": { "success": true, "data": "Invitation resent successfully." } } } } }, "deprecated": false, "servers": [ { "url": "http://example.com", "variables": { } } ], "security": [] } }, "/validate-user": { "get": { "tags": [ "User Management API" ], "summary": "Validate User", "description": "This API can be used to check if the user is valid and authenticated.", "operationId": "ValidateUser", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "required": true, "style": "simple", "schema": { "type": "string", "example": "{{bearer_token}}" } } ], "responses": { "200": { "description": "OK", "headers": { }, "content": { "application/json": { "schema": { "title": "200OK1", "required": [ "success", "data" ], "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "title": "Data4", "required": [ "isValid" ], "type": "object", "properties": { "isValid": { "type": "boolean" } }, "example": { "isValid": true } } }, "example": { "success": true, "data": { "isValid": true } } }, "example": { "success": true, "data": { "isValid": true } } } } }, "401": { "description": "Unauthorized", "headers": { }, "content": { "application/json": { "schema": { "title": "m4011", "required": [ "error", "error_description" ], "type": "object", "properties": { "error": { "type": "string" }, "error_description": { "type": "string" } }, "example": { "error": "invalid_token", "error_description": "{token}" } }, "example": { "error": "invalid_token", "error_description": "{token}" } } } } }, "deprecated": false, "security": [], "servers": [ { "url": "http://example.com", "variables": { } } ] } }, "/api/v3/ua/user/update-password": { "post": { "tags": [ "User Management API" ], "summary": "Update Password", "description": "This API will send a reset password email to the user email.", "operationId": "UpdatePassword", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "title": "UpdatePasswordRequest", "required": [ "email", "password" ], "type": "object", "properties": { "email": { "type": "string" }, "password": { "type": "string" } }, "example": { "email": "kartik.g@iqm.com", "password": "123456" } }, "example": { "email": "kartik.g@iqm.com", "password": "123456" } } }, "required": true }, "responses": { "200": { "description": "OK", "headers": { }, "content": { "application/json": { "schema": { "title": "SuccessResponse200OK", "required": [ "success", "data" ], "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "string" } }, "example": { "success": true, "data": "Invitation cancelled successfully." } }, "example": { "success": true, "data": "Password changed successfully." } } } }, "403": { "description": "Forbidden", "headers": { }, "content": { "application/json": { "schema": { "title": "ResetPasswordLinkinactive1", "required": [ "success", "data" ], "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "title": "Data5", "required": [ "invalidReason", "isValid" ], "type": "object", "properties": { "invalidReason": { "type": "string" }, "isValid": { "type": "boolean" } }, "example": { "invalidReason": "Reset password link either not valid or it is already processed.", "isValid": false } } }, "example": { "success": true, "data": { "invalidReason": "Reset password link either not valid or it is already processed.", "isValid": false } } }, "example": { "success": true, "data": { "invalidReason": "Reset password link either not valid or it is already processed.", "isValid": false } } } } } }, "deprecated": false, "servers": [ { "url": "http://example.com", "variables": { } } ], "security": [] } }, "/api/v3/ua/workspace": { "post": { "tags": [ "User Management API" ], "summary": "Create Workspace", "description": "This API can be used to create a workspace by providing invitation hash (can be retrieved from invitation link sent to customer/user), workspace domain and creator details.", "operationId": "CreateWorkspace", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "title": "CreateWorkspaceRequest", "required": [ "domain", "creatorEmail", "inviteHash" ], "type": "object", "properties": { "domain": { "type": "string" }, "creatorEmail": { "type": "string" }, "inviteHash": { "type": "string" } }, "example": { "domain": "app", "creatorEmail": "kartik.g@iqm.com", "inviteHash": "37KgCLieN6s/JxRgqYqeIV0UiAp3OWHdTjPUq8tVEilibQ9Bpo6ky+ZZeg8Wf3L9A0a3uBboKrijwXq0YZ0Qq3WXImlKQOgjYyZ7w5J6SPVwkvHTwe8yyHI2MIyR11URBlgOwoGnLtV8G4Cab+K4orlNjTnxLN+KFsYALpv0JDQkhvjRVxO8CJKhHahxu3rXZ3w6154n7PKTMZJs1ZR3r73dwHd8Ug0c/q7xB1ilGWIFnVVDb1gt1k8S5gYRNsxo9vESo0n8otr5/ha0SgW/qCZjxypIvO/59FXbjQ==" } }, "example": { "domain": "app", "creatorEmail": "kartik.g@iqm.com", "inviteHash": "37KgCLieN6s/JxRgqYqeIV0UiAp3OWHdTjPUq8tVEilibQ9Bpo6ky+ZZeg8Wf3L9A0a3uBboKrijwXq0YZ0Qq3WXImlKQOgjYyZ7w5J6SPVwkvHTwe8yyHI2MIyR11URBlgOwoGnLtV8G4Cab+K4orlNjTnxLN+KFsYALpv0JDQkhvjRVxO8CJKhHahxu3rXZ3w6154n7PKTMZJs1ZR3r73dwHd8Ug0c/q7xB1ilGWIFnVVDb1gt1k8S5gYRNsxo9vESo0n8otr5/ha0SgW/qCZjxypIvO/59FXbjQ==" } } }, "required": true }, "responses": { "200": { "description": "OK", "headers": { }, "content": { "application/json": { "schema": { "title": "SuccessResponse200OK3", "required": [ "success", "message" ], "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } }, "example": { "success": true, "message": "Workspace created successfully." } }, "example": { "success": true, "message": "Workspace created successfully." } } } }, "400": { "description": "Bad Request", "headers": { }, "content": { "application/json": { "schema": { "title": "Requiredparameterserror1", "required": [ "success", "errorObjects" ], "type": "object", "properties": { "success": { "type": "boolean" }, "errorObjects": { "type": "array", "items": { "title": "ErrorObject", "required": [ "error", "field" ], "type": "object", "properties": { "error": { "type": "string" }, "field": { "type": "string" } }, "example": { "error": "Provided invitation hash is incorrect.", "field": "inviteHash" } }, "description": "" } }, "example": { "success": false, "errorObjects": [ { "error": "Domain is required.", "field": "domain" } ] } }, "example": { "success": false, "errorObjects": [ { "error": "Domain is required.", "field": "domain" } ] } } } }, "403": { "description": "Forbidden", "headers": { }, "content": { "application/json": { "schema": { "title": "CreateworkspacenotallowedError1", "required": [ "success", "errorObjects" ], "type": "object", "properties": { "success": { "type": "boolean" }, "errorObjects": { "type": "array", "items": { "title": "ErrorObject8", "required": [ "error", "reason" ], "type": "object", "properties": { "error": { "type": "string" }, "reason": { "type": "string" } }, "example": { "error": "User is not allowed to create a workspace.", "reason": "User is not invited or invitation is processed or invitation is expired." } }, "description": "" } }, "example": { "success": false, "errorObjects": [ { "error": "User is not allowed to create a workspace.", "reason": "User is not invited or invitation is processed or invitation is expired." } ] } }, "example": { "success": false, "errorObjects": [ { "error": "User is not allowed to create a workspace.", "reason": "User is not invited or invitation is processed or invitation is expired." } ] } } } }, "422": { "description": "Unprocessable Entity (WebDAV) (RFC 4918)", "headers": { }, "content": { "application/json": { "schema": { "title": "DomainalreadyexistsError1", "required": [ "success", "errorObjects" ], "type": "object", "properties": { "success": { "type": "boolean" }, "errorObjects": { "type": "array", "items": { "title": "ErrorObject", "required": [ "error", "field" ], "type": "object", "properties": { "error": { "type": "string" }, "field": { "type": "string" } }, "example": { "error": "Provided invitation hash is incorrect.", "field": "inviteHash" } }, "description": "" } }, "example": { "success": false, "errorObjects": [ { "error": "A workspace with this URL already exists, please try a different one", "field": "domain" } ] } }, "example": { "success": false, "errorObjects": [ { "error": "A workspace with this URL already exists, please try a different one", "field": "domain" } ] } } } } }, "deprecated": false, "servers": [ { "url": "http://example.com", "variables": { } } ], "security": [] } }, "/api/v3/ua/sign-up": { "post": { "tags": [ "User Management API" ], "summary": "User Sign-up/Password Creation", "description": "This API can be used for user/customer sign-up.", "operationId": "UserSign-up/PasswordCreation", "parameters": [ { "name": "Authorization", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "Basic N3BuaWJrdWpleTFvanJnbnNsbjU6MTIzNDU2" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "title": "UserSign-upPasswordCreationRequest", "required": [ "email", "password" ], "type": "object", "properties": { "email": { "type": "string" }, "password": { "type": "string" } }, "example": { "email": "kartik.g@iqm.com", "password": "123456" } }, "example": { "email": "kartik.g@iqm.com", "password": "123456" } } }, "required": true }, "responses": { "200": { "description": "OK", "headers": { }, "content": { "application/json": { "schema": { "title": "SuccessResponse200OK4", "required": [ "success", "data" ], "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "title": "Data7", "required": [ "access_token", "refresh_token", "scope", "token_type", "expires_in" ], "type": "object", "properties": { "access_token": { "type": "string" }, "refresh_token": { "type": "string" }, "scope": { "type": "string" }, "token_type": { "type": "string" }, "expires_in": { "type": "integer", "format": "int32" } }, "example": { "access_token": "d90fa7de-534c-4652-ad8f-c4f6f70461ac", "refresh_token": "2e379c6f-959d-498f-8319-ff13ebef6bfe", "scope": "read write", "token_type": "bearer", "expires_in": 35999 } } }, "example": { "success": true, "data": { "access_token": "d90fa7de-534c-4652-ad8f-c4f6f70461ac", "refresh_token": "2e379c6f-959d-498f-8319-ff13ebef6bfe", "scope": "read write", "token_type": "bearer", "expires_in": 35999 } } }, "example": { "success": true, "data": { "access_token": "d90fa7de-534c-4652-ad8f-c4f6f70461ac", "refresh_token": "2e379c6f-959d-498f-8319-ff13ebef6bfe", "scope": "read write", "token_type": "bearer", "expires_in": 35999 } } } } }, "403": { "description": "Forbidden", "headers": { }, "content": { "application/json": { "schema": { "title": "PasswordcreationnotallowedError1", "required": [ "success", "errorObjects" ], "type": "object", "properties": { "success": { "type": "boolean" }, "errorObjects": { "type": "array", "items": { "title": "ErrorObject8", "required": [ "error", "reason" ], "type": "object", "properties": { "error": { "type": "string" }, "reason": { "type": "string" } }, "example": { "error": "User is not allowed to create a workspace.", "reason": "User is not invited or invitation is processed or invitation is expired." } }, "description": "" } }, "example": { "success": false, "errorObjects": [ { "error": "User is not allowed to create a password.", "reason": "User is not invited or invitation is processed or invitation is expired." } ] } }, "example": { "success": false, "errorObjects": [ { "error": "User is not allowed to create a password.", "reason": "User is not invited or invitation is processed or invitation is expired." } ] } } } } }, "deprecated": false, "security": [], "servers": [ { "url": "http://example.com", "variables": { } } ] } }, "/api/v3/ua/user/reset-password/validate": { "post": { "tags": [ "User Management API" ], "summary": "Validate Reset Password Link", "description": "This API can be used to validate the reset-password hash. Reset password hash can be retrieved from the email sent to the user/customer.", "operationId": "ValidateResetPasswordLink", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "title": "ValidateResetPasswordLinkRequest", "required": [ "inviteHash" ], "type": "object", "properties": { "inviteHash": { "type": "string" } }, "example": { "inviteHash": "8HQfsQcychjhvCmuuiFvVCIgqq9cJG/gh6HgmPZXxGE4od7a7tsMmh/O9+ia2Lw0FOelX3h8jTKJXR+0hUAkGXYA0cIITS13BxyrWoeBmRTnWTKxHtS+Ff41POwt/yDMY2iHXUsG86ehmWeeIi3HNMikhH5yY6BvNFnEfxq3zIdiouD3Fp/loPO9qazxU1qxZvNOOv8FZEZTzORVnJ8+ADjyZ/Zjs1dNhSFE" } }, "example": { "inviteHash": "8HQfsQcychjhvCmuuiFvVCIgqq9cJG/gh6HgmPZXxGE4od7a7tsMmh/O9+ia2Lw0FOelX3h8jTKJXR+0hUAkGXYA0cIITS13BxyrWoeBmRTnWTKxHtS+Ff41POwt/yDMY2iHXUsG86ehmWeeIi3HNMikhH5yY6BvNFnEfxq3zIdiouD3Fp/loPO9qazxU1qxZvNOOv8FZEZTzORVnJ8+ADjyZ/Zjs1dNhSFE" } } }, "required": true }, "responses": { "200": { "description": "OK", "headers": { }, "content": { "application/json": { "schema": { "title": "SuccessResponse200OK5", "required": [ "success", "data" ], "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "title": "Data8", "required": [ "resetEmail", "isValid" ], "type": "object", "properties": { "resetEmail": { "type": "string" }, "isValid": { "type": "boolean" } }, "example": { "resetEmail": "kartik.g@iqm.com", "isValid": true } } }, "example": { "success": true, "data": { "resetEmail": "kartik.g@iqm.com", "isValid": true } } }, "example": { "success": true, "data": { "resetEmail": "kartik.g@iqm.com", "isValid": true } } } } }, "403": { "description": "Forbidden", "headers": { }, "content": { "application/json": { "schema": { "title": "ResetPasswordLinkinactive1", "required": [ "success", "data" ], "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "title": "Data5", "required": [ "invalidReason", "isValid" ], "type": "object", "properties": { "invalidReason": { "type": "string" }, "isValid": { "type": "boolean" } }, "example": { "invalidReason": "Reset password link either not valid or it is already processed.", "isValid": false } } }, "example": { "success": true, "data": { "invalidReason": "Reset password link either not valid or it is already processed.", "isValid": false } } }, "example": { "success": true, "data": { "invalidReason": "Reset password link either not valid or it is already processed.", "isValid": false } } } } }, "422": { "description": "Unprocessable Entity (WebDAV) (RFC 4918)", "headers": { }, "content": { "application/json": { "schema": { "title": "InvalidResetPasswordlinkhash1", "required": [ "success", "errorObjects" ], "type": "object", "properties": { "success": { "type": "boolean" }, "errorObjects": { "type": "array", "items": { "title": "ErrorObject", "required": [ "error", "field" ], "type": "object", "properties": { "error": { "type": "string" }, "field": { "type": "string" } }, "example": { "error": "Provided invitation hash is incorrect.", "field": "inviteHash" } }, "description": "" } }, "example": { "success": false, "errorObjects": [ { "error": "Provided reset password link hash is incorrect.", "field": "inviteHash" } ] } }, "example": { "success": false, "errorObjects": [ { "error": "Provided reset password link hash is incorrect.", "field": "inviteHash" } ] } } } } }, "deprecated": false, "servers": [ { "url": "http://example.com", "variables": { } } ], "security": [] } }, "/api/v3/ua/login": { "post": { "tags": [ "User Management API" ], "summary": "Login", "description": "This API can be used by the user/customer to perform the login. This API will send OAuth compliant response with OW Id which can be used for any further API communications.", "operationId": "Login", "parameters": [ { "name": "Authorization", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "Basic N3BuaWJrdWpleTFvanJnbnNsbjU6MTIzNDU2" } }, { "name": "X-Iaa-Host", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "app.stage.inhousebuying.com" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "title": "LoginRequest", "required": [ "grantType", "email", "password" ], "type": "object", "properties": { "grantType": { "type": "string" }, "email": { "type": "string" }, "password": { "type": "string" } }, "example": { "grantType": "password", "email": "pratik.t+ihp@iqm.com", "password": "123456" } }, "example": { "grantType": "password", "email": "pratik.t+ihp@iqm.com", "password": "123456" } } }, "required": true }, "responses": { "200": { "description": "OK", "headers": { "Date": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "Tue, 13 Jul 2021 04:51:32 GMT" } } }, "Transfer-Encoding": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "chunked" } } }, "Connection": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "keep-alive" } } }, "X-Content-Type-Options": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "nosniff" } } }, "X-XSS-Protection": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "1; mode=block" } } }, "Cache-Control": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "no-cache, no-store, max-age=0, must-revalidate" } } }, "Pragma": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "no-cache" } } }, "Expires": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "0" } } }, "X-Frame-Options": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "DENY" } } } }, "content": { "application/json": { "schema": { "title": "SuccessResponse200OK6", "required": [ "success", "data" ], "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "title": "Data13", "required": [ "access_token", "refresh_token", "scope", "token_type", "expires_in", "owId" ], "type": "object", "properties": { "access_token": { "type": "string" }, "refresh_token": { "type": "string" }, "scope": { "type": "string" }, "token_type": { "type": "string" }, "expires_in": { "type": "integer", "format": "int32" }, "owId": { "type": "integer", "format": "int32" } }, "example": { "access_token": "106adb25-37b0-4cab-8381-d682fe7cc3c8", "refresh_token": "eac4c1f6-781e-4b04-baff-9c2e415d1f64", "scope": "read write", "token_type": "bearer", "expires_in": 35999, "owId": 200001 } } }, "example": { "success": true, "data": { "access_token": "106adb25-37b0-4cab-8381-d682fe7cc3c8", "refresh_token": "eac4c1f6-781e-4b04-baff-9c2e415d1f64", "scope": "read write", "token_type": "bearer", "expires_in": 35999, "owId": 200001 } } }, "example": { "success": true, "data": { "access_token": "106adb25-37b0-4cab-8381-d682fe7cc3c8", "refresh_token": "eac4c1f6-781e-4b04-baff-9c2e415d1f64", "scope": "read write", "token_type": "bearer", "expires_in": 35999, "owId": 200001 } } } } }, "400": { "description": "OK", "headers": { "Cache-Control": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "no-cache, no-store, max-age=0, must-revalidate" } } }, "Date": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "Wed, 21 Jul 2021 05:37:03 GMT" } } }, "Expires": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "0" } } }, "Pragma": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "no-cache" } } }, "Server": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "Caddy" } } }, "X-Content-Type-Options": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "nosniff" } } }, "X-Frame-Options": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "DENY" } } }, "X-Xss-Protection": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "1; mode=block" } } }, "Content-Length": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "73" } } } }, "content": { "application/json": { "schema": { "title": "OnHoldError1", "required": [ "success", "data", "errorObjects" ], "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "title": "Data11", "required": [ "status", "reason", "supportEmail" ], "type": "object", "properties": { "status": { "type": "string" }, "reason": { "type": "string" }, "supportEmail": { "type": "string" } }, "example": { "status": "On Hold", "reason": "The particular account is kept on hold due to missed payment dates for last 3 months.", "supportEmail": "support@iqm.com" } }, "errorObjects": { "type": "array", "items": { "title": "ErrorObject8", "required": [ "error", "reason" ], "type": "object", "properties": { "error": { "type": "string" }, "reason": { "type": "string" } }, "example": { "error": "User is not allowed to create a workspace.", "reason": "User is not invited or invitation is processed or invitation is expired." } }, "description": "" } }, "example": { "success": false, "data": { "status": "On Hold", "reason": "The particular account is kept on hold due to missed payment dates for last 3 months.", "supportEmail": "support@iqm.com" }, "errorObjects": [ { "error": "User is not allowed to access provided customer", "reason": "User is not associated with any active organization." } ] } }, "example": { "success": false, "data": { "status": "On Hold", "reason": "The particular account is kept on hold due to missed payment dates for last 3 months.", "supportEmail": "support@iqm.com" }, "errorObjects": [ { "error": "User is not allowed to access provided customer", "reason": "User is not associated with any active organization." } ] } } } }, "403": { "description": "Forbidden", "headers": { "Date": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "Tue, 13 Jul 2021 04:52:18 GMT" } } }, "Transfer-Encoding": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "chunked" } } }, "Connection": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "keep-alive" } } }, "X-Content-Type-Options": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "nosniff" } } }, "X-XSS-Protection": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "1; mode=block" } } }, "Cache-Control": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "no-cache, no-store, max-age=0, must-revalidate" } } }, "Pragma": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "no-cache" } } }, "Expires": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "0" } } }, "X-Frame-Options": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "DENY" } } } }, "content": { "application/json": { "schema": { "title": "NotAllowedtoWorkspace403Forbidden1", "required": [ "success", "errorObjects" ], "type": "object", "properties": { "success": { "type": "boolean" }, "errorObjects": { "type": "array", "items": { "title": "ErrorObject2", "required": [ "error" ], "type": "object", "properties": { "error": { "type": "string" } }, "example": { "error": "Only active invitations can be cancelled." } }, "description": "" } }, "example": { "success": false, "errorObjects": [ { "error": "User doesn't exist or user is not allowed to provided workspace." } ] } }, "example": { "success": false, "errorObjects": [ { "error": "User doesn't exist or user is not allowed to provided workspace." } ] } } } } }, "deprecated": false, "security": [], "servers": [ { "url": "http://example.com", "variables": { } } ] } }, "/api/v3/ua/user/email/validate": { "post": { "tags": [ "User Management API" ], "summary": "Validate User email", "description": "This API can be used to validate the provided user email.", "operationId": "ValidateUseremail", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "title": "ValidateUseremailRequest", "required": [ "email", "workspaceDomain" ], "type": "object", "properties": { "email": { "type": "string" }, "workspaceDomain": { "type": "string" } }, "example": { "email": "pratik.t+ihp@iqm.com", "workspaceDomain": "app.stage.inhousebuying.com" } }, "example": { "email": "pratik.t+ihp@iqm.com", "workspaceDomain": "app.stage.inhousebuying.com" } } }, "required": true }, "responses": { "200": { "description": "OK", "headers": { }, "content": { "application/json": { "schema": { "title": "Usernotallowedtoworkspace200OK", "required": [ "success", "data" ], "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "title": "Data14", "required": [ "isValid", "owId", "isWorkspaceAllowed" ], "type": "object", "properties": { "isValid": { "type": "boolean" }, "owId": { "type": "integer", "format": "int32" }, "isWorkspaceAllowed": { "type": "boolean" } }, "example": { "isValid": true, "owId": 0, "isWorkspaceAllowed": false } } }, "example": { "success": true, "data": { "isValid": true, "owId": 0, "isWorkspaceAllowed": false } } }, "example": { "success": true, "data": { "isValid": true, "owId": 0, "isWorkspaceAllowed": false } } } } }, "400": { "description": "Bad Request", "headers": { }, "content": { "application/json": { "schema": { "title": "400BadRequest1", "required": [ "success", "errorObjects" ], "type": "object", "properties": { "success": { "type": "boolean" }, "errorObjects": { "type": "array", "items": { "title": "ErrorObject", "required": [ "error", "field" ], "type": "object", "properties": { "error": { "type": "string" }, "field": { "type": "string" } }, "example": { "error": "Provided invitation hash is incorrect.", "field": "inviteHash" } }, "description": "" } }, "example": { "success": false, "errorObjects": [ { "error": "Workspace domain is required.", "field": "workspaceDomain" } ] } }, "example": { "success": false, "errorObjects": [ { "error": "Workspace domain is required.", "field": "workspaceDomain" } ] } } } }, "403": { "description": "Forbidden", "headers": { }, "content": { "application/json": { "schema": { "title": "Useremailnotvalid403Forbidden1", "required": [ "success", "data" ], "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "title": "Data14", "required": [ "isValid", "owId", "isWorkspaceAllowed" ], "type": "object", "properties": { "isValid": { "type": "boolean" }, "owId": { "type": "integer", "format": "int32" }, "isWorkspaceAllowed": { "type": "boolean" } }, "example": { "isValid": true, "owId": 0, "isWorkspaceAllowed": false } } }, "example": { "success": true, "data": { "isValid": false, "owId": 0, "isWorkspaceAllowed": false } } }, "example": { "success": true, "data": { "isValid": false, "owId": 0, "isWorkspaceAllowed": false } } } } } }, "deprecated": false, "servers": [ { "url": "http://example.com", "variables": { } } ], "security": [] } }, "/api/v3/ua/user/workspace/validate": { "post": { "tags": [ "User Management API" ], "summary": "Validate workspace domain", "description": "This API can be used to validate the given workspace domain for the given email.", "operationId": "Validateworkspacedomain", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "title": "ValidateworkspacedomainRequest", "required": [ "email", "workspaceDomain" ], "type": "object", "properties": { "email": { "type": "string" }, "workspaceDomain": { "type": "string" } }, "example": { "email": "user@ihp.com", "workspaceDomain": "app.stage.inhousebuying.com" } }, "example": { "email": "user@ihp.com", "workspaceDomain": "app.stage.inhousebuying.com" } } }, "required": true }, "responses": { "200": { "description": "OK", "headers": { }, "content": { "application/json": { "schema": { "title": "Userhasaccestoworkspace200OK", "required": [ "success" ], "type": "object", "properties": { "success": { "type": "boolean" } }, "example": { "success": true } }, "example": { "success": true } } } }, "403": { "description": "Forbidden", "headers": { }, "content": { "application/json": { "schema": { "title": "Domaindoesnotexist403Forbidden1", "required": [ "success", "errorObjects" ], "type": "object", "properties": { "success": { "type": "boolean" }, "errorObjects": { "type": "array", "items": { "title": "ErrorObject2", "required": [ "error" ], "type": "object", "properties": { "error": { "type": "string" } }, "example": { "error": "Only active invitations can be cancelled." } }, "description": "" } }, "example": { "success": false, "errorObjects": [ { "error": "Given workspace domain does not exist." } ] } }, "example": { "success": false, "errorObjects": [ { "error": "Given workspace domain does not exist." } ] } } } } }, "deprecated": false, "servers": [ { "url": "http://example.com", "variables": { } } ], "security": [] } }, "/api/v3/ua/logout": { "post": { "tags": [ "User Management API" ], "summary": "Logout", "description": "This API can be used to perform logout. This API will invalidate the access token.", "operationId": "Logout", "parameters": [], "responses": { "200": { "description": "OK", "headers": { "Cache-Control": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "no-cache, no-store, max-age=0, must-revalidate" } } }, "Content-Length": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "55" } } }, "Date": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "Thu, 18 Nov 2021 15:33:41 GMT" } } }, "Expires": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "0" } } }, "Pragma": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "no-cache" } } }, "Server": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "Caddy" } } }, "X-Content-Type-Options": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "nosniff" } } }, "X-Frame-Options": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "DENY" } } }, "X-Xss-Protection": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "1; mode=block" } } } }, "content": { "application/json": { "schema": { "title": "SuccessResponse200OK", "required": [ "success", "data" ], "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "string" } }, "example": { "success": true, "data": "Invitation cancelled successfully." } }, "example": { "success": true, "data": "User logged out successfully." } } } } }, "deprecated": false, "security": [ { "bearer": [] } ], "servers": [ { "url": "http://example.com", "variables": { } } ] } }, "/api/v3/ua/user-email/validate": { "post": { "tags": [ "User Management API" ], "summary": "Validate user email for signup", "operationId": "Validateuseremailforsignup", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "title": "ValidateuseremailforsignupRequest", "required": [ "email" ], "type": "object", "properties": { "email": { "type": "string" } }, "example": { "email": "email@domain.com" } }, "example": { "email": "email@domain.com" } } }, "required": true }, "responses": { "200": { "description": "OK", "headers": { }, "content": { "application/json": { "schema": { "title": "200OK2", "required": [ "success", "data" ], "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "title": "Data18", "required": [ "userName", "isNewUser", "isOrganizationOwnerUser" ], "type": "object", "properties": { "userName": { "type": "string" }, "isNewUser": { "type": "boolean" }, "isOrganizationOwnerUser": { "type": "boolean" } }, "example": { "userName": "userName", "isNewUser": false, "isOrganizationOwnerUser": false } } }, "example": { "success": true, "data": { "userName": "userName", "isNewUser": false, "isOrganizationOwnerUser": false } } }, "example": { "success": true, "data": { "userName": "userName", "isNewUser": false, "isOrganizationOwnerUser": false } } } } } }, "deprecated": false, "servers": [ { "url": "http://example.com", "variables": { } } ], "security": [] } }, "/api/v3/ua/customer/signup": { "post": { "tags": [ "User Management API" ], "summary": "Customer signup", "operationId": "Customersignup", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "title": "CustomersignupRequest", "required": [ "email", "organizationName", "userName", "industry", "companySize", "mediaBudget", "budgetSpent" ], "type": "object", "properties": { "email": { "type": "string" }, "organizationName": { "type": "string" }, "userName": { "type": "string" }, "industry": { "type": "integer", "format": "int32" }, "companySize": { "type": "integer", "format": "int32" }, "mediaBudget": { "type": "integer", "format": "int32" }, "budgetSpent": { "type": "integer", "format": "int32" } }, "example": { "email": "email@domain.com", "organizationName": "Organisation Name", "userName": "User Name", "industry": 1, "companySize": 2, "mediaBudget": 3, "budgetSpent": 2000 } }, "example": { "email": "email@domain.com", "organizationName": "Organisation Name", "userName": "User Name", "industry": 1, "companySize": 2, "mediaBudget": 3, "budgetSpent": 2000 } } }, "required": true }, "responses": { "200": { "description": "OK", "headers": { }, "content": { "application/json": { "schema": { "title": "200OK", "required": [ "success", "data" ], "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "string" } }, "example": { "success": true, "data": "Invitation resent successfully." } }, "example": { "success": true, "data": "Customer sign up requested successfully." } } } }, "403": { "description": "Forbidden", "headers": { }, "content": { "application/json": { "schema": { "title": "403-Forbidden-Notallowedtoperformselfsignup1", "required": [ "success", "errorObjects" ], "type": "object", "properties": { "success": { "type": "boolean" }, "errorObjects": { "type": "array", "items": { "title": "ErrorObject2", "required": [ "error" ], "type": "object", "properties": { "error": { "type": "string" } }, "example": { "error": "Only active invitations can be cancelled." } }, "description": "" } }, "example": { "success": false, "errorObjects": [ { "error": "Customer is not allowed to perform self signup." } ] } }, "example": { "success": false, "errorObjects": [ { "error": "Customer is not allowed to perform self signup." } ] } } } } }, "deprecated": false, "servers": [ { "url": "http://example.com", "variables": { } } ], "security": [] } }, "/api/v3/ua/customer/signup-form": { "get": { "tags": [ "User Management API" ], "summary": "Get Customer signup form", "operationId": "GetCustomersignupform", "parameters": [], "responses": { "200": { "description": "OK", "headers": { }, "content": { "application/json": { "schema": { "title": "200OK4", "required": [ "success", "data" ], "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "title": "Data19", "required": [ "isCustomerVerificationEnable", "customerFormDetails" ], "type": "object", "properties": { "isCustomerVerificationEnable": { "type": "boolean" }, "customerFormDetails": { "type": "array", "items": { "title": "CustomerFormDetail", "required": [ "id", "field", "label", "isUserRequired" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "field": { "type": "string" }, "label": { "type": "string" }, "isUserRequired": { "type": "boolean" } }, "example": { "id": 1, "field": "organizationName", "label": "Organization name", "isUserRequired": true } }, "description": "" } }, "example": { "isCustomerVerificationEnable": true, "customerFormDetails": [ { "id": 1, "field": "organizationName", "label": "Organization name", "isUserRequired": true }, { "id": 2, "field": "userName", "label": "Name of the user", "isUserRequired": true }, { "id": 3, "field": "industry", "label": "Industry", "isUserRequired": false }, { "id": 4, "field": "companySize", "label": "Company size", "isUserRequired": true }, { "id": 5, "field": "mediaBudget", "label": "Media budget", "isUserRequired": true }, { "id": 6, "field": "budgetSpent", "label": "Budget spent on programmatic", "isUserRequired": false } ] } } }, "example": { "success": true, "data": { "isCustomerVerificationEnable": true, "customerFormDetails": [ { "id": 1, "field": "organizationName", "label": "Organization name", "isUserRequired": true }, { "id": 2, "field": "userName", "label": "Name of the user", "isUserRequired": true }, { "id": 3, "field": "industry", "label": "Industry", "isUserRequired": false }, { "id": 4, "field": "companySize", "label": "Company size", "isUserRequired": true }, { "id": 5, "field": "mediaBudget", "label": "Media budget", "isUserRequired": true }, { "id": 6, "field": "budgetSpent", "label": "Budget spent on programmatic", "isUserRequired": false } ] } } }, "example": { "success": true, "data": { "isCustomerVerificationEnable": true, "customerFormDetails": [ { "id": 1, "field": "organizationName", "label": "Organization name", "isUserRequired": true }, { "id": 2, "field": "userName", "label": "Name of the user", "isUserRequired": true }, { "id": 3, "field": "industry", "label": "Industry", "isUserRequired": false }, { "id": 4, "field": "companySize", "label": "Company size", "isUserRequired": true }, { "id": 5, "field": "mediaBudget", "label": "Media budget", "isUserRequired": true }, { "id": 6, "field": "budgetSpent", "label": "Budget spent on programmatic", "isUserRequired": false } ] } } } } } }, "deprecated": false, "servers": [ { "url": "http://example.com", "variables": { } } ], "security": [] } }, "/api/v3/ua/oauth/token": { "post": { "tags": [ "User Management API" ], "summary": "Refresh Token", "operationId": "RefreshToken", "parameters": [], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { }, "schema": { "required": [ "grant_type", "refresh_token" ], "type": "object", "properties": { "grant_type": { "type": "string", "example": "refresh_token" }, "refresh_token": { "type": "string", "example": "08dc5196-aa27-4763-8b07-fd18c971c099" } } } } }, "required": false }, "responses": { "200": { "description": "OK", "headers": { }, "content": { "application/json": { "schema": { "title": "SuccessResponse200Ok9", "required": [ "access_token", "refresh_token", "scope", "token_type", "expires_in" ], "type": "object", "properties": { "access_token": { "type": "string" }, "refresh_token": { "type": "string" }, "scope": { "type": "string" }, "token_type": { "type": "string" }, "expires_in": { "type": "integer", "format": "int32" } }, "example": { "access_token": "106adb25-37b0-4cab-8381-d682fe7cc3c8", "refresh_token": "eac4c1f6-781e-4b04-baff-9c2e415d1f64", "scope": "read write", "token_type": "bearer", "expires_in": 35999 } }, "example": { "access_token": "106adb25-37b0-4cab-8381-d682fe7cc3c8", "refresh_token": "eac4c1f6-781e-4b04-baff-9c2e415d1f64", "scope": "read write", "token_type": "bearer", "expires_in": 35999 } } } } }, "deprecated": false, "security": [ { "basic": [] } ], "servers": [ { "url": "http://example.com", "variables": { } } ] } }, "/api/v3/ua/customer/application/revoke": { "post": { "tags": [ "User Management API" ], "summary": "Revoke App access for Customer", "description": "This API can be used to revoke any application access for the given customer. Application ids for various applications can be received from applications master API.", "operationId": "RevokeAppaccessforCustomer", "parameters": [ { "name": "X-IAA-OW-ID", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32", "example": 2 } }, { "name": "Authorization", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "{{bearer_token}}" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "title": "RevokeAppaccessforCustomerRequest", "required": [ "owId", "appIds" ], "type": "object", "properties": { "owId": { "type": "integer", "format": "int32" }, "appIds": { "type": "string" } }, "example": { "owId": 2, "appIds": "1,2" } }, "example": { "owId": 2, "appIds": "1,2" } } }, "required": true }, "responses": { "200": { "description": "OK", "headers": { }, "content": { "application/json": { "schema": { "title": "SuccessResponse200OK", "required": [ "success", "data" ], "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "string" } }, "example": { "success": true, "data": "Invitation cancelled successfully." } }, "example": { "success": true, "data": "Application access revoked successfully." } } } }, "403": { "description": "Forbidden", "headers": { }, "content": { "application/json": { "schema": { "title": "Notallowedtoaccesscustomer403Forbidden1", "required": [ "success", "errorObjects" ], "type": "object", "properties": { "success": { "type": "boolean" }, "errorObjects": { "type": "array", "items": { "title": "ErrorObject2", "required": [ "error" ], "type": "object", "properties": { "error": { "type": "string" } }, "example": { "error": "Only active invitations can be cancelled." } }, "description": "" } }, "example": { "success": false, "errorObjects": [ { "error": "User is not allowed to access provided customer" } ] } }, "example": { "success": false, "errorObjects": [ { "error": "User is not allowed to access provided customer" } ] } } } } }, "deprecated": false, "security": [], "servers": [ { "url": "http://example.com", "variables": { } } ] } }, "/api/v3/ua/customer/application/add": { "post": { "tags": [ "User Management API" ], "summary": "Add App access for Customer", "description": "This API can be used to add any application access for the given customer. Application ids for various applications can be received from the applications master API.\n\nAPI can be called with `Full` access level as well as `Limited` access level.", "operationId": "AddAppaccessforCustomer", "parameters": [ { "name": "Authorization", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "{{bearer_token}}" } }, { "name": "X-IAA-OW-ID", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "title": "AddAppaccessforCustomerRequest", "required": [ "owId", "appIds", "accessLevel" ], "type": "object", "properties": { "owId": { "type": "integer", "format": "int32" }, "appIds": { "type": "string" }, "accessLevel": { "type": "string" } }, "example": { "owId": 2, "appIds": "1,2", "accessLevel": "Full" } }, "example": { "owId": 2, "appIds": "1,2", "accessLevel": "Full" } } }, "required": true }, "responses": { "200": { "description": "OK", "headers": { }, "content": { "application/json": { "schema": { "title": "SuccessResponse200OK", "required": [ "success", "data" ], "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "string" } }, "example": { "success": true, "data": "Invitation cancelled successfully." } }, "example": { "success": true, "data": "Application access added successfully." } } } }, "403": { "description": "Forbidden", "headers": { }, "content": { "application/json": { "schema": { "title": "Notallowedtoaccesscustomer1", "required": [ "success", "errorObjects" ], "type": "object", "properties": { "success": { "type": "boolean" }, "errorObjects": { "type": "array", "items": { "title": "ErrorObject2", "required": [ "error" ], "type": "object", "properties": { "error": { "type": "string" } }, "example": { "error": "Only active invitations can be cancelled." } }, "description": "" } }, "example": { "success": false, "errorObjects": [ { "error": "User is not allowed to access provided customer" } ] } }, "example": { "success": false, "errorObjects": [ { "error": "User is not allowed to access provided customer" } ] } } } } }, "deprecated": false, "security": [], "servers": [ { "url": "http://example.com", "variables": { } } ] } }, "/api/v3/ua/customers/applications/list": { "get": { "tags": [ "User Management API" ], "summary": "Get Customer Allowed Applications", "description": "This API can be used to get allowed applications (along with the allowed user's list) for the given customer.", "operationId": "GetCustomerAllowedApplications", "parameters": [ { "name": "owId", "in": "query", "description": "OW Id of Customer for which application list needs to be fetched", "required": true, "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32", "example": 2 } }, { "name": "pageNo", "in": "query", "description": "(Optional) Page Number (default: -1)", "required": true, "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32", "example": 1 } }, { "name": "limit", "in": "query", "description": "(Optional) Page size (default - 10)", "required": true, "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32", "example": 10 } }, { "name": "sortBy", "in": "query", "description": "(Optional) Sort by fields (default : -appName)\nHere minus(-) sign is for order DESC and plus(+) sign for order ASC.\nValue can be from appName, subscriptionPrice.", "required": true, "style": "form", "explode": true, "schema": { "type": "string", "example": "+appName" } }, { "name": "X-IAA-OW-ID", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32", "example": 2 } }, { "name": "Authorization", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "{{bearer_token}}" } } ], "responses": { "200": { "description": "OK", "headers": { }, "content": { "application/json": { "schema": { "title": "SuccessResponse200OK15", "required": [ "success", "data" ], "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "title": "Data26", "required": [ "data", "totalRecords", "filteredRecords" ], "type": "object", "properties": { "data": { "type": "array", "items": { "title": "Data27", "required": [ "appId", "appName", "appOwner", "appIcon", "appType", "subscriptionPrice", "users" ], "type": "object", "properties": { "appId": { "type": "integer", "format": "int32" }, "appName": { "type": "string" }, "appOwner": { "type": "string" }, "appIcon": { "type": "string", "nullable": true }, "appType": { "type": "string" }, "subscriptionPrice": { "type": "number" }, "users": { "type": "array", "items": { "title": "User", "required": [ "firstName", "lastName", "email", "displayName", "userAvatar" ], "type": "object", "properties": { "firstName": { "type": "string" }, "lastName": { "type": "string", "nullable": true }, "email": { "type": "string" }, "displayName": { "type": "string" }, "userAvatar": { "type": "string", "nullable": true } }, "example": { "firstName": "Shraddha", "lastName": "Patel", "email": "shraddha.p+emailtest1@iqm.com", "displayName": "Shraddha Patel", "userAvatar": "https://tmpd3vsekqsh1zre3k8n-stage.s3.amazonaws.com/avatar/SP.svg" } }, "description": "" } }, "example": { "appId": 2, "appName": "Dashboard", "appOwner": "IHB", "appIcon": null, "appType": "Default App", "subscriptionPrice": 0, "users": [ { "firstName": "Shraddha", "lastName": "Patel", "email": "shraddha.p+emailtest1@iqm.com", "displayName": "Shraddha Patel", "userAvatar": "https://tmpd3vsekqsh1zre3k8n-stage.s3.amazonaws.com/avatar/SP.svg" }, { "firstName": "Shraddha", "lastName": "P", "email": "shraddha.p+emailtest2@iqm.com", "displayName": "Shraddha P", "userAvatar": "https://tmpd3vsekqsh1zre3k8n-stage.s3.amazonaws.com/avatar/SP.svg" } ] } }, "description": "" }, "totalRecords": { "type": "integer", "format": "int32" }, "filteredRecords": { "type": "integer", "format": "int32" } }, "example": { "data": [ { "appId": 2, "appName": "Dashboard", "appOwner": "IHB", "appIcon": null, "appType": "Default App", "subscriptionPrice": 0, "users": [ { "firstName": "Shraddha", "lastName": "Patel", "email": "shraddha.p+emailtest1@iqm.com", "displayName": "Shraddha Patel", "userAvatar": "https://tmpd3vsekqsh1zre3k8n-stage.s3.amazonaws.com/avatar/SP.svg" }, { "firstName": "Shraddha", "lastName": "P", "email": "shraddha.p+emailtest2@iqm.com", "displayName": "Shraddha P", "userAvatar": "https://tmpd3vsekqsh1zre3k8n-stage.s3.amazonaws.com/avatar/SP.svg" } ] }, { "appId": 1, "appName": "Customers", "appOwner": "IHB", "appIcon": null, "appType": "Default App", "subscriptionPrice": 0, "users": [ { "firstName": "Kartik", "lastName": "Gevariya", "email": "kartik.g@iqm.com", "displayName": "Kartik Gevariya", "userAvatar": "https://s3.amazonaws.com/admp0ed7fer7ert0em3rip5dy2/1/15e544b7b11040c1b56a61d2ab8450b4.png" }, { "firstName": "SP-IQM-User", "lastName": null, "email": "shraddha.p+iqmuser@iqm.com", "displayName": "SP-IQM-User", "userAvatar": null } ] } ], "totalRecords": 10, "filteredRecords": 10 } } }, "example": { "success": true, "data": { "data": [ { "appId": 2, "appName": "Dashboard", "appOwner": "IHB", "appIcon": null, "appType": "Default App", "subscriptionPrice": 0, "users": [ { "firstName": "Shraddha", "lastName": "Patel", "email": "shraddha.p+emailtest1@iqm.com", "displayName": "Shraddha Patel", "userAvatar": "https://tmpd3vsekqsh1zre3k8n-stage.s3.amazonaws.com/avatar/SP.svg" }, { "firstName": "Shraddha", "lastName": "P", "email": "shraddha.p+emailtest2@iqm.com", "displayName": "Shraddha P", "userAvatar": "https://tmpd3vsekqsh1zre3k8n-stage.s3.amazonaws.com/avatar/SP.svg" } ] }, { "appId": 1, "appName": "Customers", "appOwner": "IHB", "appIcon": null, "appType": "Default App", "subscriptionPrice": 0, "users": [ { "firstName": "Kartik", "lastName": "Gevariya", "email": "kartik.g@iqm.com", "displayName": "Kartik Gevariya", "userAvatar": "https://s3.amazonaws.com/admp0ed7fer7ert0em3rip5dy2/1/15e544b7b11040c1b56a61d2ab8450b4.png" }, { "firstName": "SP-IQM-User", "lastName": null, "email": "shraddha.p+iqmuser@iqm.com", "displayName": "SP-IQM-User", "userAvatar": null } ] } ], "totalRecords": 10, "filteredRecords": 10 } } }, "example": { "success": true, "data": { "data": [ { "appId": 2, "appName": "Dashboard", "appOwner": "IHB", "appIcon": null, "appType": "Default App", "subscriptionPrice": 0, "users": [ { "firstName": "Shraddha", "lastName": "Patel", "email": "shraddha.p+emailtest1@iqm.com", "displayName": "Shraddha Patel", "userAvatar": "https://tmpd3vsekqsh1zre3k8n-stage.s3.amazonaws.com/avatar/SP.svg" }, { "firstName": "Shraddha", "lastName": "P", "email": "shraddha.p+emailtest2@iqm.com", "displayName": "Shraddha P", "userAvatar": "https://tmpd3vsekqsh1zre3k8n-stage.s3.amazonaws.com/avatar/SP.svg" } ] }, { "appId": 1, "appName": "Customers", "appOwner": "IHB", "appIcon": null, "appType": "Default App", "subscriptionPrice": 0, "users": [ { "firstName": "Kartik", "lastName": "Gevariya", "email": "kartik.g@iqm.com", "displayName": "Kartik Gevariya", "userAvatar": "https://s3.amazonaws.com/admp0ed7fer7ert0em3rip5dy2/1/15e544b7b11040c1b56a61d2ab8450b4.png" }, { "firstName": "SP-IQM-User", "lastName": null, "email": "shraddha.p+iqmuser@iqm.com", "displayName": "SP-IQM-User", "userAvatar": null } ] } ], "totalRecords": 10, "filteredRecords": 10 } } } } }, "422": { "description": "Unprocessable Entity (WebDAV) (RFC 4918)", "headers": { }, "content": { "application/json": { "schema": { "title": "Invalidatesortbyvalue422UnprocessableEntity1", "required": [ "success", "errorObjects" ], "type": "object", "properties": { "success": { "type": "boolean" }, "errorObjects": { "type": "array", "items": { "title": "ErrorObject2", "required": [ "error" ], "type": "object", "properties": { "error": { "type": "string" } }, "example": { "error": "Only active invitations can be cancelled." } }, "description": "" } }, "example": { "success": false, "errorObjects": [ { "error": "Invalid sortBy value." } ] } }, "example": { "success": false, "errorObjects": [ { "error": "Invalid sortBy value." } ] } } } } }, "deprecated": false, "security": [], "servers": [ { "url": "http://example.com", "variables": { } } ] } }, "/api/v3/ua/customers/users/list": { "get": { "tags": [ "User Management API" ], "summary": "Get Users list for selected customer", "description": "This API can be used to get a list of users for the given customer (organization).", "operationId": "GetUserslistforselectedcustomer", "parameters": [ { "name": "owId", "in": "query", "description": "OW Id of Customer for which user list needs to be fetched", "required": true, "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32", "example": 1 } }, { "name": "pageNo", "in": "query", "description": "(Optional) Page Number (default: -1)", "required": true, "style": "form", "explode": true, "schema": { "type": "integer", "format": "int64", "example": -1 } }, { "name": "limit", "in": "query", "description": "(Optional) Page size (default - 10)", "required": true, "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32", "example": 10 } }, { "name": "sortBy", "in": "query", "description": "(Optional) Sort by fields (default : -displayName)\nHere minus(-) sign is for order DESC and plus(+) sign for order ASC.\nValue can be from displayName, organizationName.", "required": true, "style": "form", "explode": true, "schema": { "type": "string", "example": "+displayName" } }, { "name": "X-IAA-OW-ID", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32", "example": 1 } }, { "name": "Authorization", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "{{bearer_token}}" } } ], "responses": { "200": { "description": "OK", "headers": { }, "content": { "application/json": { "schema": { "title": "SuccessResponse200OK17", "required": [ "success", "data" ], "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "title": "Data29", "required": [ "data", "totalRecords", "filteredRecords" ], "type": "object", "properties": { "data": { "type": "array", "items": { "title": "Data30", "required": [ "userId", "displayName", "userAvatar", "email", "userTitle", "orgId", "organizationName", "apps" ], "type": "object", "properties": { "userId": { "type": "integer", "format": "int32" }, "displayName": { "type": "string" }, "userAvatar": { "type": "string" }, "email": { "type": "string" }, "userTitle": { "type": "string" }, "orgId": { "type": "integer", "format": "int32" }, "organizationName": { "type": "string" }, "apps": { "type": "array", "items": { "title": "App", "required": [ "appId", "appName", "appIcon" ], "type": "object", "properties": { "appId": { "type": "integer", "format": "int32" }, "appName": { "type": "string" }, "appIcon": { "type": "string", "nullable": true } }, "example": { "appId": 1, "appName": "Customers", "appIcon": null } }, "description": "" } }, "example": { "userId": 1, "displayName": "IHP", "userAvatar": "https://s3.amazonaws.com/admp0ed7fer7ert0em3rip5dy2/1/15e544b7b11040c1b56a61d2ab8450b4.png", "email": "pratik.t+ihp@iqm.com", "userTitle": "CEO", "orgId": 1, "organizationName": "IHP", "apps": [ { "appId": 1, "appName": "Customers", "appIcon": null }, { "appId": 2, "appName": "Dashboard", "appIcon": null } ] } }, "description": "" }, "totalRecords": { "type": "integer", "format": "int32" }, "filteredRecords": { "type": "integer", "format": "int32" } }, "example": { "data": [ { "userId": 1, "displayName": "IHP", "userAvatar": "https://s3.amazonaws.com/admp0ed7fer7ert0em3rip5dy2/1/15e544b7b11040c1b56a61d2ab8450b4.png", "email": "pratik.t+ihp@iqm.com", "userTitle": "CEO", "orgId": 1, "organizationName": "IHP", "apps": [ { "appId": 1, "appName": "Customers", "appIcon": null }, { "appId": 2, "appName": "Dashboard", "appIcon": null } ] } ], "totalRecords": 1, "filteredRecords": 1 } } }, "example": { "success": true, "data": { "data": [ { "userId": 1, "displayName": "IHP", "userAvatar": "https://s3.amazonaws.com/admp0ed7fer7ert0em3rip5dy2/1/15e544b7b11040c1b56a61d2ab8450b4.png", "email": "pratik.t+ihp@iqm.com", "userTitle": "CEO", "orgId": 1, "organizationName": "IHP", "apps": [ { "appId": 1, "appName": "Customers", "appIcon": null }, { "appId": 2, "appName": "Dashboard", "appIcon": null } ] } ], "totalRecords": 1, "filteredRecords": 1 } } }, "example": { "success": true, "data": { "data": [ { "userId": 1, "displayName": "IHP", "userAvatar": "https://s3.amazonaws.com/admp0ed7fer7ert0em3rip5dy2/1/15e544b7b11040c1b56a61d2ab8450b4.png", "email": "pratik.t+ihp@iqm.com", "userTitle": "CEO", "orgId": 1, "organizationName": "IHP", "apps": [ { "appId": 1, "appName": "Customers", "appIcon": null }, { "appId": 2, "appName": "Dashboard", "appIcon": null } ] } ], "totalRecords": 1, "filteredRecords": 1 } } } } }, "422": { "description": "Unprocessable Entity (WebDAV) (RFC 4918)", "headers": { }, "content": { "application/json": { "schema": { "title": "Invallidsortbyvalue422UnprocessableEntity1", "required": [ "success", "errorObjects" ], "type": "object", "properties": { "success": { "type": "boolean" }, "errorObjects": { "type": "array", "items": { "title": "ErrorObject2", "required": [ "error" ], "type": "object", "properties": { "error": { "type": "string" } }, "example": { "error": "Only active invitations can be cancelled." } }, "description": "" } }, "example": { "success": false, "errorObjects": [ { "error": "Invalid sortBy value." } ] } }, "example": { "success": false, "errorObjects": [ { "error": "Invalid sortBy value." } ] } } } } }, "deprecated": false, "security": [], "servers": [ { "url": "http://example.com", "variables": { } } ] } }, "/api/v3/ua/customers/remaining-applications/list": { "get": { "tags": [ "User Management API" ], "summary": "Get remaining Application list for Customer", "description": "This API can be used to get a list of remaining applications (from default allowed applications) for the given customer.", "operationId": "GetremainingApplicationlistforCustomer", "parameters": [ { "name": "owId", "in": "query", "description": "OW Id of Customer for which remaining application list needs to be fetched", "required": true, "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32", "example": 1 } }, { "name": "X-iAA-OW-ID", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32", "example": 1 } }, { "name": "Authorization", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "{{bearer_token}}" } } ], "responses": { "200": { "description": "OK", "headers": { }, "content": { "application/json": { "schema": { "title": "SuccessResponse200OK19", "required": [ "success", "data" ], "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "array", "items": { "title": "Data32", "required": [ "appId", "appName", "appIcon", "orgName", "appType", "userCount" ], "type": "object", "properties": { "appId": { "type": "integer", "format": "int32" }, "appName": { "type": "string" }, "appIcon": { "type": "string", "nullable": true }, "orgName": { "type": "string" }, "appType": { "type": "string" }, "userCount": { "type": "integer", "format": "int32" } }, "example": { "appId": 6, "appName": "Accounts", "appIcon": "", "orgName": "IHP", "appType": "Default App", "userCount": 0 } }, "description": "" } }, "example": { "success": true, "data": [ { "appId": 6, "appName": "Accounts", "appIcon": "", "orgName": "IHP", "appType": "Default App", "userCount": 0 }, { "appId": 8, "appName": "Audiences", "appIcon": "", "orgName": "IQM Corporation", "appType": "Default App", "userCount": 0 }, { "appId": 4, "appName": "Bid Model", "appIcon": "", "orgName": "IHP", "appType": "Default App", "userCount": 0 }, { "appId": 7, "appName": "Campaigns", "appIcon": "", "orgName": "IQM Corporation", "appType": "Default App", "userCount": 0 }, { "appId": 11, "appName": "Conversions", "appIcon": "", "orgName": "IQM Corporation", "appType": "Default App", "userCount": 0 }, { "appId": 9, "appName": "Creatives", "appIcon": "", "orgName": "IQM Corporation", "appType": "Default App", "userCount": 0 }, { "appId": 2, "appName": "Dashboard", "appIcon": null, "orgName": "IHP", "appType": "Default App", "userCount": 1 }, { "appId": 10, "appName": "Inventory", "appIcon": "", "orgName": "IQM Corporation", "appType": "Default App", "userCount": 0 }, { "appId": 5, "appName": "Organizations", "appIcon": "", "orgName": "IHP", "appType": "Default App", "userCount": 0 }, { "appId": 3, "appName": "Reports", "appIcon": "", "orgName": "IHP", "appType": "Default App", "userCount": 0 } ] } }, "example": { "success": true, "data": [ { "appId": 6, "appName": "Accounts", "appIcon": "", "orgName": "IHP", "appType": "Default App", "userCount": 0 }, { "appId": 8, "appName": "Audiences", "appIcon": "", "orgName": "IQM Corporation", "appType": "Default App", "userCount": 0 }, { "appId": 4, "appName": "Bid Model", "appIcon": "", "orgName": "IHP", "appType": "Default App", "userCount": 0 }, { "appId": 7, "appName": "Campaigns", "appIcon": "", "orgName": "IQM Corporation", "appType": "Default App", "userCount": 0 }, { "appId": 11, "appName": "Conversions", "appIcon": "", "orgName": "IQM Corporation", "appType": "Default App", "userCount": 0 }, { "appId": 9, "appName": "Creatives", "appIcon": "", "orgName": "IQM Corporation", "appType": "Default App", "userCount": 0 }, { "appId": 2, "appName": "Dashboard", "appIcon": null, "orgName": "IHP", "appType": "Default App", "userCount": 1 }, { "appId": 10, "appName": "Inventory", "appIcon": "", "orgName": "IQM Corporation", "appType": "Default App", "userCount": 0 }, { "appId": 5, "appName": "Organizations", "appIcon": "", "orgName": "IHP", "appType": "Default App", "userCount": 0 }, { "appId": 3, "appName": "Reports", "appIcon": "", "orgName": "IHP", "appType": "Default App", "userCount": 0 } ] } } } }, "403": { "description": "Forbidden", "headers": { }, "content": { "application/json": { "schema": { "title": "Notallowedtoaccesscustomer403Forbidden1", "required": [ "success", "errorObjects" ], "type": "object", "properties": { "success": { "type": "boolean" }, "errorObjects": { "type": "array", "items": { "title": "ErrorObject2", "required": [ "error" ], "type": "object", "properties": { "error": { "type": "string" } }, "example": { "error": "Only active invitations can be cancelled." } }, "description": "" } }, "example": { "success": false, "errorObjects": [ { "error": "User is not allowed to access provided customer" } ] } }, "example": { "success": false, "errorObjects": [ { "error": "User is not allowed to access provided customer" } ] } } } } }, "deprecated": false, "security": [], "servers": [ { "url": "http://example.com", "variables": { } } ] } }, "/api/v3/ua/customer/hold": { "patch": { "tags": [ "User Management API" ], "summary": "Put Customer On-hold", "description": "This API can be used to put a customer on hold by providing a reason.", "operationId": "PutCustomerOn-hold", "parameters": [ { "name": "X-IAA-OW-ID", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32", "example": 1 } }, { "name": "Authorization", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "{{bearer_token}}" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "title": "PutCustomerOn-holdRequest", "required": [ "owId", "statusReason" ], "type": "object", "properties": { "owId": { "type": "integer", "format": "int32" }, "statusReason": { "type": "string" } }, "example": { "owId": 54, "statusReason": "Not paid payment for 3 months" } }, "example": { "owId": 54, "statusReason": "Not paid payment for 3 months" } } }, "required": true }, "responses": { "200": { "description": "OK", "headers": { }, "content": { "application/json": { "schema": { "title": "SuccessResponse200OK", "required": [ "success", "data" ], "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "string" } }, "example": { "success": true, "data": "Invitation cancelled successfully." } }, "example": { "success": true, "data": "Customer status changed to on-hold successfully." } } } }, "403": { "description": "Forbidden", "headers": { }, "content": { "application/json": { "schema": { "title": "UsernotallowedtoCustomer403Forbidden1", "required": [ "success", "errorObjects" ], "type": "object", "properties": { "success": { "type": "boolean" }, "errorObjects": { "type": "array", "items": { "title": "ErrorObject2", "required": [ "error" ], "type": "object", "properties": { "error": { "type": "string" } }, "example": { "error": "Only active invitations can be cancelled." } }, "description": "" } }, "example": { "success": false, "errorObjects": [ { "error": "User is not allowed to access provided customer" } ] } }, "example": { "success": false, "errorObjects": [ { "error": "User is not allowed to access provided customer" } ] } } } } }, "deprecated": false, "security": [], "servers": [ { "url": "http://example.com", "variables": { } } ] } }, "/api/v3/ua/customer/re-activate": { "patch": { "tags": [ "User Management API" ], "summary": "Re-activate Customer", "description": "This API can be used to re-active any customer who is on hold.", "operationId": "Re-activateCustomer", "parameters": [ { "name": "X-IAA-OW-ID", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32", "example": 1 } }, { "name": "Authorization", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "{{bearer_token}}" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "title": "Re-activateCustomerRequest", "required": [ "owId" ], "type": "object", "properties": { "owId": { "type": "integer", "format": "int32" } }, "example": { "owId": 54 } }, "example": { "owId": 54 } } }, "required": true }, "responses": { "200": { "description": "OK", "headers": { }, "content": { "application/json": { "schema": { "title": "SuccessResponse200OK", "required": [ "success", "data" ], "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "string" } }, "example": { "success": true, "data": "Invitation cancelled successfully." } }, "example": { "success": true, "data": "Customer status changed to active successfully." } } } }, "403": { "description": "Forbidden", "headers": { }, "content": { "application/json": { "schema": { "title": "UsernotallowedtoCustomer403Forbidden1", "required": [ "success", "errorObjects" ], "type": "object", "properties": { "success": { "type": "boolean" }, "errorObjects": { "type": "array", "items": { "title": "ErrorObject2", "required": [ "error" ], "type": "object", "properties": { "error": { "type": "string" } }, "example": { "error": "Only active invitations can be cancelled." } }, "description": "" } }, "example": { "success": false, "errorObjects": [ { "error": "User is not allowed to access provided customer" } ] } }, "example": { "success": false, "errorObjects": [ { "error": "User is not allowed to access provided customer" } ] } } } } }, "deprecated": false, "security": [], "servers": [ { "url": "http://example.com", "variables": { } } ] } }, "/api/v3/ua/customers/advertisers/list": { "get": { "tags": [ "User Management API" ], "summary": "Get Advertisers list for Customer", "description": "This API can be used to get a list of advertisers for the given customer.", "operationId": "GetAdvertiserslistforCustomer", "parameters": [ { "name": "owId", "in": "query", "description": "", "required": true, "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32", "example": 2 } }, { "name": "X-IAA-OW-ID", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32", "example": 1 } }, { "name": "Authorization", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "{{bearer_token}}" } } ], "responses": { "200": { "description": "OK", "headers": { }, "content": { "application/json": { "schema": { "title": "SuccessResponse200OK22", "required": [ "success", "data" ], "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "array", "items": { "title": "Data33", "required": [ "id", "advertiserName", "website", "chiefName", "contactNumber", "contactAddress" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "advertiserName": { "type": "string" }, "website": { "type": "string" }, "chiefName": { "type": "string" }, "contactNumber": { "type": "string" }, "contactAddress": { "type": "string", "nullable": true } }, "example": { "id": 1, "advertiserName": "Nikon", "website": "http://nikonindia.com", "chiefName": "Nil Miles", "contactNumber": "+91 9999999999", "contactAddress": null } }, "description": "" } }, "example": { "success": true, "data": [ { "id": 1, "advertiserName": "Nikon", "website": "http://nikonindia.com", "chiefName": "Nil Miles", "contactNumber": "+91 9999999999", "contactAddress": null }, { "id": 2, "advertiserName": "Nike", "website": "http://nikeindia.com", "chiefName": "Nike", "contactNumber": "+91 9999988888", "contactAddress": null } ] } }, "example": { "success": true, "data": [ { "id": 1, "advertiserName": "Nikon", "website": "http://nikonindia.com", "chiefName": "Nil Miles", "contactNumber": "+91 9999999999", "contactAddress": null }, { "id": 2, "advertiserName": "Nike", "website": "http://nikeindia.com", "chiefName": "Nike", "contactNumber": "+91 9999988888", "contactAddress": null } ] } } } }, "403": { "description": "Forbidden", "headers": { }, "content": { "application/json": { "schema": { "title": "UsernotallowedtoaccessCustomer403Forbidden1", "required": [ "success", "errorObjects" ], "type": "object", "properties": { "success": { "type": "boolean" }, "errorObjects": { "type": "array", "items": { "title": "ErrorObject2", "required": [ "error" ], "type": "object", "properties": { "error": { "type": "string" } }, "example": { "error": "Only active invitations can be cancelled." } }, "description": "" } }, "example": { "success": false, "errorObjects": [ { "error": "User is not allowed to access provided customer" } ] } }, "example": { "success": false, "errorObjects": [ { "error": "User is not allowed to access provided customer" } ] } } } } }, "deprecated": false, "security": [], "servers": [ { "url": "http://example.com", "variables": { } } ] } }, "/api/v3/ua/customer/approve": { "patch": { "tags": [ "User Management API" ], "summary": "Approve customer", "description": "This API Approves provided customer along with adding access to the apps of provided appIds.\n\n**Request Body**\n\n| **Field** | **Type** | **Description** |\n| --- | --- | --- |\n| owId | Integer | Organisation Workspace Id |\n| appIds | String | Comma separated application Ids |", "operationId": "Approvecustomer", "parameters": [ { "name": "X-IAA-OW-ID", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "{{owId}}" } }, { "name": "Authorization", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "{{bearer_token}}" } } ], "requestBody": { "description": "", "content": { "text/plain": { "schema": { "type": "string", "example": "{\n \"owId\": {{ow_id}},\n \"appIds\": \"2,5,6,7,9,10,11\"\n}" }, "example": "{\n \"owId\": {{ow_id}},\n \"appIds\": \"2,5,6,7,9,10,11\"\n}" } }, "required": true }, "responses": { "200": { "description": "OK", "headers": { }, "content": { "application/json": { "schema": { "title": "200OK", "required": [ "success", "data" ], "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "string" } }, "example": { "success": true, "data": "Invitation resent successfully." } }, "example": { "success": true, "data": "Customer approved successfully." } } } }, "403": { "description": "Forbidden", "headers": { }, "content": { "application/json": { "schema": { "title": "403-Notallowedtoaccesscustomer1", "required": [ "success", "errorObjects" ], "type": "object", "properties": { "success": { "type": "boolean" }, "errorObjects": { "type": "array", "items": { "title": "ErrorObject2", "required": [ "error" ], "type": "object", "properties": { "error": { "type": "string" } }, "example": { "error": "Only active invitations can be cancelled." } }, "description": "" } }, "example": { "success": false, "errorObjects": [ { "error": "User is not allowed to access provided customer" } ] } }, "example": { "success": false, "errorObjects": [ { "error": "User is not allowed to access provided customer" } ] } } } }, "422": { "description": "Unprocessable Entity (WebDAV) (RFC 4918)", "headers": { }, "content": { "application/json": { "schema": { "title": "422-Customerisnotinpendingstate1", "required": [ "success", "errorObjects" ], "type": "object", "properties": { "success": { "type": "boolean" }, "errorObjects": { "type": "array", "items": { "title": "ErrorObject2", "required": [ "error" ], "type": "object", "properties": { "error": { "type": "string" } }, "example": { "error": "Only active invitations can be cancelled." } }, "description": "" } }, "example": { "success": false, "errorObjects": [ { "error": "Customer organization is not in pending status" } ] } }, "example": { "success": false, "errorObjects": [ { "error": "Customer organization is not in pending status" } ] } } } } }, "deprecated": false, "security": [], "servers": [ { "url": "http://example.com", "variables": { } } ] } }, "/api/v3/ua/customer/reject": { "patch": { "tags": [ "User Management API" ], "summary": "Reject customer", "operationId": "Rejectcustomer", "parameters": [ { "name": "X-IAA-OW-ID", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "{{owId}}" } }, { "name": "Authorization", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "{{bearer_token}}" } } ], "requestBody": { "description": "", "content": { "text/plain": { "schema": { "type": "string", "example": "{\n \"owId\": {{ow_id}},\n \"statusReason\": \"Customer didn't provide correct details\"\n}" }, "example": "{\n \"owId\": {{ow_id}},\n \"statusReason\": \"Customer didn't provide correct details\"\n}" } }, "required": true }, "responses": { "200": { "description": "OK", "headers": { }, "content": { "application/json": { "schema": { "title": "200OK", "required": [ "success", "data" ], "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "string" } }, "example": { "success": true, "data": "Invitation resent successfully." } }, "example": { "success": true, "data": "Customer rejected successfully." } } } }, "403": { "description": "Forbidden", "headers": { }, "content": { "application/json": { "schema": { "title": "403-Notallowedtoaccescustomer1", "required": [ "success", "errorObjects" ], "type": "object", "properties": { "success": { "type": "boolean" }, "errorObjects": { "type": "array", "items": { "title": "ErrorObject2", "required": [ "error" ], "type": "object", "properties": { "error": { "type": "string" } }, "example": { "error": "Only active invitations can be cancelled." } }, "description": "" } }, "example": { "success": false, "errorObjects": [ { "error": "User is not allowed to access provided customer" } ] } }, "example": { "success": false, "errorObjects": [ { "error": "User is not allowed to access provided customer" } ] } } } }, "422": { "description": "Unprocessable Entity (WebDAV) (RFC 4918)", "headers": { }, "content": { "application/json": { "schema": { "title": "422-Requestisnotactive1", "required": [ "success", "errorObjects" ], "type": "object", "properties": { "success": { "type": "boolean" }, "errorObjects": { "type": "array", "items": { "title": "ErrorObject2", "required": [ "error" ], "type": "object", "properties": { "error": { "type": "string" } }, "example": { "error": "Only active invitations can be cancelled." } }, "description": "" } }, "example": { "success": false, "errorObjects": [ { "error": "Sign up request status is not active." } ] } }, "example": { "success": false, "errorObjects": [ { "error": "Sign up request status is not active." } ] } } } } }, "deprecated": false, "security": [], "servers": [ { "url": "http://example.com", "variables": { } } ] } }, "/api/v3/ua/user/allowed-applications": { "get": { "tags": [ "User Management API" ], "summary": "Allowed Applications", "operationId": "AllowedApplications", "parameters": [ { "name": "X_IAA_OW_ID", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32", "example": 2 } }, { "name": "Authorization", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "{{bearer_token}}" } } ], "responses": { "200": { "description": "OK", "headers": { }, "content": { "application/json": { "schema": { "title": "SuccessResponse200OK24", "required": [ "success", "data" ], "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "array", "items": { "title": "Data36", "required": [ "appId", "appName", "appIcon", "appUrl" ], "type": "object", "properties": { "appId": { "type": "integer", "format": "int32" }, "appName": { "type": "string" }, "appIcon": { "type": "string" }, "appUrl": { "type": "string" } }, "example": { "appId": 1, "appName": "Customers", "appIcon": "https://s3.amazonaws.com/app-icons/customers.png", "appUrl": "/customers" } }, "description": "" } }, "example": { "success": true, "data": [ { "appId": 1, "appName": "Customers", "appIcon": "https://s3.amazonaws.com/app-icons/customers.png", "appUrl": "/customers" }, { "appId": 2, "appName": "Organization", "appIcon": "https://s3.amazonaws.com/app-icons/organization.png", "appUrl": "/organization" } ] } }, "example": { "success": true, "data": [ { "appId": 1, "appName": "Customers", "appIcon": "https://s3.amazonaws.com/app-icons/customers.png", "appUrl": "/customers" }, { "appId": 2, "appName": "Organization", "appIcon": "https://s3.amazonaws.com/app-icons/organization.png", "appUrl": "/organization" } ] } } } } }, "deprecated": false, "security": [], "servers": [ { "url": "http://example.com", "variables": { } } ] } }, "/api/v3/ua/user/application/add": { "post": { "tags": [ "User Management API" ], "summary": "Add App access for User", "operationId": "AddAppaccessforUser", "parameters": [ { "name": "X-IAA-OW-ID", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32", "example": 1 } }, { "name": "Authorization", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "{{bearer_token}}" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "title": "AddAppaccessforUserRequest", "required": [ "userId", "appIds", "accessLevel" ], "type": "object", "properties": { "userId": { "type": "integer", "format": "int32" }, "appIds": { "type": "string" }, "accessLevel": { "type": "string" } }, "example": { "userId": 431, "appIds": "1", "accessLevel": "Full" } }, "example": { "userId": 431, "appIds": "1", "accessLevel": "Full" } } }, "required": true }, "responses": { "200": { "description": "OK", "headers": { }, "content": { "application/json": { "schema": { "title": "SuccessResponse200OK", "required": [ "success", "data" ], "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "string" } }, "example": { "success": true, "data": "Invitation cancelled successfully." } }, "example": { "success": true, "data": "Application access added successfully." } } } }, "403": { "description": "Forbidden", "headers": { }, "content": { "application/json": { "schema": { "title": "Userisnotpartoforganization403Forbidden1", "required": [ "success", "errorObjects" ], "type": "object", "properties": { "success": { "type": "boolean" }, "errorObjects": { "type": "array", "items": { "title": "ErrorObject2", "required": [ "error" ], "type": "object", "properties": { "error": { "type": "string" } }, "example": { "error": "Only active invitations can be cancelled." } }, "description": "" } }, "example": { "success": false, "errorObjects": [ { "error": "User doesn't exist or user is not part of the organization." } ] } }, "example": { "success": false, "errorObjects": [ { "error": "User doesn't exist or user is not part of the organization." } ] } } } } }, "deprecated": false, "security": [], "servers": [ { "url": "http://example.com", "variables": { } } ] } }, "/api/v3/ua/user/application/revoke": { "delete": { "tags": [ "User Management API" ], "summary": "Revoke App access for User", "operationId": "RevokeAppaccessforUser", "parameters": [ { "name": "X-IAA-OW-ID", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32", "example": 1 } }, { "name": "Authorization", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "{{bearer_token}}" } } ], "responses": { "200": { "description": "OK", "headers": { }, "content": { "application/json": { "schema": { "title": "SuccessResponse200OK", "required": [ "success", "data" ], "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "string" } }, "example": { "success": true, "data": "Invitation cancelled successfully." } }, "example": { "success": true, "data": "Application access revoked successfully." } } } }, "403": { "description": "Forbidden", "headers": { }, "content": { "application/json": { "schema": { "title": "Userisnotpartoforganization403Forbidden1", "required": [ "success", "errorObjects" ], "type": "object", "properties": { "success": { "type": "boolean" }, "errorObjects": { "type": "array", "items": { "title": "ErrorObject2", "required": [ "error" ], "type": "object", "properties": { "error": { "type": "string" } }, "example": { "error": "Only active invitations can be cancelled." } }, "description": "" } }, "example": { "success": false, "errorObjects": [ { "error": "User doesn't exist or user is not part of the organization." } ] } }, "example": { "success": false, "errorObjects": [ { "error": "User doesn't exist or user is not part of the organization." } ] } } } } }, "deprecated": false, "security": [], "servers": [ { "url": "http://example.com", "variables": { } } ] } }, "/api/v3/ua/user/update-status": { "put": { "tags": [ "User Management API" ], "summary": "Update User Status", "operationId": "UpdateUserStatus", "parameters": [ { "name": "Authorization", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "{{bearer_token}}" } }, { "name": "X-IAA-OW-ID", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32", "example": 2 } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "title": "UpdateUserStatusRequest", "required": [ "uowId", "status", "statusReason" ], "type": "object", "properties": { "uowId": { "type": "integer", "format": "int32" }, "status": { "type": "integer", "format": "int32" }, "statusReason": { "type": "string" } }, "example": { "uowId": 166, "status": 4, "statusReason": "Payment overdue for last 3 months" } }, "example": { "uowId": 166, "status": 4, "statusReason": "Payment overdue for last 3 months" } } }, "required": true }, "responses": { "200": { "description": "OK", "headers": { }, "content": { "application/json": { "schema": { "title": "200-SuccessfullyUpdated", "required": [ "success", "data" ], "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "string" } }, "example": { "success": true, "data": "User status updated successfully." } }, "example": { "success": true, "data": "User status updated successfully." } } } } }, "deprecated": false, "security": [], "servers": [ { "url": "http://example.com", "variables": { } } ] } }, "/api/v3/ua/user/assigned-customers": { "get": { "tags": [ "User Management API" ], "summary": "User assigned Customers", "operationId": "UserassignedCustomers", "parameters": [ { "name": "pageNo", "in": "query", "description": "page number", "required": true, "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32", "example": 1 } }, { "name": "limit", "in": "query", "description": "max number of entries to be returned", "required": true, "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32", "example": 2 } }, { "name": "sortBy", "in": "query", "description": "sort by fields, allowed values \ncreatedAt, organizationName", "required": true, "style": "form", "explode": true, "schema": { "type": "string", "example": "-createdAt,+organizationName" } }, { "name": "uowId", "in": "query", "description": "customers assigned to user organization workspace id", "required": true, "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32", "example": 166 } }, { "name": "X-IAA-OW-ID", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32", "example": 2 } }, { "name": "Authorization", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "{{bearer_token}}" } } ], "responses": { "200": { "description": "OK", "headers": { }, "content": { "application/json": { "schema": { "title": "200OK7", "required": [ "success", "data" ], "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "title": "Data39", "required": [ "data", "totalRecords", "filteredRecords" ], "type": "object", "properties": { "data": { "type": "array", "items": { "title": "Data40", "required": [ "owId", "organizationName", "createdAt", "contactPersonName", "contactPersonEmail" ], "type": "object", "properties": { "owId": { "type": "integer", "format": "int32" }, "organizationName": { "type": "string" }, "createdAt": { "type": "integer", "format": "int64" }, "contactPersonName": { "type": "string" }, "contactPersonEmail": { "type": "string" } }, "example": { "owId": 58, "organizationName": "Amul", "createdAt": 1629361572000, "contactPersonName": "Amul", "contactPersonEmail": "pratik.t+nonihp@iqm.com" } }, "description": "" }, "totalRecords": { "type": "integer", "format": "int32" }, "filteredRecords": { "type": "integer", "format": "int32" } }, "example": { "data": [ { "owId": 58, "organizationName": "Amul", "createdAt": 1629361572000, "contactPersonName": "Amul", "contactPersonEmail": "pratik.t+nonihp@iqm.com" }, { "owId": 169, "organizationName": "Volkswagen India", "createdAt": 1629346722000, "contactPersonName": "Volkswagen India", "contactPersonEmail": "shraddha.p+vw@iqm.com" } ], "totalRecords": 3, "filteredRecords": 2 } } }, "example": { "success": true, "data": { "data": [ { "owId": 58, "organizationName": "Amul", "createdAt": 1629361572000, "contactPersonName": "Amul", "contactPersonEmail": "pratik.t+nonihp@iqm.com" }, { "owId": 169, "organizationName": "Volkswagen India", "createdAt": 1629346722000, "contactPersonName": "Volkswagen India", "contactPersonEmail": "shraddha.p+vw@iqm.com" } ], "totalRecords": 3, "filteredRecords": 2 } } }, "example": { "success": true, "data": { "data": [ { "owId": 58, "organizationName": "Amul", "createdAt": 1629361572000, "contactPersonName": "Amul", "contactPersonEmail": "pratik.t+nonihp@iqm.com" }, { "owId": 169, "organizationName": "Volkswagen India", "createdAt": 1629346722000, "contactPersonName": "Volkswagen India", "contactPersonEmail": "shraddha.p+vw@iqm.com" } ], "totalRecords": 3, "filteredRecords": 2 } } } } } }, "deprecated": false, "security": [], "servers": [ { "url": "http://example.com", "variables": { } } ] } }, "/api/v3/ua/user/remaining-customers": { "get": { "tags": [ "User Management API" ], "summary": "User's remaining Customers", "operationId": "User'sremainingCustomers", "parameters": [ { "name": "pageNo", "in": "query", "description": "", "required": true, "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32", "example": 1 } }, { "name": "sortBy", "in": "query", "description": "Sort by field allowed values organizationName, contactPersonName", "required": true, "style": "form", "explode": true, "schema": { "type": "string", "example": "+organizationName" } }, { "name": "searchField", "in": "query", "description": "", "required": true, "style": "form", "explode": true, "schema": { "type": "string", "example": "mult" } }, { "name": "uowId", "in": "query", "description": "", "required": true, "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32", "example": 166 } }, { "name": "limit", "in": "query", "description": "", "required": true, "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32", "example": 20 } }, { "name": "owIds", "in": "query", "description": "", "required": true, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "{{bearer_token}}" } }, { "name": "X-IAA-OW-ID", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32", "example": 2 } } ], "responses": { "200": { "description": "OK", "headers": { }, "content": { "application/json": { "schema": { "title": "200OK8", "required": [ "success", "data" ], "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "title": "Data41", "required": [ "data", "totalRecords", "filteredRecords" ], "type": "object", "properties": { "data": { "type": "array", "items": { "title": "Data42", "required": [ "owId", "organizationName", "createdAt", "balance", "contactPersonName", "contactPersonEmail", "logoUrl", "activeCampaignsCount" ], "type": "object", "properties": { "owId": { "type": "integer", "format": "int32" }, "organizationName": { "type": "string" }, "createdAt": { "type": "integer", "format": "int64" }, "balance": { "type": "integer", "format": "int32" }, "contactPersonName": { "type": "string" }, "contactPersonEmail": { "type": "string" }, "logoUrl": { "type": "string" }, "activeCampaignsCount": { "type": "integer", "format": "int32" } }, "example": { "owId": 169, "organizationName": "Volkswagen India", "createdAt": 1629346722000, "balance": 0, "contactPersonName": "Volkswagen India", "contactPersonEmail": "shraddha.p+vw@iqm.com", "logoUrl": "https://d3jme5si7t6llb.cloudfront.net/logo/iqm.png", "activeCampaignsCount": 0 } }, "description": "" }, "totalRecords": { "type": "integer", "format": "int32" }, "filteredRecords": { "type": "integer", "format": "int32" } }, "example": { "data": [ { "owId": 169, "organizationName": "Volkswagen India", "createdAt": 1629346722000, "balance": 0, "contactPersonName": "Volkswagen India", "contactPersonEmail": "shraddha.p+vw@iqm.com", "logoUrl": "https://d3jme5si7t6llb.cloudfront.net/logo/iqm.png", "activeCampaignsCount": 0 }, { "owId": 170, "organizationName": "Coca-Cola", "createdAt": 1629346703000, "balance": 0, "contactPersonName": "Coca-Cola", "contactPersonEmail": "shraddha.p+cc@iqm.com", "logoUrl": "https://d3jme5si7t6llb.cloudfront.net/logo/iqm.png", "activeCampaignsCount": 0 } ], "totalRecords": 2, "filteredRecords": 2 } } }, "example": { "success": true, "data": { "data": [ { "owId": 169, "organizationName": "Volkswagen India", "createdAt": 1629346722000, "balance": 0, "contactPersonName": "Volkswagen India", "contactPersonEmail": "shraddha.p+vw@iqm.com", "logoUrl": "https://d3jme5si7t6llb.cloudfront.net/logo/iqm.png", "activeCampaignsCount": 0 }, { "owId": 170, "organizationName": "Coca-Cola", "createdAt": 1629346703000, "balance": 0, "contactPersonName": "Coca-Cola", "contactPersonEmail": "shraddha.p+cc@iqm.com", "logoUrl": "https://d3jme5si7t6llb.cloudfront.net/logo/iqm.png", "activeCampaignsCount": 0 } ], "totalRecords": 2, "filteredRecords": 2 } } }, "example": { "success": true, "data": { "data": [ { "owId": 169, "organizationName": "Volkswagen India", "createdAt": 1629346722000, "balance": 0, "contactPersonName": "Volkswagen India", "contactPersonEmail": "shraddha.p+vw@iqm.com", "logoUrl": "https://d3jme5si7t6llb.cloudfront.net/logo/iqm.png", "activeCampaignsCount": 0 }, { "owId": 170, "organizationName": "Coca-Cola", "createdAt": 1629346703000, "balance": 0, "contactPersonName": "Coca-Cola", "contactPersonEmail": "shraddha.p+cc@iqm.com", "logoUrl": "https://d3jme5si7t6llb.cloudfront.net/logo/iqm.png", "activeCampaignsCount": 0 } ], "totalRecords": 2, "filteredRecords": 2 } } } } } }, "deprecated": false, "security": [], "servers": [ { "url": "http://example.com", "variables": { } } ] } }, "/api/v3/ua/user/customer/assign": { "post": { "tags": [ "User Management API" ], "summary": "Assign Customers to User", "operationId": "AssignCustomerstoUser", "parameters": [ { "name": "X-IAA-OW-ID", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32", "example": 2 } }, { "name": "Authorization", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "{{bearer_token}}" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "title": "AssignCustomerstoUserRequest", "required": [ "owIds", "uowIds" ], "type": "object", "properties": { "owIds": { "type": "string" }, "uowIds": { "type": "string" } }, "example": { "owIds": "170,58,167,900", "uowIds": "166" } }, "example": { "owIds": "170,58,167,900", "uowIds": "166" } } }, "required": true }, "responses": { "200": { "description": "OK", "headers": { }, "content": { "application/json": { "schema": { "title": "200OK-successfalse", "required": [ "success", "errorObjects", "data" ], "type": "object", "properties": { "success": { "type": "boolean" }, "errorObjects": { "type": "array", "items": { "title": "ErrorObject2", "required": [ "error" ], "type": "object", "properties": { "error": { "type": "string" } }, "example": { "error": "Only active invitations can be cancelled." } }, "description": "" }, "data": { "title": "Data43", "required": [ "successfulCustomerIds" ], "type": "object", "properties": { "successfulCustomerIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "" } }, "example": { "successfulCustomerIds": [58] } } }, "example": { "success": false, "errorObjects": [ { "error": "Customer with ids 900, 167 do not belong to logged in organization workspace." }, { "error": "Customer with ids 170 are already assigned to the User." } ], "data": { "successfulCustomerIds": [58] } } }, "example": { "success": false, "errorObjects": [ { "error": "Customer with ids 900, 167 do not belong to logged in organization workspace." }, { "error": "Customer with ids 170 are already assigned to the User." } ], "data": { "successfulCustomerIds": [58] } } } } }, "422": { "description": "Unprocessable Entity (WebDAV) (RFC 4918)", "headers": { }, "content": { "application/json": { "schema": { "title": "422-UnprocessableEntity1", "required": [ "success", "errorObjects" ], "type": "object", "properties": { "success": { "type": "boolean" }, "errorObjects": { "type": "array", "items": { "title": "ErrorObject2", "required": [ "error" ], "type": "object", "properties": { "error": { "type": "string" } }, "example": { "error": "Only active invitations can be cancelled." } }, "description": "" } }, "example": { "success": false, "errorObjects": [ { "error": "Please pass only one User ID for processing" } ] } }, "example": { "success": false, "errorObjects": [ { "error": "Please pass only one User ID for processing" } ] } } } }, "default": { "description": "", "headers": { }, "content": { "application/json": { "schema": { "title": "200OK-successtrue", "required": [ "success", "errorObjects", "data" ], "type": "object", "properties": { "success": { "type": "boolean" }, "errorObjects": { "type": "array", "items": { "type": "string" }, "description": "" }, "data": { "title": "Data43", "required": [ "successfulCustomerIds" ], "type": "object", "properties": { "successfulCustomerIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "" } }, "example": { "successfulCustomerIds": [58] } } }, "example": { "success": true, "errorObjects": [], "data": { "successfulCustomerIds": [58] } } }, "example": { "success": true, "errorObjects": [], "data": { "successfulCustomerIds": [58] } } } } } }, "deprecated": false, "security": [], "servers": [ { "url": "http://example.com", "variables": { } } ] } }, "/api/v3/ua/user/customer/remove": { "post": { "tags": [ "User Management API" ], "summary": "De-assign Customer From User", "operationId": "De-assignCustomerFromUser", "parameters": [ { "name": "Authorization", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "{{bearer_token}}" } }, { "name": "X-Iaa-Host", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32", "example": 2 } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "title": "De-assignCustomerFromUserRequest", "required": [ "owIds", "uowIds" ], "type": "object", "properties": { "owIds": { "type": "string" }, "uowIds": { "type": "string" } }, "example": { "owIds": "58", "uowIds": "166" } }, "example": { "owIds": "58", "uowIds": "166" } } }, "required": true }, "responses": { "200": { "description": "OK", "headers": { }, "content": { "application/json": { "schema": { "title": "200OK", "required": [ "success", "data" ], "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "string" } }, "example": { "success": true, "data": "Invitation resent successfully." } }, "example": { "success": true, "data": "Removed Customer association from User successfully." } } } }, "422": { "description": "Unprocessable Entity (WebDAV) (RFC 4918)", "headers": { }, "content": { "application/json": { "schema": { "title": "422UnprocessableEntity-22", "required": [ "success", "errorObjects" ], "type": "object", "properties": { "success": { "type": "boolean" }, "errorObjects": { "type": "array", "items": { "title": "ErrorObject2", "required": [ "error" ], "type": "object", "properties": { "error": { "type": "string" } }, "example": { "error": "Only active invitations can be cancelled." } }, "description": "" } }, "example": { "success": false, "errorObjects": [ { "error": "Customer with ids 900 do not belong to logged in organization workspace." } ] } }, "example": { "success": false, "errorObjects": [ { "error": "Customer with ids 900 do not belong to logged in organization workspace." } ] } } } }, "default": { "description": "", "headers": { }, "content": { "application/json": { "schema": { "title": "422-UnprocessableEntity2", "required": [ "success", "errorObjects" ], "type": "object", "properties": { "success": { "type": "boolean" }, "errorObjects": { "type": "array", "items": { "title": "ErrorObject2", "required": [ "error" ], "type": "object", "properties": { "error": { "type": "string" } }, "example": { "error": "Only active invitations can be cancelled." } }, "description": "" } }, "example": { "success": false, "errorObjects": [ { "error": "Please pass only one Customer ID for processing" } ] } }, "example": { "success": false, "errorObjects": [ { "error": "Please pass only one Customer ID for processing" } ] } } } } }, "deprecated": false, "security": [], "servers": [ { "url": "http://example.com", "variables": { } } ] } }, "/api/v3/ua/user/applications/list": { "get": { "tags": [ "User Management API" ], "summary": "Get User Application access list", "operationId": "GetUserApplicationaccesslist", "parameters": [ { "name": "uowId", "in": "query", "description": "uow id of selected user", "required": true, "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32", "example": 495 } }, { "name": "searchField", "in": "query", "description": "(Optional) Search keyword", "required": true, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "pageNo", "in": "query", "description": "(Optional) Page Number (default - 1)", "required": true, "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32", "example": 1 } }, { "name": "limit", "in": "query", "description": "(Optional) Page size (default - 10)", "required": true, "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32", "example": 10 } }, { "name": "sortBy", "in": "query", "description": "(Optional) Sort by fields (default : +appName)\nHere minus(-) sign is for order DESC and plus(+) sign for order ASC.\nValue can be from appName, appType.", "required": true, "style": "form", "explode": true, "schema": { "type": "string", "example": "+appName" } }, { "name": "X-IAA-OW-ID", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32", "example": 200422 } }, { "name": "Authorization", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "{{bearer_token}}" } } ], "responses": { "200": { "description": "OK", "headers": { }, "content": { "application/json": { "schema": { "title": "SuccessResponse200OK28", "required": [ "success", "data" ], "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "title": "Data54", "required": [ "data", "totalRecords", "filteredRecords" ], "type": "object", "properties": { "data": { "type": "array", "items": { "title": "Data55", "required": [ "appId", "appName", "appOwner", "appType" ], "type": "object", "properties": { "appId": { "type": "integer", "format": "int32" }, "appName": { "type": "string" }, "appOwner": { "type": "string" }, "appType": { "type": "string" } }, "example": { "appId": 7, "appName": "Campaigns", "appOwner": "IQM Corporation", "appType": "Default App" } }, "description": "" }, "totalRecords": { "type": "integer", "format": "int32" }, "filteredRecords": { "type": "integer", "format": "int32" } }, "example": { "data": [ { "appId": 7, "appName": "Campaigns", "appOwner": "IQM Corporation", "appType": "Default App" }, { "appId": 11, "appName": "Conversions", "appOwner": "IQM Corporation", "appType": "Default App" } ], "totalRecords": 2, "filteredRecords": 2 } } }, "example": { "success": true, "data": { "data": [ { "appId": 7, "appName": "Campaigns", "appOwner": "IQM Corporation", "appType": "Default App" }, { "appId": 11, "appName": "Conversions", "appOwner": "IQM Corporation", "appType": "Default App" } ], "totalRecords": 2, "filteredRecords": 2 } } }, "example": { "success": true, "data": { "data": [ { "appId": 7, "appName": "Campaigns", "appOwner": "IQM Corporation", "appType": "Default App" }, { "appId": 11, "appName": "Conversions", "appOwner": "IQM Corporation", "appType": "Default App" } ], "totalRecords": 2, "filteredRecords": 2 } } } } }, "422": { "description": "Unprocessable Entity (WebDAV) (RFC 4918)", "headers": { }, "content": { "application/json": { "schema": { "title": "InvalidsortByvalue422UnprocessableEntity1", "required": [ "success", "errorObjects" ], "type": "object", "properties": { "success": { "type": "boolean" }, "errorObjects": { "type": "array", "items": { "title": "ErrorObject2", "required": [ "error" ], "type": "object", "properties": { "error": { "type": "string" } }, "example": { "error": "Only active invitations can be cancelled." } }, "description": "" } }, "example": { "success": false, "errorObjects": [ { "error": "Invalid sortBy value." } ] } }, "example": { "success": false, "errorObjects": [ { "error": "Invalid sortBy value." } ] } } } } }, "deprecated": false, "security": [], "servers": [ { "url": "http://example.com", "variables": { } } ] } }, "/api/v3/ua/user/remaining-applications": { "get": { "tags": [ "User Management API" ], "summary": "User's remaining application list", "operationId": "User'sremainingapplicationlist", "parameters": [ { "name": "uowId", "in": "query", "description": "uow Id of selected user", "required": true, "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32", "example": 1 } }, { "name": "X-IAA-OW-ID", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32", "example": 200002 } }, { "name": "Authorization", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "{{bearer_token}}" } } ], "responses": { "200": { "description": "OK", "headers": { }, "content": { "application/json": { "schema": { "title": "SuccessResponse200OK29", "required": [ "success", "data" ], "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "array", "items": { "title": "Data56", "required": [ "appId", "appName", "appOwner" ], "type": "object", "properties": { "appId": { "type": "integer", "format": "int32" }, "appName": { "type": "string" }, "appOwner": { "type": "string" } }, "example": { "appId": 6, "appName": "Accounts", "appOwner": "IHB" } }, "description": "" } }, "example": { "success": true, "data": [ { "appId": 6, "appName": "Accounts", "appOwner": "IHB" }, { "appId": 8, "appName": "Audiences", "appOwner": "IQM Corporation" }, { "appId": 4, "appName": "Bid Model", "appOwner": "IHB" }, { "appId": 7, "appName": "Campaigns", "appOwner": "IQM Corporation" }, { "appId": 11, "appName": "Conversions", "appOwner": "IQM Corporation" }, { "appId": 9, "appName": "Creatives", "appOwner": "IQM Corporation" }, { "appId": 2, "appName": "Dashboard", "appOwner": "IHB" }, { "appId": 10, "appName": "Inventory", "appOwner": "IQM Corporation" }, { "appId": 5, "appName": "Organization", "appOwner": "IHB" }, { "appId": 3, "appName": "Reports", "appOwner": "IHB" } ] } }, "example": { "success": true, "data": [ { "appId": 6, "appName": "Accounts", "appOwner": "IHB" }, { "appId": 8, "appName": "Audiences", "appOwner": "IQM Corporation" }, { "appId": 4, "appName": "Bid Model", "appOwner": "IHB" }, { "appId": 7, "appName": "Campaigns", "appOwner": "IQM Corporation" }, { "appId": 11, "appName": "Conversions", "appOwner": "IQM Corporation" }, { "appId": 9, "appName": "Creatives", "appOwner": "IQM Corporation" }, { "appId": 2, "appName": "Dashboard", "appOwner": "IHB" }, { "appId": 10, "appName": "Inventory", "appOwner": "IQM Corporation" }, { "appId": 5, "appName": "Organization", "appOwner": "IHB" }, { "appId": 3, "appName": "Reports", "appOwner": "IHB" } ] } } } } }, "deprecated": false, "security": [], "servers": [ { "url": "http://example.com", "variables": { } } ] } }, "/api/v3/ua/user/reset-password": { "post": { "tags": [ "User Management API" ], "summary": "Reset Password Email", "operationId": "ResetPasswordEmail", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "title": "ResetPasswordEmailRequest", "required": [ "email" ], "type": "object", "properties": { "email": { "type": "string" } }, "example": { "email": "kartik@iqm.com" } }, "example": { "email": "kartik@iqm.com" } } }, "required": true }, "responses": { "200": { "description": "OK", "headers": { }, "content": { "application/json": { "schema": { "title": "SuccessResponse200OK", "required": [ "success", "data" ], "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "string" } }, "example": { "success": true, "data": "Invitation cancelled successfully." } }, "example": { "success": true, "data": "Email with reset password link sent successfully." } } } }, "404": { "description": "Not Found", "headers": { }, "content": { "application/json": { "schema": { "title": "Usernotfound1", "required": [ "success", "errorObjects" ], "type": "object", "properties": { "success": { "type": "boolean" }, "errorObjects": { "type": "array", "items": { "title": "ErrorObject2", "required": [ "error" ], "type": "object", "properties": { "error": { "type": "string" } }, "example": { "error": "Only active invitations can be cancelled." } }, "description": "" } }, "example": { "success": false, "errorObjects": [ { "error": "The email is not available in the system." } ] } }, "example": { "success": false, "errorObjects": [ { "error": "The email is not available in the system." } ] } } } } }, "deprecated": false, "servers": [ { "url": "http://example.com", "variables": { } } ], "security": [] } }, "/api/v3/ua/user/update-profile": { "patch": { "tags": [ "User Management API" ], "summary": "Update User Profile", "operationId": "UpdateUserProfile", "parameters": [ { "name": "X-IAA-OW-ID", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32", "example": 200422 } }, { "name": "Authorization", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "{{bearer_token}}" } } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { }, "schema": { "required": [ "displayName", "userAvatar", "removeUserProfile" ], "type": "object", "properties": { "displayName": { "type": "string", "description": "User name", "example": "JP orguser1" }, "userAvatar": { "type": "string", "description": "(Optional) Image file uploaded for profile" }, "removeUserProfile": { "type": "boolean", "description": "(Optional) default:- false\nTo remove profile image, set true", "example": false } } } } }, "required": false }, "responses": { "200": { "description": "OK", "headers": { }, "content": { "application/json": { "schema": { "title": "SuccessResponse200OK31", "required": [ "success", "data" ], "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "title": "Data57", "required": [ "userAvatar", "message" ], "type": "object", "properties": { "userAvatar": { "type": "string" }, "message": { "type": "string" } }, "example": { "userAvatar": "https://iqm-web-assets-c92d6b6cbde1-stage.s3.amazonaws.com/user-profile/444.jpg", "message": "Profile updated successfully." } } }, "example": { "success": true, "data": { "userAvatar": "https://iqm-web-assets-c92d6b6cbde1-stage.s3.amazonaws.com/user-profile/444.jpg", "message": "Profile updated successfully." } } }, "example": { "success": true, "data": { "userAvatar": "https://iqm-web-assets-c92d6b6cbde1-stage.s3.amazonaws.com/user-profile/444.jpg", "message": "Profile updated successfully." } } } } }, "422": { "description": "Unprocessable Entity (WebDAV) (RFC 4918)", "headers": { }, "content": { "application/json": { "schema": { "title": "ProfileImagetooLarge422UnprocessableEntity1", "required": [ "success", "errorObjects" ], "type": "object", "properties": { "success": { "type": "boolean" }, "errorObjects": { "type": "array", "items": { "title": "ErrorObject2", "required": [ "error" ], "type": "object", "properties": { "error": { "type": "string" } }, "example": { "error": "Only active invitations can be cancelled." } }, "description": "" } }, "example": { "success": false, "errorObjects": [ { "error": "Profile image should not be more than 3 MB" } ] } }, "example": { "success": false, "errorObjects": [ { "error": "Profile image should not be more than 3 MB" } ] } } } } }, "deprecated": false, "security": [], "servers": [ { "url": "http://example.com", "variables": { } } ] } }, "/api/v3/ua/organization/update-profile": { "patch": { "tags": [ "User Management API" ], "summary": "Update Organization profile", "operationId": "UpdateOrganizationprofile", "parameters": [ { "name": "X-IAA-OW-ID", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32", "example": 200422 } }, { "name": "Authorization", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "{{bearer_token}}" } } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { }, "schema": { "required": [ "organizationName", "email", "website", "contactNumber", "address", "city", "state", "country", "zipcode", "industry", "companySize", "companyId", "taxId", "currency", "dateFormat", "expertize", "description", "organizationLogo", "removeOrganizationLogo" ], "type": "object", "properties": { "organizationName": { "type": "string", "description": "Organization name", "example": "JP test org1" }, "email": { "type": "string", "description": "Organization email", "example": "jinesh.p+jptest1@iqm.com" }, "website": { "type": "string", "description": "Organizaiton website", "example": "www.jptest1.com" }, "contactNumber": { "type": "string", "description": "Contact number", "example": "+91 123987456" }, "address": { "type": "string", "description": "Organization address", "example": "A-123, ABC complex" }, "city": { "type": "string", "description": "City", "example": "Ahmedabad" }, "state": { "type": "integer", "description": "state id", "format": "int32", "example": 1672 }, "country": { "type": "integer", "description": "country id", "format": "int32", "example": 113 }, "zipcode": { "type": "integer", "description": "zipcode", "format": "int32", "example": 382418 }, "industry": { "type": "string", "description": "Industry", "example": "Advertising" }, "companySize": { "type": "integer", "description": "company size id from company size static API", "format": "int32", "example": 2 }, "companyId": { "type": "string", "description": "Company ID", "example": "A-123456" }, "taxId": { "type": "string", "description": "Tax ID", "example": "JP123456" }, "currency": { "type": "string", "description": "Company currency", "example": "Dollar ($)" }, "dateFormat": { "type": "string", "description": "Date format", "example": "DD/MM/YYYY" }, "expertize": { "type": "string", "description": "comma separated ids of expertize from organization-expertize static API", "example": "1,2,3" }, "description": { "type": "string", "description": "Organization description" }, "organizationLogo": { "type": "string", "description": "organization profile image" }, "removeOrganizationLogo": { "type": "boolean", "description": "(Optional) default:- false\nTo remove profile image, set true", "example": false } } } } }, "required": false }, "responses": { "200": { "description": "OK", "headers": { }, "content": { "application/json": { "schema": { "title": "SuccessResponse200OK32", "required": [ "success", "data" ], "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "title": "Data58", "required": [ "organizationLogo", "message" ], "type": "object", "properties": { "organizationLogo": { "type": "string" }, "message": { "type": "string" } }, "example": { "organizationLogo": "https://iqm-web-assets-c92d6b6cbde1-stage.s3.amazonaws.com/organization-profile/391/1633180356403.png", "message": "Profile updated successfully." } } }, "example": { "success": true, "data": { "organizationLogo": "https://iqm-web-assets-c92d6b6cbde1-stage.s3.amazonaws.com/organization-profile/391/1633180356403.png", "message": "Profile updated successfully." } } }, "example": { "success": true, "data": { "organizationLogo": "https://iqm-web-assets-c92d6b6cbde1-stage.s3.amazonaws.com/organization-profile/391/1633180356403.png", "message": "Profile updated successfully." } } } } } }, "deprecated": false, "security": [], "servers": [ { "url": "http://example.com", "variables": { } } ] } }, "/api/v3/ua/user/current-password/validate": { "post": { "tags": [ "User Management API" ], "summary": "Validate User's current password", "operationId": "ValidateUser'scurrentpassword", "parameters": [ { "name": "X-IAA-OW-ID", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32", "example": 200422 } }, { "name": "Authorization", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "{{bearer_token}}" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "title": "ValidateUserscurrentpasswordRequest", "required": [ "password" ], "type": "object", "properties": { "password": { "type": "string" } }, "example": { "password": "123456" } }, "example": { "password": "123456" } } }, "required": true }, "responses": { "200": { "description": "OK", "headers": { }, "content": { "application/json": { "schema": { "title": "Passwordnotmatched200OK", "required": [ "success", "data" ], "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "title": "Data4", "required": [ "isValid" ], "type": "object", "properties": { "isValid": { "type": "boolean" } }, "example": { "isValid": true } } }, "example": { "success": true, "data": { "isValid": false } } }, "example": { "success": true, "data": { "isValid": false } } } } } }, "deprecated": false, "security": [], "servers": [ { "url": "http://example.com", "variables": { } } ] } }, "/api/v3/ua/user/password/reset": { "post": { "tags": [ "User Management API" ], "summary": "Reset User password", "operationId": "ResetUserpassword", "parameters": [ { "name": "X-IAA-OW-ID", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32", "example": 200422 } }, { "name": "Authorization", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "{{bearer_token}}" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "title": "ResetUserpasswordRequest", "required": [ "oldPassword", "newPassword" ], "type": "object", "properties": { "oldPassword": { "type": "string" }, "newPassword": { "type": "string" } }, "example": { "oldPassword": "123456", "newPassword": "123456789" } }, "example": { "oldPassword": "123456", "newPassword": "123456789" } } }, "required": true }, "responses": { "200": { "description": "OK", "headers": { }, "content": { "application/json": { "schema": { "title": "SuccessMessage200OK", "required": [ "success", "data" ], "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "string" } }, "example": { "success": true, "data": "Password reset successfully." } }, "example": { "success": true, "data": "Password reset successfully." } } } }, "422": { "description": "Unprocessable Entity (WebDAV) (RFC 4918)", "headers": { }, "content": { "application/json": { "schema": { "title": "Invalidoldpassword422UnprocessableEntity1", "required": [ "success", "errorObjects" ], "type": "object", "properties": { "success": { "type": "boolean" }, "errorObjects": { "type": "array", "items": { "title": "ErrorObject2", "required": [ "error" ], "type": "object", "properties": { "error": { "type": "string" } }, "example": { "error": "Only active invitations can be cancelled." } }, "description": "" } }, "example": { "success": false, "errorObjects": [ { "error": "Invalid old password." } ] } }, "example": { "success": false, "errorObjects": [ { "error": "Invalid old password." } ] } } } } }, "deprecated": false, "security": [], "servers": [ { "url": "http://example.com", "variables": { } } ] } }, "/api/v3/ua/organization/payment-settings": { "get": { "tags": [ "User Management API" ], "summary": "Add/Update organization payment settings", "operationId": "Add/Updateorganizationpaymentsettings", "parameters": [ { "name": "X-IAA-OW-ID", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32", "example": 200422 } }, { "name": "Authorization", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "{{bearer_token}}" } } ], "responses": { "200": { "description": "OK", "headers": { }, "content": { "application/json": { "schema": { "title": "SuccessResponse200OK", "required": [ "success", "data" ], "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "string" } }, "example": { "success": true, "data": "Invitation cancelled successfully." } }, "example": { "success": true, "data": "Organization payment settings updated successfully." } } } } }, "deprecated": false, "security": [], "servers": [ { "url": "http://example.com", "variables": { } } ] } }, "/api/v3/ua/organization/update-email": { "patch": { "tags": [ "User Management API" ], "summary": "Add/Update organization support email", "operationId": "Add/Updateorganizationsupportemail", "parameters": [ { "name": "X-IAA-OW-ID", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32", "example": 200422 } }, { "name": "Authorization", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "{{bearer_token}}" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "title": "AddUpdateorganizationsupportemailRequest", "required": [ "email" ], "type": "object", "properties": { "email": { "type": "string" } }, "example": { "email": "jinesh.p+support@iqm.com" } }, "example": { "email": "jinesh.p+support@iqm.com" } } }, "required": true }, "responses": { "200": { "description": "OK", "headers": { }, "content": { "application/json": { "schema": { "title": "SuccessResponse200OK34", "required": [ "success", "data" ], "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "title": "Data62", "required": [ "isVerified", "message" ], "type": "object", "properties": { "isVerified": { "type": "boolean" }, "message": { "type": "string" } }, "example": { "isVerified": false, "message": "Organization email updated successfully." } } }, "example": { "success": true, "data": { "isVerified": false, "message": "Organization email updated successfully." } } }, "example": { "success": true, "data": { "isVerified": false, "message": "Organization email updated successfully." } } } } } }, "deprecated": false, "security": [], "servers": [ { "url": "http://example.com", "variables": { } } ] } }, "/api/v3/ua/organization/whitelabel-domain": { "post": { "tags": [ "User Management API" ], "summary": "Add/Update whitelabel domain", "operationId": "Add/Updatewhitelabeldomain", "parameters": [ { "name": "X-IAA-OW-ID", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32", "example": 200422 } }, { "name": "Authorization", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "{{bearer_token}}" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "title": "AddUpdatewhitelabeldomainRequest", "required": [ "whitelabelDomain" ], "type": "object", "properties": { "whitelabelDomain": { "type": "string" } }, "example": { "whitelabelDomain": "app.stage.iqm.com" } }, "example": { "whitelabelDomain": "app.stage.iqm.com" } } }, "required": true }, "responses": { "200": { "description": "OK", "headers": { }, "content": { "application/json": { "schema": { "title": "SuccessResponse200OK", "required": [ "success", "data" ], "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "string" } }, "example": { "success": true, "data": "Invitation cancelled successfully." } }, "example": { "success": true, "data": "domain added successfully" } } } }, "403": { "description": "Forbidden", "headers": { }, "content": { "application/json": { "schema": { "title": "Workspacedomainandwhitelabeldomaincanntbesame403Forbidden1", "required": [ "success", "errorObjects" ], "type": "object", "properties": { "success": { "type": "boolean" }, "errorObjects": { "type": "array", "items": { "title": "ErrorObject2", "required": [ "error" ], "type": "object", "properties": { "error": { "type": "string" } }, "example": { "error": "Only active invitations can be cancelled." } }, "description": "" } }, "example": { "success": false, "errorObjects": [ { "error": "Workspace domain and White label URL can not be same." } ] } }, "example": { "success": false, "errorObjects": [ { "error": "Workspace domain and White label URL can not be same." } ] } } } } }, "deprecated": false, "security": [], "servers": [ { "url": "http://example.com", "variables": { } } ] }, "delete": { "tags": [ "User Management API" ], "summary": "Add/Update whitelabel domain Copy", "operationId": "Add/UpdatewhitelabeldomainCopy", "parameters": [ { "name": "X-IAA-OW-ID", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32", "example": 200422 } }, { "name": "Authorization", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "{{bearer_token}}" } } ], "responses": { "200": { "description": "OK", "headers": { }, "content": { "application/json": { "schema": { "title": "SuccessResponse200OK", "required": [ "success", "data" ], "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "string" } }, "example": { "success": true, "data": "Invitation cancelled successfully." } }, "example": { "success": true, "data": "Domain removed successfully." } } } }, "403": { "description": "Forbidden", "headers": { }, "content": { "application/json": { "schema": { "title": "Notallowedtoaddwhitelabeldomain403Forbidden1", "required": [ "success", "errorObjects" ], "type": "object", "properties": { "success": { "type": "boolean" }, "errorObjects": { "type": "array", "items": { "title": "ErrorObject2", "required": [ "error" ], "type": "object", "properties": { "error": { "type": "string" } }, "example": { "error": "Only active invitations can be cancelled." } }, "description": "" } }, "example": { "success": false, "errorObjects": [ { "error": "You are not allowed to add white label domain." } ] } }, "example": { "success": false, "errorObjects": [ { "error": "You are not allowed to remove white label domain." } ] } } } } }, "deprecated": false, "security": [], "servers": [ { "url": "http://example.com", "variables": { } } ] } }, "/api/v3/ua/organization/verify-whitelabel-domain": { "get": { "tags": [ "User Management API" ], "summary": "Verify White-Label domain", "operationId": "VerifyWhite-Labeldomain", "parameters": [ { "name": "X-IAA-OW-ID", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32", "example": 200422 } }, { "name": "Authorization", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "{{bearer_token}}" } } ], "responses": { "200": { "description": "OK", "headers": { }, "content": { "application/json": { "schema": { "title": "SuccessResponse200OK37", "required": [ "success", "data" ], "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "title": "Data63", "required": [ "isVerified" ], "type": "object", "properties": { "isVerified": { "type": "boolean" } }, "example": { "isVerified": true } } }, "example": { "success": true, "data": { "isVerified": true } } }, "example": { "success": true, "data": { "isVerified": true } } } } } }, "deprecated": false, "security": [], "servers": [ { "url": "http://example.com", "variables": { } } ] } }, "/api/v3/ua/organization/available-domain": { "get": { "tags": [ "User Management API" ], "summary": "Get available Domain", "operationId": "GetavailableDomain", "parameters": [ { "name": "workspaceSubDomain", "in": "query", "description": "", "required": true, "style": "form", "explode": true, "schema": { "type": "string", "example": "jptest" } }, { "name": "Authorization", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "{{bearer_token}}" } }, { "name": "X-IAA-OW-ID", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32", "example": 200422 } } ], "responses": { "200": { "description": "OK", "headers": { }, "content": { "application/json": { "schema": { "title": "SuccessResponse200OK38", "required": [ "success", "data" ], "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "title": "Data64", "required": [ "isAvailable" ], "type": "object", "properties": { "isAvailable": { "type": "boolean" } }, "example": { "isAvailable": true } } }, "example": { "success": true, "data": { "isAvailable": true } } }, "example": { "success": true, "data": { "isAvailable": true } } } } } }, "deprecated": false, "security": [], "servers": [ { "url": "http://example.com", "variables": { } } ] } }, "/api/v3/ua/organization/workspace-domain": { "patch": { "tags": [ "User Management API" ], "summary": "Update workspace domain", "operationId": "Updateworkspacedomain", "parameters": [ { "name": "Authorization", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "{{bearer_token}}" } }, { "name": "X-IAA-OW-ID", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32", "example": 200422 } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "title": "UpdateworkspacedomainRequest", "required": [ "workspaceSubDomain" ], "type": "object", "properties": { "workspaceSubDomain": { "type": "string" } }, "example": { "workspaceSubDomain": "jptest" } }, "example": { "workspaceSubDomain": "jptest" } } }, "required": true }, "responses": { "200": { "description": "OK", "headers": { }, "content": { "application/json": { "schema": { "title": "SuccessResponse200OK", "required": [ "success", "data" ], "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "string" } }, "example": { "success": true, "data": "Invitation cancelled successfully." } }, "example": { "success": true, "data": "Workspace domain update successfully." } } } }, "422": { "description": "Unprocessable Entity (WebDAV) (RFC 4918)", "headers": { }, "content": { "application/json": { "schema": { "title": "Workspacedomainalreadyexist422UnprocessableEntity1", "required": [ "success", "errorObjects" ], "type": "object", "properties": { "success": { "type": "boolean" }, "errorObjects": { "type": "array", "items": { "title": "ErrorObject2", "required": [ "error" ], "type": "object", "properties": { "error": { "type": "string" } }, "example": { "error": "Only active invitations can be cancelled." } }, "description": "" } }, "example": { "success": false, "errorObjects": [ { "error": "A workspace with this URL already exists, please try a different one" } ] } }, "example": { "success": false, "errorObjects": [ { "error": "A workspace with this URL already exists, please try a different one" } ] } } } } }, "deprecated": false, "security": [], "servers": [ { "url": "http://example.com", "variables": { } } ] } }, "/api/v3/ua/organization/whitelabel-settings": { "patch": { "tags": [ "User Management API" ], "summary": "Add/Update White label settings", "operationId": "Add/UpdateWhitelabelsettings", "parameters": [ { "name": "Authorization", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "{{bearer_token}}" } }, { "name": "X-IAA-OW-ID", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32", "example": 200422 } } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { }, "schema": { "required": [ "smallFavIcon", "largeFavIcon", "isIncludeOrganizationName", "landingPage", "headerUrls", "footerUrls", "removeSmallFavIcon", "removeLargeFavIcon", "removeLandingPage" ], "type": "object", "properties": { "smallFavIcon": { "type": "string", "description": "fav icon file for 256X256" }, "largeFavIcon": { "type": "string", "description": "fav icon file for 512X512" }, "isIncludeOrganizationName": { "type": "string" }, "landingPage": { "type": "string", "description": "landing page banner file" }, "headerUrls": { "type": "string", "description": "header urls json array with label and url" }, "footerUrls": { "type": "string", "description": "footer urls json array with label and url" }, "removeSmallFavIcon": { "type": "string", "description": "url for small fav icon to remove" }, "removeLargeFavIcon": { "type": "string", "description": "url for large fav icon to remove" }, "removeLandingPage": { "type": "string", "description": "url of landing page" } } } } }, "required": false }, "responses": { "200": { "description": "OK", "headers": { }, "content": { "application/json": { "schema": { "title": "SuccessResponse200OK", "required": [ "success", "data" ], "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "string" } }, "example": { "success": true, "data": "Invitation cancelled successfully." } }, "example": { "success": true, "data": "White label settings updated successfully." } } } } }, "deprecated": false, "security": [], "servers": [ { "url": "http://example.com", "variables": { } } ] }, "get": { "tags": [ "User Management API" ], "summary": "View White label settings", "operationId": "ViewWhitelabelsettings", "parameters": [ { "name": "Authorization", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "{{bearer_token}}" } }, { "name": "X-IAA-OW-ID", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32", "example": 200422 } } ], "responses": { "200": { "description": "OK", "headers": { }, "content": { "application/json": { "schema": { "title": "SuccessResponse200OK41", "required": [ "success", "data" ], "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "title": "Data65", "required": [ "whiteLabelSettings", "domainSettings", "emailSettings", "paymentSettings" ], "type": "object", "properties": { "whiteLabelSettings": { "title": "WhiteLabelSettings", "required": [ "favIcons", "landingPage", "headerUrls", "footerUrls", "includeOrganizationName" ], "type": "object", "properties": { "favIcons": { "title": "FavIcons", "required": [ "smallFavIcon", "largeFavIcon" ], "type": "object", "properties": { "smallFavIcon": { "type": "string" }, "largeFavIcon": { "type": "string" } }, "example": { "smallFavIcon": "https://iqm-web-assets-c92d6b6cbde1-stage.s3.amazonaws.com/whitelabel-settings/favicons/200422/1633694315391_small.png", "largeFavIcon": "https://iqm-web-assets-c92d6b6cbde1-stage.s3.amazonaws.com/whitelabel-settings/favicons/200422/1633694342195_large.png" } }, "landingPage": { "type": "string" }, "headerUrls": { "type": "array", "items": { "title": "HeaderUrl", "required": [ "label", "url" ], "type": "object", "properties": { "label": { "type": "string" }, "url": { "type": "string" } }, "example": { "label": "ECOSYSTEM", "url": "https://iqm.com/applications" } }, "description": "" }, "footerUrls": { "type": "array", "items": { "title": "FooterUrl", "required": [ "label", "url" ], "type": "object", "properties": { "label": { "type": "string" }, "url": { "type": "string" } }, "example": { "label": "Terms and Condition", "url": "https://iqm.com/terms-conditions" } }, "description": "" }, "includeOrganizationName": { "type": "boolean" } }, "example": { "favIcons": { "smallFavIcon": "https://iqm-web-assets-c92d6b6cbde1-stage.s3.amazonaws.com/whitelabel-settings/favicons/200422/1633694315391_small.png", "largeFavIcon": "https://iqm-web-assets-c92d6b6cbde1-stage.s3.amazonaws.com/whitelabel-settings/favicons/200422/1633694342195_large.png" }, "landingPage": "https://iqm-web-assets-c92d6b6cbde1-stage.s3.amazonaws.com/whitelabel-settings/landing-pages/200422/1634894513821_landing_page_banner.png", "headerUrls": [ { "label": "ECOSYSTEM", "url": "https://iqm.com/applications" }, { "label": "ABOUT", "url": "https://iqm.com/who-we-are" } ], "footerUrls": [ { "label": "Terms and Condition", "url": "https://iqm.com/terms-conditions" }, { "label": "Privacy Policy", "url": "https://iqm.com/privacy-policy" } ], "includeOrganizationName": true } }, "domainSettings": { "title": "DomainSettings", "required": [ "workspaceDomain", "isWhiteLabelEnable", "whiteLabelDomain", "isVerified" ], "type": "object", "properties": { "workspaceDomain": { "type": "string" }, "isWhiteLabelEnable": { "type": "boolean" }, "whiteLabelDomain": { "type": "string" }, "isVerified": { "type": "boolean" } }, "example": { "workspaceDomain": "jptest1.stage.inhousebuying.com", "isWhiteLabelEnable": true, "whiteLabelDomain": "jptest1.stage.iqm.com", "isVerified": true } }, "emailSettings": { "title": "EmailSettings", "required": [ "email", "unverifiedEmail" ], "type": "object", "properties": { "email": { "type": "string" }, "unverifiedEmail": { "type": "string" } }, "example": { "email": "no-reply-stage@inhousebuying.com", "unverifiedEmail": "jinesh.p+support@iqm.com" } }, "paymentSettings": { "title": "PaymentSettings", "required": [ "paypalAccountId" ], "type": "object", "properties": { "paypalAccountId": { "type": "string" } }, "example": { "paypalAccountId": "jptest1@paypal" } } }, "example": { "whiteLabelSettings": { "favIcons": { "smallFavIcon": "https://iqm-web-assets-c92d6b6cbde1-stage.s3.amazonaws.com/whitelabel-settings/favicons/200422/1633694315391_small.png", "largeFavIcon": "https://iqm-web-assets-c92d6b6cbde1-stage.s3.amazonaws.com/whitelabel-settings/favicons/200422/1633694342195_large.png" }, "landingPage": "https://iqm-web-assets-c92d6b6cbde1-stage.s3.amazonaws.com/whitelabel-settings/landing-pages/200422/1634894513821_landing_page_banner.png", "headerUrls": [ { "label": "ECOSYSTEM", "url": "https://iqm.com/applications" }, { "label": "ABOUT", "url": "https://iqm.com/who-we-are" } ], "footerUrls": [ { "label": "Terms and Condition", "url": "https://iqm.com/terms-conditions" }, { "label": "Privacy Policy", "url": "https://iqm.com/privacy-policy" } ], "includeOrganizationName": true }, "domainSettings": { "workspaceDomain": "jptest1.stage.inhousebuying.com", "isWhiteLabelEnable": true, "whiteLabelDomain": "jptest1.stage.iqm.com", "isVerified": true }, "emailSettings": { "email": "no-reply-stage@inhousebuying.com", "unverifiedEmail": "jinesh.p+support@iqm.com" }, "paymentSettings": { "paypalAccountId": "jptest1@paypal" } } } }, "example": { "success": true, "data": { "whiteLabelSettings": { "favIcons": { "smallFavIcon": "https://iqm-web-assets-c92d6b6cbde1-stage.s3.amazonaws.com/whitelabel-settings/favicons/200422/1633694315391_small.png", "largeFavIcon": "https://iqm-web-assets-c92d6b6cbde1-stage.s3.amazonaws.com/whitelabel-settings/favicons/200422/1633694342195_large.png" }, "landingPage": "https://iqm-web-assets-c92d6b6cbde1-stage.s3.amazonaws.com/whitelabel-settings/landing-pages/200422/1634894513821_landing_page_banner.png", "headerUrls": [ { "label": "ECOSYSTEM", "url": "https://iqm.com/applications" }, { "label": "ABOUT", "url": "https://iqm.com/who-we-are" } ], "footerUrls": [ { "label": "Terms and Condition", "url": "https://iqm.com/terms-conditions" }, { "label": "Privacy Policy", "url": "https://iqm.com/privacy-policy" } ], "includeOrganizationName": true }, "domainSettings": { "workspaceDomain": "jptest1.stage.inhousebuying.com", "isWhiteLabelEnable": true, "whiteLabelDomain": "jptest1.stage.iqm.com", "isVerified": true }, "emailSettings": { "email": "no-reply-stage@inhousebuying.com", "unverifiedEmail": "jinesh.p+support@iqm.com" }, "paymentSettings": { "paypalAccountId": "jptest1@paypal" } } } }, "example": { "success": true, "data": { "whiteLabelSettings": { "favIcons": { "smallFavIcon": "https://iqm-web-assets-c92d6b6cbde1-stage.s3.amazonaws.com/whitelabel-settings/favicons/200422/1633694315391_small.png", "largeFavIcon": "https://iqm-web-assets-c92d6b6cbde1-stage.s3.amazonaws.com/whitelabel-settings/favicons/200422/1633694342195_large.png" }, "landingPage": "https://iqm-web-assets-c92d6b6cbde1-stage.s3.amazonaws.com/whitelabel-settings/landing-pages/200422/1634894513821_landing_page_banner.png", "headerUrls": [ { "label": "ECOSYSTEM", "url": "https://iqm.com/applications" }, { "label": "ABOUT", "url": "https://iqm.com/who-we-are" } ], "footerUrls": [ { "label": "Terms and Condition", "url": "https://iqm.com/terms-conditions" }, { "label": "Privacy Policy", "url": "https://iqm.com/privacy-policy" } ], "includeOrganizationName": true }, "domainSettings": { "workspaceDomain": "jptest1.stage.inhousebuying.com", "isWhiteLabelEnable": true, "whiteLabelDomain": "jptest1.stage.iqm.com", "isVerified": true }, "emailSettings": { "email": "no-reply-stage@inhousebuying.com", "unverifiedEmail": "jinesh.p+support@iqm.com" }, "paymentSettings": { "paypalAccountId": "jptest1@paypal" } } } } } } }, "deprecated": false, "security": [], "servers": [ { "url": "http://example.com", "variables": { } } ] } }, "/api/v3/custom/ua/campaign/margin-list": { "get": { "tags": [ "User Management API" ], "summary": "Campaign Margin", "operationId": "CampaignMargin", "parameters": [ { "name": "campaignIds", "in": "query", "description": "", "required": true, "style": "form", "explode": true, "schema": { "type": "string", "example": "105508,503" } } ], "responses": { "200": { "description": "OK", "headers": { "X-Content-Type-Options": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "nosniff" } } }, "X-XSS-Protection": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "1; mode=block" } } }, "Cache-Control": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "no-cache, no-store, max-age=0, must-revalidate" } } }, "Pragma": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "no-cache" } } }, "Expires": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "0" } } }, "X-Frame-Options": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "DENY" } } }, "Transfer-Encoding": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "chunked" } } }, "Date": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "Tue, 12 Oct 2021 19:59:09 GMT" } } }, "Keep-Alive": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "timeout=60" } } }, "Connection": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "keep-alive" } } } }, "content": { "application/json": { "schema": { "title": "OK", "required": [ "success", "data" ], "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "additionalProperties": { "title": "m503", "required": [ "workspace", "organization" ], "type": "object", "properties": { "workspace": { "type": "integer", "format": "int32" }, "organization": { "type": "integer", "format": "int32" } }, "example": { "workspace": 0, "organization": 0 } } } }, "example": { "success": true, "data": { "503": { "workspace": 0, "organization": 0 }, "105508": { "ai_margin": 55, "workspace": 0, "organization": 12 } } } }, "example": { "success": true, "data": { "503": { "workspace": 0, "organization": 0 }, "105508": { "ai_margin": 55, "workspace": 0, "organization": 12 } } } } } } }, "deprecated": false, "servers": [ { "url": "http://example.com", "variables": { } } ], "security": [] } }, "/api/v3/fa/invoice-settings/1": { "patch": { "tags": [ "User Management API" ], "summary": "Save/Update Invoice Settings", "operationId": "Save/UpdateInvoiceSettings", "parameters": [ { "name": "isWhiteLabel", "in": "query", "description": "(default value:- false)\nflag should be true if request is made from rganizaiton white label settings", "required": true, "style": "form", "explode": true, "schema": { "type": "boolean", "example": false } }, { "name": "Authorization", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "{{bearer_token}}" } }, { "name": "x-iaa-ow-id", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32", "example": 334 } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "title": "SaveUpdateInvoiceSettingsRequest", "required": [ "invoiceTitle", "invoiceCompanyAddress", "email", "website", "invoiceDescription", "termsAndConditions", "paymentTerm", "invoiceFooter", "paypalAccountId", "chequeCompanyName", "chequeCompanyAddress", "wireTransferCompanyName", "bankName", "accountNumber", "bankAddress", "companyTaxId", "companyTaxName" ], "type": "object", "properties": { "invoiceTitle": { "type": "string" }, "invoiceCompanyAddress": { "type": "string" }, "email": { "type": "string" }, "website": { "type": "string" }, "invoiceDescription": { "type": "string" }, "termsAndConditions": { "type": "string" }, "paymentTerm": { "type": "string" }, "invoiceFooter": { "type": "string" }, "paypalAccountId": { "type": "string" }, "chequeCompanyName": { "type": "string" }, "chequeCompanyAddress": { "type": "string" }, "wireTransferCompanyName": { "type": "string" }, "bankName": { "type": "string" }, "accountNumber": { "type": "string" }, "bankAddress": { "type": "string" }, "companyTaxId": { "type": "string" }, "companyTaxName": { "type": "string" } }, "example": { "invoiceTitle": "The Alchemist", "invoiceCompanyAddress": "42, 6th Avenue, New york, NY", "email": "shraddha.p+alchemist@iqm.com", "website": "www.alchemist.com", "invoiceDescription": "Dear Customer, Greetings from The Alchemist, we are writing to provice you an electronic invoice for your use of services.", "termsAndConditions": "Please make the payment in 30 days or your account might be put on hold", "paymentTerm": "30", "invoiceFooter": "The Alchemist | 12.234.56.789 | USA", "paypalAccountId": "thealchemistfinance@paypal", "chequeCompanyName": "The Alchemist Company", "chequeCompanyAddress": "45, Fifth Avenue, NY, USA", "wireTransferCompanyName": "The Alchemist", "bankName": "JP Morgan Chase Bank", "accountNumber": "670669295", "bankAddress": "498 7th Avenue New York NY", "companyTaxId": "202130INGST", "companyTaxName": "GSTIN" } }, "example": { "invoiceTitle": "The Alchemist", "invoiceCompanyAddress": "42, 6th Avenue, New york, NY", "email": "shraddha.p+alchemist@iqm.com", "website": "www.alchemist.com", "invoiceDescription": "Dear Customer, Greetings from The Alchemist, we are writing to provice you an electronic invoice for your use of services.", "termsAndConditions": "Please make the payment in 30 days or your account might be put on hold", "paymentTerm": "30", "invoiceFooter": "The Alchemist | 12.234.56.789 | USA", "paypalAccountId": "thealchemistfinance@paypal", "chequeCompanyName": "The Alchemist Company", "chequeCompanyAddress": "45, Fifth Avenue, NY, USA", "wireTransferCompanyName": "The Alchemist", "bankName": "JP Morgan Chase Bank", "accountNumber": "670669295", "bankAddress": "498 7th Avenue New York NY", "companyTaxId": "202130INGST", "companyTaxName": "GSTIN" } } }, "required": true }, "responses": { "200": { "description": "OK", "headers": { }, "content": { "application/json": { "schema": { "title": "200OKmultiplefields", "required": [ "success", "data" ], "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "title": "Data66", "required": [ "invoiceId", "message" ], "type": "object", "properties": { "invoiceId": { "type": "integer", "format": "int32" }, "message": { "type": "string" } }, "example": { "invoiceId": 1, "message": "Invoice details updated successfully" } } }, "example": { "success": true, "data": { "invoiceId": 1, "message": "Invoice details updated successfully" } } }, "example": { "success": true, "data": { "invoiceId": 1, "message": "Invoice details updated successfully" } } } } }, "422": { "description": "Unprocessable Entity (WebDAV) (RFC 4918)", "headers": { }, "content": { "application/json": { "schema": { "title": "422UnprocessableEntity8", "required": [ "success", "errorObjects" ], "type": "object", "properties": { "success": { "type": "boolean" }, "errorObjects": { "type": "array", "items": { "title": "ErrorObject2", "required": [ "error" ], "type": "object", "properties": { "error": { "type": "string" } }, "example": { "error": "Only active invitations can be cancelled." } }, "description": "" } }, "example": { "success": false, "errorObjects": [ { "error": "Invoice does not belong to the logged in organization workspace" } ] } }, "example": { "success": false, "errorObjects": [ { "error": "Invoice does not belong to the logged in organization workspace" } ] } } } }, "default": { "description": "", "headers": { }, "content": { "application/json": { "schema": { "title": "422NoinvoiceExists", "required": [ "success", "errorObjects" ], "type": "object", "properties": { "success": { "type": "boolean" }, "errorObjects": { "type": "array", "items": { "title": "ErrorObject2", "required": [ "error" ], "type": "object", "properties": { "error": { "type": "string" } }, "example": { "error": "Only active invitations can be cancelled." } }, "description": "" } }, "example": { "success": false, "errorObjects": [ { "error": "Invoice with the provided ID does not exists" } ] } }, "example": { "success": false, "errorObjects": [ { "error": "Invoice with the provided ID does not exists" } ] } } } } }, "deprecated": false, "security": [], "servers": [ { "url": "http://example.com", "variables": { } } ] } }, "/api/v3/fa/invoice-settings": { "get": { "tags": [ "User Management API" ], "summary": "Get Invoice For Organization", "operationId": "GetInvoiceForOrganization", "parameters": [ { "name": "Authorization", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "{{bearer_token}}" } }, { "name": "x-iaa-ow-id", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32", "example": 334 } } ], "responses": { "200": { "description": "OK", "headers": { }, "content": { "application/json": { "schema": { "title": "200OK10", "required": [ "success", "data" ], "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "title": "Data70", "required": [ "invoiceId", "owId", "invoiceTitle", "invoiceCompanyName", "invoiceCompanyAddress", "email", "website", "invoiceDescription", "paypalId", "chequeTransferId", "wireTransferId", "termsAndConditions", "paymentTerm", "invoiceFooter", "createdAt" ], "type": "object", "properties": { "invoiceId": { "type": "integer", "format": "int32" }, "owId": { "type": "integer", "format": "int32" }, "invoiceTitle": { "type": "string" }, "invoiceCompanyName": { "type": "string" }, "invoiceCompanyAddress": { "type": "string" }, "email": { "type": "string" }, "website": { "type": "string" }, "invoiceDescription": { "type": "string" }, "paypalId": { "type": "integer", "format": "int32" }, "chequeTransferId": { "type": "integer", "format": "int32" }, "wireTransferId": { "type": "integer", "format": "int32" }, "termsAndConditions": { "type": "string" }, "paymentTerm": { "type": "string" }, "invoiceFooter": { "type": "string" }, "createdAt": { "type": "string" } }, "example": { "invoiceId": 1, "owId": 334, "invoiceTitle": "The Alchemist", "invoiceCompanyName": "The Alchemist", "invoiceCompanyAddress": "42, 6th Avenue, New york, NY", "email": "shraddha.p+alchemist@iqm.com", "website": "www.alchemist.com", "invoiceDescription": "Dear Customer, Greetings from The Alchemist, we are writing to provice you an electronic invoice for your use of services.", "paypalId": 1, "chequeTransferId": 1, "wireTransferId": 2, "termsAndConditions": "Please make the payment in 30 days or your account might be put on hold", "paymentTerm": "30", "invoiceFooter": "The Alchemist | 12.234.56.789 | USA", "createdAt": "2021-08-27T07:33:14.000+00:00" } } }, "example": { "success": true, "data": { "invoiceId": 1, "owId": 334, "invoiceTitle": "The Alchemist", "invoiceCompanyName": "The Alchemist", "invoiceCompanyAddress": "42, 6th Avenue, New york, NY", "email": "shraddha.p+alchemist@iqm.com", "website": "www.alchemist.com", "invoiceDescription": "Dear Customer, Greetings from The Alchemist, we are writing to provice you an electronic invoice for your use of services.", "paypalId": 1, "chequeTransferId": 1, "wireTransferId": 2, "termsAndConditions": "Please make the payment in 30 days or your account might be put on hold", "paymentTerm": "30", "invoiceFooter": "The Alchemist | 12.234.56.789 | USA", "createdAt": "2021-08-27T07:33:14.000+00:00" } } }, "example": { "success": true, "data": { "invoiceId": 1, "owId": 334, "invoiceTitle": "The Alchemist", "invoiceCompanyName": "The Alchemist", "invoiceCompanyAddress": "42, 6th Avenue, New york, NY", "email": "shraddha.p+alchemist@iqm.com", "website": "www.alchemist.com", "invoiceDescription": "Dear Customer, Greetings from The Alchemist, we are writing to provice you an electronic invoice for your use of services.", "paypalId": 1, "chequeTransferId": 1, "wireTransferId": 2, "termsAndConditions": "Please make the payment in 30 days or your account might be put on hold", "paymentTerm": "30", "invoiceFooter": "The Alchemist | 12.234.56.789 | USA", "createdAt": "2021-08-27T07:33:14.000+00:00" } } } } } }, "deprecated": false, "security": [], "servers": [ { "url": "http://example.com", "variables": { } } ] } }, "/api/v3/fa/invoice-settings-payment-details": { "get": { "tags": [ "User Management API" ], "summary": "Get Invoice Payment Details", "operationId": "GetInvoicePaymentDetails", "parameters": [ { "name": "invoiceId", "in": "query", "description": "Invoice ID recived from the `/ua/invoice` API", "required": true, "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32", "example": 1 } }, { "name": "Authorization", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "{{brerer_token}}" } }, { "name": "x-iaa-ow-id", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32", "example": 334 } } ], "responses": { "200": { "description": "OK", "headers": { }, "content": { "application/json": { "schema": { "title": "200OK11", "required": [ "success", "data" ], "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "title": "Data71", "required": [ "paypalPaymentDetail", "chequePaymentDetail", "wireTransferPaymentDetail" ], "type": "object", "properties": { "paypalPaymentDetail": { "title": "PaypalPaymentDetail", "required": [ "paypalId", "paypalAccountId" ], "type": "object", "properties": { "paypalId": { "type": "integer", "format": "int32" }, "paypalAccountId": { "type": "string" } }, "example": { "paypalId": 1, "paypalAccountId": "thealchemistfinance@paypal" } }, "chequePaymentDetail": { "title": "ChequePaymentDetail", "required": [ "chequeId", "chequeCompanyName", "chequeCompanyAddress" ], "type": "object", "properties": { "chequeId": { "type": "integer", "format": "int32" }, "chequeCompanyName": { "type": "string" }, "chequeCompanyAddress": { "type": "string" } }, "example": { "chequeId": 1, "chequeCompanyName": "The Alchemist Company", "chequeCompanyAddress": "45, Fifth Avenue, NY, USA" } }, "wireTransferPaymentDetail": { "title": "WireTransferPaymentDetail", "required": [ "wireTransferId", "wireTransferCompanyName", "bankName", "accountNumber", "bankAddress", "swiftCode", "routing" ], "type": "object", "properties": { "wireTransferId": { "type": "integer", "format": "int32" }, "wireTransferCompanyName": { "type": "string" }, "bankName": { "type": "string" }, "accountNumber": { "type": "string" }, "bankAddress": { "type": "string" }, "swiftCode": { "type": "string" }, "routing": { "type": "string" } }, "example": { "wireTransferId": 2, "wireTransferCompanyName": "The Alchemist", "bankName": "JP Morgan Chase Bank", "accountNumber": "670669295", "bankAddress": "498 7th Avenue New York NY", "swiftCode": "MGTCUS3G", "routing": "150098" } } }, "example": { "paypalPaymentDetail": { "paypalId": 1, "paypalAccountId": "thealchemistfinance@paypal" }, "chequePaymentDetail": { "chequeId": 1, "chequeCompanyName": "The Alchemist Company", "chequeCompanyAddress": "45, Fifth Avenue, NY, USA" }, "wireTransferPaymentDetail": { "wireTransferId": 2, "wireTransferCompanyName": "The Alchemist", "bankName": "JP Morgan Chase Bank", "accountNumber": "670669295", "bankAddress": "498 7th Avenue New York NY", "swiftCode": "MGTCUS3G", "routing": "150098" } } } }, "example": { "success": true, "data": { "paypalPaymentDetail": { "paypalId": 1, "paypalAccountId": "thealchemistfinance@paypal" }, "chequePaymentDetail": { "chequeId": 1, "chequeCompanyName": "The Alchemist Company", "chequeCompanyAddress": "45, Fifth Avenue, NY, USA" }, "wireTransferPaymentDetail": { "wireTransferId": 2, "wireTransferCompanyName": "The Alchemist", "bankName": "JP Morgan Chase Bank", "accountNumber": "670669295", "bankAddress": "498 7th Avenue New York NY", "swiftCode": "MGTCUS3G", "routing": "150098" } } } }, "example": { "success": true, "data": { "paypalPaymentDetail": { "paypalId": 1, "paypalAccountId": "thealchemistfinance@paypal" }, "chequePaymentDetail": { "chequeId": 1, "chequeCompanyName": "The Alchemist Company", "chequeCompanyAddress": "45, Fifth Avenue, NY, USA" }, "wireTransferPaymentDetail": { "wireTransferId": 2, "wireTransferCompanyName": "The Alchemist", "bankName": "JP Morgan Chase Bank", "accountNumber": "670669295", "bankAddress": "498 7th Avenue New York NY", "swiftCode": "MGTCUS3G", "routing": "150098" } } } } } }, "422": { "description": "Unprocessable Entity (WebDAV) (RFC 4918)", "headers": { }, "content": { "application/json": { "schema": { "title": "422UnprocessableEntity8", "required": [ "success", "errorObjects" ], "type": "object", "properties": { "success": { "type": "boolean" }, "errorObjects": { "type": "array", "items": { "title": "ErrorObject2", "required": [ "error" ], "type": "object", "properties": { "error": { "type": "string" } }, "example": { "error": "Only active invitations can be cancelled." } }, "description": "" } }, "example": { "success": false, "errorObjects": [ { "error": "Invoice does not belong to the logged in organization workspace" } ] } }, "example": { "success": false, "errorObjects": [ { "error": "Invoice does not belong to the logged in organization workspace" } ] } } } }, "default": { "description": "", "headers": { }, "content": { "application/json": { "schema": { "title": "422NoinvoiceExists", "required": [ "success", "errorObjects" ], "type": "object", "properties": { "success": { "type": "boolean" }, "errorObjects": { "type": "array", "items": { "title": "ErrorObject2", "required": [ "error" ], "type": "object", "properties": { "error": { "type": "string" } }, "example": { "error": "Only active invitations can be cancelled." } }, "description": "" } }, "example": { "success": false, "errorObjects": [ { "error": "Invoice with the provided ID does not exists" } ] } }, "example": { "success": false, "errorObjects": [ { "error": "Invoice with the provided ID does not exists" } ] } } } } }, "deprecated": false, "security": [], "servers": [ { "url": "http://example.com", "variables": { } } ] } }, "/api/v3/fa/invoice-settings-tax-data": { "delete": { "tags": [ "User Management API" ], "summary": "Delete Invoice Tax data", "operationId": "DeleteInvoiceTaxdata", "parameters": [ { "name": "taxId", "in": "query", "description": "", "required": true, "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32", "example": 2 } }, { "name": "Authorization", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "{{bearer_toke}}" } }, { "name": "x-iaa-ow-id", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32", "example": 334 } } ], "responses": { "200": { "description": "OK", "headers": { }, "content": { "application/json": { "schema": { "title": "200OK", "required": [ "success", "data" ], "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "string" } }, "example": { "success": true, "data": "Invitation resent successfully." } }, "example": { "success": true, "data": "Tax data deleted successfully" } } } }, "422": { "description": "Unprocessable Entity (WebDAV) (RFC 4918)", "headers": { }, "content": { "application/json": { "schema": { "title": "422UnprocessableEntity8", "required": [ "success", "errorObjects" ], "type": "object", "properties": { "success": { "type": "boolean" }, "errorObjects": { "type": "array", "items": { "title": "ErrorObject2", "required": [ "error" ], "type": "object", "properties": { "error": { "type": "string" } }, "example": { "error": "Only active invitations can be cancelled." } }, "description": "" } }, "example": { "success": false, "errorObjects": [ { "error": "Invoice does not belong to the logged in organization workspace" } ] } }, "example": { "success": false, "errorObjects": [ { "error": "Tax ID is invalid" } ] } } } } }, "deprecated": false, "security": [], "servers": [ { "url": "http://example.com", "variables": { } } ] } }, "/api/v3/fa/invoice/list/200485": { "get": { "tags": [ "User Management API" ], "summary": "List Invoice For Customer", "operationId": "ListInvoiceForCustomer", "parameters": [ { "name": "status", "in": "query", "description": "Status ids obtained from /fa/static/invoice-status", "required": true, "style": "form", "explode": true, "schema": { "type": "string", "example": "1,2,3,4,7" } }, { "name": "sortBy", "in": "query", "description": "other allowed values issuedOn,invoiceAmount,status", "required": true, "style": "form", "explode": true, "schema": { "type": "string", "example": "-invoiceId" } }, { "name": "Authorization", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "{{bearer_token}}" } }, { "name": "x-iaa-ow-id", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32", "example": 200002 } } ], "responses": { "200": { "description": "OK", "headers": { }, "content": { "application/json": { "schema": { "title": "200OK13", "required": [ "success", "data" ], "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "title": "Data72", "required": [ "data", "totalRecords", "filteredRecords" ], "type": "object", "properties": { "data": { "type": "array", "items": { "title": "Data73", "required": [ "invoiceId", "invoiceFromDate", "invoiceToDate", "issuedOn", "invoiceAmount", "status", "paymentTerm", "paidAmount", "paymentMode", "invoiceName", "actionNote", "invoiceStatusUpdatedBy", "modifiedAt" ], "type": "object", "properties": { "invoiceId": { "type": "integer", "format": "int32" }, "invoiceFromDate": { "type": "integer", "format": "int32" }, "invoiceToDate": { "type": "integer", "format": "int32" }, "issuedOn": { "type": "integer", "format": "int32" }, "invoiceAmount": { "type": "number" }, "status": { "type": "integer", "format": "int32" }, "paymentTerm": { "type": "integer", "format": "int32" }, "paidAmount": { "type": "number" }, "paymentMode": { "oneOf": [ { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, { "type": "string", "nullable": true }, { "nullable": true } ] }, "invoiceName": { "type": "string", "nullable": true }, "actionNote": { "type": "string", "nullable": true }, "invoiceStatusUpdatedBy": { "type": "string", "nullable": true }, "modifiedAt": { "type": "integer", "format": "int64" } }, "example": { "invoiceId": 79, "invoiceFromDate": 1601510400, "invoiceToDate": 1604102400, "issuedOn": 1632182400, "invoiceAmount": 553611.718, "status": 7, "paymentTerm": 30, "paidAmount": 5000, "paymentMode": [2, 4], "invoiceName": "Zydus - Oct2020", "actionNote": null, "invoiceStatusUpdatedBy": "Kartik Gevariya", "modifiedAt": 1632801378000 } }, "description": "" }, "totalRecords": { "type": "integer", "format": "int32" }, "filteredRecords": { "type": "integer", "format": "int32" } } } } } } } } }, "deprecated": false, "security": [], "servers": [ { "url": "http://example.com", "variables": { } } ] } }, "/api/v3/fa/invoice-approve/79": { "patch": { "tags": [ "User Management API" ], "summary": "Approve Invoice", "operationId": "ApproveInvoice", "parameters": [ { "name": "Authorization", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "{{bearer_token}}" } }, { "name": "x-iaa-ow-id", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32", "example": 200002 } } ], "responses": { "200": { "description": "OK", "headers": { }, "content": { "application/json": { "schema": { "title": "200OK", "required": [ "success", "data" ], "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "string" } }, "example": { "success": true, "data": "Invitation resent successfully." } }, "example": { "success": true, "data": "Invoice with the provided ID approved successfully" } } } }, "422": { "description": "Unprocessable Entity (WebDAV) (RFC 4918)", "headers": { }, "content": { "application/json": { "schema": { "title": "m4221", "required": [ "success", "errorObjects" ], "type": "object", "properties": { "success": { "type": "boolean" }, "errorObjects": { "type": "array", "items": { "title": "ErrorObject2", "required": [ "error" ], "type": "object", "properties": { "error": { "type": "string" } }, "example": { "error": "Only active invitations can be cancelled." } }, "description": "" } }, "example": { "success": false, "errorObjects": [ { "error": "Only Pending status invoices can be approved" } ] } }, "example": { "success": false, "errorObjects": [ { "error": "Only Pending status invoices can be approved" } ] } } } } }, "deprecated": false, "security": [], "servers": [ { "url": "http://example.com", "variables": { } } ] } }, "/api/v3/fa/invoice-cancel/79": { "patch": { "tags": [ "User Management API" ], "summary": "Cancel Invoice", "operationId": "CancelInvoice", "parameters": [ { "name": "Authorization", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "{{bearer_token}}" } }, { "name": "x-iaa-ow-id", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32", "example": 200002 } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "title": "CancelInvoiceRequest", "required": [ "actionNote" ], "type": "object", "properties": { "actionNote": { "type": "string" } }, "example": { "actionNote": "cancelling invoice" } }, "example": { "actionNote": "cancelling invoice" } } }, "required": true }, "responses": { "200": { "description": "OK", "headers": { }, "content": { "application/json": { "schema": { "title": "200OK", "required": [ "success", "data" ], "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "string" } }, "example": { "success": true, "data": "Invitation resent successfully." } }, "example": { "success": true, "data": "Invoice with the provided ID rejected successfully" } } } }, "422": { "description": "Unprocessable Entity (WebDAV) (RFC 4918)", "headers": { }, "content": { "application/json": { "schema": { "title": "m4221", "required": [ "success", "errorObjects" ], "type": "object", "properties": { "success": { "type": "boolean" }, "errorObjects": { "type": "array", "items": { "title": "ErrorObject2", "required": [ "error" ], "type": "object", "properties": { "error": { "type": "string" } }, "example": { "error": "Only active invitations can be cancelled." } }, "description": "" } }, "example": { "success": false, "errorObjects": [ { "error": "Only Pending status invoices can be approved" } ] } }, "example": { "success": false, "errorObjects": [ { "error": "Only Pending or Un-Paid invoices can be rejected" } ] } } } } }, "deprecated": false, "security": [], "servers": [ { "url": "http://example.com", "variables": { } } ] } }, "/api/v3/fa/pay-invoice": { "post": { "tags": [ "User Management API" ], "summary": "Mark Invoice As Paid", "operationId": "MarkInvoiceAsPaid", "parameters": [ { "name": "Authorization", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "{{bearer-token}}" } }, { "name": "x-iaa-ow-id", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32", "example": 200002 } } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { }, "schema": { "required": [ "owId", "paymentAmount", "paymentType", "invoiceId" ], "type": "object", "properties": { "owId": { "type": "integer", "description": "For which payment is being made", "format": "int32", "example": 200485 }, "paymentAmount": { "type": "integer", "format": "int32", "example": 100 }, "paymentType": { "type": "integer", "description": "As funds or Via Payment (id from /api/v3/fa/static/payment-type) API", "format": "int32", "example": 1 }, "invoiceId": { "type": "integer", "format": "int32", "example": 32 } } } } }, "required": false }, "responses": { "200": { "description": "OK", "headers": { }, "content": { "application/json": { "schema": { "title": "200OKPayinvoicefromOrganizationApp", "required": [ "success", "data" ], "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "string" } }, "example": { "success": true, "data": "Payment added Successfully." } }, "example": { "success": true, "data": "Payment added Successfully." } } } }, "422": { "description": "Unprocessable Entity (WebDAV) (RFC 4918)", "headers": { }, "content": { "application/json": { "schema": { "title": "m4221", "required": [ "success", "errorObjects" ], "type": "object", "properties": { "success": { "type": "boolean" }, "errorObjects": { "type": "array", "items": { "title": "ErrorObject2", "required": [ "error" ], "type": "object", "properties": { "error": { "type": "string" } }, "example": { "error": "Only active invitations can be cancelled." } }, "description": "" } }, "example": { "success": false, "errorObjects": [ { "error": "Only Pending status invoices can be approved" } ] } }, "example": { "success": false, "errorObjects": [ { "error": "Invoice status is not in Processing, Unpaid and Partially Paid state" } ] } } } } }, "deprecated": false, "security": [], "servers": [ { "url": "http://example.com", "variables": { } } ] } }, "/api/v3/fa/download-invoice/200485/79": { "get": { "tags": [ "User Management API" ], "summary": "Download Invoice", "operationId": "DownloadInvoice", "parameters": [ { "name": "isCustomerRequest", "in": "query", "description": "defualt value:- true\nFor Customer app request: true\nFor Organization app request: false", "required": true, "style": "form", "explode": true, "schema": { "type": "boolean", "example": true } }, { "name": "Authorization", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "{{brearer_token}}" } }, { "name": "x-iaa-ow-id", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32", "example": 200002 } } ], "responses": { "200": { "description": "OK", "headers": { "Content-Disposition": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "attachment; filename=Invoice-79.pdf" } } } }, "content": { } } }, "deprecated": false, "security": [], "servers": [ { "url": "http://example.com", "variables": { } } ] } }, "/api/v3/fa/invoice/list/200483": { "get": { "tags": [ "User Management API" ], "summary": "List Invoice In Organization", "operationId": "ListInvoiceInOrganization", "parameters": [ { "name": "status", "in": "query", "description": "", "required": true, "style": "form", "explode": true, "schema": { "type": "string", "example": "1,2,3,4,7" } }, { "name": "sortBy", "in": "query", "description": "", "required": true, "style": "form", "explode": true, "schema": { "type": "string", "example": "-invoiceId" } }, { "name": "isCustomerRequest", "in": "query", "description": "", "required": true, "style": "form", "explode": true, "schema": { "type": "boolean", "example": false } }, { "name": "Authorization", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "{{bearer-token}}" } }, { "name": "x-iaa-ow-id", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32", "example": 200483 } } ], "responses": { "200": { "description": "OK", "headers": { }, "content": { "application/json": { "schema": { "title": "200OK16", "required": [ "success", "data" ], "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "title": "Data74", "required": [ "data", "totalRecords", "filteredRecords" ], "type": "object", "properties": { "data": { "type": "array", "items": { "title": "Data75", "required": [ "invoiceId", "invoiceFromDate", "invoiceToDate", "issuedOn", "invoiceAmount", "status", "paymentTerm", "paidAmount", "paymentMode", "invoiceName", "actionNote", "invoiceStatusUpdatedBy", "modifiedAt" ], "type": "object", "properties": { "invoiceId": { "type": "integer", "format": "int32" }, "invoiceFromDate": { "type": "integer", "format": "int32" }, "invoiceToDate": { "type": "integer", "format": "int32" }, "issuedOn": { "type": "integer", "format": "int32" }, "invoiceAmount": { "type": "number" }, "status": { "type": "integer", "format": "int32" }, "paymentTerm": { "type": "integer", "format": "int32" }, "paidAmount": { "type": "number" }, "paymentMode": { "oneOf": [ { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, { "type": "string", "nullable": true }, { "nullable": true } ] }, "invoiceName": { "type": "string" }, "actionNote": { "type": "string", "nullable": true }, "invoiceStatusUpdatedBy": { "type": "string", "nullable": true }, "modifiedAt": { "type": "integer", "format": "int64" } }, "example": { "invoiceId": 2444, "invoiceFromDate": 1609459200, "invoiceToDate": 1612051200, "issuedOn": 1633046400, "invoiceAmount": 11746.188, "status": 7, "paymentTerm": 20, "paidAmount": 0, "paymentMode": [1], "invoiceName": "GroupM - Jan2021", "actionNote": "Approving for Payment", "invoiceStatusUpdatedBy": "IHB Owner", "modifiedAt": 1633364857000 } }, "description": "" }, "totalRecords": { "type": "integer", "format": "int32" }, "filteredRecords": { "type": "integer", "format": "int32" } } } } } } } }, "422": { "description": "Unprocessable Entity (WebDAV) (RFC 4918)", "headers": { }, "content": { "application/json": { "schema": { "title": "422UnprocessableEntity8", "required": [ "success", "errorObjects" ], "type": "object", "properties": { "success": { "type": "boolean" }, "errorObjects": { "type": "array", "items": { "title": "ErrorObject2", "required": [ "error" ], "type": "object", "properties": { "error": { "type": "string" } }, "example": { "error": "Only active invitations can be cancelled." } }, "description": "" } }, "example": { "success": false, "errorObjects": [ { "error": "Invoice does not belong to the logged in organization workspace" } ] } }, "example": { "success": false, "errorObjects": [ { "error": "User cannot access invoices" } ] } } } } }, "deprecated": false, "security": [], "servers": [ { "url": "http://example.com", "variables": { } } ] } }, "/api/v3/fa/email-invoice/200483/2438": { "post": { "tags": [ "User Management API" ], "summary": "Email Invoice", "operationId": "EmailInvoice", "parameters": [ { "name": "Authorization", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "{{bearer_token}}" } }, { "name": "X-IAA-OW-ID", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32", "example": 200001 } } ], "responses": { "200": { "description": "OK", "headers": { }, "content": { "application/json": { "schema": { "title": "SuccessResponse200OK", "required": [ "success", "data" ], "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "string" } }, "example": { "success": true, "data": "Invitation cancelled successfully." } }, "example": { "success": true, "data": "Invoice e-mail sent successfully." } } } } }, "deprecated": false, "security": [], "servers": [ { "url": "http://example.com", "variables": { } } ] } }, "/api/v3/ua/static/user-status": { "get": { "tags": [ "User Management API" ], "summary": "User Status", "operationId": "UserStatus", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "required": true, "style": "simple", "schema": { "type": "string", "example": "{{bearer_token}}" } } ], "responses": { "200": { "description": "OK", "headers": { }, "content": { "application/json": { "schema": { "title": "200OK17", "required": [ "success", "data" ], "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "array", "items": { "title": "Data76", "required": [ "name", "id", "label", "order" ], "type": "object", "properties": { "name": { "type": "string" }, "id": { "type": "integer", "format": "int32" }, "label": { "type": "string" }, "order": { "type": "integer", "format": "int32" } }, "example": { "name": "pending", "id": 2, "label": "Pending", "order": 1 } }, "description": "" } }, "example": { "success": true, "data": [ { "name": "pending", "id": 2, "label": "Pending", "order": 1 }, { "name": "invited", "id": 3, "label": "Invited", "order": 3 }, { "name": "on_hold", "id": 4, "label": "On Hold", "order": 4 }, { "name": "active", "id": 1, "label": "Active", "order": 2 }, { "name": "deleted", "id": 5, "label": "Deleted", "order": 5 } ] } }, "example": { "success": true, "data": [ { "name": "pending", "id": 2, "label": "Pending", "order": 1 }, { "name": "invited", "id": 3, "label": "Invited", "order": 3 }, { "name": "on_hold", "id": 4, "label": "On Hold", "order": 4 }, { "name": "active", "id": 1, "label": "Active", "order": 2 }, { "name": "deleted", "id": 5, "label": "Deleted", "order": 5 } ] } } } } }, "deprecated": false, "security": [], "servers": [ { "url": "http://example.com", "variables": { } } ] } }, "/api/v3/ua/static/user-sort-by": { "get": { "tags": [ "User Management API" ], "summary": "User Sort By", "operationId": "UserSortBy", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "required": true, "style": "simple", "schema": { "type": "string", "example": "{{bearer_token}}" } } ], "responses": { "200": { "description": "OK", "headers": { }, "content": { "application/json": { "schema": { "title": "200OK20", "required": [ "success", "data" ], "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "array", "items": { "title": "Data77", "required": [ "label", "field", "order" ], "type": "object", "properties": { "label": { "type": "string" }, "field": { "type": "string" }, "order": { "type": "integer", "format": "int32" } }, "example": { "label": "Status", "field": "status", "order": 1 } }, "description": "" } }, "example": { "success": true, "data": [ { "label": "Status", "field": "status", "order": 1 }, { "label": "Number of Customers", "field": "customersCount", "order": 2 }, { "label": "Name", "field": "displayName", "order": 3 } ] } }, "example": { "success": true, "data": [ { "label": "Status", "field": "status", "order": 1 }, { "label": "Number of Customers", "field": "customersCount", "order": 2 }, { "label": "Name", "field": "displayName", "order": 3 } ] } } } } }, "deprecated": false, "security": [], "servers": [ { "url": "http://example.com", "variables": { } } ] } }, "/api/v3/ua/static/organization-workspace-status": { "get": { "tags": [ "User Management API" ], "summary": "Organization Workspace Status", "operationId": "OrganizationWorkspaceStatus", "parameters": [ { "name": "view", "in": "query", "description": "", "required": true, "style": "form", "explode": true, "schema": { "type": "string", "example": "finance" } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "required": true, "style": "simple", "schema": { "type": "string", "example": "{{bearer_token}}" } } ], "responses": { "200": { "description": "OK", "headers": { }, "content": { "application/json": { "schema": { "title": "200OK17", "required": [ "success", "data" ], "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "array", "items": { "title": "Data76", "required": [ "name", "id", "label", "order" ], "type": "object", "properties": { "name": { "type": "string" }, "id": { "type": "integer", "format": "int32" }, "label": { "type": "string" }, "order": { "type": "integer", "format": "int32" } }, "example": { "name": "pending", "id": 2, "label": "Pending", "order": 1 } }, "description": "" } }, "example": { "success": true, "data": [ { "name": "pending", "id": 2, "label": "Pending", "order": 1 }, { "name": "invited", "id": 3, "label": "Invited", "order": 3 }, { "name": "on_hold", "id": 4, "label": "On Hold", "order": 4 }, { "name": "active", "id": 1, "label": "Active", "order": 2 }, { "name": "deleted", "id": 5, "label": "Deleted", "order": 5 } ] } }, "example": { "success": true, "data": [ { "name": "pending", "id": 2, "label": "Pending", "order": 1 }, { "name": "active", "id": 1, "label": "Active", "order": 2 }, { "name": "invited", "id": 3, "label": "Invited", "order": 3 }, { "name": "on_hold", "id": 4, "label": "On Hold", "order": 4 }, { "name": "rejected", "id": 5, "label": "Rejected", "order": 5 }, { "name": "deleted", "id": 6, "label": "Deleted", "order": 6 } ] } } } } }, "deprecated": false, "security": [], "servers": [ { "url": "http://example.com", "variables": { } } ] } }, "/api/v3/ua/static/customer-type": { "get": { "tags": [ "User Management API" ], "summary": "Customer Type", "operationId": "CustomerType", "parameters": [ { "name": "Authorization", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "{{bearer_token}}" } } ], "responses": { "200": { "description": "OK", "headers": { }, "content": { "application/json": { "schema": { "title": "SuccessResponse200OK43", "required": [ "success", "data" ], "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "array", "items": { "title": "Data76", "required": [ "name", "id", "label", "order" ], "type": "object", "properties": { "name": { "type": "string" }, "id": { "type": "integer", "format": "int32" }, "label": { "type": "string" }, "order": { "type": "integer", "format": "int32" } }, "example": { "name": "pending", "id": 2, "label": "Pending", "order": 1 } }, "description": "" } }, "example": { "success": true, "data": [ { "name": "self_served", "id": 1, "label": "Self Served", "order": 2 }, { "name": "managed_services", "id": 2, "label": "Managed Services ", "order": 1 }, { "name": "app_users", "id": 3, "label": "App Users", "order": 3 }, { "name": "advertisers", "id": 4, "label": "Advertisers", "order": 4 }, { "name": "workspaces", "id": 5, "label": "Workspaces", "order": 5 } ] } }, "example": { "success": true, "data": [ { "name": "self_served", "id": 1, "label": "Self Served", "order": 2 }, { "name": "managed_services", "id": 2, "label": "Managed Services ", "order": 1 }, { "name": "app_users", "id": 3, "label": "App Users", "order": 3 }, { "name": "advertisers", "id": 4, "label": "Advertisers", "order": 4 }, { "name": "workspaces", "id": 5, "label": "Workspaces", "order": 5 } ] } } } } }, "deprecated": false, "security": [], "servers": [ { "url": "http://example.com", "variables": { } } ] } }, "/api/v3/ua/static/customer-list-sortable-field": { "get": { "tags": [ "User Management API" ], "summary": "Customer List Sortable Fields API", "operationId": "CustomerListSortableFieldsAPI", "parameters": [ { "name": "Authorization", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "{{bearer_token}}" } } ], "responses": { "200": { "description": "OK", "headers": { "Date": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "Thu, 19 Aug 2021 15:14:10 GMT" } } }, "Transfer-Encoding": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "chunked" } } }, "Connection": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "keep-alive" } } }, "Cache-Control": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "public, max-age=86400" } } }, "X-Content-Type-Options": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "nosniff" } } }, "X-XSS-Protection": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "1; mode=block" } } }, "X-Frame-Options": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "DENY" } } } }, "content": { "application/json": { "schema": { "title": "SuccessResponse200OK44", "required": [ "success", "data" ], "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "array", "items": { "title": "Data77", "required": [ "label", "field", "order" ], "type": "object", "properties": { "label": { "type": "string" }, "field": { "type": "string" }, "order": { "type": "integer", "format": "int32" } }, "example": { "label": "Status", "field": "status", "order": 1 } }, "description": "" } }, "example": { "success": true, "data": [ { "label": "Status", "field": "status", "order": 1 }, { "label": "Date of joining", "field": "createdAt", "order": 2 } ] } }, "example": { "success": true, "data": [ { "label": "Status", "field": "status", "order": 1 }, { "label": "Date of joining", "field": "createdAt", "order": 2 } ] } } } } }, "deprecated": false, "security": [], "servers": [ { "url": "http://example.com", "variables": { } } ] } }, "/api/v3/fa/static/invoice-payment-terms": { "get": { "tags": [ "User Management API" ], "summary": "Invoice Payment Term", "operationId": "InvoicePaymentTerm", "parameters": [ { "name": "Authorization", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "{{bearer_token}}" } } ], "responses": { "200": { "description": "OK", "headers": { }, "content": { "application/json": { "schema": { "title": "200OK17", "required": [ "success", "data" ], "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "array", "items": { "title": "Data76", "required": [ "name", "id", "label", "order" ], "type": "object", "properties": { "name": { "type": "string" }, "id": { "type": "integer", "format": "int32" }, "label": { "type": "string" }, "order": { "type": "integer", "format": "int32" } }, "example": { "name": "pending", "id": 2, "label": "Pending", "order": 1 } }, "description": "" } }, "example": { "success": true, "data": [ { "name": "pending", "id": 2, "label": "Pending", "order": 1 }, { "name": "invited", "id": 3, "label": "Invited", "order": 3 }, { "name": "on_hold", "id": 4, "label": "On Hold", "order": 4 }, { "name": "active", "id": 1, "label": "Active", "order": 2 }, { "name": "deleted", "id": 5, "label": "Deleted", "order": 5 } ] } }, "example": { "success": true, "data": [ { "name": "7", "id": 1, "label": "Net 7", "order": 1 }, { "name": "15", "id": 2, "label": "Net 15", "order": 2 }, { "name": "30", "id": 3, "label": "Net 30", "order": 3 }, { "name": "45", "id": 4, "label": "Net 45", "order": 4 }, { "name": "60", "id": 5, "label": "Net 60", "order": 5 }, { "name": "90", "id": 6, "label": "Net 90", "order": 6 }, { "name": "120", "id": 7, "label": "Net 120", "order": 7 }, { "name": "0", "id": 8, "label": "Custom", "order": 8 } ] } } } } }, "deprecated": false, "security": [], "servers": [ { "url": "http://example.com", "variables": { } } ] } }, "/api/v3/fa/static/invoice-payment-modes": { "get": { "tags": [ "User Management API" ], "summary": "Invoice Payment Modes", "operationId": "InvoicePaymentModes", "parameters": [ { "name": "Authorization", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "{{bearer_token}}" } } ], "responses": { "200": { "description": "OK", "headers": { }, "content": { "application/json": { "schema": { "title": "200OK17", "required": [ "success", "data" ], "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "array", "items": { "title": "Data76", "required": [ "name", "id", "label", "order" ], "type": "object", "properties": { "name": { "type": "string" }, "id": { "type": "integer", "format": "int32" }, "label": { "type": "string" }, "order": { "type": "integer", "format": "int32" } }, "example": { "name": "pending", "id": 2, "label": "Pending", "order": 1 } }, "description": "" } }, "example": { "success": true, "data": [ { "name": "pending", "id": 2, "label": "Pending", "order": 1 }, { "name": "invited", "id": 3, "label": "Invited", "order": 3 }, { "name": "on_hold", "id": 4, "label": "On Hold", "order": 4 }, { "name": "active", "id": 1, "label": "Active", "order": 2 }, { "name": "deleted", "id": 5, "label": "Deleted", "order": 5 } ] } }, "example": { "success": true, "data": [ { "name": "paypal", "id": 1, "label": "PayPal", "order": 1 }, { "name": "cheque", "id": 2, "label": "Cheque", "order": 2 }, { "name": "wire_transfer", "id": 3, "label": "Wire Transfer", "order": 3 } ] } } } } }, "deprecated": false, "security": [], "servers": [ { "url": "http://example.com", "variables": { } } ] } }, "/api/v3/fa/static/payment-type": { "get": { "tags": [ "User Management API" ], "summary": "Payment Types", "operationId": "PaymentTypes", "parameters": [ { "name": "Authorization", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "{{bearer_token}}" } } ], "responses": { "200": { "description": "OK", "headers": { }, "content": { "application/json": { "schema": { "title": "SuccessResponse200OK43", "required": [ "success", "data" ], "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "array", "items": { "title": "Data76", "required": [ "name", "id", "label", "order" ], "type": "object", "properties": { "name": { "type": "string" }, "id": { "type": "integer", "format": "int32" }, "label": { "type": "string" }, "order": { "type": "integer", "format": "int32" } }, "example": { "name": "pending", "id": 2, "label": "Pending", "order": 1 } }, "description": "" } }, "example": { "success": true, "data": [ { "name": "self_served", "id": 1, "label": "Self Served", "order": 2 }, { "name": "managed_services", "id": 2, "label": "Managed Services ", "order": 1 }, { "name": "app_users", "id": 3, "label": "App Users", "order": 3 }, { "name": "advertisers", "id": 4, "label": "Advertisers", "order": 4 }, { "name": "workspaces", "id": 5, "label": "Workspaces", "order": 5 } ] } }, "example": { "success": true, "data": [ { "name": "as_fund", "id": 1, "label": "As Fund", "order": 1 }, { "name": "against_invoice", "id": 2, "label": "Against Invoice", "order": 2 }, { "name": "refund", "id": 3, "label": "Refund", "order": 3 } ] } } } } }, "deprecated": false, "security": [], "servers": [ { "url": "http://example.com", "variables": { } } ] } }, "/api/v3/fa/static/payment-status": { "get": { "tags": [ "User Management API" ], "summary": "Payment Status", "operationId": "PaymentStatus", "parameters": [ { "name": "Authorization", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "{{bearer_token}}" } } ], "responses": { "200": { "description": "OK", "headers": { }, "content": { "application/json": { "schema": { "title": "SuccessResponse200OK43", "required": [ "success", "data" ], "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "array", "items": { "title": "Data76", "required": [ "name", "id", "label", "order" ], "type": "object", "properties": { "name": { "type": "string" }, "id": { "type": "integer", "format": "int32" }, "label": { "type": "string" }, "order": { "type": "integer", "format": "int32" } }, "example": { "name": "pending", "id": 2, "label": "Pending", "order": 1 } }, "description": "" } }, "example": { "success": true, "data": [ { "name": "self_served", "id": 1, "label": "Self Served", "order": 2 }, { "name": "managed_services", "id": 2, "label": "Managed Services ", "order": 1 }, { "name": "app_users", "id": 3, "label": "App Users", "order": 3 }, { "name": "advertisers", "id": 4, "label": "Advertisers", "order": 4 }, { "name": "workspaces", "id": 5, "label": "Workspaces", "order": 5 } ] } }, "example": { "success": true, "data": [ { "name": "processing", "id": 1, "label": "Processing", "order": 1 }, { "name": "paid", "id": 2, "label": "Paid", "order": 2 }, { "name": "rejected", "id": 3, "label": "Rejected", "order": 3 }, { "name": "cancelled", "id": 4, "label": "Cancelled", "order": 4 } ] } } } } }, "deprecated": false, "security": [], "servers": [ { "url": "http://example.com", "variables": { } } ] } }, "/api/v3/fa/static/invoice-status": { "get": { "tags": [ "User Management API" ], "summary": "Invoice Status", "operationId": "InvoiceStatus", "parameters": [ { "name": "Authorization", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "{{bearer_token}}" } } ], "responses": { "200": { "description": "OK", "headers": { }, "content": { "application/json": { "schema": { "title": "200OK17", "required": [ "success", "data" ], "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "array", "items": { "title": "Data76", "required": [ "name", "id", "label", "order" ], "type": "object", "properties": { "name": { "type": "string" }, "id": { "type": "integer", "format": "int32" }, "label": { "type": "string" }, "order": { "type": "integer", "format": "int32" } }, "example": { "name": "pending", "id": 2, "label": "Pending", "order": 1 } }, "description": "" } }, "example": { "success": true, "data": [ { "name": "pending", "id": 2, "label": "Pending", "order": 1 }, { "name": "invited", "id": 3, "label": "Invited", "order": 3 }, { "name": "on_hold", "id": 4, "label": "On Hold", "order": 4 }, { "name": "active", "id": 1, "label": "Active", "order": 2 }, { "name": "deleted", "id": 5, "label": "Deleted", "order": 5 } ] } }, "example": { "success": true, "data": [ { "name": "pending", "id": 1, "label": "Pending", "order": 1 }, { "name": "partially_paid", "id": 2, "label": "Partially Paid", "order": 2 }, { "name": "unpaid", "id": 3, "label": "Unpaid", "order": 3 }, { "name": "paid", "id": 4, "label": "Paid", "order": 4 }, { "name": "overdue", "id": 5, "label": "Overdue", "order": 5 }, { "name": "processing", "id": 7, "label": "Processing", "order": 7 }, { "name": "cancelled", "id": 8, "label": "Cancelled", "order": 8 } ] } } } } }, "deprecated": false, "security": [], "servers": [ { "url": "http://example.com", "variables": { } } ] } }, "/api/v3/ua/static/organization-expertize": { "get": { "tags": [ "User Management API" ], "summary": "Organization Expertize", "operationId": "OrganizationExpertize", "parameters": [ { "name": "Authorization", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "{{bearer_token}}" } } ], "responses": { "200": { "description": "OK", "headers": { }, "content": { "application/json": { "schema": { "title": "SuccessResponse200OK43", "required": [ "success", "data" ], "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "array", "items": { "title": "Data76", "required": [ "name", "id", "label", "order" ], "type": "object", "properties": { "name": { "type": "string" }, "id": { "type": "integer", "format": "int32" }, "label": { "type": "string" }, "order": { "type": "integer", "format": "int32" } }, "example": { "name": "pending", "id": 2, "label": "Pending", "order": 1 } }, "description": "" } }, "example": { "success": true, "data": [ { "name": "self_served", "id": 1, "label": "Self Served", "order": 2 }, { "name": "managed_services", "id": 2, "label": "Managed Services ", "order": 1 }, { "name": "app_users", "id": 3, "label": "App Users", "order": 3 }, { "name": "advertisers", "id": 4, "label": "Advertisers", "order": 4 }, { "name": "workspaces", "id": 5, "label": "Workspaces", "order": 5 } ] } }, "example": { "success": true, "data": [ { "name": "account_administration", "id": 1, "label": "Account Administration", "order": 1 }, { "name": "campaign_optimization", "id": 2, "label": "Campaign Optimization", "order": 2 }, { "name": "creative_serivces", "id": 3, "label": "Creative Serivces", "order": 3 }, { "name": "audience_building", "id": 4, "label": "Audience Building", "order": 4 }, { "name": "inventory_management", "id": 5, "label": "Inventory Management", "order": 5 }, { "name": "finance_and_accounting", "id": 6, "label": "Finance & Accounting", "order": 6 }, { "name": "campaign_creation", "id": 7, "label": "Campaign Creation", "order": 7 } ] } } } } }, "deprecated": false, "security": [], "servers": [ { "url": "http://example.com", "variables": { } } ] } }, "/api/v3/ua/static/company-size": { "get": { "tags": [ "User Management API" ], "summary": "Company size", "operationId": "Companysize", "parameters": [], "responses": { "200": { "description": "OK", "headers": { }, "content": { "application/json": { "schema": { "title": "SuccessResponse200OK43", "required": [ "success", "data" ], "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "array", "items": { "title": "Data76", "required": [ "name", "id", "label", "order" ], "type": "object", "properties": { "name": { "type": "string" }, "id": { "type": "integer", "format": "int32" }, "label": { "type": "string" }, "order": { "type": "integer", "format": "int32" } }, "example": { "name": "pending", "id": 2, "label": "Pending", "order": 1 } }, "description": "" } }, "example": { "success": true, "data": [ { "name": "self_served", "id": 1, "label": "Self Served", "order": 2 }, { "name": "managed_services", "id": 2, "label": "Managed Services ", "order": 1 }, { "name": "app_users", "id": 3, "label": "App Users", "order": 3 }, { "name": "advertisers", "id": 4, "label": "Advertisers", "order": 4 }, { "name": "workspaces", "id": 5, "label": "Workspaces", "order": 5 } ] } }, "example": { "success": true, "data": [ { "name": "1_10", "id": 1, "label": "1-10", "order": 1 }, { "name": "11_50", "id": 2, "label": "11-50", "order": 2 }, { "name": "51_200", "id": 3, "label": "51-200", "order": 3 }, { "name": "201_500", "id": 4, "label": "201-500", "order": 4 }, { "name": "501_1000", "id": 5, "label": "501-1000", "order": 5 }, { "name": "1001_5000", "id": 6, "label": "1001-5000", "order": 6 }, { "name": "5000+", "id": 7, "label": "5000+", "order": 7 } ] } } } } }, "deprecated": false, "servers": [ { "url": "http://example.com", "variables": { } } ], "security": [] } }, "/api/v3/ua/static/industries": { "get": { "tags": [ "User Management API" ], "summary": "Industries", "operationId": "Industries", "parameters": [], "responses": { "200": { "description": "OK", "headers": { }, "content": { "application/json": { "schema": { "title": "200OK17", "required": [ "success", "data" ], "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "array", "items": { "title": "Data76", "required": [ "name", "id", "label", "order" ], "type": "object", "properties": { "name": { "type": "string" }, "id": { "type": "integer", "format": "int32" }, "label": { "type": "string" }, "order": { "type": "integer", "format": "int32" } }, "example": { "name": "pending", "id": 2, "label": "Pending", "order": 1 } }, "description": "" } }, "example": { "success": true, "data": [ { "name": "pending", "id": 2, "label": "Pending", "order": 1 }, { "name": "invited", "id": 3, "label": "Invited", "order": 3 }, { "name": "on_hold", "id": 4, "label": "On Hold", "order": 4 }, { "name": "active", "id": 1, "label": "Active", "order": 2 }, { "name": "deleted", "id": 5, "label": "Deleted", "order": 5 } ] } }, "example": { "success": true, "data": [ { "name": "accounting", "id": 1, "label": "Accounting ", "order": 1 }, { "name": "airlines/aviation", "id": 2, "label": "Airlines/Aviation", "order": 2 }, { "name": "alternative_dispute_resolution", "id": 3, "label": "Alternative Dispute Resolution", "order": 3 }, { "name": "alternative_medicine", "id": 4, "label": "Alternative Medicine", "order": 4 }, { "name": "animation", "id": 5, "label": "Animation", "order": 5 }, { "name": "apparel/fashion", "id": 6, "label": "Apparel/Fashion", "order": 6 }, { "name": "architecture/planning", "id": 7, "label": "Architecture/Planning", "order": 7 }, { "name": "arts/crafts", "id": 8, "label": "Arts/Crafts", "order": 8 }, { "name": "automotive", "id": 9, "label": "Automotive", "order": 9 }, { "name": "aviation/aerospace", "id": 10, "label": "Aviation/Aerospace", "order": 10 }, { "name": "banking/mortgage", "id": 11, "label": "Banking/Mortgage", "order": 11 }, { "name": "biotechnology/greentech", "id": 12, "label": "Biotechnology/Greentech", "order": 12 }, { "name": "broadcast_media", "id": 13, "label": "Broadcast Media", "order": 13 }, { "name": "building_materials", "id": 14, "label": "Building Materials", "order": 14 }, { "name": "business_supplies/equipment", "id": 15, "label": "Business Supplies/Equipment", "order": 15 }, { "name": "capital_markets/hedge_fund/private_equity", "id": 16, "label": "Capital Markets/Hedge Fund/Private Equity", "order": 16 }, { "name": "chemicals", "id": 17, "label": "Chemicals", "order": 17 }, { "name": "civic/social_organization", "id": 18, "label": "Civic/Social Organization", "order": 18 }, { "name": "civil_engineering", "id": 19, "label": "Civil Engineering", "order": 19 }, { "name": "commercial_real_estate", "id": 20, "label": "Commercial Real Estate", "order": 20 }, { "name": "computer_games", "id": 21, "label": "Computer Games", "order": 21 }, { "name": "computer_hardware", "id": 22, "label": "Computer Hardware", "order": 22 }, { "name": "computer_networking", "id": 23, "label": "Computer Networking", "order": 23 }, { "name": "computer_software/engineering", "id": 24, "label": "Computer Software/Engineering", "order": 24 }, { "name": "computer/network_security", "id": 25, "label": "Computer/Network Security", "order": 25 }, { "name": "construction", "id": 26, "label": "Construction", "order": 26 }, { "name": "consumer_electronics", "id": 27, "label": "Consumer Electronics", "order": 27 }, { "name": "consumer_goods", "id": 28, "label": "Consumer Goods", "order": 28 }, { "name": "consumer_services", "id": 29, "label": "Consumer Services", "order": 29 }, { "name": "cosmetics", "id": 30, "label": "Cosmetics", "order": 30 }, { "name": "dairy", "id": 31, "label": "Dairy", "order": 31 }, { "name": "defense/space", "id": 32, "label": "Defense/Space", "order": 32 }, { "name": "design", "id": 33, "label": "Design", "order": 33 }, { "name": "e-learning", "id": 34, "label": "E-Learning", "order": 34 }, { "name": "education_management", "id": 35, "label": "Education Management", "order": 35 }, { "name": "electrical/electronic_manufacturing", "id": 36, "label": "Electrical/Electronic Manufacturing", "order": 36 }, { "name": "entertainment/movie_production", "id": 37, "label": "Entertainment/Movie Production", "order": 37 }, { "name": "environmental_services", "id": 38, "label": "Environmental Services", "order": 38 }, { "name": "events_services", "id": 39, "label": "Events Services", "order": 39 }, { "name": "executive_office", "id": 40, "label": "Executive Office", "order": 40 }, { "name": "facilities_services", "id": 41, "label": "Facilities Services", "order": 41 }, { "name": "farming", "id": 42, "label": "Farming", "order": 42 }, { "name": "financial_services", "id": 43, "label": "Financial Services", "order": 43 }, { "name": "fine_art", "id": 44, "label": "Fine Art", "order": 44 }, { "name": "fishery", "id": 45, "label": "Fishery", "order": 45 }, { "name": "food_production", "id": 46, "label": "Food Production", "order": 46 }, { "name": "food/beverages", "id": 47, "label": "Food/Beverages", "order": 47 }, { "name": "fundraising", "id": 48, "label": "Fundraising", "order": 48 }, { "name": "furniture", "id": 49, "label": "Furniture", "order": 49 }, { "name": "gambling/casinos", "id": 50, "label": "Gambling/Casinos", "order": 50 }, { "name": "glass/ceramics/concrete", "id": 51, "label": "Glass/Ceramics/Concrete", "order": 51 }, { "name": "government_administration", "id": 52, "label": "Government Administration", "order": 52 }, { "name": "government_relations", "id": 53, "label": "Government Relations", "order": 53 }, { "name": "graphic_design/web_design", "id": 54, "label": "Graphic Design/Web Design", "order": 54 }, { "name": "health/fitness", "id": 55, "label": "Health/Fitness", "order": 55 }, { "name": "higher_education/acadamia", "id": 56, "label": "Higher Education/Acadamia", "order": 56 }, { "name": "hospital/health_care", "id": 57, "label": "Hospital/Health Care", "order": 57 }, { "name": "hospitality", "id": 58, "label": "Hospitality", "order": 58 }, { "name": "human_resources/hr", "id": 59, "label": "Human Resources/HR", "order": 59 }, { "name": "import/export", "id": 60, "label": "Import/Export", "order": 60 }, { "name": "individual/family_services", "id": 61, "label": "Individual/Family Services", "order": 61 }, { "name": "industrial_automation", "id": 62, "label": "Industrial Automation", "order": 62 }, { "name": "information_services", "id": 63, "label": "Information Services", "order": 63 }, { "name": "information_technology/it", "id": 64, "label": "Information Technology/IT", "order": 64 }, { "name": "insurance", "id": 65, "label": "Insurance", "order": 65 }, { "name": "international_affairs", "id": 66, "label": "International Affairs", "order": 66 }, { "name": "international_trade/development", "id": 67, "label": "International Trade/Development", "order": 67 }, { "name": "internet", "id": 68, "label": "Internet", "order": 68 }, { "name": "investment_banking/venture", "id": 69, "label": "Investment Banking/Venture", "order": 69 }, { "name": "investment_management/hedge_fund/private_equity", "id": 70, "label": "Investment Management/Hedge Fund/Private Equity", "order": 70 }, { "name": "judiciary", "id": 71, "label": "Judiciary", "order": 71 }, { "name": "law_enforcement", "id": 72, "label": "Law Enforcement", "order": 72 }, { "name": "law_practice/law_firms", "id": 73, "label": "Law Practice/Law Firms", "order": 73 }, { "name": "legal_services", "id": 74, "label": "Legal Services", "order": 74 }, { "name": "legislative_office", "id": 75, "label": "Legislative Office", "order": 75 }, { "name": "leisure/travel", "id": 76, "label": "Leisure/Travel", "order": 76 }, { "name": "library", "id": 77, "label": "Library", "order": 77 }, { "name": "logistics/procurement", "id": 78, "label": "Logistics/Procurement", "order": 78 }, { "name": "luxury_goods/jewelry", "id": 79, "label": "Luxury Goods/Jewelry", "order": 79 }, { "name": "machinery", "id": 80, "label": "Machinery", "order": 80 }, { "name": "management_consulting", "id": 81, "label": "Management Consulting", "order": 81 }, { "name": "maritime", "id": 82, "label": "Maritime", "order": 82 }, { "name": "market_research", "id": 83, "label": "Market Research", "order": 83 }, { "name": "marketing/advertising/sales", "id": 84, "label": "Marketing/Advertising/Sales", "order": 84 }, { "name": "mechanical_or_industrial_engineering", "id": 85, "label": "Mechanical or Industrial Engineering", "order": 85 }, { "name": "media_production", "id": 86, "label": "Media Production", "order": 86 }, { "name": "medical_equipment", "id": 87, "label": "Medical Equipment", "order": 87 }, { "name": "medical_practice", "id": 88, "label": "Medical Practice", "order": 88 }, { "name": "mental_health_care", "id": 89, "label": "Mental Health Care", "order": 89 }, { "name": "military_industry", "id": 90, "label": "Military Industry", "order": 90 }, { "name": "mining/metals", "id": 91, "label": "Mining/Metals", "order": 91 }, { "name": "motion_pictures/film", "id": 92, "label": "Motion Pictures/Film", "order": 92 }, { "name": "museums/institutions", "id": 93, "label": "Museums/Institutions", "order": 93 }, { "name": "music", "id": 94, "label": "Music", "order": 94 }, { "name": "nanotechnology", "id": 95, "label": "Nanotechnology", "order": 95 }, { "name": "newspapers/journalism", "id": 96, "label": "Newspapers/Journalism", "order": 96 }, { "name": "non-profit/volunteering", "id": 97, "label": "Non-Profit/Volunteering", "order": 97 }, { "name": "oil/energy/solar/greentech", "id": 98, "label": "Oil/Energy/Solar/Greentech", "order": 98 }, { "name": "online_publishing", "id": 99, "label": "Online Publishing", "order": 99 }, { "name": "other_industry", "id": 100, "label": "Other Industry", "order": 100 }, { "name": "outsourcing/offshoring", "id": 101, "label": "Outsourcing/Offshoring", "order": 101 }, { "name": "package/freight_delivery", "id": 102, "label": "Package/Freight Delivery", "order": 102 }, { "name": "packaging/containers", "id": 103, "label": "Packaging/Containers", "order": 103 }, { "name": "paper/forest_products", "id": 104, "label": "Paper/Forest Products", "order": 104 }, { "name": "performing_arts", "id": 105, "label": "Performing Arts", "order": 105 }, { "name": "pharmaceuticals", "id": 106, "label": "Pharmaceuticals", "order": 106 }, { "name": "philanthropy", "id": 107, "label": "Philanthropy", "order": 107 }, { "name": "photography", "id": 108, "label": "Photography", "order": 108 }, { "name": "plastics", "id": 109, "label": "Plastics", "order": 109 }, { "name": "political_organization", "id": 110, "label": "Political Organization", "order": 110 }, { "name": "primary/secondary_education", "id": 111, "label": "Primary/Secondary Education", "order": 111 }, { "name": "printing", "id": 112, "label": "Printing", "order": 112 }, { "name": "professional_training", "id": 113, "label": "Professional Training", "order": 113 }, { "name": "program_development", "id": 114, "label": "Program Development", "order": 114 }, { "name": "public_relations/pr", "id": 115, "label": "Public Relations/PR", "order": 115 }, { "name": "public_safety", "id": 116, "label": "Public Safety", "order": 116 }, { "name": "publishing_industry", "id": 117, "label": "Publishing Industry", "order": 117 }, { "name": "railroad_manufacture", "id": 118, "label": "Railroad Manufacture", "order": 118 }, { "name": "ranching", "id": 119, "label": "Ranching", "order": 119 }, { "name": "real_estate/mortgage", "id": 120, "label": "Real Estate/Mortgage", "order": 120 }, { "name": "recreational_facilities/services", "id": 121, "label": "Recreational Facilities/Services", "order": 121 }, { "name": "religious_institutions", "id": 122, "label": "Religious Institutions", "order": 122 }, { "name": "renewables/environment", "id": 123, "label": "Renewables/Environment", "order": 123 }, { "name": "research_industry", "id": 124, "label": "Research Industry", "order": 124 }, { "name": "restaurants", "id": 125, "label": "Restaurants", "order": 125 }, { "name": "retail_industry", "id": 126, "label": "Retail Industry", "order": 126 }, { "name": "security/investigations", "id": 127, "label": "Security/Investigations", "order": 127 }, { "name": "semiconductors", "id": 128, "label": "Semiconductors", "order": 128 }, { "name": "shipbuilding", "id": 129, "label": "Shipbuilding", "order": 129 }, { "name": "sporting_goods", "id": 130, "label": "Sporting Goods", "order": 130 }, { "name": "sports", "id": 131, "label": "Sports", "order": 131 }, { "name": "staffing/recruiting", "id": 132, "label": "Staffing/Recruiting", "order": 132 }, { "name": "supermarkets", "id": 133, "label": "Supermarkets", "order": 133 }, { "name": "telecommunications", "id": 134, "label": "Telecommunications", "order": 134 }, { "name": "textiles", "id": 135, "label": "Textiles", "order": 135 }, { "name": "think_tanks", "id": 136, "label": "Think Tanks", "order": 136 }, { "name": "tobacco", "id": 137, "label": "Tobacco", "order": 137 }, { "name": "translation/localization", "id": 138, "label": "Translation/Localization", "order": 138 }, { "name": "transportation", "id": 139, "label": "Transportation", "order": 139 }, { "name": "utilities", "id": 140, "label": "Utilities", "order": 140 }, { "name": "venture_capital/vc", "id": 141, "label": "Venture Capital/VC", "order": 141 }, { "name": "veterinary", "id": 142, "label": "Veterinary", "order": 142 }, { "name": "warehousing", "id": 143, "label": "Warehousing", "order": 143 }, { "name": "wholesale", "id": 144, "label": "Wholesale", "order": 144 }, { "name": "wine/spirits", "id": 145, "label": "Wine/Spirits", "order": 145 }, { "name": "wireless", "id": 146, "label": "Wireless", "order": 146 }, { "name": "writing/editing", "id": 147, "label": "Writing/Editing", "order": 147 } ] } } } } }, "deprecated": false, "servers": [ { "url": "http://example.com", "variables": { } } ], "security": [] } }, "/api/v3/ua/static/media-budget": { "get": { "tags": [ "User Management API" ], "summary": "Media budget", "operationId": "Mediabudget", "parameters": [], "responses": { "200": { "description": "OK", "headers": { }, "content": { "application/json": { "schema": { "title": "200OK17", "required": [ "success", "data" ], "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "array", "items": { "title": "Data76", "required": [ "name", "id", "label", "order" ], "type": "object", "properties": { "name": { "type": "string" }, "id": { "type": "integer", "format": "int32" }, "label": { "type": "string" }, "order": { "type": "integer", "format": "int32" } }, "example": { "name": "pending", "id": 2, "label": "Pending", "order": 1 } }, "description": "" } }, "example": { "success": true, "data": [ { "name": "pending", "id": 2, "label": "Pending", "order": 1 }, { "name": "invited", "id": 3, "label": "Invited", "order": 3 }, { "name": "on_hold", "id": 4, "label": "On Hold", "order": 4 }, { "name": "active", "id": 1, "label": "Active", "order": 2 }, { "name": "deleted", "id": 5, "label": "Deleted", "order": 5 } ] } }, "example": { "success": true, "data": [ { "name": "\u003C50,000", "id": 1, "label": "\u003C $50,000", "order": 1 }, { "name": "50,000_100,000", "id": 2, "label": "$50,000 - $100,000", "order": 2 }, { "name": "100,000_500,000", "id": 3, "label": "$100,000 - $500,000", "order": 3 }, { "name": "500,000_1,000,000", "id": 4, "label": "$500,000 - $1,000,000", "order": 4 }, { "name": "1,000,000_10,000,000", "id": 5, "label": "$1,000,000 - $10,000,000", "order": 5 }, { "name": "\u003E10,000,000", "id": 6, "label": "\u003E $10,000,000", "order": 6 } ] } } } } }, "deprecated": false, "servers": [ { "url": "http://example.com", "variables": { } } ], "security": [] } }, "/api/v3/fa/customer/campaign-margin-list": { "get": { "tags": [ "User Management API" ], "summary": "Get campaign wise margin list", "operationId": "Getcampaignwisemarginlist", "parameters": [ { "name": "owId", "in": "query", "description": "", "required": true, "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32", "example": 1 } }, { "name": "searchField", "in": "query", "description": "", "required": true, "style": "form", "explode": true, "schema": { "type": "string", "example": "test" } }, { "name": "isEdit", "in": "query", "description": "(Optional) default - false, \nfor non-edit mode isEdit: false,\nfor edit mode isEdit: true.", "required": true, "style": "form", "explode": true, "schema": { "type": "boolean", "example": true } }, { "name": "X-IAA-OW-ID", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32", "example": 1 } }, { "name": "Authorization", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "{{bearer_token}}" } } ], "responses": { "200": { "description": "OK", "headers": { }, "content": { "application/json": { "schema": { "title": "SuccessResponse200OK51", "required": [ "success", "data" ], "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "title": "Data91", "required": [ "data", "totalRecords", "filteredRecords" ], "type": "object", "properties": { "data": { "type": "array", "items": { "title": "Data92", "required": [ "default", "campaignId", "campaignName", "status", "creativeTypeId", "campaignMargin", "isDefault" ], "type": "object", "properties": { "default": { "type": "boolean" }, "campaignId": { "type": "integer", "format": "int32" }, "campaignName": { "type": "string" }, "status": { "type": "string" }, "creativeTypeId": { "type": "integer", "format": "int32" }, "campaignMargin": { "type": "number" }, "isDefault": { "type": "boolean" } }, "example": { "default": false, "campaignId": 192476, "campaignName": "Start_Track_Reach2", "status": "running", "creativeTypeId": 13, "campaignMargin": 0, "isDefault": false } }, "description": "" }, "totalRecords": { "type": "integer", "format": "int32" }, "filteredRecords": { "type": "integer", "format": "int32" } }, "example": { "data": [ { "default": false, "campaignId": 192476, "campaignName": "Start_Track_Reach2", "status": "running", "creativeTypeId": 13, "campaignMargin": 0, "isDefault": false } ], "totalRecords": 1, "filteredRecords": 1 } } }, "example": { "success": true, "data": { "data": [ { "default": false, "campaignId": 192476, "campaignName": "Start_Track_Reach2", "status": "running", "creativeTypeId": 13, "campaignMargin": 0, "isDefault": false } ], "totalRecords": 1, "filteredRecords": 1 } } }, "example": { "success": true, "data": { "data": [ { "default": false, "campaignId": 192476, "campaignName": "Start_Track_Reach2", "status": "running", "creativeTypeId": 13, "campaignMargin": 0, "isDefault": false } ], "totalRecords": 1, "filteredRecords": 1 } } } } } }, "deprecated": false, "security": [], "servers": [ { "url": "http://example.com", "variables": { } } ] } }, "/api/v3/fa/customer/credit/add": { "post": { "tags": [ "User Management API" ], "summary": "Add Credit to Customer", "operationId": "AddCredittoCustomer", "parameters": [ { "name": "Authorization", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "{{bearer_token}}" } }, { "name": "X-IAA-OW-ID", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32", "example": 1 } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "title": "AddCredittoCustomerRequest", "required": [ "owId", "creditAmount" ], "type": "object", "properties": { "owId": { "type": "integer", "format": "int32" }, "creditAmount": { "type": "integer", "format": "int32" } }, "example": { "owId": 23, "creditAmount": 5000 } }, "example": { "owId": 23, "creditAmount": 5000 } } }, "required": true }, "responses": { "200": { "description": "OK", "headers": { }, "content": { "application/json": { "schema": { "title": "SuccessResponse200OK", "required": [ "success", "data" ], "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "string" } }, "example": { "success": true, "data": "Invitation cancelled successfully." } }, "example": { "success": true, "data": "Credits offered Successfully." } } } }, "403": { "description": "Forbidden", "headers": { }, "content": { "application/json": { "schema": { "title": "Notallowedtoaccesscustomer403Forbidden1", "required": [ "success", "errorObjects" ], "type": "object", "properties": { "success": { "type": "boolean" }, "errorObjects": { "type": "array", "items": { "title": "ErrorObject2", "required": [ "error" ], "type": "object", "properties": { "error": { "type": "string" } }, "example": { "error": "Only active invitations can be cancelled." } }, "description": "" } }, "example": { "success": false, "errorObjects": [ { "error": "User is not allowed to access provided customer" } ] } }, "example": { "success": false, "errorObjects": [ { "error": "User is not allowed to access provided customer" } ] } } } } }, "deprecated": false, "security": [], "servers": [ { "url": "http://example.com", "variables": { } } ] } }, "/api/v3/fa/customer/credit/edit": { "patch": { "tags": [ "User Management API" ], "summary": "Edit offered Credit to Customer", "operationId": "EditofferedCredittoCustomer", "parameters": [ { "name": "X-IAA-OW-ID", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32", "example": 1 } }, { "name": "Authorization", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "{{bearer_token}}" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "title": "EditofferedCredittoCustomerRequest", "required": [ "owId", "creditAmount", "creditId" ], "type": "object", "properties": { "owId": { "type": "integer", "format": "int32" }, "creditAmount": { "type": "integer", "format": "int32" }, "creditId": { "type": "integer", "format": "int32" } }, "example": { "owId": 54, "creditAmount": 4000, "creditId": 3 } }, "example": { "owId": 54, "creditAmount": 4000, "creditId": 3 } } }, "required": true }, "responses": { "200": { "description": "OK", "headers": { }, "content": { "application/json": { "schema": { "title": "SuccessResponse200OK", "required": [ "success", "data" ], "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "string" } }, "example": { "success": true, "data": "Invitation cancelled successfully." } }, "example": { "success": true, "data": "Credits updated Successfully." } } } }, "422": { "description": "Unprocessable Entity (WebDAV) (RFC 4918)", "headers": { }, "content": { "application/json": { "schema": { "title": "Creditnotupdated422UnprocessableEntity1", "required": [ "success", "errorObjects" ], "type": "object", "properties": { "success": { "type": "boolean" }, "errorObjects": { "type": "array", "items": { "title": "ErrorObject2", "required": [ "error" ], "type": "object", "properties": { "error": { "type": "string" } }, "example": { "error": "Only active invitations can be cancelled." } }, "description": "" } }, "example": { "success": false, "errorObjects": [ { "error": "Credit is not updated for provided customer" } ] } }, "example": { "success": false, "errorObjects": [ { "error": "Credit is not updated for provided customer" } ] } } } } }, "deprecated": false, "security": [], "servers": [ { "url": "http://example.com", "variables": { } } ] } }, "/api/v3/fa/customer/credits/list": { "get": { "tags": [ "User Management API" ], "summary": "List credits offered to customer", "operationId": "Listcreditsofferedtocustomer", "parameters": [ { "name": "owId", "in": "query", "description": "", "required": true, "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32", "example": 54 } }, { "name": "X-IAA-OW-ID", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32", "example": 1 } }, { "name": "Authorization", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "{{bearer_token}}" } } ], "responses": { "200": { "description": "OK", "headers": { }, "content": { "application/json": { "schema": { "title": "SuccessResponse200OK54", "required": [ "success", "data" ], "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "array", "items": { "title": "Data93", "required": [ "creditId", "owId", "creditAmount", "status", "modifiedAt", "uowId", "displayName" ], "type": "object", "properties": { "creditId": { "type": "integer", "format": "int32" }, "owId": { "type": "integer", "format": "int32" }, "creditAmount": { "type": "number" }, "status": { "type": "string" }, "modifiedAt": { "type": "string" }, "uowId": { "type": "integer", "format": "int32" }, "displayName": { "type": "string" } }, "example": { "creditId": 3, "owId": 54, "creditAmount": 1000, "status": "Revoked", "modifiedAt": "2021-09-03T04:23:41.000+00:00", "uowId": 1, "displayName": "IHP" } }, "description": "" } }, "example": { "success": true, "data": [ { "creditId": 3, "owId": 54, "creditAmount": 1000, "status": "Revoked", "modifiedAt": "2021-09-03T04:23:41.000+00:00", "uowId": 1, "displayName": "IHP" }, { "creditId": 2, "owId": 54, "creditAmount": 2000, "status": "Unclaimed", "modifiedAt": "2021-08-31T12:43:38.000+00:00", "uowId": 1, "displayName": "IHP" }, { "creditId": 1, "owId": 54, "creditAmount": 6000, "status": "Unclaimed", "modifiedAt": "2021-08-31T12:12:43.000+00:00", "uowId": 1, "displayName": "IHP" } ] } }, "example": { "success": true, "data": [ { "creditId": 3, "owId": 54, "creditAmount": 1000, "status": "Revoked", "modifiedAt": "2021-09-03T04:23:41.000+00:00", "uowId": 1, "displayName": "IHP" }, { "creditId": 2, "owId": 54, "creditAmount": 2000, "status": "Unclaimed", "modifiedAt": "2021-08-31T12:43:38.000+00:00", "uowId": 1, "displayName": "IHP" }, { "creditId": 1, "owId": 54, "creditAmount": 6000, "status": "Unclaimed", "modifiedAt": "2021-08-31T12:12:43.000+00:00", "uowId": 1, "displayName": "IHP" } ] } } } }, "403": { "description": "Forbidden", "headers": { }, "content": { "application/json": { "schema": { "title": "Notallowedtoaccesscustomer403Forbidden1", "required": [ "success", "errorObjects" ], "type": "object", "properties": { "success": { "type": "boolean" }, "errorObjects": { "type": "array", "items": { "title": "ErrorObject2", "required": [ "error" ], "type": "object", "properties": { "error": { "type": "string" } }, "example": { "error": "Only active invitations can be cancelled." } }, "description": "" } }, "example": { "success": false, "errorObjects": [ { "error": "User is not allowed to access provided customer" } ] } }, "example": { "success": false, "errorObjects": [ { "error": "User is not allowed to access provided customer" } ] } } } } }, "deprecated": false, "security": [], "servers": [ { "url": "http://example.com", "variables": { } } ] } }, "/api/v3/fa/customer/credit/revoke": { "post": { "tags": [ "User Management API" ], "summary": "Revoke Credit offered to Customer", "operationId": "RevokeCreditofferedtoCustomer", "parameters": [ { "name": "X-IAA-OW-ID", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32", "example": 1 } }, { "name": "Authorization", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "{{bearer_token}}" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "title": "RevokeCreditofferedtoCustomerRequest", "required": [ "owId", "creditId" ], "type": "object", "properties": { "owId": { "type": "integer", "format": "int32" }, "creditId": { "type": "integer", "format": "int32" } }, "example": { "owId": 54, "creditId": 2 } }, "example": { "owId": 54, "creditId": 2 } } }, "required": true }, "responses": { "200": { "description": "OK", "headers": { }, "content": { "application/json": { "schema": { "title": "SuccessResponse200OK", "required": [ "success", "data" ], "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "string" } }, "example": { "success": true, "data": "Invitation cancelled successfully." } }, "example": { "success": true, "data": "Credits revoked Successfully." } } } }, "422": { "description": "Unprocessable Entity (WebDAV) (RFC 4918)", "headers": { }, "content": { "application/json": { "schema": { "title": "Creditsnotrevoked422UnprocessableEntity1", "required": [ "success", "errorObjects" ], "type": "object", "properties": { "success": { "type": "boolean" }, "errorObjects": { "type": "array", "items": { "title": "ErrorObject2", "required": [ "error" ], "type": "object", "properties": { "error": { "type": "string" } }, "example": { "error": "Only active invitations can be cancelled." } }, "description": "" } }, "example": { "success": false, "errorObjects": [ { "error": "Credit is not revoked for provided customer." } ] } }, "example": { "success": false, "errorObjects": [ { "error": "Credit is not revoked for provided customer." } ] } } } } }, "deprecated": false, "security": [], "servers": [ { "url": "http://example.com", "variables": { } } ] } }, "/api/v3/fa/credit/claim": { "post": { "tags": [ "User Management API" ], "summary": "Claim offered credits", "operationId": "Claimofferedcredits", "parameters": [ { "name": "X-IAA-OW-ID", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32", "example": 1 } }, { "name": "Authorization", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "{{bearer_token}}" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "title": "ClaimofferedcreditsRequest", "required": [ "creditId", "customerName", "businessName", "taxId", "contactPersonName", "contactPersonEmail", "incorporationPlace", "address" ], "type": "object", "properties": { "creditId": { "type": "integer", "format": "int32" }, "customerName": { "type": "string" }, "businessName": { "type": "string" }, "taxId": { "type": "string" }, "contactPersonName": { "type": "string" }, "contactPersonEmail": { "type": "string" }, "incorporationPlace": { "type": "string" }, "address": { "type": "string" } }, "example": { "creditId": 4, "customerName": "JP test ", "businessName": "JP test org3", "taxId": "123456", "contactPersonName": "JP", "contactPersonEmail": "jinesh.p+nonihpcust2@iqm.com", "incorporationPlace": "Gujarat, India", "address": "A-123, XYZ Complex, Ahmedabad, Gujarat, India - 380059" } }, "example": { "creditId": 4, "customerName": "JP test ", "businessName": "JP test org3", "taxId": "123456", "contactPersonName": "JP", "contactPersonEmail": "jinesh.p+nonihpcust2@iqm.com", "incorporationPlace": "Gujarat, India", "address": "A-123, XYZ Complex, Ahmedabad, Gujarat, India - 380059" } } }, "required": true }, "responses": { "200": { "description": "OK", "headers": { }, "content": { "application/json": { "schema": { "title": "SuccessResponse200OK", "required": [ "success", "data" ], "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "string" } }, "example": { "success": true, "data": "Invitation cancelled successfully." } }, "example": { "success": true, "data": "Credits claimed." } } } }, "422": { "description": "Unprocessable Entity (WebDAV) (RFC 4918)", "headers": { }, "content": { "application/json": { "schema": { "title": "Creditsnotclaimed422UnprocessableEntity1", "required": [ "success", "errorObjects" ], "type": "object", "properties": { "success": { "type": "boolean" }, "errorObjects": { "type": "array", "items": { "title": "ErrorObject2", "required": [ "error" ], "type": "object", "properties": { "error": { "type": "string" } }, "example": { "error": "Only active invitations can be cancelled." } }, "description": "" } }, "example": { "success": false, "errorObjects": [ { "error": "Credits can not be claimed." } ] } }, "example": { "success": false, "errorObjects": [ { "error": "Credits can not be claimed." } ] } } } } }, "deprecated": false, "security": [], "servers": [ { "url": "http://example.com", "variables": { } } ] } }, "/api/v3/fa/credits/list": { "get": { "tags": [ "User Management API" ], "summary": "List Credits offered to my organization", "operationId": "ListCreditsofferedtomyorganization", "parameters": [ { "name": "pageNo", "in": "query", "description": "", "required": true, "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32", "example": 1 } }, { "name": "limit", "in": "query", "description": "", "required": true, "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32", "example": 50 } }, { "name": "sortBy", "in": "query", "description": "", "required": true, "style": "form", "explode": true, "schema": { "type": "string", "example": "-modifiedAt" } }, { "name": "X-IAA-OW-ID", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32", "example": 200425 } }, { "name": "Authorization", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "{{bearer_token}}" } } ], "responses": { "200": { "description": "OK", "headers": { }, "content": { "application/json": { "schema": { "title": "SuccessResponse200OK57", "required": [ "success", "data" ], "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "title": "Data94", "required": [ "data", "totalRecords", "filteredRecords" ], "type": "object", "properties": { "data": { "type": "array", "items": { "title": "Data95", "required": [ "creditId", "creditAmount", "modifiedAt", "status", "organizationName" ], "type": "object", "properties": { "creditId": { "type": "integer", "format": "int32" }, "creditAmount": { "type": "number" }, "modifiedAt": { "type": "string" }, "status": { "type": "string" }, "organizationName": { "type": "string" } }, "example": { "creditId": 2, "creditAmount": 1000, "modifiedAt": "2021-09-08T10:24:32.000+00:00", "status": "Unclaimed", "organizationName": "JP test org" } }, "description": "" }, "totalRecords": { "type": "integer", "format": "int32" }, "filteredRecords": { "type": "integer", "format": "int32" } }, "example": { "data": [ { "creditId": 2, "creditAmount": 1000, "modifiedAt": "2021-09-08T10:24:32.000+00:00", "status": "Unclaimed", "organizationName": "JP test org" }, { "creditId": 1, "creditAmount": 1500, "modifiedAt": "2021-09-08T05:46:15.000+00:00", "status": "Revoked", "organizationName": "JP test org" } ], "totalRecords": 2, "filteredRecords": 2 } } }, "example": { "success": true, "data": { "data": [ { "creditId": 2, "creditAmount": 1000, "modifiedAt": "2021-09-08T10:24:32.000+00:00", "status": "Unclaimed", "organizationName": "JP test org" }, { "creditId": 1, "creditAmount": 1500, "modifiedAt": "2021-09-08T05:46:15.000+00:00", "status": "Revoked", "organizationName": "JP test org" } ], "totalRecords": 2, "filteredRecords": 2 } } }, "example": { "success": true, "data": { "data": [ { "creditId": 2, "creditAmount": 1000, "modifiedAt": "2021-09-08T10:24:32.000+00:00", "status": "Unclaimed", "organizationName": "JP test org" }, { "creditId": 1, "creditAmount": 1500, "modifiedAt": "2021-09-08T05:46:15.000+00:00", "status": "Revoked", "organizationName": "JP test org" } ], "totalRecords": 2, "filteredRecords": 2 } } } } }, "422": { "description": "Unprocessable Entity (WebDAV) (RFC 4918)", "headers": { }, "content": { "application/json": { "schema": { "title": "InvalidsortByvalue422UnprocessableEntity1", "required": [ "success", "errorObjects" ], "type": "object", "properties": { "success": { "type": "boolean" }, "errorObjects": { "type": "array", "items": { "title": "ErrorObject2", "required": [ "error" ], "type": "object", "properties": { "error": { "type": "string" } }, "example": { "error": "Only active invitations can be cancelled." } }, "description": "" } }, "example": { "success": false, "errorObjects": [ { "error": "Invalid sortBy value." } ] } }, "example": { "success": false, "errorObjects": [ { "error": "Invalid sortBy value." } ] } } } } }, "deprecated": false, "security": [], "servers": [ { "url": "https://jptest1.stage.inhousebuying.com/api/v3/fa/credits", "variables": { } } ] } }, "/api/v3/fa/credit-summary/{owId}": { "get": { "tags": [ "User Management API" ], "summary": "Credit Summary", "operationId": "CreditSummary", "parameters": [ { "name": "isCustomerRequest", "in": "query", "description": "default:- true\nFor customer app request, value=true\nFor organization app request, value=false", "required": true, "style": "form", "explode": true, "schema": { "type": "boolean", "example": true } }, { "name": "Authorization", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "{{bearer_token}}" } }, { "name": "X-IAA-OW-ID", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32", "example": 200422 } }, { "name": "owId", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": { }, "content": { "application/json": { "schema": { "title": "SuccessResponse200OK58", "required": [ "success", "data" ], "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "title": "Data96", "required": [ "usedCredit", "totalCredit" ], "type": "object", "properties": { "usedCredit": { "type": "number" }, "totalCredit": { "type": "number" } }, "example": { "usedCredit": 21875.37, "totalCredit": 50000 } } }, "example": { "success": true, "data": { "usedCredit": 21875.37, "totalCredit": 50000 } } }, "example": { "success": true, "data": { "usedCredit": 21875.37, "totalCredit": 50000 } } } } } }, "deprecated": false, "security": [], "servers": [ { "url": "http://example.com", "variables": { } } ] } }, "/api/v3/fa/customer/payments/list": { "get": { "tags": [ "User Management API" ], "summary": "List Payment for Customer", "operationId": "ListPaymentforCustomer", "parameters": [ { "name": "owId", "in": "query", "description": "ow id of selected customer", "required": true, "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32", "example": 200425 } }, { "name": "status", "in": "query", "description": "(Optional) payment status id", "required": true, "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32", "example": 1 } }, { "name": "paymentType", "in": "query", "description": "(Optional) payment type id", "required": true, "style": "form", "explode": true, "schema": { "type": "string", "example": "1,2" } }, { "name": "searchField", "in": "query", "description": "(Optional) search field", "required": true, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "pageNo", "in": "query", "description": "(Optional) Page Number (default: 1)", "required": true, "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32", "example": 1 } }, { "name": "limit", "in": "query", "description": "(Optional) Page Size (default: 10)", "required": true, "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32", "example": 10 } }, { "name": "sortBy", "in": "query", "description": "(Optional) Sort by fields (default : -modifiedAt)\nHere minus(-) sign is for order DESC and plus(+) sign for order ASC.\nValue can be from paymentId. paymentDate, paymentAmount, organizationName, paymentType, paymentMode, paymentStatus, modifiedAt.", "required": true, "style": "form", "explode": true, "schema": { "type": "string", "example": "-paymentStatus" } } ], "responses": { "200": { "description": "OK", "headers": { }, "content": { "application/json": { "schema": { "title": "SuccessResponse200OK59", "required": [ "success", "data" ], "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "title": "Data97", "required": [ "data", "totalRecords", "filteredRecords" ], "type": "object", "properties": { "data": { "type": "array", "items": { "title": "Data98", "required": [ "isPaymentInitiatorOrg", "paymentId", "createdAt", "createdByUserEmail", "createdByUserProfile", "paymentDate", "paymentAmount", "paymentStatus", "paymentMode", "paymentType", "invoiceId", "transactionId", "modifiedAt", "modifiedByUserEmail", "modifiedByUserProfile", "bankName", "refundReason" ], "type": "object", "properties": { "isPaymentInitiatorOrg": { "type": "boolean" }, "paymentId": { "type": "integer", "format": "int32" }, "createdAt": { "type": "integer", "format": "int64" }, "createdByUserEmail": { "type": "string" }, "createdByUserProfile": { "type": "string" }, "paymentDate": { "type": "integer", "format": "int64" }, "paymentAmount": { "type": "number" }, "paymentStatus": { "type": "string" }, "paymentMode": { "type": "string" }, "paymentType": { "type": "string" }, "invoiceId": { "type": "integer", "format": "int32" }, "transactionId": { "type": "string", "nullable": true }, "modifiedAt": { "type": "integer", "format": "int64" }, "modifiedByUserEmail": { "type": "string" }, "modifiedByUserProfile": { "type": "string" }, "bankName": { "type": "string", "nullable": true }, "refundReason": { "type": "string", "nullable": true } }, "example": { "isPaymentInitiatorOrg": false, "paymentId": 19, "createdAt": 1632295016000, "createdByUserEmail": "jinesh.p+nonihpcust2@iqm.com", "createdByUserProfile": "https://iqm-web-assets-c92d6b6cbde1-stage.s3.amazonaws.com/avatar/JO.svg", "paymentDate": 1632076200000, "paymentAmount": 10000, "paymentStatus": "Rejected", "paymentMode": "PayPal", "paymentType": "As Fund", "invoiceId": 0, "transactionId": "T-1234567", "modifiedAt": 1637566978000, "modifiedByUserEmail": "jinesh.p+ihpcust@iqm.com", "modifiedByUserProfile": "https://iqm-web-assets-c92d6b6cbde1-stage.s3.amazonaws.com/avatar/JO.svg", "bankName": null, "refundReason": null } }, "description": "" }, "totalRecords": { "type": "integer", "format": "int32" }, "filteredRecords": { "type": "integer", "format": "int32" } }, "example": { "data": [ { "isPaymentInitiatorOrg": false, "paymentId": 19, "createdAt": 1632295016000, "createdByUserEmail": "jinesh.p+nonihpcust2@iqm.com", "createdByUserProfile": "https://iqm-web-assets-c92d6b6cbde1-stage.s3.amazonaws.com/avatar/JO.svg", "paymentDate": 1632076200000, "paymentAmount": 10000, "paymentStatus": "Rejected", "paymentMode": "PayPal", "paymentType": "As Fund", "invoiceId": 0, "transactionId": "T-1234567", "modifiedAt": 1637566978000, "modifiedByUserEmail": "jinesh.p+ihpcust@iqm.com", "modifiedByUserProfile": "https://iqm-web-assets-c92d6b6cbde1-stage.s3.amazonaws.com/avatar/JO.svg", "bankName": null, "refundReason": null }, { "isPaymentInitiatorOrg": false, "paymentId": 886, "createdAt": 1635831910000, "createdByUserEmail": "jinesh.p+ihpcust@iqm.com", "createdByUserProfile": "https://iqm-web-assets-c92d6b6cbde1-stage.s3.amazonaws.com/avatar/JO.svg", "paymentDate": 1635791400000, "paymentAmount": 10, "paymentStatus": "Processing", "paymentMode": "Check", "paymentType": "Refund", "invoiceId": 0, "transactionId": "123456", "modifiedAt": 1635831910000, "modifiedByUserEmail": "jinesh.p+ihpcust@iqm.com", "modifiedByUserProfile": "https://iqm-web-assets-c92d6b6cbde1-stage.s3.amazonaws.com/avatar/JO.svg", "bankName": null, "refundReason": "Testing" }, { "isPaymentInitiatorOrg": false, "paymentId": 885, "createdAt": 1635831695000, "createdByUserEmail": "jinesh.p+ihpcust@iqm.com", "createdByUserProfile": "https://iqm-web-assets-c92d6b6cbde1-stage.s3.amazonaws.com/avatar/JO.svg", "paymentDate": 1635791400000, "paymentAmount": 10, "paymentStatus": "Processing", "paymentMode": "To Funds", "paymentType": "Refund", "invoiceId": 0, "transactionId": "123456", "modifiedAt": 1635831695000, "modifiedByUserEmail": "jinesh.p+ihpcust@iqm.com", "modifiedByUserProfile": "https://iqm-web-assets-c92d6b6cbde1-stage.s3.amazonaws.com/avatar/JO.svg", "bankName": null, "refundReason": "Testing" }, { "isPaymentInitiatorOrg": false, "paymentId": 884, "createdAt": 1635831127000, "createdByUserEmail": "jinesh.p+ihpcust@iqm.com", "createdByUserProfile": "https://iqm-web-assets-c92d6b6cbde1-stage.s3.amazonaws.com/avatar/JO.svg", "paymentDate": 1635791400000, "paymentAmount": 10, "paymentStatus": "Processing", "paymentMode": "To Funds", "paymentType": "Refund", "invoiceId": 0, "transactionId": "123456", "modifiedAt": 1635831127000, "modifiedByUserEmail": "jinesh.p+ihpcust@iqm.com", "modifiedByUserProfile": "https://iqm-web-assets-c92d6b6cbde1-stage.s3.amazonaws.com/avatar/JO.svg", "bankName": null, "refundReason": "Testing" }, { "isPaymentInitiatorOrg": false, "paymentId": 883, "createdAt": 1635830983000, "createdByUserEmail": "jinesh.p+ihpcust@iqm.com", "createdByUserProfile": "https://iqm-web-assets-c92d6b6cbde1-stage.s3.amazonaws.com/avatar/JO.svg", "paymentDate": 1635791400000, "paymentAmount": 10, "paymentStatus": "Processing", "paymentMode": "To Funds", "paymentType": "Refund", "invoiceId": 0, "transactionId": null, "modifiedAt": 1635830983000, "modifiedByUserEmail": "jinesh.p+ihpcust@iqm.com", "modifiedByUserProfile": "https://iqm-web-assets-c92d6b6cbde1-stage.s3.amazonaws.com/avatar/JO.svg", "bankName": null, "refundReason": "Testing" } ], "totalRecords": 68, "filteredRecords": 68 } } }, "example": { "success": true, "data": { "data": [ { "isPaymentInitiatorOrg": false, "paymentId": 19, "createdAt": 1632295016000, "createdByUserEmail": "jinesh.p+nonihpcust2@iqm.com", "createdByUserProfile": "https://iqm-web-assets-c92d6b6cbde1-stage.s3.amazonaws.com/avatar/JO.svg", "paymentDate": 1632076200000, "paymentAmount": 10000, "paymentStatus": "Rejected", "paymentMode": "PayPal", "paymentType": "As Fund", "invoiceId": 0, "transactionId": "T-1234567", "modifiedAt": 1637566978000, "modifiedByUserEmail": "jinesh.p+ihpcust@iqm.com", "modifiedByUserProfile": "https://iqm-web-assets-c92d6b6cbde1-stage.s3.amazonaws.com/avatar/JO.svg", "bankName": null, "refundReason": null }, { "isPaymentInitiatorOrg": false, "paymentId": 886, "createdAt": 1635831910000, "createdByUserEmail": "jinesh.p+ihpcust@iqm.com", "createdByUserProfile": "https://iqm-web-assets-c92d6b6cbde1-stage.s3.amazonaws.com/avatar/JO.svg", "paymentDate": 1635791400000, "paymentAmount": 10, "paymentStatus": "Processing", "paymentMode": "Check", "paymentType": "Refund", "invoiceId": 0, "transactionId": "123456", "modifiedAt": 1635831910000, "modifiedByUserEmail": "jinesh.p+ihpcust@iqm.com", "modifiedByUserProfile": "https://iqm-web-assets-c92d6b6cbde1-stage.s3.amazonaws.com/avatar/JO.svg", "bankName": null, "refundReason": "Testing" }, { "isPaymentInitiatorOrg": false, "paymentId": 885, "createdAt": 1635831695000, "createdByUserEmail": "jinesh.p+ihpcust@iqm.com", "createdByUserProfile": "https://iqm-web-assets-c92d6b6cbde1-stage.s3.amazonaws.com/avatar/JO.svg", "paymentDate": 1635791400000, "paymentAmount": 10, "paymentStatus": "Processing", "paymentMode": "To Funds", "paymentType": "Refund", "invoiceId": 0, "transactionId": "123456", "modifiedAt": 1635831695000, "modifiedByUserEmail": "jinesh.p+ihpcust@iqm.com", "modifiedByUserProfile": "https://iqm-web-assets-c92d6b6cbde1-stage.s3.amazonaws.com/avatar/JO.svg", "bankName": null, "refundReason": "Testing" }, { "isPaymentInitiatorOrg": false, "paymentId": 884, "createdAt": 1635831127000, "createdByUserEmail": "jinesh.p+ihpcust@iqm.com", "createdByUserProfile": "https://iqm-web-assets-c92d6b6cbde1-stage.s3.amazonaws.com/avatar/JO.svg", "paymentDate": 1635791400000, "paymentAmount": 10, "paymentStatus": "Processing", "paymentMode": "To Funds", "paymentType": "Refund", "invoiceId": 0, "transactionId": "123456", "modifiedAt": 1635831127000, "modifiedByUserEmail": "jinesh.p+ihpcust@iqm.com", "modifiedByUserProfile": "https://iqm-web-assets-c92d6b6cbde1-stage.s3.amazonaws.com/avatar/JO.svg", "bankName": null, "refundReason": "Testing" }, { "isPaymentInitiatorOrg": false, "paymentId": 883, "createdAt": 1635830983000, "createdByUserEmail": "jinesh.p+ihpcust@iqm.com", "createdByUserProfile": "https://iqm-web-assets-c92d6b6cbde1-stage.s3.amazonaws.com/avatar/JO.svg", "paymentDate": 1635791400000, "paymentAmount": 10, "paymentStatus": "Processing", "paymentMode": "To Funds", "paymentType": "Refund", "invoiceId": 0, "transactionId": null, "modifiedAt": 1635830983000, "modifiedByUserEmail": "jinesh.p+ihpcust@iqm.com", "modifiedByUserProfile": "https://iqm-web-assets-c92d6b6cbde1-stage.s3.amazonaws.com/avatar/JO.svg", "bankName": null, "refundReason": "Testing" } ], "totalRecords": 68, "filteredRecords": 68 } } }, "example": { "success": true, "data": { "data": [ { "isPaymentInitiatorOrg": false, "paymentId": 19, "createdAt": 1632295016000, "createdByUserEmail": "jinesh.p+nonihpcust2@iqm.com", "createdByUserProfile": "https://iqm-web-assets-c92d6b6cbde1-stage.s3.amazonaws.com/avatar/JO.svg", "paymentDate": 1632076200000, "paymentAmount": 10000, "paymentStatus": "Rejected", "paymentMode": "PayPal", "paymentType": "As Fund", "invoiceId": 0, "transactionId": "T-1234567", "modifiedAt": 1637566978000, "modifiedByUserEmail": "jinesh.p+ihpcust@iqm.com", "modifiedByUserProfile": "https://iqm-web-assets-c92d6b6cbde1-stage.s3.amazonaws.com/avatar/JO.svg", "bankName": null, "refundReason": null }, { "isPaymentInitiatorOrg": false, "paymentId": 886, "createdAt": 1635831910000, "createdByUserEmail": "jinesh.p+ihpcust@iqm.com", "createdByUserProfile": "https://iqm-web-assets-c92d6b6cbde1-stage.s3.amazonaws.com/avatar/JO.svg", "paymentDate": 1635791400000, "paymentAmount": 10, "paymentStatus": "Processing", "paymentMode": "Check", "paymentType": "Refund", "invoiceId": 0, "transactionId": "123456", "modifiedAt": 1635831910000, "modifiedByUserEmail": "jinesh.p+ihpcust@iqm.com", "modifiedByUserProfile": "https://iqm-web-assets-c92d6b6cbde1-stage.s3.amazonaws.com/avatar/JO.svg", "bankName": null, "refundReason": "Testing" }, { "isPaymentInitiatorOrg": false, "paymentId": 885, "createdAt": 1635831695000, "createdByUserEmail": "jinesh.p+ihpcust@iqm.com", "createdByUserProfile": "https://iqm-web-assets-c92d6b6cbde1-stage.s3.amazonaws.com/avatar/JO.svg", "paymentDate": 1635791400000, "paymentAmount": 10, "paymentStatus": "Processing", "paymentMode": "To Funds", "paymentType": "Refund", "invoiceId": 0, "transactionId": "123456", "modifiedAt": 1635831695000, "modifiedByUserEmail": "jinesh.p+ihpcust@iqm.com", "modifiedByUserProfile": "https://iqm-web-assets-c92d6b6cbde1-stage.s3.amazonaws.com/avatar/JO.svg", "bankName": null, "refundReason": "Testing" }, { "isPaymentInitiatorOrg": false, "paymentId": 884, "createdAt": 1635831127000, "createdByUserEmail": "jinesh.p+ihpcust@iqm.com", "createdByUserProfile": "https://iqm-web-assets-c92d6b6cbde1-stage.s3.amazonaws.com/avatar/JO.svg", "paymentDate": 1635791400000, "paymentAmount": 10, "paymentStatus": "Processing", "paymentMode": "To Funds", "paymentType": "Refund", "invoiceId": 0, "transactionId": "123456", "modifiedAt": 1635831127000, "modifiedByUserEmail": "jinesh.p+ihpcust@iqm.com", "modifiedByUserProfile": "https://iqm-web-assets-c92d6b6cbde1-stage.s3.amazonaws.com/avatar/JO.svg", "bankName": null, "refundReason": "Testing" }, { "isPaymentInitiatorOrg": false, "paymentId": 883, "createdAt": 1635830983000, "createdByUserEmail": "jinesh.p+ihpcust@iqm.com", "createdByUserProfile": "https://iqm-web-assets-c92d6b6cbde1-stage.s3.amazonaws.com/avatar/JO.svg", "paymentDate": 1635791400000, "paymentAmount": 10, "paymentStatus": "Processing", "paymentMode": "To Funds", "paymentType": "Refund", "invoiceId": 0, "transactionId": null, "modifiedAt": 1635830983000, "modifiedByUserEmail": "jinesh.p+ihpcust@iqm.com", "modifiedByUserProfile": "https://iqm-web-assets-c92d6b6cbde1-stage.s3.amazonaws.com/avatar/JO.svg", "bankName": null, "refundReason": "Testing" } ], "totalRecords": 68, "filteredRecords": 68 } } } } } }, "deprecated": false, "servers": [ { "url": "http://example.com", "variables": { } } ], "security": [] } }, "/api/v3/fa/customer/payment/add": { "post": { "tags": [ "User Management API" ], "summary": "Add Payment for customer", "operationId": "AddPaymentforcustomer", "parameters": [ { "name": "X-IAA-OW-ID", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32", "example": 200422 } }, { "name": "Authorization", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "{{bearer_token}}" } } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { }, "schema": { "required": [ "owId", "paymentAmount", "paymentDate", "paymentMode", "transactionId", "paymentProof", "paymentType", "invoiceId" ], "type": "object", "properties": { "owId": { "type": "integer", "description": "ow id of selected customer organization", "format": "int32", "example": 200485 }, "paymentAmount": { "type": "integer", "description": "payment amount", "format": "int32", "example": 5000 }, "paymentDate": { "type": "string", "description": "Payment date in format YYYY-MM-DD", "example": "2021-09-16" }, "paymentMode": { "type": "integer", "description": "Payment mode id\n(Take payment mode id from payment modes API)", "format": "int32", "example": 1 }, "transactionId": { "type": "string", "description": "Transaction id", "example": "T-1234567" }, "paymentProof": { "type": "string", "description": "(Optional) Proof of payment image (jpeg/png)" }, "paymentType": { "type": "integer", "description": "Payment type id\n(Take payment type id from payment types API)", "format": "int32", "example": 2 }, "invoiceId": { "type": "integer", "description": "Invoice id (Provide only if payment type is 'Against Invoice')", "format": "int32", "example": 1 } } } } }, "required": false }, "responses": { "200": { "description": "OK", "headers": { }, "content": { "application/json": { "schema": { "title": "SuccessResponse200OK", "required": [ "success", "data" ], "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "string" } }, "example": { "success": true, "data": "Invitation cancelled successfully." } }, "example": { "success": true, "data": "Payment added Successfully." } } } } }, "deprecated": false, "security": [], "servers": [ { "url": "http://example.com", "variables": { } } ] } }, "/api/v3/fa/customer/payment/refund": { "post": { "tags": [ "User Management API" ], "summary": "Initiate Refund", "operationId": "InitiateRefund", "parameters": [ { "name": "X-IAA-OW-ID", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32", "example": 200422 } }, { "name": "Authorization", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "{{bearer_token}}" } } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { }, "schema": { "required": [ "owId", "paymentAmount", "paymentDate", "paymentMode", "transactionId", "paymentProof" ], "type": "object", "properties": { "owId": { "type": "integer", "description": "ow id of selected customer organization", "format": "int32", "example": 200485 }, "paymentAmount": { "type": "integer", "description": "payment amount", "format": "int32", "example": 5000 }, "paymentDate": { "type": "string", "description": "Payment date in format YYYY-MM-DD", "example": "2021-09-16" }, "paymentMode": { "type": "integer", "description": "Payment mode id\n(Take payment mode id from payment modes API)", "format": "int32", "example": 1 }, "transactionId": { "type": "string", "description": "Transaction id", "example": "T-1234567" }, "paymentProof": { "type": "string", "description": "(Optional) Proof of payment image (jpeg/png)" } } } } }, "required": false }, "responses": { "200": { "description": "OK", "headers": { }, "content": { "application/json": { "schema": { "title": "SuccessResponse200OK", "required": [ "success", "data" ], "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "string" } }, "example": { "success": true, "data": "Invitation cancelled successfully." } }, "example": { "success": true, "data": "Refund Initiated." } } } } }, "deprecated": false, "security": [], "servers": [ { "url": "http://example.com", "variables": { } } ] } }, "/api/v3/fa/customer/payment/14": { "put": { "tags": [ "User Management API" ], "summary": "Edit Payment of customer", "operationId": "EditPaymentofcustomer", "parameters": [ { "name": "X-IAA-OW-ID", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32", "example": 200422 } }, { "name": "Authorization", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "{{bearer_token}}" } } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { }, "schema": { "required": [ "owId", "paymentAmount", "paymentDate", "paymentMode", "transactionId", "paymentProof", "paymentType", "invoiceId" ], "type": "object", "properties": { "owId": { "type": "integer", "description": "ow id of selected customer organization", "format": "int32", "example": 200485 }, "paymentAmount": { "type": "integer", "description": "payment amount", "format": "int32", "example": 5000 }, "paymentDate": { "type": "string", "description": "Payment date in format YYYY-MM-DD", "example": "2021-09-16" }, "paymentMode": { "type": "integer", "description": "Payment mode id\n(Take payment mode id from payment modes API)", "format": "int32", "example": 1 }, "transactionId": { "type": "string", "description": "Transaction id", "example": "T-1234567" }, "paymentProof": { "type": "string", "description": "Send in body only if file is updated or changed.\n(Optional) Proof of payment image (jpeg/png)" }, "paymentType": { "type": "integer", "description": "Payment type id\n(Take payment type id from payment types API)", "format": "int32", "example": 2 }, "invoiceId": { "type": "integer", "description": "Invoice id (Provide only if payment type is 'Against Invoice')", "format": "int32", "example": 33 } } } } }, "required": false }, "responses": { "200": { "description": "OK", "headers": { }, "content": { "application/json": { "schema": { "title": "SuccessResponse200OK", "required": [ "success", "data" ], "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "string" } }, "example": { "success": true, "data": "Invitation cancelled successfully." } }, "example": { "success": true, "data": "Payment updated Successfully." } } } } }, "deprecated": false, "security": [], "servers": [ { "url": "http://example.com", "variables": { } } ] } }, "/api/v3/fa/customer/payment/approve/14": { "post": { "tags": [ "User Management API" ], "summary": "Approve Payment", "operationId": "ApprovePayment", "parameters": [ { "name": "X-IAA-OW-ID", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32", "example": 200483 } }, { "name": "Authorization", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "{{bearer_token}}" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "title": "ApprovePaymentRequest", "required": [ "owId", "actionNote" ], "type": "object", "properties": { "owId": { "type": "integer", "format": "int32" }, "actionNote": { "type": "string" } }, "example": { "owId": 200485, "actionNote": "Payment paid partially" } }, "example": { "owId": 200485, "actionNote": "Payment paid partially" } } }, "required": true }, "responses": { "200": { "description": "OK", "headers": { }, "content": { "application/json": { "schema": { "title": "SuccessResponse200OK", "required": [ "success", "data" ], "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "string" } }, "example": { "success": true, "data": "Invitation cancelled successfully." } }, "example": { "success": true, "data": "Payment approved Successfully." } } } } }, "deprecated": false, "security": [], "servers": [ { "url": "http://example.com", "variables": { } } ] } }, "/api/v3/fa/payment/add-fund": { "post": { "tags": [ "User Management API" ], "summary": "Add Payment from Organization App", "operationId": "AddPaymentfromOrganizationApp", "parameters": [ { "name": "X-IAA-OW-ID", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32", "example": 200422 } }, { "name": "Authorization", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "{{bearer_token}}" } } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { }, "schema": { "required": [ "paymentAmount", "paymentDate", "paymentMode", "paymentProof", "bankName" ], "type": "object", "properties": { "paymentAmount": { "type": "integer", "description": "payment amount", "format": "int32", "example": 10000 }, "paymentDate": { "type": "string", "description": "Payment date in format YYYY-MM-DD", "example": "2021-09-20" }, "paymentMode": { "type": "integer", "description": "Payment mode id\n(Take payment mode id from payment modes API)", "format": "int32", "example": 1 }, "paymentProof": { "type": "string", "description": "(Optional) Proof of payment image (jpeg/png)" }, "bankName": { "type": "string", "description": "(Optional) Required only if payment mode is Check or Wire Transfer", "example": "ICICI Bank" } } } } }, "required": false }, "responses": { "200": { "description": "OK", "headers": { }, "content": { "application/json": { "schema": { "title": "SuccessResponse200OK", "required": [ "success", "data" ], "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "string" } }, "example": { "success": true, "data": "Invitation cancelled successfully." } }, "example": { "success": true, "data": "Payment Successful." } } } } }, "deprecated": false, "security": [], "servers": [ { "url": "http://example.com", "variables": { } } ] } }, "/api/v3/fa/payments/list": { "get": { "tags": [ "User Management API" ], "summary": "List of Payment transaction for my Organisation", "operationId": "ListofPaymenttransactionformyOrganisation", "parameters": [ { "name": "status", "in": "query", "description": "", "required": true, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "paymentType", "in": "query", "description": "", "required": true, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "searchField", "in": "query", "description": "", "required": true, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "pageNo", "in": "query", "description": "", "required": true, "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32", "example": 1 } }, { "name": "limit", "in": "query", "description": "", "required": true, "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32", "example": 10 } }, { "name": "Authorization", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "{{bearer_token}}" } }, { "name": "X-IAA-OW-ID", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32", "example": 200483 } } ], "responses": { "200": { "description": "OK", "headers": { }, "content": { "application/json": { "schema": { "title": "SuccessResponse200OK65", "required": [ "success", "data" ], "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "title": "Data99", "required": [ "data", "totalRecords", "filteredRecords" ], "type": "object", "properties": { "data": { "type": "array", "items": { "title": "Data100", "required": [ "isPaymentInitiatorOrg", "paymentId", "createdByUserEmail", "paymentDate", "paymentAmount", "paymentStatus", "paymentMode", "paymentType", "invoiceId", "modifiedAt", "bankName", "refundReason" ], "type": "object", "properties": { "isPaymentInitiatorOrg": { "type": "boolean" }, "paymentId": { "type": "integer", "format": "int32" }, "createdByUserEmail": { "type": "string" }, "paymentDate": { "type": "integer", "format": "int64" }, "paymentAmount": { "type": "number" }, "paymentStatus": { "type": "string" }, "paymentMode": { "type": "string" }, "paymentType": { "type": "string" }, "invoiceId": { "type": "integer", "format": "int32" }, "modifiedAt": { "type": "integer", "format": "int64" }, "bankName": { "type": "string", "nullable": true }, "refundReason": { "type": "string", "nullable": true } }, "example": { "isPaymentInitiatorOrg": true, "paymentId": 19, "createdByUserEmail": "jinesh.p+nonihpcust2@iqm.com", "paymentDate": 1632076200000, "paymentAmount": 10000, "paymentStatus": "Rejected", "paymentMode": "PayPal", "paymentType": "As Fund", "invoiceId": 0, "modifiedAt": 1637566978000, "bankName": null, "refundReason": null } }, "description": "" }, "totalRecords": { "type": "integer", "format": "int32" }, "filteredRecords": { "type": "integer", "format": "int32" } }, "example": { "data": [ { "isPaymentInitiatorOrg": true, "paymentId": 19, "createdByUserEmail": "jinesh.p+nonihpcust2@iqm.com", "paymentDate": 1632076200000, "paymentAmount": 10000, "paymentStatus": "Rejected", "paymentMode": "PayPal", "paymentType": "As Fund", "invoiceId": 0, "modifiedAt": 1637566978000, "bankName": null, "refundReason": null }, { "isPaymentInitiatorOrg": false, "paymentId": 886, "createdByUserEmail": "jinesh.p+ihpcust@iqm.com", "paymentDate": 1635791400000, "paymentAmount": 10, "paymentStatus": "Processing", "paymentMode": "Check", "paymentType": "Refund", "invoiceId": 0, "modifiedAt": 1635831910000, "bankName": null, "refundReason": "Testing" }, { "isPaymentInitiatorOrg": false, "paymentId": 885, "createdByUserEmail": "jinesh.p+ihpcust@iqm.com", "paymentDate": 1635791400000, "paymentAmount": 10, "paymentStatus": "Processing", "paymentMode": "To Funds", "paymentType": "Refund", "invoiceId": 0, "modifiedAt": 1635831695000, "bankName": null, "refundReason": "Testing" }, { "isPaymentInitiatorOrg": false, "paymentId": 884, "createdByUserEmail": "jinesh.p+ihpcust@iqm.com", "paymentDate": 1635791400000, "paymentAmount": 10, "paymentStatus": "Processing", "paymentMode": "To Funds", "paymentType": "Refund", "invoiceId": 0, "modifiedAt": 1635831127000, "bankName": null, "refundReason": "Testing" }, { "isPaymentInitiatorOrg": false, "paymentId": 883, "createdByUserEmail": "jinesh.p+ihpcust@iqm.com", "paymentDate": 1635791400000, "paymentAmount": 10, "paymentStatus": "Processing", "paymentMode": "To Funds", "paymentType": "Refund", "invoiceId": 0, "modifiedAt": 1635830983000, "bankName": null, "refundReason": "Testing" } ], "totalRecords": 68, "filteredRecords": 68 } } }, "example": { "success": true, "data": { "data": [ { "isPaymentInitiatorOrg": true, "paymentId": 19, "createdByUserEmail": "jinesh.p+nonihpcust2@iqm.com", "paymentDate": 1632076200000, "paymentAmount": 10000, "paymentStatus": "Rejected", "paymentMode": "PayPal", "paymentType": "As Fund", "invoiceId": 0, "modifiedAt": 1637566978000, "bankName": null, "refundReason": null }, { "isPaymentInitiatorOrg": false, "paymentId": 886, "createdByUserEmail": "jinesh.p+ihpcust@iqm.com", "paymentDate": 1635791400000, "paymentAmount": 10, "paymentStatus": "Processing", "paymentMode": "Check", "paymentType": "Refund", "invoiceId": 0, "modifiedAt": 1635831910000, "bankName": null, "refundReason": "Testing" }, { "isPaymentInitiatorOrg": false, "paymentId": 885, "createdByUserEmail": "jinesh.p+ihpcust@iqm.com", "paymentDate": 1635791400000, "paymentAmount": 10, "paymentStatus": "Processing", "paymentMode": "To Funds", "paymentType": "Refund", "invoiceId": 0, "modifiedAt": 1635831695000, "bankName": null, "refundReason": "Testing" }, { "isPaymentInitiatorOrg": false, "paymentId": 884, "createdByUserEmail": "jinesh.p+ihpcust@iqm.com", "paymentDate": 1635791400000, "paymentAmount": 10, "paymentStatus": "Processing", "paymentMode": "To Funds", "paymentType": "Refund", "invoiceId": 0, "modifiedAt": 1635831127000, "bankName": null, "refundReason": "Testing" }, { "isPaymentInitiatorOrg": false, "paymentId": 883, "createdByUserEmail": "jinesh.p+ihpcust@iqm.com", "paymentDate": 1635791400000, "paymentAmount": 10, "paymentStatus": "Processing", "paymentMode": "To Funds", "paymentType": "Refund", "invoiceId": 0, "modifiedAt": 1635830983000, "bankName": null, "refundReason": "Testing" } ], "totalRecords": 68, "filteredRecords": 68 } } }, "example": { "success": true, "data": { "data": [ { "isPaymentInitiatorOrg": true, "paymentId": 19, "createdByUserEmail": "jinesh.p+nonihpcust2@iqm.com", "paymentDate": 1632076200000, "paymentAmount": 10000, "paymentStatus": "Rejected", "paymentMode": "PayPal", "paymentType": "As Fund", "invoiceId": 0, "modifiedAt": 1637566978000, "bankName": null, "refundReason": null }, { "isPaymentInitiatorOrg": false, "paymentId": 886, "createdByUserEmail": "jinesh.p+ihpcust@iqm.com", "paymentDate": 1635791400000, "paymentAmount": 10, "paymentStatus": "Processing", "paymentMode": "Check", "paymentType": "Refund", "invoiceId": 0, "modifiedAt": 1635831910000, "bankName": null, "refundReason": "Testing" }, { "isPaymentInitiatorOrg": false, "paymentId": 885, "createdByUserEmail": "jinesh.p+ihpcust@iqm.com", "paymentDate": 1635791400000, "paymentAmount": 10, "paymentStatus": "Processing", "paymentMode": "To Funds", "paymentType": "Refund", "invoiceId": 0, "modifiedAt": 1635831695000, "bankName": null, "refundReason": "Testing" }, { "isPaymentInitiatorOrg": false, "paymentId": 884, "createdByUserEmail": "jinesh.p+ihpcust@iqm.com", "paymentDate": 1635791400000, "paymentAmount": 10, "paymentStatus": "Processing", "paymentMode": "To Funds", "paymentType": "Refund", "invoiceId": 0, "modifiedAt": 1635831127000, "bankName": null, "refundReason": "Testing" }, { "isPaymentInitiatorOrg": false, "paymentId": 883, "createdByUserEmail": "jinesh.p+ihpcust@iqm.com", "paymentDate": 1635791400000, "paymentAmount": 10, "paymentStatus": "Processing", "paymentMode": "To Funds", "paymentType": "Refund", "invoiceId": 0, "modifiedAt": 1635830983000, "bankName": null, "refundReason": "Testing" } ], "totalRecords": 68, "filteredRecords": 68 } } } } } }, "deprecated": false, "security": [], "servers": [ { "url": "http://example.com", "variables": { } } ] } }, "/api/v3/fa/customer/payment/cancel/441": { "post": { "tags": [ "User Management API" ], "summary": "Cancel Payment", "operationId": "CancelPayment", "parameters": [ { "name": "Authorization", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "{{bearer_token}}" } }, { "name": "X-IAA-OW-ID", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32", "example": 200422 } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "title": "CancelPaymentRequest", "required": [ "owId", "actionNote" ], "type": "object", "properties": { "owId": { "type": "integer", "format": "int32" }, "actionNote": { "type": "string" } }, "example": { "owId": 200425, "actionNote": "Payment done" } }, "example": { "owId": 200425, "actionNote": "Payment done" } } }, "required": true }, "responses": { "200": { "description": "OK", "headers": { }, "content": { "application/json": { "schema": { "title": "SuccessResponse200OK", "required": [ "success", "data" ], "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "string" } }, "example": { "success": true, "data": "Invitation cancelled successfully." } }, "example": { "success": true, "data": "Payment cancelled Successfully." } } } }, "422": { "description": "Unprocessable Entity (WebDAV) (RFC 4918)", "headers": { }, "content": { "application/json": { "schema": { "title": "Paymentnotcancelled422UnprocessableEntity1", "required": [ "success", "errorObjects" ], "type": "object", "properties": { "success": { "type": "boolean" }, "errorObjects": { "type": "array", "items": { "title": "ErrorObject2", "required": [ "error" ], "type": "object", "properties": { "error": { "type": "string" } }, "example": { "error": "Only active invitations can be cancelled." } }, "description": "" } }, "example": { "success": false, "errorObjects": [ { "error": "Payment can not be cancelled as it is not in processing state" } ] } }, "example": { "success": false, "errorObjects": [ { "error": "Payment can not be cancelled as it is not in processing state" } ] } } } } }, "deprecated": false, "security": [], "servers": [ { "url": "http://example.com", "variables": { } } ] } }, "/api/v3/fa/customer/payment/reject/441": { "post": { "tags": [ "User Management API" ], "summary": "Reject Payment", "operationId": "RejectPayment", "parameters": [ { "name": "X-IAA-OW-Id", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32", "example": 200422 } }, { "name": "Authorization", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "{{bearer_token}}" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "title": "RejectPaymentRequest", "required": [ "owId", "actionNote" ], "type": "object", "properties": { "owId": { "type": "integer", "format": "int32" }, "actionNote": { "type": "string" } }, "example": { "owId": 200425, "actionNote": "Testing" } }, "example": { "owId": 200425, "actionNote": "Testing" } } }, "required": true }, "responses": { "200": { "description": "OK", "headers": { }, "content": { "application/json": { "schema": { "title": "SuccessResponse200OK", "required": [ "success", "data" ], "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "string" } }, "example": { "success": true, "data": "Invitation cancelled successfully." } }, "example": { "success": true, "data": "Payment rejected Successfully." } } } }, "422": { "description": "Unprocessable Entity (WebDAV) (RFC 4918)", "headers": { }, "content": { "application/json": { "schema": { "title": "Paymentnotrejected422UnprocessableEntity1", "required": [ "success", "errorObjects" ], "type": "object", "properties": { "success": { "type": "boolean" }, "errorObjects": { "type": "array", "items": { "title": "ErrorObject2", "required": [ "error" ], "type": "object", "properties": { "error": { "type": "string" } }, "example": { "error": "Only active invitations can be cancelled." } }, "description": "" } }, "example": { "success": false, "errorObjects": [ { "error": "Payment can not be rejected as it is not in processing state" } ] } }, "example": { "success": false, "errorObjects": [ { "error": "Payment can not be rejected as it is not in processing state" } ] } } } } }, "deprecated": false, "security": [], "servers": [ { "url": "http://example.com", "variables": { } } ] } }, "/api/v3/fa/customer/payment/approve-refund/714": { "post": { "tags": [ "User Management API" ], "summary": "Approve Refund", "operationId": "ApproveRefund", "parameters": [ { "name": "Authorization", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "{{bearer_token}}" } }, { "name": "X-IAA-OW-ID", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32", "example": 200422 } } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "encoding": { }, "schema": { "required": [ "owId", "paymentProof" ], "type": "object", "properties": { "owId": { "type": "integer", "description": "ow Id of customer", "format": "int32", "example": 200425 }, "paymentProof": { "type": "string", "description": "Proof of payment file,\nRequired for payment mode oother than \"To Funds\"" } } } } }, "required": false }, "responses": { "200": { "description": "", "headers": { }, "content": { "application/json": { "schema": { "title": "SuccessResponse200OK", "required": [ "success", "data" ], "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "string" } }, "example": { "success": true, "data": "Invitation cancelled successfully." } }, "example": { "success": true, "data": "Refund successful." } } } } }, "deprecated": false, "security": [], "servers": [ { "url": "http://example.com", "variables": { } } ] } }, "/api/v3/fa/payment/download-receipt/829": { "get": { "tags": [ "User Management API" ], "summary": "Download Payment Receipt pdf", "operationId": "DownloadPaymentReceiptpdf", "parameters": [ { "name": "owId", "in": "query", "description": "ow id of selected organization", "required": true, "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32", "example": 200425 } }, { "name": "isCustomerRequest", "in": "query", "description": "(Optional) defualt: true\nIf request made from Customers app, value =true\nIf request made from Organization app, value=false", "required": true, "style": "form", "explode": true, "schema": { "type": "boolean", "example": true } }, { "name": "X-IAA-OW-ID", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32", "example": 200422 } }, { "name": "Authorization", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "{{bearer_token}}" } } ], "responses": { "200": { "description": "OK", "headers": { }, "content": { } } }, "deprecated": false, "security": [], "servers": [ { "url": "http://example.com", "variables": { } } ] } }, "/api/v3/fa/payment/email-receipt/200425/829": { "post": { "tags": [ "User Management API" ], "summary": "Email Payment Receipt", "operationId": "EmailPaymentReceipt", "parameters": [ { "name": "Authorization", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "{{bearer_token}}" } }, { "name": "X-IAA-OW-ID", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32", "example": 200422 } } ], "responses": { "200": { "description": "OK", "headers": { }, "content": { "application/json": { "schema": { "title": "200OKEmailsent", "required": [ "success", "data" ], "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "string" } }, "example": { "success": true, "data": "Payment receipt e-mail sent successfully." } }, "example": { "success": true, "data": "Payment receipt e-mail sent successfully." } } } } }, "deprecated": false, "security": [], "servers": [ { "url": "http://example.com", "variables": { } } ] } }, "/api/v3/fa/paypal/payment": { "post": { "tags": [ "User Management API" ], "summary": "Payment with PayPal", "operationId": "PaymentwithPayPal", "parameters": [ { "name": "X-IAA-OW-ID", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32", "example": 200002 } }, { "name": "Authorization", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "{{bearer_token}}" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "title": "PaymentwithPayPalRequest", "required": [ "paymentAmount" ], "type": "object", "properties": { "paymentAmount": { "type": "integer", "format": "int32" } }, "example": { "paymentAmount": 1 } }, "example": { "paymentAmount": 1 } } }, "required": true }, "responses": { "200": { "description": "OK", "headers": { }, "content": { "application/json": { "schema": { "title": "SuccessResponse200OK", "required": [ "success", "data" ], "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "string" } }, "example": { "success": true, "data": "Invitation cancelled successfully." } }, "example": { "success": true, "data": "https://www.sandbox.paypal.com/cgi-bin/webscr?cmd=_express-checkout&token=EC-3YM2956846765604B" } } } } }, "deprecated": false, "security": [], "servers": [ { "url": "http://example.com", "variables": { } } ] } }, "/api/v3/ua/customer/invite/pre-requisite": { "get": { "tags": [ "User Management API" ], "summary": "WhiteLabel Domain and Email Invite Pre-Requisite", "operationId": "WhiteLabelDomainandEmailInvitePre-Requisite", "parameters": [ { "name": "Authorization", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "{{bearer_token}}" } }, { "name": "x-iaa-ow-id", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32", "example": 200483 } } ], "responses": { "200": { "description": "OK", "headers": { }, "content": { "application/json": { "schema": { "title": "200OK27", "required": [ "success", "data" ], "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "title": "Data101", "required": [ "workspaceDomain", "whiteLabelDomain", "isVerified", "supportEmail", "isSupportEmailVerified", "organizationAppAccessible" ], "type": "object", "properties": { "workspaceDomain": { "type": "string" }, "whiteLabelDomain": { "type": "string", "nullable": true }, "isVerified": { "type": "boolean" }, "supportEmail": { "type": "string" }, "isSupportEmailVerified": { "type": "boolean" }, "organizationAppAccessible": { "type": "boolean" } }, "example": { "workspaceDomain": "iqm.stage.inhousebuying.com", "whiteLabelDomain": null, "isVerified": false, "supportEmail": "no-reply-stage@inhousebuying.com", "isSupportEmailVerified": true, "organizationAppAccessible": true } } }, "example": { "success": true, "data": { "workspaceDomain": "iqm.stage.inhousebuying.com", "whiteLabelDomain": null, "isVerified": false, "supportEmail": "no-reply-stage@inhousebuying.com", "isSupportEmailVerified": true, "organizationAppAccessible": true } } }, "example": { "success": true, "data": { "workspaceDomain": "iqm.stage.inhousebuying.com", "whiteLabelDomain": null, "isVerified": false, "supportEmail": "no-reply-stage@inhousebuying.com", "isSupportEmailVerified": true, "organizationAppAccessible": true } } } } } }, "deprecated": false, "security": [], "servers": [ { "url": "http://example.com", "variables": { } } ] } }, "/api/v3/fa/invoice-template-margin-details/pre-requisite": { "get": { "tags": [ "User Management API" ], "summary": "Margin not set Pre-Requisite popup", "operationId": "MarginnotsetPre-Requisitepopup", "parameters": [ { "name": "Authorization", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "{{bearer_token}}" } }, { "name": "x-iaa-ow-id", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32", "example": 200483 } } ], "responses": { "200": { "description": "OK", "headers": { }, "content": { "application/json": { "schema": { "title": "200OK28", "required": [ "success", "data" ], "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "title": "Data102", "required": [ "isParentInvoiceTemplateSet", "invoiceTemplateRequired", "organizationAppAccessible", "customerAppAccessible", "customerMarginList" ], "type": "object", "properties": { "isParentInvoiceTemplateSet": { "type": "boolean" }, "invoiceTemplateRequired": { "type": "boolean" }, "organizationAppAccessible": { "type": "boolean" }, "customerAppAccessible": { "type": "boolean" }, "customerMarginList": { "type": "array", "items": { "title": "CustomerMarginList", "required": [ "owId", "customerName" ], "type": "object", "properties": { "owId": { "type": "integer", "format": "int32" }, "customerName": { "type": "string" } }, "example": { "owId": 100002, "customerName": "Darshan Khatri" } }, "description": "" } }, "example": { "isParentInvoiceTemplateSet": true, "invoiceTemplateRequired": true, "organizationAppAccessible": true, "customerAppAccessible": true, "customerMarginList": [ { "owId": 100002, "customerName": "Darshan Khatri" }, { "owId": 100001, "customerName": "Bhaumik Shukla" } ] } } }, "example": { "success": true, "data": { "isParentInvoiceTemplateSet": true, "invoiceTemplateRequired": true, "organizationAppAccessible": true, "customerAppAccessible": true, "customerMarginList": [ { "owId": 100002, "customerName": "Darshan Khatri" }, { "owId": 100001, "customerName": "Bhaumik Shukla" } ] } } }, "example": { "success": true, "data": { "isParentInvoiceTemplateSet": true, "invoiceTemplateRequired": true, "organizationAppAccessible": true, "customerAppAccessible": true, "customerMarginList": [ { "owId": 100002, "customerName": "Darshan Khatri" }, { "owId": 100001, "customerName": "Bhaumik Shukla" } ] } } } } } }, "deprecated": false, "security": [], "servers": [ { "url": "http://example.com", "variables": { } } ] } }, "/api/v3/fa/available-balance": { "get": { "tags": [ "User Management API" ], "summary": "Get Available Balance", "operationId": "GetAvailableBalance", "parameters": [ { "name": "owId", "in": "query", "description": "(Optional) provide owId in case viewing customer's balance.", "required": true, "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32", "example": 200001 } }, { "name": "isCustomerRequest", "in": "query", "description": "default :- true\nisCustomerRequest - true, if organization viewing customer's balance,\nisCustomerRequest - false, if organization viewing its balance.", "required": true, "style": "form", "explode": true, "schema": { "type": "boolean", "example": false } }, { "name": "Authorization", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "{{bearer_token}}" } }, { "name": "x-iaa-ow-id", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32", "example": 200483 } } ], "responses": { "200": { "description": "OK", "headers": { }, "content": { "application/json": { "schema": { "title": "GetAvailableBalance", "required": [ "success", "data" ], "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "number" } }, "example": { "success": true, "data": 5855904.72 } }, "example": { "success": true, "data": 5855904.72 } } } } }, "deprecated": false, "security": [], "servers": [ { "url": "http://example.com", "variables": { } } ] } }, "/api/v3/fa/customer/financial-details": { "get": { "tags": [ "User Management API" ], "summary": "Get Customer Overview", "operationId": "GetCustomerOverview", "parameters": [ { "name": "owId", "in": "query", "description": "ow id of selected customer organization", "required": true, "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32", "example": 100129 } }, { "name": "isFinanceRequest", "in": "query", "description": "(Optional) default:- true\nFor Customer Management tab, isFinanceRequest: false\nFor Finance tab, isFinanceRequest: true", "required": true, "style": "form", "explode": true, "schema": { "type": "boolean", "example": false } }, { "name": "year", "in": "query", "description": "(Optional) Year for which data need to be fetch", "required": true, "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32", "example": 2021 } }, { "name": "Authorization", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "{{bearer_token}}" } }, { "name": "X-IAA-OW-ID", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32", "example": 200001 } } ], "responses": { "200": { "description": "OK", "headers": { }, "content": { "application/json": { "schema": { "title": "CustomerManagementTab", "required": [ "success", "data" ], "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "title": "Data107", "required": [ "pendingCampaigns", "runningCampaigns", "totalCampaigns", "dataCost", "actualSpent", "credits", "balance", "spent", "earning" ], "type": "object", "properties": { "pendingCampaigns": { "type": "integer", "format": "int32" }, "runningCampaigns": { "type": "integer", "format": "int32" }, "totalCampaigns": { "type": "integer", "format": "int32" }, "dataCost": { "type": "number" }, "actualSpent": { "type": "number" }, "credits": { "type": "number" }, "balance": { "type": "number" }, "spent": { "type": "number" }, "earning": { "type": "number" } }, "example": { "pendingCampaigns": 15, "runningCampaigns": 10, "totalCampaigns": 48, "dataCost": 0, "actualSpent": 0, "credits": 0, "balance": 30430.75, "spent": 0, "earning": 0 } } }, "example": { "success": true, "data": { "pendingCampaigns": 15, "runningCampaigns": 10, "totalCampaigns": 48, "dataCost": 0, "actualSpent": 0, "credits": 0, "balance": 30430.75, "spent": 0, "earning": 0 } } }, "example": { "success": true, "data": { "pendingCampaigns": 15, "runningCampaigns": 10, "totalCampaigns": 48, "dataCost": 0, "actualSpent": 0, "credits": 0, "balance": 30430.75, "spent": 0, "earning": 0 } } } } } }, "deprecated": false, "security": [], "servers": [ { "url": "http://example.com", "variables": { } } ] } }, "/api/v3/ua/init": { "get": { "tags": [ "User Management API" ], "summary": "Init", "operationId": "Init", "parameters": [], "responses": { "200": { "description": "OK", "headers": { }, "content": { "application/json": { "schema": { "title": "SuccessResponse200OK75", "required": [ "success", "data" ], "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "title": "Data109", "required": [ "wsId", "orgId", "owId", "organizationName", "isIncludeOrganizationName", "largeLogoUrl", "smallLogoUrl", "supportEmail", "ihpOwner", "workspaceURLSuffix", "pages" ], "type": "object", "properties": { "wsId": { "type": "integer", "format": "int32" }, "orgId": { "type": "integer", "format": "int32" }, "owId": { "type": "integer", "format": "int32" }, "organizationName": { "type": "string" }, "isIncludeOrganizationName": { "type": "boolean" }, "largeLogoUrl": { "type": "string" }, "smallLogoUrl": { "type": "string" }, "supportEmail": { "type": "string" }, "ihpOwner": { "type": "boolean" }, "workspaceURLSuffix": { "type": "string" }, "pages": { "title": "Pages", "required": [ "landingPages", "help_url", "header", "footer" ], "type": "object", "properties": { "landingPages": { "type": "array", "items": { "type": "string" }, "description": "" }, "help_url": { "type": "array", "items": { "title": "HelpUrl", "required": [ "label", "url" ], "type": "object", "properties": { "label": { "type": "string" }, "url": { "type": "string" } }, "example": { "label": "Help", "url": "http://help.iqm.com/" } }, "description": "" }, "header": { "type": "array", "items": { "title": "Header", "required": [ "label", "url" ], "type": "object", "properties": { "label": { "type": "string" }, "url": { "type": "string" } }, "example": { "label": "PLATFORM", "url": "https://iqm.com/consumer-targeting" } }, "description": "" }, "footer": { "type": "array", "items": { "title": "Footer", "required": [ "label", "url" ], "type": "object", "properties": { "label": { "type": "string" }, "url": { "type": "string" } }, "example": { "label": "Terms and Condition", "url": "https://iqm.com/terms-conditions" } }, "description": "" } }, "example": { "landingPages": [ "https://iqm-web-assets-c92d6b6cbde1-stage.s3.amazonaws.com/whitelabel-settings/landing-pages/200422/1633694815234_1.png", "https://iqm-web-assets-c92d6b6cbde1-stage.s3.amazonaws.com/whitelabel-settings/landing-pages/200422/1633694817381_2.png" ], "help_url": [ { "label": "Help", "url": "http://help.iqm.com/" } ], "header": [ { "label": "PLATFORM", "url": "https://iqm.com/consumer-targeting" }, { "label": "ECOSYSTEM", "url": "https://iqm.com/applications" }, { "label": "ABOUT", "url": "https://iqm.com/who-we-are" } ], "footer": [ { "label": "Terms and Condition", "url": "https://iqm.com/terms-conditions" }, { "label": "Privacy Policy", "url": "https://iqm.com/privacy-policy" } ] } } }, "example": { "wsId": 1, "orgId": 1, "owId": 200001, "organizationName": "IHB", "isIncludeOrganizationName": true, "largeLogoUrl": "https://d3jme5si7t6llb.cloudfront.net/logo/ihb_logo_scaled.png", "smallLogoUrl": "https://d3jme5si7t6llb.cloudfront.net/logo/ihb_logo_scaled.png", "supportEmail": "support@inhousebuying.com", "ihpOwner": true, "workspaceURLSuffix": ".stage.inhousebuying.com", "pages": { "landingPages": [ "https://iqm-web-assets-c92d6b6cbde1-stage.s3.amazonaws.com/whitelabel-settings/landing-pages/200422/1633694815234_1.png", "https://iqm-web-assets-c92d6b6cbde1-stage.s3.amazonaws.com/whitelabel-settings/landing-pages/200422/1633694817381_2.png" ], "help_url": [ { "label": "Help", "url": "http://help.iqm.com/" } ], "header": [ { "label": "PLATFORM", "url": "https://iqm.com/consumer-targeting" }, { "label": "ECOSYSTEM", "url": "https://iqm.com/applications" }, { "label": "ABOUT", "url": "https://iqm.com/who-we-are" } ], "footer": [ { "label": "Terms and Condition", "url": "https://iqm.com/terms-conditions" }, { "label": "Privacy Policy", "url": "https://iqm.com/privacy-policy" } ] } } } }, "example": { "success": true, "data": { "wsId": 1, "orgId": 1, "owId": 200001, "organizationName": "IHB", "isIncludeOrganizationName": true, "largeLogoUrl": "https://d3jme5si7t6llb.cloudfront.net/logo/ihb_logo_scaled.png", "smallLogoUrl": "https://d3jme5si7t6llb.cloudfront.net/logo/ihb_logo_scaled.png", "supportEmail": "support@inhousebuying.com", "ihpOwner": true, "workspaceURLSuffix": ".stage.inhousebuying.com", "pages": { "landingPages": [ "https://iqm-web-assets-c92d6b6cbde1-stage.s3.amazonaws.com/whitelabel-settings/landing-pages/200422/1633694815234_1.png", "https://iqm-web-assets-c92d6b6cbde1-stage.s3.amazonaws.com/whitelabel-settings/landing-pages/200422/1633694817381_2.png" ], "help_url": [ { "label": "Help", "url": "http://help.iqm.com/" } ], "header": [ { "label": "PLATFORM", "url": "https://iqm.com/consumer-targeting" }, { "label": "ECOSYSTEM", "url": "https://iqm.com/applications" }, { "label": "ABOUT", "url": "https://iqm.com/who-we-are" } ], "footer": [ { "label": "Terms and Condition", "url": "https://iqm.com/terms-conditions" }, { "label": "Privacy Policy", "url": "https://iqm.com/privacy-policy" } ] } } } }, "example": { "success": true, "data": { "wsId": 1, "orgId": 1, "owId": 200001, "organizationName": "IHB", "isIncludeOrganizationName": true, "largeLogoUrl": "https://d3jme5si7t6llb.cloudfront.net/logo/ihb_logo_scaled.png", "smallLogoUrl": "https://d3jme5si7t6llb.cloudfront.net/logo/ihb_logo_scaled.png", "supportEmail": "support@inhousebuying.com", "ihpOwner": true, "workspaceURLSuffix": ".stage.inhousebuying.com", "pages": { "landingPages": [ "https://iqm-web-assets-c92d6b6cbde1-stage.s3.amazonaws.com/whitelabel-settings/landing-pages/200422/1633694815234_1.png", "https://iqm-web-assets-c92d6b6cbde1-stage.s3.amazonaws.com/whitelabel-settings/landing-pages/200422/1633694817381_2.png" ], "help_url": [ { "label": "Help", "url": "http://help.iqm.com/" } ], "header": [ { "label": "PLATFORM", "url": "https://iqm.com/consumer-targeting" }, { "label": "ECOSYSTEM", "url": "https://iqm.com/applications" }, { "label": "ABOUT", "url": "https://iqm.com/who-we-are" } ], "footer": [ { "label": "Terms and Condition", "url": "https://iqm.com/terms-conditions" }, { "label": "Privacy Policy", "url": "https://iqm.com/privacy-policy" } ] } } } } } }, "422": { "description": "Unprocessable Entity (WebDAV) (RFC 4918)", "headers": { }, "content": { "application/json": { "schema": { "title": "WorkspaceDomainnotexist1", "required": [ "success", "errorObjects" ], "type": "object", "properties": { "success": { "type": "boolean" }, "errorObjects": { "type": "array", "items": { "title": "ErrorObject2", "required": [ "error" ], "type": "object", "properties": { "error": { "type": "string" } }, "example": { "error": "Only active invitations can be cancelled." } }, "description": "" } }, "example": { "success": false, "errorObjects": [ { "error": "Given workspace domain does not exist." } ] } }, "example": { "success": false, "errorObjects": [ { "error": "Given workspace domain does not exist." } ] } } } } }, "deprecated": false, "servers": [ { "url": "http://example.com", "variables": { } } ], "security": [] } }, "/api/v3/ua/logo": { "get": { "tags": [ "User Management API" ], "summary": "Workspace logo", "operationId": "Workspacelogo", "parameters": [], "responses": { "200": { "description": "OK", "headers": { }, "content": { } } }, "deprecated": false, "servers": [ { "url": "http://example.com", "variables": { } } ], "security": [] } }, "/api/v3/ua/customer/invite": { "post": { "tags": [ "User Management API" ], "summary": "This API invites customer to the platform", "description": "This API invites the workspace as well as advertiser from platform It also supports multiple invitations. The maximum number of invitations allowed per request is 10. ", "operationId": "sendInvitations", "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "invitedUserOWId": { "type": "integer", "format": "int32" }, "email": { "type": "string" }, "password": { "type": "string" }, "name": { "type": "string" }, "ownerUserName": { "type": "string" }, "owId": { "type": "integer", "format": "int32" }, "uowId": { "type": "integer", "format": "int32" }, "modifiedByUOWId": { "type": "integer", "format": "int32" }, "status": { "type": "integer", "format": "int32" }, "expiresAt": { "type": "integer", "format": "int64" }, "modifiedAt": { "type": "string", "format": "date-time" }, "invitationUserType": { "type": "string" }, "verticalId": { "type": "integer", "format": "int32" }, "logoUrl": { "type": "string" }, "serviceType": { "type": "integer", "format": "int32" }, "customerOperationDetails": { "type": "object", "properties": { "customerTypeId": { "type": "integer", "format": "int32" }, "customerPaymentTypeId": { "type": "integer", "format": "int32" }, "countryId": { "type": "integer", "format": "int32" }, "createdByUowId": { "type": "integer", "format": "int32" }, "modifiedByUowId": { "type": "integer", "format": "int32" }, "adOpsAssigneeUserIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "sellerAssigneeUserIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "labelIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } } } } } } }, "examples": { "Invitation Details VO For Workspace": { "description": "Invitation Details VO For Workspace", "value": [ { "email": "user1@iqm.com", "name": "ORG - 1", "password": "password@123", "ownerUserName": "User-1", "verticalId": 1, "logoUrl": "https://d3jme5si7t6llb.cloudfront.net/assets/202753/Pd7Xx26_1721991655891.png", "customerOperationDetails": { "customerTypeId": 2, "customerPaymentTypeId": 2, "countryId": 30100001, "adOpsAssigneeUserIds": [], "sellerAssigneeUserIds": [7184], "labelIds": [7, 8, 9] } } ] }, "Invitation Details VO For Advertiser": { "description": "Invitation Details VO For Advertiser", "value": [ { "email": "user2@iqm.com", "name": "ORG - 2", "password": "password@123", "ownerUserName": "User-2", "verticalId": 1, "logoUrl": "https://d3jme5si7t6llb.cloudfront.net/assets/202753/Pd7Xx26_1721991655891.png" } ] } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Success for multiple organization": { "description": "Success for multiple organization", "value": { "success": true, "data": { "successfulEmails": [ "user1.g@iqm.com" ], "failedEmails": [ "user2.p@iqm.com" ], "message": "1 invitations sent successfully." } } } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "errorObjects": { "type": "array", "items": { "type": "object", "properties": { "error": { "type": "string" }, "reason": { "type": "string" }, "field": { "type": "string" } } } }, "data": { "type": "object" } } }, "examples": { "Response when number of invited customers is more than 10": { "description": "Response when number of invited customers is more than 10", "value": { "success": false, "errorObjects": [ { "error": "Max Limit is 10 customers at a time." } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/ua/customer/basic/list": { "post": { "tags": [ "User Management API" ], "summary": "Get customer basic details list", "description": "API to get customer basic details. ---#### Request Body Detail\n\n| **Field** | **Type** | **Description** |\n| --- | --- | --- |\n| pageNo `[optional]` | Number | Page number for the required data. Default value is 1. || noOfEntries `[optional]` | Number | The maximum number of returned results per page. Default value is 20.|| searchField `[optional]` | String | Search the result by provided keyword in the searchField. It will search customers by customer id (owId), organization name. || owIds `[optional]` | Array of Integer | Filter customers list for provided customer owIds. || owStatusIds `[optional]` | Array of Integer | Filter customers list for provided customer statuses. Default value :- `[1,4]`. Status id should be from [organization-workspace-status](?path=/User%20Management%20API/OrganizationWorkspaceStatus) || provideRunningCampaigns `[optional]` | Boolean | To get running campaign count. Default value is `false`. |", "operationId": "getCustomerBasicDetails", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "sortByFields": { "type": "object", "additionalProperties": { "type": "string" }, "deprecated": true }, "sortByFieldsLinkedHashMap": { "type": "object", "additionalProperties": { "type": "string" } }, "searchBy": { "type": "array", "items": { "type": "string" } }, "owIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "owStatusIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "ids": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "provideRunningCampaigns": { "type": "boolean" }, "pagination": { "type": "string" }, "pageNo": { "type": "integer", "format": "int32" }, "noOfEntries": { "type": "integer", "format": "int32" }, "sortBy": { "type": "string" }, "searchField": { "type": "string" }, "order": { "type": "string", "enum": [ "com.iqm.api.common.model.enums.SortOrderEnum@53c649f2[id=1,name=asc,symbol=+,name=ASC,ordinal=0]", "com.iqm.api.common.model.enums.SortOrderEnum@511fac12[id=2,name=desc,symbol=-,name=DESC,ordinal=1]" ] }, "offset": { "type": "integer", "format": "int32" } } }, "examples": { "Get all customers": { "description": "Get all customers", "value": { "owStatusIds": [], "pageNo": 1, "noOfEntries": 20, "owIds": [], "searchField": "", "provideRunningCampaigns": false } }, "Get all customers with Running Campaigns count": { "description": "Get all customers with Running Campaigns count", "value": { "owStatusIds": [], "pageNo": 1, "noOfEntries": 20, "owIds": [], "searchField": "", "provideRunningCampaigns": true } }, "Apply search and filter": { "description": "Apply search and filter", "value": { "owStatusIds": [1, 2], "pageNo": 1, "noOfEntries": 20, "owIds": [20001], "searchField": "Agency", "provideRunningCampaigns": false } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Get all customers": { "description": "Get all customers", "value": { "success": true, "data": { "data": [ { "owId": 20001, "organizationName": "AdAgencyABC 1", "organizationLogo": "https://logo-bucket/avatar/123456.png", "owStatus": "Active", "owStatusId": 1, "wsId": 2, "runningCampaigns": 0, "ownerUserName": "yourname 1", "ownerUserEmail": "yourname@yourcompany1.com" }, { "owId": 20002, "organizationName": "AdAgencyABC 2", "organizationLogo": "https://logo-bucket/avatar/123456.png", "owStatus": "Invited", "owStatusId": 3, "wsId": 2, "runningCampaigns": 0, "ownerUserName": "yourname 2", "ownerUserEmail": "yourname@yourcompany2.com" } ], "totalRecords": 2, "filteredRecords": 2 } } }, "Get all customers with Running Campaigns count": { "description": "Get all customers with Running Campaigns count", "value": { "success": true, "data": { "data": [ { "owId": 20001, "organizationName": "AdAgencyABC 1", "organizationLogo": "https://logo-bucket/avatar/123456.png", "owStatus": "Active", "owStatusId": 1, "wsId": 2, "runningCampaigns": 4, "ownerUserName": "yourname 1", "ownerUserEmail": "yourname@yourcompany1.com" }, { "owId": 20002, "organizationName": "AdAgencyABC 2", "organizationLogo": "https://logo-bucket/avatar/123456.png", "owStatus": "Invited", "owStatusId": 3, "wsId": 2, "runningCampaigns": 10, "ownerUserName": "yourname 2", "ownerUserEmail": "yourname@yourcompany2.com" } ], "totalRecords": 2, "filteredRecords": 2 } } }, "Apply search and filter": { "description": "Apply search and filter", "value": { "success": true, "data": { "data": [ { "owId": 20001, "organizationName": "AdAgencyABC 1", "organizationLogo": "https://logo-bucket/avatar/123456.png", "owStatus": "Active", "owStatusId": 1, "wsId": 2, "runningCampaigns": 0, "ownerUserName": "yourname 1", "ownerUserEmail": "yourname@yourcompany1.com" } ], "totalRecords": 2, "filteredRecords": 1 } } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/ua/customer-operations/label/add": { "post": { "tags": [ "User Management API" ], "summary": "Add label for customer operation", "description": "This API adds a label for customer operations, which will be displayed in the labels list", "operationId": "addLabelForCustomerOperation", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "content": { "application/json": { "schema": { "required": [ "labelName" ], "type": "object", "properties": { "labelName": { "maxLength": 30, "minLength": 1, "type": "string" }, "createdByUowId": { "type": "integer", "format": "int32" } } }, "examples": { "Request body for adding label": { "description": "Request body for adding label", "value": { "labelName": "Test-case-high" } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "example": { "success": true, "data": { "labelId": 2, "message": "label Added successfully" } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/internal/ua/user-config": { "post": { "tags": [ "User Management API" ], "summary": "Update or reset the user config objects in redis cache.", "description": "This API updates or resets the user config objects in redis cache for email provided else all objects.\n\n---\n\n#### Request Body Detail\n\n| **Field** | **Type** | **Description** |\n| --- | --- | --- |\n| emails | String Array | List of emails for which update is to be done |\n| owIds | Integer Array | List of owIds for which update is to be done |\n| dryRun | Boolean | Represents whether changes needs to be updated in db or not |\n| userConfigKeyList | List | List of fields to be updated |\n", "operationId": "manageUserConfig", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "emails": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "owIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "dryRun": { "type": "boolean" }, "userConfigKeyList": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "orgWsConfigKeyList": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "emailFilterStrategy": { "type": "string" }, "strategy": { "type": "object" } } }, "examples": { "Some user-config's fields updated with dry-run example.": { "description": "Some user-config's fields updated with dry-run example.", "value": { "emails": [ "user1@eamil.com", "user2@eamil.com" ], "dryRun": true, "userConfigKeyList": [ "defaultOwId", "isBetaUser" ] } }, "Reset all user-config objects in redis cache example.": { "description": "Reset all user-config objects in redis cache example.", "value": "{ \"dryRun\": false,}" } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Successful retrieval": { "description": "Successful retrieval", "value": "{ \"success\": true, \"data\": { \"response\": { \"email1@email.com\": { \"organizationWorkspaces\": { \"100320\": { \"uowId\": 163562, \"policy\": { \"policies\": {} }, \"workspaceDomain\": \"domain.address.com\", \"whiteLabelDomain\": \"whitelabel.domain.address.com\", \"organizationType\": \"ADVERTISER\", \"isOwnerUser\": true } }, \"isBetaUser\": false, \"defaultOwId\": 0, \"userId\": 1234, \"isDefaultUser\": false, \"isAdmin\": false }, \"email2@email.com\": { \"organizationWorkspaces\": { \"100321\": { \"uowId\": 163563, \"policy\": { \"policies\": {} }, \"workspaceDomain\": \"domain.address.com\", \"whiteLabelDomain\": \"whitelabel.domain.address.com\", \"organizationType\": \"SUPER\", \"isOwnerUser\": true } }, \"isBetaUser\": false, \"defaultOwId\": 1, \"userId\": 1254, \"isDefaultUser\": false, \"isAdmin\": false }, } }}" } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "examples": { "Invalid email provided": { "description": "Invalid email provided", "value": { "success": false, "errorObjects": [ { "error": "Provide a valid email which is part of some organization" } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/internal/ua/organization/transfer-ownership": { "post": { "tags": [ "User Management API" ], "summary": "Transfer Ownership for the given owId to given user", "description": "This API Transfers Ownership of Organization with given OwId to User with given Email.", "operationId": "transferOrganizationOwnership", "parameters": [ { "name": "owId", "in": "query", "description": "owId of Organization", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "newOwnerEmail", "in": "query", "description": "Email of User for Transferring Ownership of Organization", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Success": { "description": "Success", "value": { "success": true, "data": "Organization Owner updated successfully." } } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "examples": { "Email of Existing Owner": { "description": "Email of Existing Owner", "value": { "success": false, "errorObjects": [ { "error": "User is already owner of the organization." } ] } }, "InActive User or Wrong OwId": { "description": "InActive User or Wrong OwId", "value": { "success": false, "errorObjects": [ { "error": "User doesn't exist or user is not part of the organization." } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/internal/ua/organization/parent-details": { "post": { "tags": [ "User Management API" ], "summary": "Get parent owId (organization-workspace id) details for the given owIds", "description": "This API fetches the workspace as well as super owId for advertiser and super owId for workspaces. It returns empty response for super's owId", "operationId": "getParentDetails", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "object" } }, "examples": { "Get parent owId details": { "description": "Get parent owId details", "value": { "owIds": [201427, 200002, 200001] } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Success for multiple organization": { "description": "Success for multiple organization", "value": { "success": true, "data": { "200001": { }, "200002": { "parentOWId": 200001 }, "201427": { "adminOWId": 200001, "parentOWId": 200002 } } } }, "Success for Advertiser": { "description": "Success for Advertiser", "value": { "success": true, "data": { "201427": { "adminOWId": 200001, "parentOWId": 200002 } } } }, "Success for workspace": { "description": "Success for workspace", "value": { "success": true, "data": { "200002": { "parentOWId": 200001 } } } }, "Success for super": { "description": "Success for super", "value": { "success": true, "data": { "200001": { } } } } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "examples": { "Empty ow ids provided": { "description": "Empty ow ids provided", "value": { "success": false, "errorObjects": [ { "error": "Invalid ow ids provided." } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/internal/ua/customer-config": { "post": { "tags": [ "User Management API" ], "summary": "Update or reset the customer config objects in redis cache.", "description": "This API updates or resets the customer config objects in redis cache for owIds provided else all objects.\n\n---\n\n#### Request Body Detail\n\n| **Field** | **Type** | **Description** |\n| --- | --- | --- |\n| owIds | Integer Array | List of owIds for which update is to be done |\n| organizationType | String | Type of organization |\n| dryRun | Boolean | Represents whether changes needs to be updated in db or not |\n| customerConfigKeyList | List | List of fields to be updated |\n", "operationId": "manageCustomerConfig", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "owIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "organizationType": { "type": "string" }, "dryRun": { "type": "boolean" }, "customerConfigKeyList": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } } }, "examples": { "Some customer-config's fields updated with dry-run example.": { "description": "Some customer-config's fields updated with dry-run example.", "value": { "owIds": [1234, 1235], "organizationType": "WORKSPACE", "dryRun": true, "customerConfigKeyList": [ "isBidShadingEnabled", "isVldEnabled", "isPldEnabled", "vertical" ] } }, "Reset all customer-config objects in redis cache example.": { "description": "Reset all customer-config objects in redis cache example.", "value": { "owIds": [], "organizationType": null, "dryRun": false, "customerConfigKeyList": [] } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Successful retrieval": { "description": "Successful retrieval", "value": "{ \"success\": true, \"data\": { \"advertiser\": { 1234: { \"isTestCustomer\": false, \"isBidShadingEnabled\": true, \"pgCampaignFees\": 12.5, \"pgWorkspaceShare\": 5.0, \"organizationType\": \"WORKSPACE\", \"isVldEnabled\": false, \"vertical\": \"healthcare\", \"hadVldGenerated\": false, \"vldMarkupTypeId\": null, \"vldMarkupValue\": null, \"parentOwId\": 10001, \"isPldEnabled\": true, \"hadPldGenerated\": false, \"pldMarkupTypeId\": 2, \"pldMarkupValue\": 30 }, 1235: { \"isTestCustomer\": false, \"isBidShadingEnabled\": true, \"pgCampaignFees\": 12.5, \"pgWorkspaceShare\": 5.0, \"organizationType\": \"WORKSPACE\", \"isVldEnabled\": true, \"vertical\": \"political\", \"hadVldGenerated\": true, \"vldMarkupTypeId\": 1, \"vldMarkupValue\": 12.5, \"parentOwId\": 10001, \"isPldEnabled\": false, \"hadPldGenerated\": false, \"pldMarkupTypeId\": null, \"pldMarkupValue\": null }, } }}" } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "examples": { "Invalid organization type": { "description": "Invalid organization type", "value": { "success": false, "errorObjects": [ { "error": "Provide a valid organization type" } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/ua/customer/enable-bid-shading/{customerOwId}": { "patch": { "tags": [ "User Management API" ], "summary": "Enable bid shading for customer", "description": "This API is used to enable bid shading for the given customer owId ", "operationId": "updateIsBidShadingEnabledFlag", "parameters": [ { "name": "customerOwId", "in": "path", "description": "Organization workspace Id for which bid shading is to be enabled", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Get all customers": { "description": "Get all customers", "value": { "success": true, "data": "Bid Shading Enabled Successfully" } } } } } }, "403": { "description": "forbidden", "content": { "application/json": { "examples": { "owID under different workspace": { "description": "owID under different workspace", "value": { "success": false, "errorObjects": [ { "error": "The customer does not belong to the logged in workspace" } ] } }, "enable bid shading for customer": { "description": "enable bid shading for customer", "value": { "success": false, "errorObjects": [ { "error": "Enabling bid shading for workspace is not allowed" } ] } } } } } }, "422": { "description": "Unprocessable entity", "content": { "application/json": { "examples": { "Cannot disable bid shading once it is enabled": { "description": "Cannot disable bid shading once it is enabled", "value": { "success": false, "errorObjects": [ { "error": "Bid shading is already enabled" } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/ua/customer-operations/{owId}": { "patch": { "tags": [ "User Management API" ], "summary": "Updates Customer Operation details for given customer owID ", "description": "Updates Customer Operation information about Advertiser or Workspace organization modified by SA users", "operationId": "updateCustomerOperationDetailsByOwId", "parameters": [ { "name": "owId", "in": "path", "description": "customer owID", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "properties": { "customerOperationsDetails": { "type": "object", "properties": { "customerTypeId": { "type": "integer", "format": "int32" }, "customerPaymentTypeId": { "type": "integer", "format": "int32" }, "countryId": { "type": "integer", "format": "int32" }, "createdByUowId": { "type": "integer", "format": "int32" }, "modifiedByUowId": { "type": "integer", "format": "int32" }, "adOpsAssigneeUserIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "sellerAssigneeUserIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "labelIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } } } }, "resetFields": { "type": "object", "properties": { "customerTypeId": { "type": "boolean" }, "customerPaymentTypeId": { "type": "boolean" }, "countryId": { "type": "boolean" }, "adOpsAssigneeUserIds": { "type": "boolean" }, "sellerAssigneeUserIds": { "type": "boolean" }, "labelIds": { "type": "boolean" } } } } } ] } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "errorObjects": { "type": "array", "items": { "type": "object", "properties": { "error": { "type": "string" }, "reason": { "type": "string" }, "field": { "type": "string" } } } }, "data": { "type": "object" } } }, "examples": { "Successful response": { "description": "Successful response", "value": { "success": true, "data": { "message": "Customer operation details updated successfully" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden!" } ] } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "errorObjects": { "type": "array", "items": { "type": "object", "properties": { "error": { "type": "string" }, "reason": { "type": "string" }, "field": { "type": "string" } } } }, "data": { "type": "object" } } }, "examples": { "Response when the user is not a super user": { "description": "Response when the user is not a super user", "value": { "success": false, "errorObjects": [ { "error": "Only super user can perform this operation" } ] } }, "Invalid PG Deal access": { "description": "Invalid PG Deal access", "value": { "success": false, "errorObjects": [ { "error": "Exception while updating customer operations details" } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/internal/ua/organizations/test-customer-flag": { "patch": { "tags": [ "User Management API" ], "summary": "Update the IsTestCustomer flag.", "description": "This API updates the IsTestCustomer flag in the customer's configuration.", "operationId": "updateIsTestCustomerFlag", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "customerOwIdsList": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "isTestCustomerFlag": { "type": "boolean" } } }, "examples": { "All customer's flag updated example.": { "description": "All customer's flag updated example.", "value": { "customerOwIdsList": [1234, 1235], "isTestCustomerFlag": true } }, "Partial customer's flag updated example.": { "description": "Partial customer's flag updated example.", "value": { "customerOwIdsList": [111, 222, 999999999], "isTestCustomerFlag": false } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "All customer's flag updated example.": { "description": "All customer's flag updated example.", "value": { "success": true, "data": { "updateCustomersList": [1234, 1235] } } }, "Partial customer's flag updated example.": { "description": "Partial customer's flag updated example.", "value": { "success": true, "data": { "failedCustomersList": [999999999], "updateCustomersList": [111, 222] } } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/internal/ua/customer/vertical": { "patch": { "tags": [ "User Management API" ], "summary": "This internal API is used to update the vertical for the given owIds.", "description": "This internal API is used to update the vertical for audience, insights and organisation apps for the given owIds.", "operationId": "updateVerticals", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "owIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "verticalId": { "type": "integer", "format": "int32" } } }, "examples": { "Request body to update the vertical.": { "description": "Request body to update the vertical.", "value": { "owIds": [23, 12], "verticalId": 1 } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Success response": { "description": "Success response", "value": { "success": true, "data": "Updated the vertical for the given owIds" } } } } } }, "422": { "description": "Illegal Argument exception for the given owIds", "content": { "application/json": { "examples": { "If the verticalId is same as the existing verticalId": { "description": "If the verticalId is same as the existing verticalId", "value": { "success": false, "error": "OwIDs are already in the targetVerticalId provided" } }, "Audience data and segment data is created for OwId": { "description": "Audience data and segment data is created for OwId", "value": { "success": false, "error": "Vertical Specific audiences {[1]} are present for the provided owId {[1]}" } }, "VLD report is created": { "description": "VLD report is created", "value": { "success": false, "error": "VLD reports has been created for the owId: 2" } }, "PLD report is created": { "description": "PLD report is created", "value": { "success": false, "error": "PLD reports has been created for the owId: 2" } }, "SLS report is created": { "description": "SLS report is created", "value": { "success": false, "error": "SLS reports has been created for the owId: 2" } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/ua/users/list": { "get": { "tags": [ "User Management API" ], "summary": "It will get the user's list under the organization app", "description": "This API will fetch the user details according to the logged in user and the portal in which the user is logged in.", "operationId": "getUsersList", "parameters": [ { "name": "status", "in": "query", "description": "Status ids obtained from [user-status](?path=/User%20Management%20API/UserStatus", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "pageNo", "in": "query", "description": "Page number for the required data. ", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "limit", "in": "query", "description": "Number of entries", "required": false, "schema": { "type": "integer", "format": "int32", "default": 10 } }, { "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. ", "required": false, "schema": { "type": "string", "default": "+displayName" } }, { "name": "searchField", "in": "query", "description": "Search the result by provided keyword in the searchField. ", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Successful Fetching of users list": { "description": "Successful Fetching of users list", "value": { "success": true, "data": { "data": [ { "userId": 7130, "firstName": "sample adv user -2", "lastName": "2", "email": "sample-user@iqm.com", "displayName": "sample adv user - 2", "status": "active", "statusId": 1, "userAvatar": "https://iqm-web-assets-c92d6b6cbde1-stage.s3.amazonaws.com/avatar/K2.png", "createdAt": 1705452608000, "uowId": 119592, "customersCount": 0, "organizationName": "Adv Acc 1", "invitedOn": 1705452608000, "isOrganizationOwnerUser": false, "isModificationAllowed": true, "invitedByUserName": "User 2", "invitedByUserEmail": "user2@iqm.com", "isAssignActionAllowed": true }, { "userId": 7131, "firstName": "sample-adv-user-3", "email": "sample-user1@iqm.com", "displayName": "sample-adv-user-3", "status": "invited", "statusId": 3, "userAvatar": "https://iqm-web-assets-c92d6b6cbde1-stage.s3.amazonaws.com/avatar/KH.png", "createdAt": 1705466349000, "uowId": 119595, "customersCount": 0, "organizationName": " Adv Acc", "invitedOn": 1705466349000, "isOrganizationOwnerUser": false, "isModificationAllowed": true, "invitedByUserName": "User 1", "invitedByUserEmail": "user1@iqm.com", "isAssignActionAllowed": true }, { "userId": 7150, "firstName": "sample-adv-user-4", "email": "sampleuser4@iqm.com", "displayName": "sample-adv-user-4", "status": "active", "statusId": 1, "userAvatar": "https://iqm-web-assets-c92d6b6cbde1-stage.s3.amazonaws.com/avatar/KH.png", "createdAt": 1706102938000, "uowId": 119728, "customersCount": 0, "organizationName": "'Adv Acc", "invitedOn": 1706102938000, "isOrganizationOwnerUser": false, "isModificationAllowed": true, "invitedByUserName": "User 1", "invitedByUserEmail": "user1@iqm.com", "isAssignActionAllowed": true } ], "totalRecords": 6, "filteredRecords": 3 } } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/ua/users/config": { "get": { "tags": [ "User Management API" ], "summary": "This API provides user config details", "description": "API to get configuration details of the user.", "operationId": "getUserConfigDetails", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "For Super/Workspace account": { "description": "For Super/Workspace account", "value": { "success": true, "data": { "marginAccess": true } } }, "For Advertiser account": { "description": "For Advertiser account", "value": { "success": true, "data": { } } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/ua/user/allowed-organizations": { "get": { "tags": [ "User Management API" ], "summary": "This API provides the list of allowed organization to the user.", "description": "API to get a list of organizations based on the provided searchField, pageSize, pageNo, status , account type and sortBy parameters.", "operationId": "getAllowedOrganizations", "parameters": [ { "name": "searchField", "in": "query", "description": "Search the result by provided keyword in the searchField. Search Insertion-Order by name or id.", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "noOfEntries", "in": "query", "description": "The maximum number of returned results per page. " }, { "name": "pageNo", "in": "query", "description": "Page number for the required data. ", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "status", "in": "query", "description": "Comma separated organization workspace status ids. Status id should be from [organization-workspace-status](?path=/User%20Management%20API/OrganizationWorkspaceStatus) |\n", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "customerAccountType", "in": "query", "description": "Customer account type i.e organization is advertiser or workspace", "required": false, "schema": { "type": "string", "default": "" } }, { "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 - status, organization name, date of joining, title, last active", "required": false, "schema": { "type": "string", "default": "-lastActive" } }, { "name": "isOrganizationAccess", "in": "query", "description": "This is a boolean value which states regarding the api response if the api should show the info for the current organization or not. If value is true then do not show else include current organization", "required": false, "schema": { "type": "boolean", "default": true } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "default": 10 } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "isOrganizationAccess = true : does not show the value of current organization": { "description": "isOrganizationAccess = true : does not show the value of current organization", "value": { "success": true, "data": { "data": [ { "owId": 202318, "organizationName": "User 1 Adv Acc", "ownerUserEmail": "user1@iqm.com", "workspaceDomain": "stage.applift.com", "customerType": "Advertiser", "logoUrl": "https://s3bucket/organization-profile/5722/1722490577394.png", "dateOfJoining": "2024-01-11", "title": null, "status": "Active", "statusId": 1, "contactPersonName": "User 1", "workspaceOwnerOrganizationName": "user's Workspace" }, { "owId": 202316, "organizationName": "user's Workspace", "ownerUserEmail": "user2.v@iqm.com", "workspaceDomain": "stage.applift.com", "customerType": "Workspace", "logoUrl": "https://s3bucket.s3.amazonaws.com/avatar/KW.png", "dateOfJoining": null, "title": null, "status": "Active", "statusId": 1, "contactPersonName": "New User", "workspaceOwnerOrganizationName": "New User's Workspace" } ], "totalRecords": 2, "filteredRecords": 2 } } }, "isOrganizationAccess = false : shows the value of current organization": { "description": "isOrganizationAccess = false : shows the value of current organization", "value": { "success": true, "data": { "data": [ { "owId": 202318, "organizationName": "User 1 Adv Acc", "ownerUserEmail": "user1@iqm.com", "workspaceDomain": "stage.applift.com", "customerType": "Advertiser", "logoUrl": "https://s3bucket/organization-profile/5722/1722490577394.png", "dateOfJoining": "2024-01-11", "title": null, "status": "Active", "statusId": 1, "contactPersonName": "User 1", "workspaceOwnerOrganizationName": "user's Workspace" }, { "owId": 202316, "organizationName": "user's Workspace", "ownerUserEmail": "user2.v@iqm.com", "workspaceDomain": "stage.applift.com", "customerType": "Workspace", "logoUrl": "https://s3bucket.s3.amazonaws.com/avatar/KW.png", "dateOfJoining": null, "title": null, "status": "Active", "statusId": 1, "contactPersonName": "New User", "workspaceOwnerOrganizationName": "New User's Workspace" } ], "totalRecords": 66, "filteredRecords": 66, "currentOrganization": { "owId": 200001, "organizationName": "Super IQM Org 1", "ownerUserEmail": "user2.t+ihp@iqm.com", "workspaceDomain": "app.stage.applift.com", "customerType": "Workspace", "logoUrl": "https://s3bucket.net/logo/ihb_logo_scaled.png", "dateOfJoining": "2023-08-24", "title": null, "status": "Active", "statusId": 1, "contactPersonName": " Super Account 1", "workspaceOwnerOrganizationName": "Super IQM Org 1" } } } } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Invalid sortBy value." } ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/ua/static/verticals": { "get": { "tags": [ "User Management API" ], "summary": "Get the available verticals", "description": "This static API fetches the available types of verticals.", "operationId": "getVerticals", "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "success": true, "data": [ { "name": "political", "id": 1, "label": "Political", "order": 1, "description": "This caters to advertisers from the political domain targeting users for for issue advocacy, persuasion, event promotion, fundraising and other type of campaigns" }, { "name": "healthcare", "id": 2, "label": "Healthcare", "order": 2, "description": "This caters to advertisers from domains such as pharmaceutical and medical equipment manufacturers targeting healthcare professionals." }, { "name": "specialty", "id": 17, "label": "Specialty", "order": 11, "description": "This caters to advertisers from niche domains such as automobiles, finance, retail, travel, B2B and others." } ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/ua/static/customer-payment-types": { "get": { "tags": [ "User Management API" ], "summary": "Get the customer payment types", "description": "This static API fetches the customer payment types.", "operationId": "getCustomerPaymentType", "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "success": true, "data": { "totalRecords": 2, "filteredRecords": 2, "customerPaymentTypes": [ { "name": "prepaid", "id": 1, "label": "PrePaid", "order": 1 }, { "name": "postpaid", "id": 2, "label": "PostPaid", "order": 2 } ] } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/ua/static/customer-account-types": { "get": { "tags": [ "User Management API" ], "summary": "Get the customer account types", "description": "This static API fetches the customer account types.", "operationId": "getCustomerAccountType", "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "success": true, "data": { "totalRecords": 2, "filteredRecords": 2, "customerAccountTypes": [ { "name": "advertiser", "id": 1, "label": "Advertiser", "order": 1 }, { "name": "workspace", "id": 2, "label": "Workspace", "order": 2 } ] } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/ua/profile": { "get": { "tags": [ "User Management API" ], "summary": "Get Profile details for the user", "description": "This Api provides details of the profile of the user along with parent organisation hierarchy.", "operationId": "getProfile", "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Response for user with breadcrumb of advertiser": { "description": "Response for user with breadcrumb of advertiser", "value": { "success": true, "data": { "owId": 202049, "status": 1, "invoiceId": 0, "firstName": "your first name", "lastName": null, "displayName": "your Display Name", "userAvatar": "https://iqm-web-assets-c92d6b6cbde1-stage.s3.amazonaws.com/avatar/JE.png", "email": "youremail@yahoo.com", "organizationName": "AdAgency 1", "organizationLogo": "https://iqm-web-assets-c92d6b6cbde1-stage.s3.amazonaws.com/avatar/TO.png", "isOwnerUser": false, "isPlatformOwnerOrg": false, "isWorkspaceOwnerOrg": false, "isCampaignAppOwner": false, "isBetaUser": false, "globalBlocklistMaxFileSize": 50000, "allowExtendedReportDuration": 0, "parentOrganization": { "owId": 202017, "organizationName": "AdAgency 2", "workspaceDomain": "yourDomain.com", "isAccess": false, "parentOrganization": { "owId": 200001, "organizationName": "AdAgency 3", "workspaceDomain": "yourDomainForParent.com", "isAccess": true } }, "organizationTimezone": 29, "mfaEnabled": true } } }, "Response for user with breadcrumb of workspace": { "description": "Response for user with breadcrumb of workspace", "value": { "success": true, "data": { "owId": 200002, "status": 1, "invoiceId": 283, "firstName": "your first name", "lastName": "1", "displayName": "display Name", "userAvatar": "https://iqm-web-assets-c92d6b6cbde1-stage.s3.amazonaws.com/user-profile/1/1651537740179.jpg", "email": "yourEmail@yahoo.com", "organizationName": "AdAgency 1", "organizationLogo": "https://d3jme5si7t6llb.cloudfront.net/logo/iqm.png", "isOwnerUser": false, "isPlatformOwnerOrg": false, "isWorkspaceOwnerOrg": true, "isCampaignAppOwner": false, "isBetaUser": true, "allowExtendedReportDuration": 1, "globalBlocklistMaxFileSize": 50000, "parentOrganization": { "owId": 200001, "organizationName": "AdAgency 2", "workspaceDomain": "yourDomain.com", "isAccess": true }, "protoFeaturesConfig": { "new_dashboard": false, "goal_ai": true }, "organizationTimezone": 29, "mfaEnabled": false } } }, "Response for user with breadcrumb of super user": { "description": "Response for user with breadcrumb of super user", "value": { "success": true, "data": { "owId": 200001, "status": 1, "invoiceId": 256, "firstName": "your firstName", "lastName": null, "displayName": "Display name", "userAvatar": "https://iqm-web-assets-c92d6b6cbde1-stage.s3.amazonaws.com/avatar/JE.png", "email": "yourEmail@yah", "organizationName": "AdAgency 1", "organizationLogo": "https://iqm-web-assets-c92d6b6cbde1-stage.s3.amazonaws.com/organization-profile/1/1683547807670.jpg", "isOwnerUser": false, "isPlatformOwnerOrg": true, "isWorkspaceOwnerOrg": true, "isCampaignAppOwner": true, "isBetaUser": false, "globalBlocklistMaxFileSize": 50000, "allowExtendedReportDuration": 0, "parentOrganization": null, "organizationTimezone": 21, "mfaEnabled": false, "userId": 1234 } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "User is not allowed to use dashboard application." } ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/ua/organization/view-profile": { "get": { "tags": [ "User Management API" ], "summary": "This API will provide organization's details", "description": "This API fetches the profile info of organization for logged in organization ", "operationId": "getOrganizationProfile", "parameters": [ { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "success": true, "data": { "organizationName": "JP test org1", "email": "jinesh.p+jptest1@iqm.com", "website": "www.jptest1.com", "contactNumber": "+91 123987456", "address": "A-123, ABC complex", "city": "Ahmedabad", "state": 1672, "country": 113, "zipcode": "382418", "isAvatarUrl": false, "organizationLogo": "https://iqm-web-assets-c92d6b6cbde1-stage.s3.amazonaws.com/organization-profile/391.png", "industry": "Advertising", "companySize": 2, "companyId": "A-123456", "taxId": "JP123456", "currency": "Dollar ($)", "dateFormat": "DD/MM/YYYY", "description": "", "verticalId": 1, "expertize": "1,2,3" } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "User is not authorized to access customers of given organizations" } ] } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Invalid sortBy value." } ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/ua/immediate/customers/list": { "get": { "tags": [ "User Management API" ], "summary": "This API will provide immediate customer details list", "description": "This API provides the immediate customers for the requested owIds. (i.e. immediate customers of OW id provided in the request parameters). ", "operationId": "getImmediateCustomers", "parameters": [ { "name": "owIds", "in": "query", "description": "Comma separated OW Ids of organizations whose customers needs to be fetched (Normally it would be workspace related OW Ids).If advertiser owId is passed , it will not have immediate customers and hence have the empty result.If owId of workspace is passed then it will provide workspace and its advertisers details.", "required": false, "schema": { "type": "string", "default": "all" } }, { "name": "childOWIds", "in": "query", "description": "Comma separated OW Ids of organization which will only be provided in response (To filter second level customers only).", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "status", "in": "query", "description": "Comma separated organization workspace status ids. Status id should be from [organization-workspace-status](?path=/User%20Management%20API/OrganizationWorkspaceStatus) |", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "searchField", "in": "query", "description": "Search the result by provided keyword in the searchField. Search customer by organization name, workspace name, ow id, contact person name, contact person email.", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "limit", "in": "query", "description": "The maximum number of returned results per page. ", "required": false, "schema": { "type": "integer", "format": "int32", "default": 10 } }, { "name": "pageNo", "in": "query", "description": "Page number for the required data. ", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "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. Value can be from owId, organizationName, status, contactPersonEmail, createdAt, balance, workspaceId, runningCampaigns, customersCount, lastAccess.", "required": false, "schema": { "type": "string", "default": "-createdAt" } }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "success": true, "data": { "data": [ { "isUserAllowed": false, "isWorkspaceOwner": false, "owId": 100404, "organizationName": "AdAgencyABC 1", "workspaceName": "AdAgencyABC 1", "workspaceDomain": "yourworkspace1.iqm.com", "owStatus": "active", "owStatusId": 1, "createdAt": "2021-10-01T22:20:46.000+00:00", "modifiedAt": "2021-10-01T22:20:46.000+00:00", "parentOrganizationName": "AdAgencyABC 1", "tags": [ "Self Service", "Advertiser" ], "customersCount": 0, "balance": 1000000, "contactPersonName": "yourname 1", "contactPersonEmail": "yourname@yourcompany1.com", "approvedBy": "yourname 3", "approvedByEmail": "yourname@yourcompany3.com", "logoUrl": "https://iqm-web-assets-c92d6b6cbde1-stage.s3.amazonaws.com/avatar/TA.svg", "activeCampaignsCount": 28, "industry": 1, "companySize": 2, "mediaBudget": 3, "budgetSpent": 1000, "showFinance": false, "workspaceId": 632, "lastAccess": 0, "onHoldReason": null, "verticalId": 1, "isBidShadingEnabled": null }, { "isUserAllowed": false, "isWorkspaceOwner": false, "owId": 100431, "organizationName": "AdAgencyABC 2", "workspaceName": "AdAgencyABC 1", "workspaceDomain": "yourworkspace1.iqm.com", "owStatus": "active", "owStatusId": 1, "createdAt": "2021-10-01T22:20:46.000+00:00", "modifiedAt": "2021-10-01T22:20:46.000+00:00", "parentOrganizationName": "AdAgencyABC 1", "tags": [ "Self Service", "Advertiser" ], "customersCount": 0, "balance": 0, "contactPersonName": "yourname 2", "contactPersonEmail": "yourname@yourcompany2.com", "approvedBy": "yourname 3", "approvedByEmail": "yourname@yourcompany3.com", "logoUrl": "https://iqm-web-assets-c92d6b6cbde1-stage.s3.amazonaws.com/avatar/IQ.svg", "activeCampaignsCount": 23, "industry": 1, "companySize": 2, "mediaBudget": 3, "budgetSpent": 1000, "showFinance": false, "workspaceId": 632, "lastAccess": 0, "onHoldReason": null, "verticalId": 1, "isBidShadingEnabled": null } ], "totalRecords": 2, "filteredRecords": 2 } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "User is not authorized to access customers of given organizations" } ] } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Invalid sortBy value." } ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/ua/customers/workspaces/list": { "get": { "tags": [ "User Management API" ], "summary": "This API will provide workspace details list", "description": "This API will provide all customers of logged in user (i.e. customers of OW id provided in the header). Customers can be app users, immediate customers, workspaces, advertisers, etc.", "operationId": "getWorkspaces", "parameters": [ { "name": "searchField", "in": "query", "description": "Search the result by provided keyword in the searchField. ", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "success": true, "data": [ { "owId": 202373, "workspaceName": "Workspace 1", "logoUrl": "https://iqm-web-assets/avatar/WS.png", "statusId": 1, "status": "Active", "ownerUserName": "Workspace User 1", "ownerUserEmail": "workspaceUser1@iqm.com" }, { "owId": 200002, "workspaceName": "Workspace 2", "logoUrl": "https://iqm-web-assets/avatar/IC.png", "statusId": 1, "status": "Active", "ownerUserName": "Workspace User 2", "ownerUserEmail": "WorkspaceUser2@iqm.com" } ] } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Security exception while getting workspaces" } ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/ua/customers/list": { "get": { "tags": [ "User Management API" ], "summary": "This API will provide customer details list", "description": "This API will provide all customers of logged in user (i.e. customers of OW id provided in the header). Customers can be app users, immediate customers, workspaces, advertisers, etc.", "operationId": "getCustomersList", "parameters": [ { "name": "owIds", "in": "query", "description": "Comma separated OW Ids of organizations whose customers needs to be fetched (Normally it would be workspace related OW Ids).If owId of advertiser is passed then it will provide advertiser details.If owId of workspace is passed then it will provide workspace and its advertisers details.", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "childOWIds", "in": "query", "description": "Comma separated OW Ids of organization which will only be provided in response (To filter second level customers only).", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "status", "in": "query", "description": "Comma separated organization workspace status ids. Status id should be from [organization-workspace-status](?path=/User%20Management%20API/OrganizationWorkspaceStatus) |", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "customerType", "in": "query", "description": "Comma separated customer type ids. Customer type id should be from [customer-type](?path=/User%20Management%20API/CustomerType)", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "customerAccountType", "in": "query", "description": "Comma separated customer account type ids. Customer type id should be from [customer-account-types](?path=/User%20Management%20API/CustomerAccountTypes)", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "countryId", "in": "query", "description": "Required country id. Country id should be from [countries](?path=/Master%20API/Country)", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "verticalId", "in": "query", "description": "Required vertical id. Vertical id should be from [verticals](?path=/User%20Management%20API/Verticals)", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "adOpsAssigneeUserIds", "in": "query", "description": "Comma separated adops assignee user ids.", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "sellerAssigneeUserIds", "in": "query", "description": "Comma separated seller assignee user ids.", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "labelIds", "in": "query", "description": "Comma separated label ids.", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "customerPaymentTypeIds", "in": "query", "description": "Comma separated customer payment type ids.", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "searchField", "in": "query", "description": "Search the result by provided keyword in the searchField. Search customer by organization name, workspace name, ow id, contact person name, contact person email.", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "limit", "in": "query", "description": "The maximum number of returned results per page. ", "required": false, "schema": { "type": "integer", "format": "int32", "default": 10 } }, { "name": "pageNo", "in": "query", "description": "Page number for the required data. ", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "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. Value can be from owId, organizationName, status, contactPersonEmail, createdAt, balance, workspaceId, runningCampaigns, customersCount, lastAccess.", "required": false, "schema": { "type": "string", "default": "-runningCampaigns" } }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "success": true, "data": { "data": [ { "isUserAllowed": false, "isWorkspaceOwner": false, "owId": 100404, "organizationName": "AdAgencyABC 1", "workspaceName": "AdAgencyABC 1", "workspaceDomain": "yourworkspace1.iqm.com", "owStatus": "active", "owStatusId": 1, "createdAt": "2021-10-01T22:20:46.000+00:00", "modifiedAt": "2021-10-01T22:20:46.000+00:00", "parentOrganizationName": "AdAgencyABC 1", "tags": [ "Self Service", "Advertiser" ], "customersCount": 0, "balance": 1000000, "contactPersonName": "yourname 1", "contactPersonEmail": "yourname@yourcompany1.com", "approvedBy": "yourname 3", "approvedByEmail": "yourname@yourcompany3.com", "logoUrl": "https://iqm-web-assets-c92d6b6cbde1-stage.s3.amazonaws.com/avatar/TA.svg", "activeCampaignsCount": 28, "industry": 1, "companySize": 2, "mediaBudget": 3, "budgetSpent": 1000, "showFinance": false, "workspaceId": 632, "lastAccess": 0, "verticalTypeId": 1, "onHoldReason": null }, { "isUserAllowed": false, "isWorkspaceOwner": false, "owId": 100431, "organizationName": "AdAgencyABC 2", "workspaceName": "AdAgencyABC 1", "workspaceDomain": "yourworkspace1.iqm.com", "owStatus": "active", "owStatusId": 1, "createdAt": "2021-10-01T22:20:46.000+00:00", "modifiedAt": "2021-10-01T22:20:46.000+00:00", "parentOrganizationName": "AdAgencyABC 1", "tags": [ "Self Service", "Advertiser" ], "customersCount": 0, "balance": 0, "contactPersonName": "yourname 2", "contactPersonEmail": "yourname@yourcompany2.com", "approvedBy": "yourname 3", "approvedByEmail": "yourname@yourcompany3.com", "logoUrl": "https://iqm-web-assets-c92d6b6cbde1-stage.s3.amazonaws.com/avatar/IQ.svg", "activeCampaignsCount": 23, "industry": 1, "companySize": 2, "mediaBudget": 3, "budgetSpent": 1000, "showFinance": false, "workspaceId": 632, "lastAccess": 0, "verticalTypeId": null, "onHoldReason": null } ], "totalRecords": 2, "filteredRecords": 2 } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "User is not authorized to access customers of given organizations" } ] } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Invalid sortBy value." } ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/ua/customers/list/multi-level": { "get": { "tags": [ "User Management API" ], "summary": "This API will provide multi-level customers list", "description": "This API will provide all customers of logged in user (i.e. customers of OW id provided in the header). Customers can be app users, immediate customers, workspaces, advertisers, etc.To filter all customers related to a specific workspace, provide OW id related to that workspace as `owIds` parameter.", "operationId": "getMultiLevelOrganizations", "parameters": [ { "name": "owIds", "in": "query", "description": "Comma separated OW Ids of organizations whose customers needs to be fetched (Normally it would be workspace related OW Ids)", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "searchField", "in": "query", "description": "Search keyword", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "sortBy", "in": "query", "description": "Sort by fields. Here minus(-) sign is for order DESC and plus(+) sign for order ASC.Value can be from orgId, organizationName.", "required": false, "schema": { "type": "string", "default": "+superParentOrganizationId" } }, { "name": "status", "in": "query", "description": "Comma separated customer status ids. Status id should be from [organization-workspace-status](?path=/User%20Management%20API/OrganizationWorkspaceStatus)", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "limit", "in": "query", "description": "Page size", "required": false, "schema": { "type": "integer", "format": "int32", "default": 10 } }, { "name": "pageNo", "in": "query", "description": "Page number", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "verticalIds", "in": "query", "description": "Comma separated vertical ids to filter advertisers based on verticals. Vertical id should be from [verticals](?path=/User%20Management%20API/Verticals)", "required": false, "schema": { "type": "array", "items": { "type": "integer", "format": "int32" }, "default": [] } }, { "name": "advertiserPresent", "in": "query", "description": "True, return only workspaces with at least one advertiser. False, return all workspaces regardless of advertiser presence", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "success": true, "data": { "data": [ { "owId": 200129, "organizationName": "AdAgencyABC 1", "isAccess": true, "logoUrl": "https://logo-bucket/avatar/123456.png", "status": "Active", "statusId": 1, "activeCampaignsCount": 17, "ownerUserName": "yourname 1", "ownerUserEmail": "yourname@yourcompany1.com", "customers": [ { "owId": 200176, "organizationName": "AdAgencyABC 4", "logoUrl": "https://logo-bucket/avatar/123456.png", "status": "Active", "statusId": 1, "activeCampaignsCount": 0, "ownerUserName": "yourname 4", "ownerUserEmail": "yourname@yourcompany4.com", "verticalId": 2 }, { "owId": 200177, "organizationName": "AdAgencyABC 5", "logoUrl": "https://logo-bucket/avatar/123456.png", "status": "Active", "statusId": 1, "activeCampaignsCount": 0, "ownerUserName": "yourname 5", "ownerUserEmail": "yourname@yourcompany5.com", "verticalId": 2 } ] }, { "owId": 200422, "organizationName": "AdAgencyABC 2", "isAccess": false, "logoUrl": "https://logo-bucket/avatar/123456.png", "status": "Active", "statusId": 1, "activeCampaignsCount": 0, "ownerUserName": "yourname 2", "ownerUserEmail": "jp@iqm.com", "customers": [ { "owId": 200425, "organizationName": "AdAgencyABC 6", "logoUrl": "https://logo-bucket/avatar/123456.png", "status": "Active", "statusId": 1, "activeCampaignsCount": 17, "ownerUserName": "yourname 6", "ownerUserEmail": "yourname@yourcompany6.com", "verticalId": 2 }, { "owId": 200495, "organizationName": "AdAgencyABC 7", "logoUrl": "https://logo-bucket/avatar/123456.png", "status": "Active", "statusId": 1, "activeCampaignsCount": 17, "ownerUserName": "yourname 7", "ownerUserEmail": "yourname@yourcompany7.com", "verticalId": 2 } ] }, { "owId": 200424, "organizationName": "AdAgencyABC 3", "isAccess": true, "customers": [], "logoUrl": "https://logo-bucket/avatar/123456.png", "status": "Active", "statusId": 1, "activeCampaignsCount": 17, "ownerUserName": "yourname 3", "ownerUserEmail": "yourname@yourcompany3.com" } ], "totalRecords": 3, "filteredRecords": 3 } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Invalid sortBy value." } ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/ua/customers/count": { "get": { "tags": [ "User Management API" ], "summary": "Retrieves customer count by status", "description": "Returns the count of customers for each status, such as pending, active, invited, suspended, rejected etc.", "operationId": "getCustomerCount", "parameters": [ { "name": "owIds", "in": "query", "description": "List of OW IDs to filter by", "required": false, "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "Successfully retrieved customer count by status", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "errorObjects": { "type": "array", "items": { "type": "object", "properties": { "error": { "type": "string" }, "reason": { "type": "string" }, "field": { "type": "string" } } } }, "data": { "type": "object" } } }, "examples": { "Response including customer counts by status": { "description": "Response including customer counts by status", "value": { "success": true, "data": [ { "name": "pending", "id": 2, "label": "Pending", "order": 1, "statusCount": 0 }, { "name": "active", "id": 1, "label": "Active", "order": 2, "statusCount": 1900 }, { "name": "invited", "id": 3, "label": "Invited", "order": 3, "statusCount": 0 }, { "name": "suspended", "id": 4, "label": "Suspended", "order": 4, "statusCount": 87 }, { "name": "rejected", "id": 5, "label": "Rejected", "order": 5, "statusCount": 0 } ] } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden!" } ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/ua/customer/config/{customerOwId}": { "get": { "tags": [ "User Management API" ], "summary": "Fetch customer config", "description": "This API is used to fetch customer configurations like bid shading , test customer etc for the given customer owId ", "operationId": "getCustomerConfig", "parameters": [ { "name": "customerOwId", "in": "path", "description": "Organization workspace Id for which bid shading is to be enabled", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Get customer config for advertiser": { "description": "Get customer config for advertiser", "value": { "success": true, "data": { "organizationType": "advertiser", "hadPldGenerated": false, "pldRateForDiscount": 10, "pldMarkupPercentageForDiscount": 20, "slsRateForDiscount": 3, "slsMarkupPercentageForDiscount": 0, "pgCampaignFees": 10, "vertical": "political", "isBidShadingEnabled": true, "isPldEnabled": false, "hadVldGenerated": false, "isVldEnabled": false, "pgWorkspaceShare": 0, "isTestCustomer": false, "wasThirdPartyCostActiveAtleastOnce": true, "inventory": { "globalBlocklistMaxFileSize": 50000 }, "campaign": { "allowedMinBid": 1 }, "bidModel": { "minDuration": 30, "minDailyBudget": 100, "minDailyImpressions": 1000 }, "goalAi": { "minRequiredBudgetDollar": 10000, "minRequiredBudgetImpression": 10000 }, "thirdPartyCost": { "cost": 4.2, "isActive": true } } } }, "Get customer config for workspace": { "description": "Get customer config for workspace", "value": { "success": true, "data": { "organizationType": "workspace", "pldMarkupValue": 3, "pldRateForDiscount": 10, "pldMarkupPercentageForDiscount": 20, "pgCampaignFees": 10, "isBidShadingEnabled": false, "pgWorkspaceShare": 0, "pldMarkupTypeId": 1, "isTestCustomer": false, "inventory": { "globalBlocklistMaxFileSize": 50000 }, "campaign": { "allowedMinBid": 1 }, "bidModel": { "minDuration": 3, "minDailyBudget": 100, "minDailyImpressions": 1000 }, "goalAi": { "minRequiredBudgetImpression": 10000, "minRequiredBudgetDollar": 10000 } } } } } } } }, "422": { "description": "Unprocessable entity", "content": { "application/json": { "examples": { "invalid owId": { "description": "invalid owId", "value": { "success": false, "errorObjects": [ { "error": "Invalid OwId" } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/ua/customer-operations/label/list": { "get": { "tags": [ "User Management API" ], "summary": "This API provides the list of label for customer operations.", "description": "API to get a list of labels based on the provided searchField, pageSize, pageNo, and sortBy parameters.", "operationId": "getCustomerOperationLabels", "parameters": [ { "name": "searchField", "in": "query", "description": "Search the result by provided keyword in the searchField. Search Insertion-Order by name or id.", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "noOfEntries", "in": "query", "description": "The maximum number of returned results per page. ", "required": false, "schema": { "type": "integer", "format": "int32", "default": 20 } }, { "name": "pageNo", "in": "query", "description": "Page number for the required data. ", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "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, startTime, endTime, totalBudget", "required": false, "schema": { "type": "string", "default": "-id" } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Success response": { "description": "Success response", "value": { "success": true, "data": { "totalRecords": 36, "filteredRecords": 36, "operationalLabels": [ { "label": "Test Label with 30 chars - 857", "id": 29 }, { "label": "Test Label with 30 characters.", "id": 16 } ] } } }, "Response when Invalid sortBy": { "description": "Response when Invalid sortBy", "value": { "success": false, "errorObjects": [ { "error": "Invalid sortBy value." } ] } }, "Response when the user is not a super user": { "description": "Response when the user is not a super user", "value": { "success": false, "errorObjects": [ { "error": "Only super user can perform this operation" } ] } } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Invalid sortBy value." } ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/ua/customer-operations/details/{owId}": { "get": { "tags": [ "User Management API" ], "summary": "Retrieves Customer Operation details by given customer owID ", "description": "Returns Customer Operation information about Advertiser or Workspace organization set by SA users", "operationId": "getCustomerOperationDetailsById", "parameters": [ { "name": "owId", "in": "path", "description": "customer owID", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "errorObjects": { "type": "array", "items": { "type": "object", "properties": { "error": { "type": "string" }, "reason": { "type": "string" }, "field": { "type": "string" } } } }, "data": { "type": "object" } } }, "examples": { "Workspace details": { "description": "Workspace details", "value": { "success": true, "data": { "workspaceCustomerOperationDetails": { "customerTypeId": 1, "owId": 202879, "customerPaymentTypeId": 2, "countryId": 30100001, "adOpsAssigneeUserIds": [7184], "sellerAssigneeUserIds": [6900], "labelIds": [1, 3, 4], "overridenFields": { "customerTypeId": false, "customerPaymentTypeId": false, "countryId": false, "adOpsAssigneeUserIds": false, "sellerAssigneeUserIds": false, "labelIds": false } } } } }, "Advertiser details": { "description": "Advertiser details", "value": { "success": true, "data": { "workspaceCustomerOperationDetails": { "customerTypeId": 1, "owId": 202815, "customerPaymentTypeId": 2, "countryId": 30100001, "adOpsAssigneeUserIds": [7184], "sellerAssigneeUserIds": [6900], "labelIds": [1, 3, 4], "overridenFields": { "customerTypeId": false, "customerPaymentTypeId": false, "countryId": false, "adOpsAssigneeUserIds": false, "sellerAssigneeUserIds": false, "labelIds": false } }, "advertiserCustomerOperationDetails": { "customerTypeId": 1, "owId": 202932, "customerPaymentTypeId": 1, "countryId": 30100001, "adOpsAssigneeUserIds": [7184], "sellerAssigneeUserIds": [6900], "labelIds": [1, 3, 4], "overridenFields": { "customerTypeId": false, "customerPaymentTypeId": true, "countryId": false, "adOpsAssigneeUserIds": false, "sellerAssigneeUserIds": false, "labelIds": false } } } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden!" } ] } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "errorObjects": { "type": "array", "items": { "type": "object", "properties": { "error": { "type": "string" }, "reason": { "type": "string" }, "field": { "type": "string" } } } }, "data": { "type": "object" } } }, "examples": { "Response when the user is not a super user": { "description": "Response when the user is not a super user", "value": { "success": false, "errorObjects": [ { "error": "Only super user can perform this operation" } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/ua/admin-users/list": { "get": { "tags": [ "User Management API" ], "summary": "This API provides the list of admin user.", "description": "API to get a list of admin user based on the provided searchField, pageSize, pageNo, status and sortBy parameters.", "operationId": "getAdminUserList", "parameters": [ { "name": "searchField", "in": "query", "description": "Search the result by provided keyword in the searchField. Search by userName or UserId.", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "noOfEntries", "in": "query", "description": "The maximum number of returned results per page. ", "required": false, "schema": { "type": "integer", "format": "int32", "default": 20 } }, { "name": "pageNo", "in": "query", "description": "Page number for the required data. ", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "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 - userid, userName", "required": false, "schema": { "type": "string", "default": "+userId" } }, { "name": "userStatusIds", "in": "query", "description": "Comma separated status type ids of user whose details needs to be fetched, Status values are 1(active), 2(pending), 3(invited), 4(on hold), 5(deleted).", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Success response": { "description": "Success response", "value": { "success": true, "data": { "totalRecords": 598, "filteredRecords": 255, "adminUsersList": [ { "userName": "user-1", "userId": 1 }, { "userName": "user-2", "userId": 2 } ] } } } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Invalid sortBy value." } ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/internal/ua/users/details": { "get": { "tags": [ "User Management API" ], "summary": "Retrieve detailed user information for specified UOWIDs", "description": "This endpoint fetches detailed user information for a list of specified UOWIDs, intended primarily for internal usage.", "operationId": "fetchCompleteUserDetailsByUowIds", "parameters": [ { "name": "uowIds", "in": "query", "description": "Comma-separated string of UOW IDs for which detailed user information is to be fetched.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful retrieval of user details", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "errorObjects": { "type": "array", "items": { "type": "object", "properties": { "error": { "type": "string" }, "reason": { "type": "string" }, "field": { "type": "string" } } } }, "data": { "type": "object" } } }, "examples": { "Success": { "description": "Success", "value": { "success": true, "data": { "116011": { "userId": 7042, "owId": 200001, "firstName": "Nisha", "lastName": "T", "email": "nisha.t+stage@iqm.com", "userDesignation": null, "displayName": "Nisha T", "statusId": "1", "userAvatar": "https://iqm-web-assets-c92d6b6cbde1-stage.s3.amazonaws.com/avatar/NT.png", "contactNumber": null, "userLanguageId": null, "userTimezoneId": null, "userTimezone": null, "organizationTimezoneId": null, "organizationTimezone": null, "createdAt": "2023-10-25T00:52:22.000+00:00", "modifiedAt": "2023-10-25T06:04:50.000+00:00", "userProfileUrl": null, "betaUser": false } } } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/internal/ua/organization/{owId}/margin-access": { "get": { "tags": [ "User Management API" ], "summary": "This API will provide margin access detail", "description": "This API will provide margin access detail of provide user in organization.", "operationId": "checkForMarginAccess", "parameters": [ { "name": "owId", "in": "path", "description": "organization workspace Id for in which margin access details needed", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "isDefaultUser", "in": "query", "description": "Flag to indicate whether margin access is checked for default/owner user of the organization or not", "required": false, "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "success": true, "data": true } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/internal/ua/organization/{owId}/activity-config": { "get": { "tags": [ "User Management API" ], "summary": "This API will provide activity configuration", "description": "This API will provide activity configuration details for provided organization.", "operationId": "getActivityConfig", "parameters": [ { "name": "owId", "in": "path", "description": "organization workspace Id for in activity configuration details needed", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "success": true, "data": { "excludeActivityActionIds": [27, 116, 117, 134] } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/internal/ua/organization/logo-url/{owId}": { "get": { "tags": [ "User Management API" ], "summary": "Gets the logo URL for the given owId", "description": "This API fetches logo URL based on the provided owId", "operationId": "getOrganizationLogoByOwId", "parameters": [ { "name": "owId", "in": "path", "description": "owId for which logo URL is to be fetched.", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Success": { "description": "Success", "value": { "success": true, "data": { "logoUrl": "https://iqm-web-assets-c92d6b6cbde1-stage.s3.amazonaws.com/avatar/sample-logo.png" } } } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "examples": { "Invalid owId": { "description": "Invalid owId", "value": { "success": false, "errorObjects": [ { "error": "The provided owId - 1111 is invalid." } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/internal/ua/organization/bid-shading-enabled/{owId}": { "get": { "tags": [ "User Management API" ], "summary": "Get bid shading visibility flag.", "description": "This API fetches bid shading visibility flag for the provided organization.", "operationId": "getIsBidShadingEnabledFlag", "parameters": [ { "name": "owId", "in": "path", "description": "Organization Workspace Id", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Successful retrieval": { "description": "Successful retrieval", "value": { "success": true, "data": { "202316": false } } } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "examples": { "Invalid owId": { "description": "Invalid owId", "value": { "success": false, "errorObjects": [ { "error": "Invalid owId" } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/internal/ua/organization/assigned-customer-ids": { "get": { "tags": [ "User Management API" ], "summary": "Get Customers assigned to given user along with workspace details", "description": "This API fetches assigned customer ids for given user and user's workspace details", "operationId": "getUserAssignedCustomerIds", "parameters": [ { "name": "uowId", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "owId", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "defaultOrOwnerUser", "in": "query", "required": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Assigned Customer IDs and user's workspace details": { "description": "Assigned Customer IDs and user's workspace details", "value": { "success": true, "data": { "userAssignedCustomers": [123, 234, 345], "isWorkspace": true, "organizationName": "Sample Organization" } } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/internal/ua/organization/advertisers-profiles": { "get": { "tags": [ "User Management API" ], "summary": "This API will provide customer details list", "description": "This API will provide all customers of logged in user (i.e. customers of OW id provided in the header). Customers can be app users, immediate customers, workspaces, advertisers, etc.", "operationId": "getAdvertiserProfiles_1", "parameters": [ { "name": "owId", "in": "query", "description": "organization workspace Id for which details are required", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "advertiserIds", "in": "query", "description": "Comma separated advertiser Ids of users whose info needs to be fetched ", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "searchField", "in": "query", "description": "Search the result by provided keyword in the searchField. Search customer by organization name, workspace name, ow id, contact person name, contact person email.", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "limit", "in": "query", "description": "The maximum number of returned results per page. ", "required": false, "schema": { "type": "integer", "format": "int32", "default": 10 } }, { "name": "pageNo", "in": "query", "description": "Page number for the required data. ", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "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. \nValue can be from owId, organizationName, status, contactPersonEmail, createdAt, balance, workspaceId, runningCampaigns, customersCount, lastAccess." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "success": true, "data": { "data": [ { "id": 1, "advertiserName": "Nikon", "website": "http://nikonindia.com", "chiefName": "Nil Miles", "contactNumber": "+91 9999999999", "contactAddress": null, "politicalIdentifier": "120-234-356-46" }, { "id": 2, "advertiserName": "Nike", "website": "http://nikeindia.com", "chiefName": "Nike", "contactNumber": "+91 9999988888", "contactAddress": null, "politicalIdentifier": null } ], "totalRecords": 2, "filteredRecords": 2 } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "User is not authorized to access customers of given organizations" } ] } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Invalid sortBy value." } ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/custom/ua/organization/detail/{owId}": { "get": { "tags": [ "User Management API" ], "summary": "This api fetches the organization details based on owId", "description": "This api fetches the organization details like advertiser name , logo and isVerified based on owId used for fetching the organization details for microsite", "operationId": "getOrganizationDetailsByOWId", "parameters": [ { "name": "owId", "in": "path", "description": "Organization Workspace ID for which details need to be fetched", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "success": true, "data": { "organizationName": "iqm corporation", "logoUrl": "http://aws/s2/logo.png", "isVerified": true } } } } }, "422": { "description": "Unprocessable entity", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Invalid OwId" } ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/custom/ua/customers/advertiser-details": { "get": { "tags": [ "User Management API" ], "summary": "This api fetches the advertiser details based on uuId, advertiserId or owId", "description": "This api fetches the advertiser details like advertiser name , links , logo etc. based on uuId, advertiserId or owId", "operationId": "getAdvertiserDetails", "parameters": [ { "name": "uuid", "in": "query", "description": "UUID of the attached advertiser for which advertiser details is needed", "required": false, "schema": { "type": "string" } }, { "name": "advertiserId", "in": "query", "description": "ID of the attached advertiser for which advertiser details is needed", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "owId", "in": "query", "description": "Organization Workspace ID for which advertiser details need to be fetched", "required": false, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "success": true, "data": { "advertiserName": "Test Adv", "website": "http://iqm.com", "chiefName": "Maulik", "contactNumber": "12345", "address": "Abad", "id": 4572, "legalInfo": "Test", "links": "iqm.com", "organizationName": "iqm corporation", "logoUrl": "http://aws/s2/logo.png", "isVerified": true, "uuid": "1a5ef58f-4dcf-45ee-afaf-8ae563f4d534" } } } } }, "422": { "description": "Unprocessable entity", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "OwId is required with advertiserId" } ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/internal/fa/campaigns/margin-detail": { "post": { "tags": [ "User Management API" ], "summary": "This API will provide campaign margin details", "operationId": "getCampaignMarginDetails", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "object" } }, "example": { "campaignIds": [1234, 4567] } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "success": true, "data": { "1234": { "workspaceMargin": 10, "organizationMargin": 10 }, "4567": { "workspaceMargin": 11, "organizationMargin": 20 } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/internal/fa/campaign/edit-margin": { "post": { "tags": [ "User Management API" ], "summary": "This API will update campaign margin details as per uowId and owId for a single proposal", "operationId": "updateCampaignMargins", "parameters": [ { "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "uowId": { "type": "integer", "format": "int32" }, "owId": { "type": "integer", "format": "int32" }, "parentOwId": { "type": "integer", "format": "int32" }, "proposalId": { "type": "integer", "format": "int32" }, "campaignMargins": { "type": "array", "items": { "type": "object", "properties": { "campaignId": { "type": "integer", "format": "int32" }, "campaignMargin": { "type": "integer", "format": "int32" }, "campaignName": { "type": "string" } } } } } }, "example": { "owId": 121212, "uowId": 121211, "parentOwId": 121211, "proposalId": 12, "campaignMargins": [ { "campaignId": 1, "campaignName": "Campaign 1", "campaignMargin": 10 }, { "campaignId": 2, "campaignName": "Campaign 2", "campaignMargin": 9 } ] } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "success": true, "data": { "message": "Campaign margin updated successfully." } } } } } } } }, "/api/v3/fa/organization/margin-settings": { "get": { "tags": [ "User Management API" ], "summary": "This API is used to get margin settings of the workspace", "description": "This API can be used by workspace organization users to get margin related settings. For example, workspace can view default margin which would be applied on newly onboarded advertiser. ", "operationId": "getMarginSettings", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "success": true, "data": { "totalRecords": 2, "data": [ { "marginTypeId": 1, "marginType": "Gross Margin", "marginValue": 20 } ], "filteredRecords": 1 } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "User is not allowed to access this api" } ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } }, "post": { "tags": [ "User Management API" ], "summary": "This API is used to update margin settings of the workspace", "description": "This API can be used by workspace organization users to update margin related settings. \nFor example, workspace can set default margin and it will applied on newly onboarded advertiser. \n\n---\n\n#### Request Body Detail\n\n| **Field** | **Type** | **Description** |\n| --- | --- | --- |\n| marginTypeId | Integer | Margin type id. 1 - Gross margin. |\n| marginValue | Integer | Margin value. It should be between 1 to 99. |\n", "operationId": "updateMarginSettings", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "customerOwId": { "type": "integer", "format": "int32" }, "pgCampaignFees": { "type": "number", "format": "double" }, "pgWorkspaceShare": { "type": "number", "format": "double" } } }, "examples": { "Update gross margin": { "description": "Update gross margin", "value": { "marginTypeId": 1, "marginValue": 10 } }, "Invalid margin type id": { "description": "Invalid margin type id", "value": { "marginTypeId": 2, "marginValue": 10 } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "success": true, "data": "Margin settings updated successfully." } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "User is not allowed to access this api" } ] } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Invalid marginTypeId : 2" } ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/fa/customer/edit-margin": { "post": { "tags": [ "User Management API" ], "summary": "This API is used to edit customer or bid shading margin details based on margin type id", "operationId": "editCustomerMargin", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "type": "string" }, "username": { "type": "string" }, "campaignId": { "type": "integer", "format": "int32" }, "workspaceMargin": { "type": "integer", "format": "int32" }, "organizationMargin": { "type": "integer", "format": "int32" }, "marginTypeId": { "type": "integer", "format": "int32" } } }, "example": { "owId": 202318, "marginTypeId": 1, "marginValue": 15 } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden!" } ] } } } }, "422": { "description": "Unprocessable entity", "content": { "application/json": { } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/internal/fa/insights/reports/fees": { "patch": { "tags": [ "User Management API" ], "summary": "Delete Insights Report Fees", "description": "Deletes insights report fees details based on the provided insight type IDs and OW IDs from the database. However, the cache values for CustomerConfig might have the keys as the removal of those keys are not part of this API.", "operationId": "deleteInsightsReportByOwIds", "requestBody": { "description": "Map of insight type IDs to comma-separated OW IDs", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } }, "examples": { "Example Request": { "summary": "Example request body for deleting insights report fees", "description": "Example Request", "value": { "1": "1,2,3", "2": "1,2,3", "3": "1,2,3" } } } } }, "required": true }, "responses": { "200": { "description": "Insights reports fees deleted successfully", "content": { "application/json": { "examples": { "Success Response": { "summary": "Response after successful deletion of insights report fees", "description": "Success Response", "value": { "success": true, "data": "Insights reports fees deleted successfully" } } } } } }, "422": { "description": "Unprocessable Entity - Invalid insight type ID", "content": { "application/json": { "examples": { "Bad Request Response": { "summary": "Response when the request body is invalid", "description": "Bad Request Response", "value": { "success": false, "errorObjects": [ { "error": "Invalid insight type ID: 12" } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/internal/fa/customer/dv-ivt": { "patch": { "tags": [ "User Management API" ], "summary": "API to enable/disable free DV IVT pre-bid segments for multiple customers", "description": "This API is used to update DV IVT flag for multiple customers in DB and config_obj via internal user-api call", "operationId": "updateCustomerConfig", "requestBody": { "description": "Request object containing advertiser's OW IDs and value of DV IVT flag to be set", "content": { "application/json": { "schema": { "required": [ "customerOwIds" ], "type": "object", "properties": { "customerOwIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "dvIvtSegmentsEnabled": { "type": "boolean" } } }, "example": { "customerOwIds": [12345, 67890], "dvIvtSegmentsEnabled": true } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "success": true, "data": { "customerOwIds": [12345, 67890], "isDvIvtSegmentsEnabled": true, "message": "DV Fraud & IVT segments enabled for free successfully" } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "example": { "success": false, "error": { "message": "No advertiser customers found for the given OW IDs" } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/internal/fa/campaign/margin": { "get": { "tags": [ "User Management API" ], "operationId": "getCampaignMargin", "parameters": [ { "name": "campaignId", "in": "query", "description": "Campaign Id", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "success": true, "data": { "campaignId": 123456, "workspaceMargin": 20, "organizationMargin": 25 } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } }, "patch": { "tags": [ "User Management API" ], "operationId": "updateCampaignMargin", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "type": "string" }, "username": { "type": "string" }, "campaignId": { "type": "integer", "format": "int32" }, "workspaceMargin": { "type": "integer", "format": "int32" }, "organizationMargin": { "type": "integer", "format": "int32" }, "marginTypeId": { "type": "integer", "format": "int32" } } }, "example": { "email": "email@domain.com", "username": "User Name", "campaignId": 123456, "workspaceMargin": 20, "organizationMargin": 25 } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "success": true, "data": "Campaign margin updated successfully." } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/fa/customer/{customerOwId}/pg-fees": { "patch": { "tags": [ "User Management API" ], "summary": "This API is used to edit customer PG Fees details based on given customer owId", "operationId": "editPgFeesDetails", "parameters": [ { "name": "customerOwId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "customerOwId": { "type": "integer", "format": "int32" }, "pgCampaignFees": { "type": "number", "format": "double" }, "pgWorkspaceShare": { "type": "number", "format": "double" } } }, "example": { "owId": 202318, "pgCampaignFees": 10, "pgWorkspaceShare": 15 } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "success": true, "data": "PG Fees details updated Successfully." } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden!" } ] } } } }, "422": { "description": "Unprocessable entity", "content": { "application/json": { } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/fa/customer/vld-fees": { "patch": { "tags": [ "User Management API" ], "summary": "Update vld finance details", "description": "This API can be used by workspace and super organization users to update vld related finance details including vld rate, vld enabled flag, vld markup type and vld markup value as per logged in organization ---#### Request Body Detail| **Field** | **Type** | **Description** || --- | --- | --- || owId | Integer | ow id of the customer to update details (required) || vldRate | Double | vld rate for workspace customer || vldEnabled | Boolean | boolean flag to enable and disable vld feature for advertiser customer || vldMarkupTypeId | Integer | vld markup type id to represent markup types absolute or percentage || vldMarkupValue | Double | vld markup value for advertiser customer |", "operationId": "editVLDFees", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "content": { "application/json": { "schema": { "required": [ "owId" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "owId": { "type": "integer", "format": "int32" }, "vldRate": { "minimum": 0, "type": "number", "format": "double" }, "vldEnabled": { "type": "boolean" }, "vldMarkupType": { "type": "string" }, "vldMarkupTypeId": { "type": "integer", "format": "int32" }, "vldMarkupValue": { "maximum": 9999, "minimum": 0, "type": "number", "format": "double" } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "VLD rate updated successfully for workspace customer by super user": { "description": "VLD rate updated successfully for workspace customer by super user", "value": { "success": true, "data": { "id": 1, "message": "VLD Rate updated successfully. The new rate applies only to newly created VLDs" } } }, "VLD details enabled for advertiser customer by super user": { "description": "VLD details enabled for advertiser customer by super user", "value": { "success": true, "data": { "id": 6, "message": "VLD Insights enabled successfully." } } } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "examples": { "Invalid/Inaccessible customer ow id passed": { "description": "Invalid/Inaccessible customer ow id passed", "value": { "success": true, "data": { "success": false, "errorObjects": [ { "error": "User is not allowed to access provided customer details" } ] } } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } }, "deprecated": true } }, "/api/v3/fa/customer/sls-fees": { "patch": { "tags": [ "User Management API" ], "summary": "Update sls finance details", "description": "This API can be used by workspace and super organization users to update sls related finance details including sls rate, sls enabled flag, sls markup type and sls markup value as per logged in organization \n\n---\n\n#### Request Body Detail\n\n| **Field** | **Type** | **Description** |\n| --- | --- | --- |\n| owId | Integer | ow id of the customer to update details (required) |\n| slsRate | Double | sls rate for workspace customer |\n| slsEnabled | Boolean | boolean flag to enable and disable sls feature for advertiser customer |\n| slsMarkupTypeId | Integer | sls markup type id to represent markup types absolute or percentage |\n| slsMarkupValue | Double | sls markup value for advertiser customer |", "operationId": "editSLSFees", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "content": { "application/json": { "schema": { "required": [ "owId" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "owId": { "type": "integer", "format": "int32" }, "slsRate": { "maximum": 10000, "minimum": 0, "type": "number", "format": "double" }, "slsEnabled": { "type": "boolean" }, "slsMarkupType": { "type": "string" }, "slsMarkupTypeId": { "type": "integer", "format": "int32" }, "slsMarkupValue": { "maximum": 10000, "minimum": 0, "type": "number", "format": "double" } } }, "examples": { "SLS rate updated for workspace customer by super user": { "description": "SLS rate updated for workspace customer by super user", "value": { "owId": 2000022, "slsRate": 3 } }, "SLS feature activation for advertiser customer by super user": { "description": "SLS feature activation for advertiser customer by super user", "value": { "owId": 2037022, "slsEnabled": true } }, "SLS markup rate updated for workspace customer by super user": { "description": "SLS markup rate updated for workspace customer by super user", "value": { "owId": 2037028, "slsMarkupTypeId": 2, "slsMarkupValue": 20 } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "SLS rate updated successfully for workspace customer by super user": { "description": "SLS rate updated successfully for workspace customer by super user", "value": { "success": true, "data": { "id": 1, "message": "SLS Rate updated successfully. The new rate applies only to newly created SLS reports" } } }, "SLS feature activation for advertiser customer by super user": { "description": "SLS feature activation for advertiser customer by super user", "value": { "success": true, "data": { "id": 6, "message": "SLS Insights enabled successfully." } } }, "SLS markup details updated for advertiser customer by workspace user": { "description": "SLS markup details updated for advertiser customer by workspace user", "value": { "success": true, "data": { "id": 4, "message": "SLS Rate Markup updated successfully." } } } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "examples": { "Invalid/Inaccessible customer ow id passed": { "description": "Invalid/Inaccessible customer ow id passed", "value": { "success": true, "data": { "success": false, "errorObjects": [ { "error": "User is not allowed to access provided customer details" } ] } } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } }, "deprecated": true } }, "/api/v3/fa/customer/pld-fees": { "patch": { "tags": [ "User Management API" ], "summary": "Update pld finance details", "description": "This API can be used by workspace and super organization users to update pld related finance details including pld rate, pld enabled flag, pld markup type and pld markup value as per logged in organization ---#### Request Body Detail| **Field** | **Type** | **Description** || --- | --- | --- || owId | Integer | ow id of the customer to update details (required) || pldRate | Double | pld rate for workspace customer || pldEnabled | Boolean | boolean flag to enable and disable pld feature for advertiser customer || pldMarkupTypeId | Integer | pld markup type id to represent markup types absolute or percentage || pldMarkupValue | Double | pld markup value for advertiser customer |", "operationId": "updatePLDFees", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "content": { "application/json": { "schema": { "required": [ "owId" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "owId": { "type": "integer", "format": "int32" }, "pldRate": { "maximum": 10000, "minimum": 0, "type": "number", "format": "double" }, "pldEnabled": { "type": "boolean" }, "pldMarkupType": { "type": "string" }, "pldMarkupTypeId": { "type": "integer", "format": "int32" }, "pldMarkupValue": { "maximum": 10000, "minimum": 0, "type": "number", "format": "double" } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "PLD rate updated successfully for workspace customer by super user": { "description": "PLD rate updated successfully for workspace customer by super user", "value": { "success": true, "data": { "id": 1, "message": "PLD Rate updated successfully. The new rate applies only to newly created PLDs" } } }, "PLD details enabled for advertiser customer by super user": { "description": "PLD details enabled for advertiser customer by super user", "value": { "success": true, "data": { "id": 6, "message": "PLD Insights enabled successfully." } } }, "PLD rate Markup updated successfully for advertiser by workspace user": { "description": "PLD rate Markup updated successfully for advertiser by workspace user", "value": { "success": true, "data": { "id": 6, "message": "PLD Rate Markup updated successfully." } } } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "examples": { "Invalid/Inaccessible customer ow id passed": { "description": "Invalid/Inaccessible customer ow id passed", "value": { "success": true, "data": { "success": false, "errorObjects": [ { "error": "User is not allowed to access provided customer details" } ] } } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } }, "deprecated": true } }, "/api/v3/fa/customer/dv-ivt": { "get": { "tags": [ "User Management API" ], "summary": "Fetch DV-IVT free segments enabled/disabled flag", "description": "This API can be used by super organization users to fetch DV-IVT free segments enabled/disabled flag for customer organization ---#### Request Params Detail| **Field** | **Type** | **Description** || --- | --- | --- || customerOwId | Integer | ow id of the customer to update details (required) |", "operationId": "getDvIvtFlag", "parameters": [ { "name": "customerOwId", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "DV Fraud & IVT segments flag fetched": { "description": "DV Fraud & IVT segments flag fetched", "value": { "success": true, "data": { "customerOwId": 1, "isDvIvtSegmentsEnabled": true } } } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "examples": { "Invalid/Inaccessible customer ow id passed": { "description": "Invalid/Inaccessible customer ow id passed", "value": { "success": true, "data": { "success": false, "errorObjects": [ { "error": "User is not allowed to access provided customer details" } ] } } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } }, "patch": { "tags": [ "User Management API" ], "summary": "Update DV-IVT free segments enabled/disabled flag", "description": "This API can be used by super organization users to update DV-IVT free segments enabled/disabled flag for customer organization ---#### Request Params Detail| **Field** | **Type** | **Description** || --- | --- | --- || customerOwId | Integer | ow id of the customer to update details (required) || isDvIvtSegmentsEnabled | Boolean | boolean flag to enable and disable free DV-IVT segments for advertiser customer |", "operationId": "updateDvIvtFlag", "parameters": [ { "name": "customerOwId", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "isDvIvtSegmentsEnabled", "in": "query", "required": true, "schema": { "type": "boolean" } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "DV Fraud & IVT segments enabled for free successfully": { "description": "DV Fraud & IVT segments enabled for free successfully", "value": { "success": true, "data": { "customerOwId": 1, "isDvIvtSegmentsEnabled": true, "message": "DV Fraud & IVT segments enabled for free successfully" } } }, "DV Fraud & IVT segments will now be chargeable": { "description": "DV Fraud & IVT segments will now be chargeable", "value": { "success": true, "data": { "customerOwId": 1, "isDvIvtSegmentsEnabled": false, "message": "DV Fraud & IVT segments will now be chargeable" } } } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "examples": { "Invalid/Inaccessible customer ow id passed": { "description": "Invalid/Inaccessible customer ow id passed", "value": { "success": true, "data": { "success": false, "errorObjects": [ { "error": "User is not allowed to access provided customer details" } ] } } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/fa/customer/aqs-fees": { "patch": { "tags": [ "User Management API" ], "summary": "Update aqs finance details", "description": "This API can be used by workspace and super organization users to update aqs related finance details including aqs rate, aqs enabled flag, aqs markup type and aqs markup value as per logged in organization ---#### Request Body Detail| **Field** | **Type** | **Description** || --- | --- | --- || owId | Integer | ow id of the customer to update details (required) || aqsRate | Double | aqs rate for workspace customer || aqsEnabled | Boolean | boolean flag to enable and disable aqs feature for advertiser customer || aqsMarkupTypeId | Integer | aqs markup type id to represent markup types absolute or percentage || aqsMarkupValue | Double | aqs markup value for advertiser customer |", "operationId": "editAQSFees", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "content": { "application/json": { "schema": { "required": [ "owId" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "owId": { "type": "integer", "format": "int32" }, "aqsRate": { "maximum": 10000, "minimum": 0, "type": "number", "format": "double" }, "aqsEnabled": { "type": "boolean" }, "aqsMarkupType": { "type": "string" }, "aqsMarkupTypeId": { "type": "integer", "format": "int32" }, "aqsMarkupValue": { "maximum": 10000, "minimum": 0, "type": "number", "format": "double" } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "AQS rate updated successfully for workspace customer by super user": { "description": "AQS rate updated successfully for workspace customer by super user", "value": { "success": true, "data": { "id": 1, "message": "AQS Rate updated successfully. The new rate applies only to newly created AQSs" } } }, "AQS details enabled for advertiser customer by super user": { "description": "AQS details enabled for advertiser customer by super user", "value": { "success": true, "data": { "id": 6, "message": "AQS Insights enabled successfully." } } } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "examples": { "Invalid/Inaccessible customer ow id passed": { "description": "Invalid/Inaccessible customer ow id passed", "value": { "success": true, "data": { "success": false, "errorObjects": [ { "error": "User is not allowed to access provided customer details" } ] } } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } }, "deprecated": true } }, "/api/v3/internal/fa/{owId}/pg-fees": { "get": { "tags": [ "User Management API" ], "summary": "This Internal API fetches the PG fees details for workspace owId for the given customer owId from the database", "operationId": "getPgDetailsByOwId", "parameters": [ { "name": "owId", "in": "path", "description": "Organization Workspace Id whose PG fees detail needs to be fetched", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "success": true, "data": { "organizationPgFeesDetails": { "pgCampaignFees": 10, "pgWorkspaceShare": 12 } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/internal/fa/customer/{customerOwId}/third-party-cost": { "get": { "tags": [ "User Management API" ], "summary": "Get Third Party Cost", "description": "This internal API retrieves the third-party cost details for a specific customer.\nThe details include the owId and the associated third-party cost data.\nThis internal API can be consumed by other microservices or data modules to fetch the third party cost details if needed.\nThis internal API is not to be consumed by external clients or exposed in the public API documentation.", "operationId": "getThirdPartyCost", "parameters": [ { "name": "customerOwId", "in": "path", "description": "Customer's ow id for whom the cost details are being fetched (required).", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Third-party cost details retrieved successfully.", "content": { "application/json": { } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/internal/fa/customer/gross-margin": { "get": { "tags": [ "User Management API" ], "summary": "This Internal API fetches the default gross margin applied on workspace user or advertiser user.", "operationId": "getCustomerDefaultMarginForAdvertiser", "parameters": [ { "name": "owIds", "in": "query", "description": "Organization Workspace Id of advertiser user whose gross margin percentage needs to be fetched", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "success": true, "data": { "marginTypeId": 1, "marginType": "Gross Margin", "marginValue": 44 } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/internal/fa/campaign-finance-details": { "get": { "tags": [ "User Management API" ], "summary": "Get all finance and organization details for provided campaign.", "description": "This API will get all finance and organization details for provided campaign.", "operationId": "getCampaignMarginDetail", "parameters": [ { "name": "campaignId", "in": "query", "description": "Campaign ID for which finance information needs to be fetched", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "owId", "in": "query", "description": "organization Workspace relation id of the campaign", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "success": true, "data": { "campaignMarginDetails": { "1": 0, "2": 10 }, "owIdConfigObj": { "bid_shading_share": 40, "is_only_impression_based_customer": true } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/internal/fa/available-balance": { "get": { "tags": [ "User Management API" ], "summary": "API to get available balance for a organisation or workspace ", "description": "Internal API to get the balance for the different advertisers and workspace", "operationId": "getAvailableBalance", "parameters": [ { "name": "owIds", "in": "query", "description": "organization Workspace relation id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "success": true, "data": { "2": 25.15, "12": 6.02 } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/fa/static/pg/payment-type": { "get": { "tags": [ "User Management API" ], "summary": "This API fetches a static list of payment types from the database, sorted in ascending order by the default order column.", "operationId": "getPgPaymentTypes", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Pg Payment Types": { "description": "Pg Payment Types", "value": { "success": true, "data": { "totalRecords": 2, "filteredRecords": 2, "pgPaymentTypes": [ { "id": 1, "name": "publisher", "label": "Publisher", "order": 1 }, { "id": 2, "name": "platform", "label": "Platform", "order": 2 } ] } } } } } } }, "204": { "description": "No Content" }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/fa/customer/{owId}/pg-fees": { "get": { "tags": [ "User Management API" ], "summary": "This API will provide customer PG Fees details", "operationId": "getPgFeesDetails", "parameters": [ { "name": "owId", "in": "path", "description": "Organization Workspace Id whose PG fees detail needs to be fetched", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Response for Workspace OwId": { "description": "Response for Workspace OwId", "value": { "success": true, "data": { "organizationPgFeesDetails": { "pgCampaignFees": 10, "pgWorkspaceShare": 15 } } } }, "Response for Advertiser OwId": { "description": "Response for Advertiser OwId", "value": { "success": true, "data": { "organizationPgFeesDetails": { "pgWorkspaceShare": 10 } } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { } } }, "422": { "description": "Unprocessable entity", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "PG Feed Details was not found for the given customer owId" } ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/fa/customer/{customerOwId}/vld-fees": { "get": { "tags": [ "User Management API" ], "summary": "Get vld finance details", "description": "This API can be used by workspace and super organization users to get vld related finance details including vld rate, vld enabled flag, vld markup type and vld markup value as per logged in organization ", "operationId": "getVLDFees", "parameters": [ { "name": "customerOwId", "in": "path", "description": "owId of the organization to fetch vld details", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "VLD details of workspace fetched by super": { "description": "VLD details of workspace fetched by super", "value": { "success": true, "data": { "id": 1, "vldRate": 3 } } }, "VLD details of advertiser fetched by super/workspace with vld flag disabled": { "description": "VLD details of advertiser fetched by super/workspace with vld flag disabled", "value": { "success": true, "data": { "vldRate": 3, "vldEnabled": false } } }, "VLD details of advertiser fetched by super/workspace with vld flag enabled": { "description": "VLD details of advertiser fetched by super/workspace with vld flag enabled", "value": { "success": true, "data": { "id": 3, "owId": 201427, "vldRate": 3, "vldEnabled": true, "vldMarkupType": "Percentage", "vldMarkupValue": 10 } } } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "examples": { "Invalid/Inaccessible customer ow id passed": { "description": "Invalid/Inaccessible customer ow id passed", "value": { "success": true, "data": { "success": false, "errorObjects": [ { "error": "User is not allowed to access provided customer" } ] } } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } }, "deprecated": true } }, "/api/v3/fa/customer/{customerOwId}/sls-fees": { "get": { "tags": [ "User Management API" ], "summary": "Get SLS finance details", "description": "This API can be used by workspace and super organization users to get sls related finance details including sls data rate, sls enabled flag, sls markup type and sls markup value as per logged in organization ", "operationId": "getSLSFees", "parameters": [ { "name": "customerOwId", "in": "path", "description": "owId of the organization to fetch sls details", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "SLS details of workspace fetched by super": { "description": "SLS details of workspace fetched by super", "value": { "success": true, "data": { "id": 1, "slsRate": 3 } } }, "SLS details of advertiser fetched by super/workspace with sls flag disabled": { "description": "SLS details of advertiser fetched by super/workspace with sls flag disabled", "value": { "success": true, "data": { "slsRate": 3, "slsEnabled": false } } }, "SLS details of advertiser fetched by super/workspace with sls flag enabled": { "description": "SLS details of advertiser fetched by super/workspace with sls flag enabled", "value": { "success": true, "data": { "id": 3, "owId": 201427, "slsRate": 3, "slsEnabled": true, "slsMarkupType": "Percentage", "slsMarkupValue": 10 } } } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "examples": { "Invalid/Inaccessible customer ow id passed": { "description": "Invalid/Inaccessible customer ow id passed", "value": { "success": true, "data": { "success": false, "errorObjects": [ { "error": "User is not allowed to access provided customer" } ] } } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } }, "deprecated": true } }, "/api/v3/fa/customer/{customerOwId}/pld-fees": { "get": { "tags": [ "User Management API" ], "summary": "Get pld finance details", "description": "This API can be used by workspace and super organization users to get pld related finance details including pld rate, pld enabled flag, pld markup type and pld markup value as per logged in organization ", "operationId": "getPLDFees", "parameters": [ { "name": "customerOwId", "in": "path", "description": "owId of the organization to fetch pld details", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "PLD details of workspace fetched by super": { "description": "PLD details of workspace fetched by super", "value": { "success": true, "data": { "id": 1, "pldRate": 3 } } }, "PLD details of advertiser fetched by super/workspace with pld flag disabled": { "description": "PLD details of advertiser fetched by super/workspace with pld flag disabled", "value": { "success": true, "data": { "pldRate": 3, "pldEnabled": false } } }, "PLD details of advertiser fetched by super/workspace with pld flag enabled": { "description": "PLD details of advertiser fetched by super/workspace with pld flag enabled", "value": { "success": true, "data": { "id": 3, "owId": 201427, "pldRate": 3, "pldEnabled": true, "pldMarkupType": "Percentage", "pldMarkupValue": 10 } } } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "examples": { "Invalid/Inaccessible customer ow id passed": { "description": "Invalid/Inaccessible customer ow id passed", "value": { "success": true, "data": { "success": false, "errorObjects": [ { "error": "User is not allowed to access provided customer" } ] } } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } }, "deprecated": true } }, "/api/v3/fa/customer/{customerOwId}/aqs-fees": { "get": { "tags": [ "User Management API" ], "summary": "Get AQ finance details", "description": "This API can be used by workspace and super organization users to get AQ related finance details including AQ rate, AQ enabled flag, AQ markup type and AQ markup value as per logged in organization ", "operationId": "getAQSFees", "parameters": [ { "name": "customerOwId", "in": "path", "description": "owId of the organization to fetch AQ details", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "AQS details of workspace fetched by super": { "description": "AQS details of workspace fetched by super", "value": { "success": true, "data": { "id": 1, "aqsRate": 3 } } }, "AQS details of advertiser fetched by super/workspace with AQS flag disabled": { "description": "AQS details of advertiser fetched by super/workspace with AQS flag disabled", "value": { "success": true, "data": { "aqsRate": 3, "aqsEnabled": false } } }, "AQS details of advertiser fetched by super/workspace with AQS flag enabled": { "description": "AQS details of advertiser fetched by super/workspace with AQS flag enabled", "value": { "success": true, "data": { "id": 3, "owId": 201427, "aqsRate": 3, "aqsEnabled": true, "aqsMarkupType": "Percentage", "aqsMarkupValue": 10 } } } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "examples": { "Invalid/Inaccessible customer ow id passed": { "description": "Invalid/Inaccessible customer ow id passed", "value": { "success": true, "data": { "success": false, "errorObjects": [ { "error": "User is not allowed to access provided customer" } ] } } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } }, "deprecated": true } }, "/api/v3/fa/customer/view-margin": { "get": { "tags": [ "User Management API" ], "summary": "This API will provide customer margin details", "operationId": "getCustomerMargin", "parameters": [ { "name": "marginTypeIds", "in": "query", "description": "Comma separated margin type ids whose margin detail needs to be fetched", "required": false, "schema": { "type": "string" } }, { "name": "owId", "in": "query", "description": "Organization Workspace Id whose margin detail needs to be fetched", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "success": true, "data": { "totalRecords": 1, "data": [ { "marginTypeId": 1, "marginType": "Gross Margin", "marginValue": 15 } ], "filteredRecords": 1, "isBidShadingEnabled": false } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { } } }, "422": { "description": "Unprocessable entity", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Invalid Margin Type" } ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/fa/basic/details": { "get": { "tags": [ "User Management API" ], "summary": "This API will provide basic finance details ", "operationId": "getBasicDetails", "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "success": true, "data": { "paypalFeesPercentage": 3.5 } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "ow id provided in header is not configured in redis." } ] } } } } } } }, "/api/v3/custom/fa/list/campaign-margin-detail": { "get": { "tags": [ "User Management API" ], "summary": "This API will provide campaign margin details", "operationId": "getCampaignMarginDetailList", "parameters": [ { "name": "campaignIds", "in": "query", "description": "Comma separated campaign ids whose margin detail needs to be fetched", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "success": true, "data": { "1234": { "workspaceMargin": 10, "organizationMargin": 10 }, "4567": { "workspaceMargin": 11, "organizationMargin": 20 } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/internal/ins/insights/update-status": { "put": { "tags": [ "Insights API" ], "summary": "This api used to update insight status for requested source id.", "description": "This api update status of insight in both insight and supported source.", "operationId": "updateInsightStatus", "requestBody": { "description": "\n**Request Body Details:**\n\n| **Field** | **Type** | **Description** |\n| --- | --- | --- |\n| sourceId | Integer | The ID of the source which insight status need to update. |\n| owId | Integer | The ID of the organization work space associated with the insights. |\n| status | Integer | The new status of the insights update to source. Allowed values are `ready`, `failed`. |\n| insightsType | String | The type of insights to be updated. Supported values are `audiences`. |\n", "content": { "application/json": { "schema": { "required": [ "status" ], "type": "object", "properties": { "sourceId": { "minimum": 0, "type": "integer", "format": "int32" }, "owId": { "minimum": 0, "type": "integer", "format": "int32" }, "status": { "pattern": "ready|failed", "type": "string" }, "insightsType": { "type": "string" } } }, "examples": { "Update insight status": { "description": "Update insight status", "value": { "sourceId": 123, "owId": 100384, "status": "ready", "insightsType": "audiences" } }, "Invalid insight status": { "description": "Invalid insight status", "value": { "sourceId": 123, "owId": 100384, "status": "success", "insightsType": "audiences" } }, "Invalid insight type for not created insights": { "description": "Invalid insight type for not created insights", "value": { "sourceId": 123, "owId": 100384, "status": "ready" } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Update insight status": { "description": "Update insight status", "value": { "success": true, "data": "Insights status updated successfully." } } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "examples": { "Invalid insight status": { "description": "Invalid insight status", "value": { "success": false, "errorObjects": [ { "error": "Please provide valid status value. Allowed status values are ready, failed.", "field": "status" } ] } }, "Invalid insight type for not created insights": { "description": "Invalid insight type for not created insights", "value": { "success": false, "errorObjects": [ { "error": "Please provide insight type. Insight type mandatory for not created insight" } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/internal/ins/insights-report/campaign/audience-eligibility": { "post": { "tags": [ "Insights API" ], "summary": "Upsert the campaign audience eligibility for insights report generation ", "description": "This API Insert/Update the campaign audience eligibility for insights report generation for multiple campaigns\n---\n\n**Request Body Details:**\n\n| **Field** | **Type** | **Description** |\n| --- | --- | --- |\n| campaignId | Integer | Campaign ID |\n| eligibilityFlag | Boolean | Audience eligibility flag |\n| timezone | Integer | Timezone of the campaign |\n| reportTypeId | Integer | Type of insights report |\n", "operationId": "upsertCampaignAudienceEligibilityForInsights", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "insightsReportCampaignEligibilityList": { "uniqueItems": true, "type": "array", "items": { "type": "object", "properties": { "campaignId": { "type": "integer", "format": "int32" }, "eligibilityFlag": { "type": "boolean" }, "timezone": { "type": "integer", "format": "int32" }, "reportTypeId": { "type": "integer", "format": "int32" } } } } } }, "example": { "insightsReportCampaignEligibilityList": [ { "campaignId": 123, "eligibilityFlag": false, "timezone": 105, "reportTypeId": 1 }, { "campaignId": 123, "eligibilityFlag": false, "timezone": 29, "reportTypeId": 1 } ] } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "success": true, "data": { "Message": "Audience eligibility updated successfully" } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden !" } ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/internal/ins/audience/insights/create": { "post": { "tags": [ "Insights API" ], "summary": "This api used to create insights for the given source ids.", "description": "This API creates insights for the valid source ids and returns its details.", "operationId": "createInsights", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "insightsRequestVO": { "type": "object", "properties": { "insightsTypeId": { "type": "integer", "format": "int32" }, "sourceIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "owId": { "type": "integer", "format": "int32" }, "uowId": { "type": "integer", "format": "int32" } } }, "audienceDetailsVOList": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "audienceName": { "type": "string" }, "matchRate": { "type": "number", "format": "double" }, "uniques": { "type": "integer", "format": "int32" }, "insightsStatus": { "type": "integer", "format": "int32" } } } } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "UnprocessableEntity422 error message": { "description": "UnprocessableEntity422 error message", "value": { "success": false, "errorObjects": [ { "error": "Error message" } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/ins/vld-reports/computation": { "post": { "tags": [ "Insights API" ], "summary": "This API computes the cost and impressions for creation of VLD reports", "description": "This API appropriately calculates the cost for the impressions for the Voter Level Data Reports based on the impressions and the mark up charged on the organisation.", "operationId": "getChargeableImpressionsDataForVLDReports", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "campaignId": { "type": "integer", "format": "int32" }, "vldId": { "type": "integer", "format": "int32" }, "vldStartDate": { "type": "integer", "format": "int64" }, "vldEndDate": { "type": "integer", "format": "int64" }, "startDate": { "type": "integer", "format": "int64" }, "endDate": { "type": "integer", "format": "int64" }, "id": { "type": "integer", "format": "int32" }, "templateId": { "type": "integer", "format": "int32" }, "idempotencyKey": { "type": "string" }, "triggerTime": { "type": "integer", "format": "int64" }, "ioId": { "type": "integer", "format": "int32" }, "category": { "type": "string" } } }, "examples": { "For new Campaign and date range": { "description": "For new Campaign and date range", "value": { "campaignId": 1, "vldStartDate": 1722311000, "vldEndDate": 1722315000 } }, "For Generate Again": { "description": "For Generate Again", "value": { "vldId": 1 } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Successful VLD Report computation": { "description": "Successful VLD Report computation", "value": { "success": true, "data": { "vldReportCreated": true, "campaignId": 1, "campaignName": "Campaign Name", "campaignStatus": "running", "vldStartDate": 1722311000, "vldEndDate": 1722315000, "vldChargeableImps": 1000, "vldChargedImps": 100, "vldChargeableCost": 1000, "vldChargedCost": 100, "fundsAvailable": true } } }, "Same VLD report exists": { "description": "Same VLD report exists", "value": { "success": true, "data": { "vldReportCreated": false, "vldId": 1, "vldName": "1_VLD_INSIGHTS_1", "vldStatusId": 1, "vldCreatedOn": 1722315234, "campaignId": 1, "campaignName": "Campaign Name", "creativeTypeId": 1, "ioId": 1, "ioName": "Insertion Order Name", "ioTypeId": 1 } } }, "VLD report exists same campaign with overlapping date range is in processing": { "description": "VLD report exists same campaign with overlapping date range is in processing", "value": { "success": true, "data": { "vldReportCreated": false, "message": "VLD Insights can't be generated for this campaign at the moment as another insight with overlapping date range is processing" } } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/ins/vld-report": { "post": { "tags": [ "Insights API" ], "summary": "This API generates VLD reports", "description": "This API appropriately calculates the cost for the impressions for the Voter Level Data Reports based on the impressions and the mark up charged on the organisation and then creates the VLD Reports.", "operationId": "generateVLDReports", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "campaignId": { "type": "integer", "format": "int32" }, "vldId": { "type": "integer", "format": "int32" }, "vldStartDate": { "type": "integer", "format": "int64" }, "vldEndDate": { "type": "integer", "format": "int64" }, "startDate": { "type": "integer", "format": "int64" }, "endDate": { "type": "integer", "format": "int64" }, "id": { "type": "integer", "format": "int32" }, "templateId": { "type": "integer", "format": "int32" }, "idempotencyKey": { "type": "string" }, "triggerTime": { "type": "integer", "format": "int64" }, "ioId": { "type": "integer", "format": "int32" }, "category": { "type": "string" } } }, "examples": { "For new Campaign and date range": { "description": "For new Campaign and date range", "value": { "campaignId": 1, "vldStartDate": 1722311000, "vldEndDate": 1722315000 } }, "For Generate Again": { "description": "For Generate Again", "value": { "vldId": 1 } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Successful VLD Report": { "description": "Successful VLD Report", "value": { "success": true, "data": { "vldReportCreated": true, "campaignId": 1, "campaignName": "Campaign Name", "campaignStatus": "running", "vldStartDate": 1722311000, "vldEndDate": 1722315000, "vldChargeableImps": 1000, "vldChargedImps": 100, "vldChargeableCost": 1000, "vldChargedCost": 100, "fundsAvailable": true } } }, "Same VLD report exists": { "description": "Same VLD report exists", "value": { "success": true, "data": { "vldReportCreated": false, "vldId": 1, "vldName": "1_VLD_INSIGHTS_1", "vldStatusId": 1, "vldCreatedOn": 1722315234, "campaignId": 1, "campaignName": "Campaign Name", "creativeTypeId": 1, "ioId": 1, "ioName": "Insertion Order Name", "ioTypeId": 1 } } }, "VLD report exists same campaign with overlapping date range is in processing": { "description": "VLD report exists same campaign with overlapping date range is in processing", "value": { "success": true, "data": { "vldReportCreated": false, "message": "VLD Insights can't be generated for this campaign at the moment as another insight with overlapping date range is processing" } } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } }, "delete": { "tags": [ "Insights API" ], "summary": "Delete Failed VLD Reports", "description": "This API deletes VLD reports that are not marked as deleted and have a 'failed' status. It requires the user to be authorized and checks if the provided VLD IDs are valid.", "operationId": "deleteFailedVLDReport", "parameters": [ { "name": "vldIds", "in": "query", "description": "Comma-separated list of VLD IDs to delete.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "individual VLD report successfully deleted.", "content": { "application/json": { "examples": { "Success response": { "description": "Success response", "value": { "success": true, "data": { "message": "255944_VLD_Insights_2 deleted successfully" } } } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Invalid sortBy value." } ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/ins/vld-report/download": { "post": { "tags": [ "Insights API" ], "summary": "Download VLD (Audience Quality Score) Report", "description": "Downloads the Audience Quality Score (VLD) report.\nOnly reports with a 'ready' status are eligible for download.\nThe API validates the report status, file type, and user permissions before generating a pre-signed download URL.\n", "operationId": "getVLDReportDownloadUrl", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fileTypeId": { "type": "integer", "format": "int32" }, "reportId": { "type": "integer", "format": "int32" } } }, "examples": { "Download XLSX file": { "description": "Download XLSX file", "value": { "fileTypeId": 1, "reportId": 50 } }, "Download CSV file": { "description": "Download CSV file", "value": { "fileTypeId": 2, "reportId": 50 } } } } }, "required": true }, "responses": { "200": { "description": "Successfully generated download URL for the VLD report", "content": { "application/json": { "examples": { "Successful response": { "description": "Successful response", "value": { "success": true, "data": { "reportUrl": "https://xyz.abc.com/reports/abcd/2024-12-03/50_acbd_Report.xlsx?X-Amz-Algorithm=AWS4-HMAC" } } } } } } }, "400": { "description": "Invalid request - unsupported file type", "content": { "application/json": { "examples": { "Invalid file type": { "description": "Invalid file type", "value": { "success": false, "errorObjects": [ { "error": "Unsupported file type provided. Please use fileType 1 for XLSX or 2 for CSV." } ] } } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Invalid sortBy value." } ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/ins/templates/validate-name": { "post": { "tags": [ "Insights API" ], "summary": "Validate Template name availability", "description": "Checks if the given Template name is available (not already in use) within the caller's organization.", "operationId": "validateTemplateName", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "description": "Template name to validate.", "content": { "application/json": { "schema": { "required": [ "category", "name" ], "type": "object", "properties": { "name": { "maxLength": 100, "minLength": 3, "type": "string" }, "category": { "pattern": "(?i)^(pld|ict|nld)$", "type": "string" } } }, "example": { "name": "Monthly PLD Report", "category": "pld" } } }, "required": true }, "responses": { "200": { "description": "Template name availability checked successfully", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "errorObjects": { "type": "array", "items": { "type": "object", "properties": { "error": { "type": "string" }, "reason": { "type": "string" }, "field": { "type": "string" } } } }, "data": { "type": "object" } } }, "examples": { "Name is available": { "description": "Name is available", "value": { "success": true, "data": { "available": true } } }, "Name is not available": { "description": "Name is not available", "value": { "success": true, "data": { "available": false } } } } } } }, "400": { "description": "Bad request due to missing or invalid inputs", "content": { "application/json": { "examples": { "Template name is null or empty": { "description": "Template name is null or empty", "value": { "success": false, "errorObjects": [ { "error": "Template name must not be null or empty.", "field": "name" } ] } }, "Template name too short or too long": { "description": "Template name too short or too long", "value": { "success": false, "errorObjects": [ { "error": "Template name must be between 3 and 100 characters.", "field": "name" } ] } }, "Report type is not provided": { "description": "Report type is not provided", "value": { "success": false, "errorObjects": [ { "error": "InsightType is required", "field": "category" } ] } }, "Invalid report type provided": { "description": "Invalid report type provided", "value": { "success": false, "errorObjects": [ { "error": "InsightType must be one of: pld, ict or nld", "field": "category" } ] } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden !" } ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/ins/sls-reports": { "get": { "tags": [ "Insights API" ], "summary": "This API provides a list of SLS reports in the Insight app.", "description": "API to get a list of sls report based on the provided searchField, pageSize, pageNo, and sortBy parameters.", "operationId": "getSLSReportList", "parameters": [ { "name": "searchField", "in": "query", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "pageNo", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "noOfEntries", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "default": 200 } }, { "name": "sortBy", "in": "query", "required": false, "schema": { "type": "string", "default": "reportId" } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": "{\n \"success\": true,\n \"data\": {\n \"totalRecords\": 2,\n \"slsReportDataList\": [\n {\n \"slsId\": 10,\n \"slsName\": \"530667_SLS_Insights_7\",\n \"campaignIds\": [21145,21146,21147],\n \"slsStatusId\": 3,\n \"slsStatusName\": \"Failed\",\n \"startDate\": 1732165200000,\n \"endDate\": 1732424399000,\n \"ioId\": 5,\n \"ioName\": \"Corporate, Inc.\",\n \"isCampaignEligible\": false,\n \"slsCreatedOn\": 1721253632,\n \"campaignSlsTimezoneId\": 29,\n \"ioTypeId\": 1,\n \"pdfFileSize\": 2500000, //in bytes\n \"excelFileSize\": 2500000, //in bytes\n \"slsReportTypeIds\": [1,2,3]\n },\n {\n \"slsId\": 9,\n \"slsName\": \"530667_SLS_Insights_6\",\n \"campaignId\": [4949,5959],\n \"slsStatusId\": 2,\n \"slsStatusName\": \"Processing\",\n \"startDate\": 1732165200000,\n \"endDate\": 1732424399000,\n \"ioId\": 15,\n \"ioName\": \"Quinton for Mayor\",\n \"isCampaignEligible\": false,\n \"slsCreatedOn\": 1720325578,\n \"campaignSlsTimezoneId\": 29,\n \"ioTypeId\": 1,\n \"slsReportTypeIds\": [1,3]\n }\n ],\n \"filteredRecords\": 2\n }\n}\n" } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } }, "post": { "tags": [ "Insights API" ], "summary": "This API generates SLS reports", "description": "This API appropriately calculates the cost for the impressions for the ScriptLift Studies Reports based on the impressions and the mark up charged on the organisation and then creates the SLS Reports.", "operationId": "generateSLSReports", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ioId": { "type": "integer", "format": "int32" }, "campaignIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "slsId": { "type": "integer", "format": "int32" }, "slsStartDate": { "type": "integer", "format": "int64" }, "slsEndDate": { "type": "integer", "format": "int64" }, "slsName": { "type": "string" }, "slsLookbackDuration": { "type": "integer", "format": "int32" }, "conceptGroupId": { "type": "string" }, "competitorConceptGroupIds": { "type": "array", "items": { "type": "string" } }, "reportTypes": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "startDate": { "type": "integer", "format": "int64" }, "endDate": { "type": "integer", "format": "int64" }, "id": { "type": "integer", "format": "int32" }, "templateId": { "type": "integer", "format": "int32" }, "idempotencyKey": { "type": "string" }, "triggerTime": { "type": "integer", "format": "int64" }, "category": { "type": "string" } } }, "examples": { "For generation of new report without competitive_analysis report type": { "description": "For generation of new report without competitive_analysis report type", "value": { "ioId": 1234, "campaignIds": [1, 2, 3], "slsStartDate": 1722311000, "slsEndDate": 1722315000, "slsName": "Dummy SLS Name", "slsLookbackDuration": 3, "conceptGroupId": 202335, "reportTypes": [1, 2] } }, "For generation of new report competitive_analysis report type": { "description": "For generation of new report competitive_analysis report type", "value": { "ioId": 1234, "campaignIds": [1, 2, 3], "slsStartDate": 1722311000, "slsEndDate": 1722315000, "slsName": "Dummy SLS Name", "slsLookbackDuration": 3, "conceptGroupId": 202335, "reportTypes": [1, 2, 3], "competitorConceptGroupIds": [800214, 800215, 800216] } }, "For regeneration of failed SLS reports": { "description": "For regeneration of failed SLS reports", "value": { "slsId": 1 } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Successful SLS Report computation": { "description": "Successful SLS Report computation", "value": { "success": true, "data": { "slsReportCreated": true, "campaignIds": [1, 2, 3], "slsStartDate": 1722311000, "slsEndDate": 1722315000, "slsChargeableImps": 1000, "slsChargedImps": 100, "slsChargeableCost": 1000, "slsChargedCost": 100, "slsName": "Dummy SLS Name", "slsLookbackDuration": 3, "conceptGroupId": 202335, "reportTypes": [1, 2, 3], "competitorConceptGroupIds": [800214, 800215, 800216], "fundsAvailable": true } } }, "Same SLS report exists": { "description": "Same SLS report exists", "value": { "success": true, "data": { "slsReportCreated": false, "slsId": 1, "slsName": "SLS report 1", "slsStatusId": 1, "slsCreatedOn": 1722315234, "campaignId": [1, 2], "ioId": 1, "ioName": "Insertion Order Name", "ioTypeId": 1, "slsLookbackDuration": 3, "conceptGroupId": 202335, "reportTypes": [1, 2, 3], "competitorConceptGroupIds": [800214, 800215, 800216] } } }, "Another SLS report with same campaign with overlapping date range is in processing": { "description": "Another SLS report with same campaign with overlapping date range is in processing", "value": { "success": true, "data": { "slsReportCreated": false, "message": "SLS Insights can't be generated for this campaigns at the moment as another insight with overlapping date range is processing" } } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } }, "delete": { "tags": [ "Insights API" ], "summary": "Delete Failed SLS Reports", "description": "This API deletes SLS reports that are not marked as deleted and have a 'failed' status. It requires the user to be authorized and checks if the provided SLS IDs are valid.\n---\n#### Request Body Detail\n\n| **Field** | **Type** | **Description** |\n| --- | --- | --- |\n| slsIds | Array | List of slsIds to be deleted |\n", "operationId": "deleteFailedSLSReport", "parameters": [ { "name": "slsIds", "in": "query", "description": "Comma-separated list of SLS IDs to delete.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "Success response", "content": { "application/json": { "examples": { "Bulk SLS reports successfully deleted.": { "description": "Bulk SLS reports successfully deleted.", "value": { "success": true, "data": { "message": "2 SLS insights deleted successfully" } } }, "Individual SLS report successfully deleted.": { "description": "Individual SLS report successfully deleted.", "value": { "success": true, "data": { "message": "255944_SLS_Insights_2 deleted successfully" } } } } } } }, "422": { "description": "Error response", "content": { "application/json": { "examples": { "Invalid SLS IDs provided": { "description": "Invalid SLS IDs provided", "value": { "success": false, "errorObjects": [ { "error": "Some of the provided SLS ID(s) are either already deleted, do not exist, or do not have a 'failed' status." } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/ins/sls-reports/download": { "post": { "tags": [ "Insights API" ], "summary": "Download SLS (Audience Quality Score) Report", "description": "Downloads the Audience Quality Score (SLS) report.\nOnly reports with a 'ready' status are eligible for download.\nThe API validates the report status, file type, and user permissions before generating a pre-signed download URL.\n", "operationId": "getSLSReportDownloadUrl", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fileTypeId": { "type": "integer", "format": "int32" }, "reportId": { "type": "integer", "format": "int32" } } }, "examples": { "Download XLSX file": { "description": "Download XLSX file", "value": { "fileTypeId": 1, "reportId": 50 } }, "Download CSV file": { "description": "Download CSV file", "value": { "fileTypeId": 2, "reportId": 50 } } } } }, "required": true }, "responses": { "200": { "description": "Successfully generated download URL for the SLS report", "content": { "application/json": { "examples": { "Successful response": { "description": "Successful response", "value": { "success": true, "data": { "reportUrl": "https://xyz.abc.com/reports/abcd/2024-12-03/50_acbd_Report.xlsx?X-Amz-Algorithm=AWS4-HMAC" } } } } } } }, "400": { "description": "Invalid request - unsupported file type", "content": { "application/json": { "examples": { "Invalid file type": { "description": "Invalid file type", "value": { "success": false, "errorObjects": [ { "error": "Unsupported file type provided. Please use fileType 1 for XLSX or 2 for CSV." } ] } } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Invalid sortBy value." } ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/ins/sls-reports/computation": { "post": { "tags": [ "Insights API" ], "summary": "This API computes the cost and impressions for creation of SLS reports", "description": "This API appropriately calculates the cost for the impressions for the Script Lift Studies based on the impressions and the mark up charged on the organisation.", "operationId": "getChargeableImpressionsDataForSLSReports", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ioId": { "type": "integer", "format": "int32" }, "campaignIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "slsId": { "type": "integer", "format": "int32" }, "slsStartDate": { "type": "integer", "format": "int64" }, "slsEndDate": { "type": "integer", "format": "int64" }, "slsName": { "type": "string" }, "slsLookbackDuration": { "type": "integer", "format": "int32" }, "conceptGroupId": { "type": "string" }, "competitorConceptGroupIds": { "type": "array", "items": { "type": "string" } }, "reportTypes": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "startDate": { "type": "integer", "format": "int64" }, "endDate": { "type": "integer", "format": "int64" }, "id": { "type": "integer", "format": "int32" }, "templateId": { "type": "integer", "format": "int32" }, "idempotencyKey": { "type": "string" }, "triggerTime": { "type": "integer", "format": "int64" }, "category": { "type": "string" } } }, "examples": { "For generation of new report without competitive_analysis report type": { "description": "For generation of new report without competitive_analysis report type", "value": { "ioId": 1234, "campaignIds": [1, 2, 3], "slsStartDate": 1722311000, "slsEndDate": 1722315000, "slsName": "Dummy SLS Name", "slsLookbackDuration": 3, "conceptGroupId": 202335, "reportTypes": [1, 2] } }, "For generation of new report competitive_analysis report type": { "description": "For generation of new report competitive_analysis report type", "value": { "ioId": 1234, "campaignIds": [1, 2, 3], "slsStartDate": 1722311000, "slsEndDate": 1722315000, "slsName": "Dummy SLS Name", "slsLookbackDuration": 3, "conceptGroupId": 202335, "reportTypes": [1, 2, 3], "competitorConceptGroupIds": [800214, 800215, 800216] } }, "For regeneration of failed SLS reports": { "description": "For regeneration of failed SLS reports", "value": { "slsId": 1 } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Successful SLS Report computation": { "description": "Successful SLS Report computation", "value": { "success": true, "data": { "slsReportCreated": true, "campaignIds": [1, 2, 3], "slsStartDate": 1722311000, "slsEndDate": 1722315000, "slsChargeableImps": 1000, "slsChargedImps": 100, "slsChargeableCost": 1000, "slsChargedCost": 100, "slsName": "Dummy SLS Name", "slsLookbackDuration": 3, "conceptGroupId": 202335, "reportTypes": [1, 2, 3], "competitorConceptGroupIds": [800214, 800215, 800216], "fundsAvailable": true } } }, "Same SLS report exists": { "description": "Same SLS report exists", "value": { "success": true, "data": { "slsReportCreated": false, "slsId": 1, "slsName": "SLS report 1", "slsStatusId": 1, "slsCreatedOn": 1722315234, "campaignId": [1, 2], "ioId": 1, "ioName": "Insertion Order Name", "ioTypeId": 1, "slsLookbackDuration": 3, "conceptGroupId": 202335, "reportTypes": [1, 2, 3], "competitorConceptGroupIds": [800214, 800215, 800216] } } }, "Another SLS report with same campaign with overlapping date range is in processing": { "description": "Another SLS report with same campaign with overlapping date range is in processing", "value": { "success": true, "data": { "slsReportCreated": false, "message": "SLS Insights can't be generated for this campaigns at the moment as another insight with overlapping date range is processing" } } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/ins/send-email": { "post": { "tags": [ "Insights API" ], "summary": "This API send insights email.", "description": "This API send insights email. This email contains attachment for insights reports. This Consumes data in multipart/form-data format.", "operationId": "sendInsightsEmail", "parameters": [ { "name": "id", "in": "query", "description": "Insights identity number(Option if audienceId is provided)", "required": false, "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "audienceId", "in": "query", "description": "Audience identity number(Option if id(insight Id) is provided)", "required": false, "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "attachmentType", "in": "query", "description": "The form of insights report attachment to include in the email. Supported values are `xlsx` and `pdf`.", "required": true, "schema": { "type": "string" } }, { "name": "recipientEmails", "in": "query", "description": "The comma-separated string of recipient emails to send the Insights report emails.Up to 15 emails can be specified at a time.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Email sent successful": { "description": "Email sent successful", "value": { "success": true, "data": "Insights-1 pdf email sent successfully." } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden !" } ] } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "examples": { "Invalid insights id": { "description": "Invalid insights id", "value": { "success": false, "errorObjects": [ { "error": "Please provide valid insights id value." } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/ins/report/download": { "post": { "tags": [ "Insights API" ], "summary": "Downloads the Insights Report", "description": "Downloads the Insights report for the ID provided.\nOnly reports with a 'ready' status are eligible for download.\nThe API validates the report status, file type, and user permissions before generating a pre-signed download URL.\n", "operationId": "getReportDownloadUrl", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fileTypeId": { "type": "integer", "format": "int32" }, "reportId": { "type": "integer", "format": "int32" } } }, "examples": { "Download XLSX file": { "description": "Download XLSX file", "value": { "fileTypeId": 1, "reportId": 50 } }, "Download CSV file": { "description": "Download CSV file", "value": { "fileTypeId": 2, "reportId": 50 } }, "Download PDF file": { "description": "Download PDF file", "value": { "fileTypeId": 3, "reportId": 50 } }, "Download ZIP file": { "description": "Download ZIP file", "value": { "fileTypeId": 4, "reportId": 50 } } } } }, "required": true }, "responses": { "200": { "description": "Successfully generated download URL for the insights report", "content": { "application/json": { "examples": { "Successful response": { "description": "Successful response", "value": { "success": true, "data": { "reportUrl": "https://xyz.abc.com/reports/abcd/2024-12-03/50_acbd_Report.xlsx?X-Amz-Algorithm=AWS4-HMAC" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden !" } ] } } } }, "422": { "description": "Report is not in ready state or invalid report ID", "content": { "application/json": { "examples": { "Null report ID provided": { "description": "Null report ID provided", "value": { "success": false, "data": { "message": "Report IDs cannot be empty" } } }, "Invalid file type": { "description": "Invalid file type", "value": { "success": false, "errorObjects": [ { "error": "Unsupported file type provided" } ] } }, "Report not ready": { "description": "Report not ready", "value": { "success": false, "errorObjects": [ { "error": "The provided ICT report ID: 50 is not in the ready state." } ] } }, "Report not found": { "description": "Report not found", "value": { "success": false, "errorObjects": [ { "error": "Please provide valid insights id value." } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/ins/regenerate/report/{reportId}": { "post": { "tags": [ "Insights API" ], "summary": "Regenerates a schedulable insights report by its ID", "description": "This API allows the regeneration of an insights report for a given report ID.\nIt validates the user session, retrieves the necessary details, and triggers the regeneration process.\nIt pushes the message to SQS queue for regeneration and can be used only for reports which can be scheduled.\n", "operationId": "regenerateReports", "parameters": [ { "name": "reportId", "in": "path", "description": "The ID of the report to regenerate.", "required": true, "schema": { "type": "integer" } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "Successfully regenerated the report.", "content": { "application/json": { "schema": { "type": "object", "properties": { "reportId": { "type": "integer", "format": "int32" }, "reportName": { "type": "string" }, "templateId": { "type": "integer", "format": "int32" }, "nextRunDate": { "type": "integer", "format": "int64" } } }, "examples": { "Successful regeneration response": { "description": "Successful regeneration response", "value": { "success": true, "data": { "reportId": 12, "templateId": 123, "nextRunDate": 1765774800000, "reportName": "sample report" } } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "examples": { "Report is already deleted or is in READY/PROCESSING state": { "description": "Report is already deleted or is in READY/PROCESSING state", "value": { "success": false, "data": { "message": "ICT Report ID : 12 is already deleted or is in READY/PROCESSING state." } } }, "Report is not in FAILED state": { "description": "Report is not in FAILED state", "value": { "success": false, "data": { "message": "Report with id 12 is not in a valid failed state, hence cannot be regenerated." } } }, "Template not found for report": { "description": "Template not found for report", "value": { "success": false, "data": { "message": "Template id not found for report id : 12" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden !" } ] } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "examples": { "Invalid report ID provided": { "description": "Invalid report ID provided", "value": { "success": false, "data": { "message": "Please provide valid insights id value." } } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/ins/regenerate/pld-report/{pldId}": { "post": { "tags": [ "Insights API" ], "summary": "Regenerates a PLD report by its ID", "description": "This API allows the regeneration of a Practitioner Level Data (PLD) report for a given PLD ID. It validates the user session, retrieves the necessary details, and triggers the regeneration process.", "operationId": "regeneratePLDReports", "parameters": [ { "name": "pldId", "in": "path", "description": "The ID of the PLD report to regenerate.", "required": true, "schema": { "type": "integer" } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "Successfully regenerated the PLD report.", "content": { "application/json": { "schema": { "type": "object", "properties": { "reportId": { "type": "integer", "format": "int32" }, "reportName": { "type": "string" }, "templateId": { "type": "integer", "format": "int32" }, "nextRunDate": { "type": "integer", "format": "int64" } } }, "examples": { "Successful regeneration response": { "description": "Successful regeneration response", "value": "{ \"success\": true, \"data\": { \"reportId\": 12, \"templateId\": 123, \"nextRunDate\": 1765774800000 \"reportName\": \"sample report\" } }" } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } }, "deprecated": true } }, "/api/v3/ins/pld-reports/columns": { "get": { "tags": [ "Insights API" ], "summary": "This API fetches the user-selected columns for PLD reports", "description": "This API gets the selection of columns to be shown for PLD reports if customised else provides default selection.", "operationId": "fetchPLDReportSelectedColumns", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Successful response body": { "description": "Successful response body", "value": { "success": true, "data": { "id": true, "insightsName": true, "campaignName": true, "campaignId": true, "status": true, "dateRange": true, "createdOn": true, "ioName": true, "ioId": false } } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } }, "post": { "tags": [ "Insights API" ], "summary": "This API saves or updates the user-selected columns for PLD reports", "description": "This API saves or updates the selection of columns to be shown for PLD reports provided as json.", "operationId": "saveOrUpdatePLDReportSelectedColumns", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "content": { "application/json": { "schema": { "type": "string" }, "examples": { "Save the columns": { "description": "Save the columns", "value": { "id": true, "insightsName": true, "campaignName": true, "campaignId": true, "status": true, "dateRange": true, "createdOn": true, "ioName": true, "ioId": false } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Successful response body": { "description": "Successful response body", "value": { "success": true, "data": { "id": true, "insightsName": true, "campaignName": true, "campaignId": true, "status": true, "dateRange": true, "createdOn": true, "ioName": true, "ioId": false } } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/ins/pld-report": { "post": { "tags": [ "Insights API" ], "summary": "This API generates PLD reports", "description": "This API appropriately calculates the cost for the impressions for the Practitioner Level Data Reports based on the impressions and the mark up charged on the organisation and then creates the PLD Reports.", "operationId": "generatePLDReports", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ioId": { "type": "integer", "format": "int32" }, "campaignIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "pldId": { "type": "integer", "format": "int32" }, "pldStartDate": { "type": "integer", "format": "int64" }, "pldEndDate": { "type": "integer", "format": "int64" }, "templateId": { "type": "integer", "format": "int32" }, "triggerTime": { "type": "integer", "format": "int64" }, "idempotencyKey": { "type": "string" }, "startDate": { "type": "integer", "format": "int64" }, "endDate": { "type": "integer", "format": "int64" }, "id": { "type": "integer", "format": "int32" }, "category": { "type": "string" } } }, "examples": { "For new Campaign and date range": { "description": "For new Campaign and date range", "value": { "campaignId": 1, "pldStartDate": 1722311000, "pldEndDate": 1722315000 } }, "For Generate Again": { "description": "For Generate Again", "value": { "pldId": 1 } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Successful PLD Report": { "description": "Successful PLD Report", "value": { "success": true, "data": { "pldReportCreated": true, "campaignId": 1, "campaignName": "Campaign Name", "campaignStatus": "running", "pldStartDate": 1722311000, "pldEndDate": 1722315000, "pldChargeableImps": 1000, "pldChargedImps": 100, "pldChargeableCost": 1000, "pldChargedCost": 100, "fundsAvailable": true } } }, "Same PLD report exists": { "description": "Same PLD report exists", "value": { "success": true, "data": { "pldReportCreated": false, "pldId": 1, "pldName": "1_VLD_INSIGHTS_1", "pldStatusId": 1, "pldCreatedOn": 1722315234, "campaignId": 1, "campaignName": "Campaign Name", "creativeTypeId": 1, "ioId": 1, "ioName": "Insertion Order Name", "ioTypeId": 1 } } }, "PLD report exists same campaign with overlapping date range is in processing": { "description": "PLD report exists same campaign with overlapping date range is in processing", "value": { "success": true, "data": { "pldReportCreated": false, "message": "PLD Insights can't be generated for this campaign at the moment as another insight with overlapping date range is processing" } } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/ins/pld-report/download": { "post": { "tags": [ "Insights API" ], "summary": "Download PLD (Audience Quality Score) Report", "description": "Downloads the Audience Quality Score (PLD) report.\nOnly reports with a 'ready' status are eligible for download.\nThe API validates the report status, file type, and user permissions before generating a pre-signed download URL.\n", "operationId": "getPLDReportDownloadUrl", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fileTypeId": { "type": "integer", "format": "int32" }, "reportId": { "type": "integer", "format": "int32" } } }, "examples": { "Download XLSX file": { "description": "Download XLSX file", "value": { "fileTypeId": 1, "reportId": 50 } }, "Download CSV file": { "description": "Download CSV file", "value": { "fileTypeId": 2, "reportId": 50 } } } } }, "required": true }, "responses": { "200": { "description": "Successfully generated download URL for the PLD report", "content": { "application/json": { "examples": { "Successful response": { "description": "Successful response", "value": { "success": true, "data": { "reportUrl": "https://xyz.abc.com/reports/abcd/2024-12-03/50_acbd_Report.xlsx?X-Amz-Algorithm=AWS4-HMAC" } } } } } } }, "400": { "description": "Invalid request - unsupported file type", "content": { "application/json": { "examples": { "Invalid file type": { "description": "Invalid file type", "value": { "success": false, "errorObjects": [ { "error": "Unsupported file type provided. Please use fileType 1 for XLSX or 2 for CSV." } ] } } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Invalid sortBy value." } ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } }, "deprecated": true } }, "/api/v3/ins/insights/regenerate/{insightsId}": { "post": { "tags": [ "Insights API" ], "summary": "This API regenerates the insights report for the given insightId, if the insights is failed.", "description": "This API regenerates the insights report for the given insightId, if the insights is failed.", "operationId": "regenerateInsights", "parameters": [ { "name": "insightsId", "in": "path", "description": "Insights identity number", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Regeneration success response": { "description": "Regeneration success response", "value": { "success": true, "data": "Insights regenerated successfully." } }, "Regeneration failed response": { "description": "Regeneration failed response", "value": { "success": true, "data": "Insights regeneration failed." } }, "422_UnProcessable_Entity": { "description": "422_UnProcessable_Entity", "value": { "success": false, "errorObjects": [ { "error": "error message." } ] } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden !" } ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/ins/insights/download": { "post": { "tags": [ "Insights API" ], "summary": "This API downloads insights report for audience(pdf or xlsx).", "description": "This API downloads insights report for audience(pdf or xlsx).This Consumes data in multipart/form-data format.", "operationId": "downloadInsights", "parameters": [ { "name": "insightsId", "in": "query", "description": "Insights identity number", "required": true, "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "audienceId", "in": "query", "description": "Insights audience Id(source Id) number", "required": true, "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "fileType", "in": "query", "description": "The form of insights report. Supported values are `xlsx` and `pdf`.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "customLogoFile": { "type": "string", "format": "binary" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden !" } ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/ins/insights/computation": { "post": { "tags": [ "Insights API" ], "summary": "This API computes insights reports for the provided campaigns", "description": "This API triggers computation of insights reports based on the provided request parameters including report type, campaign IDs, and date windows.\nThe computation process is asynchronous and returns a computation response with status and details.\n\n---\n\n#### Request Body Detail\n\n| **Field** | **Type** | **Description** |\n| --- | --- | --- |\n| reportType | String | **Type of report** to compute (e.g., PLD, NLD, ICT). Currently, VLD, SLS and AQS are not supported |\n| campaignIds | List\u003CInteger\u003E | List of **campaign IDs** for which to compute insights reports. |\n| startDate | Long | **Start date** timestamp for the report date window (epoch milliseconds). |\n| endDate | Long | **End date** timestamp for the report date window (epoch milliseconds). |\n| additionalParams | Map\u003CString, Object\u003E | **Optional parameters** specific to the report type. |\n", "operationId": "computeInsightsReports", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "description": "Request body for computing insights reports.", "content": { "application/json": { "schema": { "type": "object", "properties": { "ioId": { "type": "integer", "format": "int32" }, "campaignIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "reportId": { "type": "integer", "format": "int32" }, "startDate": { "type": "integer", "format": "int64" }, "endDate": { "type": "integer", "format": "int64" }, "templateId": { "type": "integer", "format": "int32" }, "triggerTime": { "type": "integer", "format": "int64" }, "idempotencyKey": { "type": "string" }, "category": { "type": "string" }, "id": { "type": "integer", "format": "int32" } } }, "examples": { "Computation request": { "description": "Computation request", "value": { "category": "pld", "campaignIds": [451351, 451352], "startDate": 1640995200000, "endDate": 1643673599000 } } } } }, "required": true }, "responses": { "200": { "description": "Computation request processed successfully", "content": { "application/json": { "examples": { "Successful computation response": { "description": "Successful computation response", "value": { "success": true, "data": { "id": 0, "ioId": 101, "ioName": "Test IO", "startDate": 1742898000000, "endDate": 1774238399000, "campaignIds": [11011], "reportCreatable": true, "chargeableImps": 100, "chargedImps": 25, "chargeableCost": 345.23, "chargedCost": 45.21, "fundsAvailable": true, "effectiveRate": 3.45, "templateId": 111 } } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "examples": { "Invalid request parameters": { "description": "Invalid request parameters", "value": { "success": false, "errorObjects": [ { "error": "Invalid report type provided" } ] } }, "Invalid campaign IDs": { "description": "Invalid campaign IDs", "value": { "success": false, "errorObjects": [ { "error": "One or more campaign IDs are invalid or not accessible" } ] } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden !" } ] } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "examples": { "Validation error": { "description": "Validation error", "value": { "success": false, "errorObjects": [ { "error": "Date range is invalid or exceeds maximum allowed period" } ] } }, "Invalid report ID provided for regeneration of reports": { "description": "Invalid report ID provided for regeneration of reports", "value": { "success": false, "errorObjects": [ { "error": "Please provide valid insights id value." } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/ins/insights/add": { "post": { "tags": [ "Insights API" ], "summary": "This API creates insights for the given audience id(s)", "description": "This API creates insights for the given audience id(s).\n\n---\n\n#### Request Body Detail\n\n| **Field** | **Type** | **Description** |\n| --- | --- | --- |\n| insightsTypeId | int | **Type Id** for insights.|\n| sourceIds | List\u003CInteger\u003E | List of **Ids** of sources for which insights be generated (Audience ids for audience insights) .|\n", "operationId": "createInsightsDetails", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "insightsTypeId": { "type": "integer", "format": "int32" }, "sourceIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "owId": { "type": "integer", "format": "int32" }, "uowId": { "type": "integer", "format": "int32" } } }, "example": { "insightsTypeId": 1, "sourceIds": [567895, 925436, 123677] } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "UnprocessableEntity422 error message": { "description": "UnprocessableEntity422 error message", "value": { "success": false, "errorObjects": [ { "error": "Insights type is not valid" } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/ins/aqs-reports": { "get": { "tags": [ "Insights API" ], "summary": "Fetch a paginated list of AQS reports with detailed information", "description": "This API retrieves a list of Audience Quality Score (AQS) reports based on the provided filters, pagination, and sorting options. The response includes detailed information about each report, such as report name, campaign details, status, and file size details.", "operationId": "getReportDetailList", "parameters": [ { "name": "searchField", "in": "query", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "pageNo", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "noOfEntries", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "default": 200 } }, { "name": "sortBy", "in": "query", "required": false, "schema": { "type": "string", "default": "reportId" } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "success": true, "data": { "totalRecords": 10, "reportDataList": [ { "reportId": 10, "reportName": "530667_AQS_Insights_7", "campaignName": "prod-campaign-21145", "campaignId": 21145, "statusId": 3, "statusName": "Completed", "startDate": 1603152000, "endDate": 1603411200, "ioId": 5, "ioName": "Corporate, Inc.", "isCampaignEligible": false, "reportCreatedOn": 1721253632, "creativeTypeId": 11, "ioBudgetType": 1, "campaignTimeZoneId": 29, "fileSizeDetails": { "1": 1024, "2": 1024 } }, { "reportId": 9, "reportName": "530667_AQS_Insights_6", "campaignName": "Campaign-4949", "campaignId": 4949, "statusId": 3, "statusName": "Completed", "startDate": 1603152000, "endDate": 1603411200, "ioId": 15, "ioName": "Quinton for Mayor", "isCampaignEligible": false, "reportCreatedOn": 1720325578, "creativeTypeId": 14, "ioBudgetType": 1, "campaignTimeZoneId": 29, "fileSizeDetails": { "1": 1024, "2": 1024 } } ], "filteredRecords": 10 } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } }, "post": { "tags": [ "Insights API" ], "summary": "This API generates AQS reports", "description": "This API appropriately calculates the cost for the impressions for the ScriptLift Studies Reports based on the impressions and the mark up charged on the organisation and then creates the AQS Reports.", "operationId": "generateAQReports", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "campaignId": { "type": "integer", "format": "int32" }, "aqsId": { "type": "integer", "format": "int32" }, "aqsName": { "type": "string" }, "aqsStartDate": { "type": "integer", "format": "int64" }, "aqsEndDate": { "type": "integer", "format": "int64" }, "aqsReportTypeId": { "type": "integer", "format": "int32" }, "aqsAudienceConceptGroups": { "type": "array", "items": { "type": "object", "properties": { "conceptGroupId": { "type": "integer", "format": "int32" }, "audienceId": { "type": "integer", "format": "int32" } } } } } }, "examples": { "For generation of new report without competitive_analysis report type": { "description": "For generation of new report without competitive_analysis report type", "value": "{\n \"campaignId\": 1,2,3,\n \"aqsStartDate\": 1722311000,\n \"aqsEndDate\": 1722315000,\n \"aqsName\": \"Dummy AQS Name\",\n \"conceptGroupId\": 202335,\n \"aqsReportTypeId\": [1,2],\n \"aqsAudienceConceptGroups\": {\n \"audienceId\": 101,\n \"conceptGroupId\": \"202335\"\n }\n}\n" }, "For regeneration of failed AQS reports": { "description": "For regeneration of failed AQS reports", "value": { "aqsId": 1 } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "aqsReportCreatable": { "type": "boolean" }, "aqsChargeableImps": { "type": "integer", "format": "int64" }, "aqsChargedImps": { "type": "integer", "format": "int64" }, "aqsChargeableCost": { "type": "number", "format": "double" }, "aqsChargedCost": { "type": "number", "format": "double" }, "fundsAvailable": { "type": "boolean" }, "effectiveAqsRate": { "type": "number", "format": "double" }, "message": { "type": "string" }, "timezoneId": { "type": "integer", "format": "int32" }, "aqsId": { "type": "integer", "format": "int32" }, "aqsName": { "type": "string" }, "aqsStatus": { "type": "integer", "format": "int32" }, "ioId": { "type": "integer", "format": "int32" }, "ioName": { "type": "string" }, "ioTypeId": { "type": "integer", "format": "int32" }, "aqsCreatedOn": { "type": "integer", "format": "int64" }, "aqsStartDate": { "type": "integer", "format": "int64" }, "aqsEndDate": { "type": "integer", "format": "int64" }, "campaignId": { "type": "integer", "format": "int32" }, "aqsReportTypeId": { "type": "integer", "format": "int32" }, "creativeTypeId": { "type": "integer", "format": "int32" }, "aqsAudienceConceptGroups": { "type": "array", "items": { "type": "object", "properties": { "conceptGroupId": { "type": "integer", "format": "int32" }, "audienceId": { "type": "integer", "format": "int32" } } } } } }, "examples": { "Successful AQS Report computation": { "description": "Successful AQS Report computation", "value": { "success": true, "data": { "aqsReportCreatable": true, "aqsChargeableImps": 1, "aqsChargedImps": 1, "aqsChargeableCost": 1, "aqsChargedCost": 1, "fundsAvailable": true, "effectiveAqsRate": 1 } } }, "Same AQS report exists": { "description": "Same AQS report exists", "value": { "success": true, "data": { "aqsReportCreated": false, "aqsId": 1, "aqsName": "AQS report 1", "aqsStatusId": 1, "aqsCreatedOn": 1722315234, "campaignId": 1, "ioId": 1, "ioName": "Insertion Order Name", "ioTypeId": 1, "aqsReportTypeId": 1, "aqsAudienceConceptGroups": { "audienceId": 101, "conceptGroupId": "202335" } } } }, "Another AQS report with same campaign with overlapping date range is in processing": { "description": "Another AQS report with same campaign with overlapping date range is in processing", "value": { "success": true, "data": { "aqsReportCreated": false, "message": "AQS Insights can't be generated for this campaigns at the moment as another insight with overlapping date range is processing" } } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } }, "delete": { "tags": [ "Insights API" ], "summary": "Delete Failed AQS Reports", "description": "This API deletes AQS reports that are not marked as deleted and have a 'failed' status. It requires the user to be authorized and checks if the provided AQS IDs are valid.", "operationId": "deleteFailedReports", "parameters": [ { "name": "reportIds", "in": "query", "description": "Comma-separated list of AQS IDs to delete.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "individual AQS report successfully deleted.", "content": { "application/json": { "examples": { "Success response": { "description": "Success response", "value": { "success": true, "data": { "message": "255944_AQS_Insights_2 deleted successfully" } } } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Invalid sortBy value." } ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/ins/aqs-reports/download": { "post": { "tags": [ "Insights API" ], "summary": "Download AQS (Audience Quality Score) Report", "description": "Downloads the Audience Quality Score (AQS) report.\nOnly reports with a 'ready' status are eligible for download.\nThe API validates the report status, file type, and user permissions before generating a pre-signed download URL.\n", "operationId": "getAQSReportDownloadUrl", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fileTypeId": { "type": "integer", "format": "int32" }, "reportId": { "type": "integer", "format": "int32" } } }, "examples": { "Download XLSX file": { "description": "Download XLSX file", "value": { "fileTypeId": 1, "reportId": 50 } }, "Download CSV file": { "description": "Download CSV file", "value": { "fileTypeId": 2, "reportId": 50 } } } } }, "required": true }, "responses": { "200": { "description": "Successfully generated download URL for the AQS report", "content": { "application/json": { "examples": { "Successful response": { "description": "Successful response", "value": { "success": true, "data": { "reportUrl": "https://xyz.abc.com/reports/abcd/2024-12-03/50_acbd_Report.xlsx?X-Amz-Algorithm=AWS4-HMAC" } } } } } } }, "400": { "description": "Invalid request - unsupported file type", "content": { "application/json": { "examples": { "Invalid file type": { "description": "Invalid file type", "value": { "success": false, "errorObjects": [ { "error": "Unsupported file type provided. Please use fileType 1 for XLSX or 2 for CSV." } ] } } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Invalid sortBy value." } ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/ins/aqs-reports/computation": { "post": { "tags": [ "Insights API" ], "summary": "This API computes the cost and impressions for creation of AQS reports", "description": "This API appropriately calculates the cost for the impressions for the Script Lift Studies based on the impressions and the mark up charged on the organisation.", "operationId": "computeReports", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "campaignId": { "type": "integer", "format": "int32" }, "aqsId": { "type": "integer", "format": "int32" }, "aqsName": { "type": "string" }, "aqsStartDate": { "type": "integer", "format": "int64" }, "aqsEndDate": { "type": "integer", "format": "int64" }, "aqsReportTypeId": { "type": "integer", "format": "int32" }, "aqsAudienceConceptGroups": { "type": "array", "items": { "type": "object", "properties": { "conceptGroupId": { "type": "integer", "format": "int32" }, "audienceId": { "type": "integer", "format": "int32" } } } } } }, "examples": { "For generation of new report without competitive_analysis report type": { "description": "For generation of new report without competitive_analysis report type", "value": { "campaignId": 1, "aqsStartDate": 1722311000, "aqsEndDate": 1722315000, "aqsName": "Dummy AQS Name", "aqsReportTypeId": 1, "aqsAudienceConceptGroups": { "audienceId": 101, "conceptGroupId": "202335" } } }, "For generation of new report competitive_analysis report type": { "description": "For generation of new report competitive_analysis report type", "value": { "ioId": 1234, "campaignIds": [1, 2, 3], "aqsStartDate": 1722311000, "aqsEndDate": 1722315000, "aqsName": "Dummy AQS Name", "aqsReportTypeId": 1, "aqsAudienceConceptGroups": { "audienceId": 101, "conceptGroupId": "202335" } } }, "For regeneration of failed AQS reports": { "description": "For regeneration of failed AQS reports", "value": { "aqsId": 1 } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Successful AQS Report computation": { "description": "Successful AQS Report computation", "value": { "success": true, "data": { "aqsReportCreated": true, "campaignId": 1, "aqsStartDate": 1722311000, "aqsEndDate": 1722315000, "aqsChargeableImps": 1000, "aqsChargedImps": 100, "aqsChargeableCost": 1000, "aqsChargedCost": 100, "aqsName": "Dummy AQS Name", "aqsReportTypeId": 1, "aqsAudienceConceptGroups": { "audienceId": 101, "conceptGroupId": "202335" }, "fundsAvailable": true } } }, "Same AQS report exists": { "description": "Same AQS report exists", "value": { "success": true, "data": { "aqsReportCreated": false, "aqsId": 1, "aqsName": "AQS report 1", "aqsStatusId": 1, "aqsCreatedOn": 1722315234, "campaignId": 1, "ioId": 1, "ioName": "Insertion Order Name", "ioTypeId": 1, "aqsReportTypeId": 1, "aqsAudienceConceptGroups": { "audienceId": 101, "conceptGroupId": "202335" } } } }, "Another AQS report with same campaign with overlapping date range is in processing": { "description": "Another AQS report with same campaign with overlapping date range is in processing", "value": { "success": true, "data": { "aqsReportCreated": false, "message": "AQS Insights can't be generated for this campaigns at the moment as another insight with overlapping date range is processing" } } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/internal/ins/vld/update/status/{vldId}": { "patch": { "tags": [ "Insights API" ], "summary": "This API will update status with the reports link", "description": "This API updates the status of the VLD reports and updates the link for the same if the VLD reports is in READY status", "operationId": "updateVLDReports", "parameters": [ { "name": "vldId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "statusId": { "type": "integer", "format": "int32" }, "vldGenerationLink": { "type": "string" }, "pldGenerationLink": { "type": "string" }, "excelFileSize": { "type": "number", "format": "double" }, "csvFileSize": { "type": "number", "format": "double" }, "slsGenerationLink": { "type": "string" }, "pdfFileSize": { "type": "number", "format": "double" }, "idempotencyKey": { "type": "string" }, "ictGenerationLink": { "type": "string" }, "nldGenerationLink": { "type": "string" }, "zipFileSize": { "type": "number", "format": "double" }, "failureReason": { "type": "object", "properties": { "status": { "type": "string" }, "description": { "type": "string" }, "task_id": { "type": "string" } } } } }, "examples": { "UPDATE status to READY status": { "description": "UPDATE status to READY status", "value": { "statusId": 3, "vldGenerationLink": "someFolderName/anotherFolder" } }, "UPDATE status to FAILED status": { "description": "UPDATE status to FAILED status", "value": { "statusId": 1 } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "VLD reports updated successfully": { "description": "VLD reports updated successfully", "value": { "success": true, "data": "VLD reports updated successfully" } } } } } } } } }, "/api/v3/internal/ins/sls/update/status/{slsId}": { "patch": { "tags": [ "Insights API" ], "summary": "This API will update status of SLS report with the reports' link and size", "description": "This API updates the status of the SLS reports and updates the file-size for the same if the SLS reports is in PROCESSING status", "operationId": "updateSLSReports", "parameters": [ { "name": "slsId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "statusId": { "type": "integer", "format": "int32" }, "vldGenerationLink": { "type": "string" }, "pldGenerationLink": { "type": "string" }, "excelFileSize": { "type": "number", "format": "double" }, "csvFileSize": { "type": "number", "format": "double" }, "slsGenerationLink": { "type": "string" }, "pdfFileSize": { "type": "number", "format": "double" }, "idempotencyKey": { "type": "string" }, "ictGenerationLink": { "type": "string" }, "nldGenerationLink": { "type": "string" }, "zipFileSize": { "type": "number", "format": "double" }, "failureReason": { "type": "object", "properties": { "status": { "type": "string" }, "description": { "type": "string" }, "task_id": { "type": "string" } } } } }, "examples": { "UPDATE status to READY": { "description": "UPDATE status to READY", "value": { "statusId": 3, "slsGenerationLink": "someFolderName/anotherFolder", "pdfFileSize": "slsPdfReportSizeInBytes", "excelFileSize": "slsExcelReportSizeInBytes" } }, "UPDATE status to FAILED": { "description": "UPDATE status to FAILED", "value": { "statusId": 1, "failureReason": { "task_id": 123, "status": "FAIL", "description": "Authentication failure" } } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "SLS reports updated successfully": { "description": "SLS reports updated successfully", "value": { "success": true, "data": { "message": "SLS reports updated successfully" } } } } } } } } } }, "/api/v3/internal/ins/pld/update/status/{pldId}": { "patch": { "tags": [ "Insights API" ], "summary": "This API will update status with the reports link", "description": "This API updates the status of the PLD reports and updates the file-size for the same if the PLD reports is in READY status", "operationId": "updatePLDReports", "parameters": [ { "name": "pldId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "statusId": { "type": "integer", "format": "int32" }, "vldGenerationLink": { "type": "string" }, "pldGenerationLink": { "type": "string" }, "excelFileSize": { "type": "number", "format": "double" }, "csvFileSize": { "type": "number", "format": "double" }, "slsGenerationLink": { "type": "string" }, "pdfFileSize": { "type": "number", "format": "double" }, "idempotencyKey": { "type": "string" }, "ictGenerationLink": { "type": "string" }, "nldGenerationLink": { "type": "string" }, "zipFileSize": { "type": "number", "format": "double" }, "failureReason": { "type": "object", "properties": { "status": { "type": "string" }, "description": { "type": "string" }, "task_id": { "type": "string" } } } } }, "examples": { "UPDATE status to READY status": { "description": "UPDATE status to READY status", "value": "{ \"statusId\": 3, \"pldGenerationLink\": \"someFolderName/anotherFolder\" \"excelFileSize\": \"pldExcelReportSizeInBytes\" \"csvFileSize\": \"pldCsvReportSizeInBytes\"}" }, "UPDATE status to FAILED status": { "description": "UPDATE status to FAILED status", "value": { "statusId": 1 } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "PLD reports updated successfully": { "description": "PLD reports updated successfully", "value": { "success": true, "data": "PLD reports updated successfully" } } } } } } } } }, "/api/v3/internal/ins/insights-report/{reportId}/status/{statusId}": { "patch": { "tags": [ "Insights API" ], "summary": "This API will update status with the reports link", "description": "This API updates the status of the insights reports and\nupdates the s3path for the same if the insights reports is in READY status,\nupdates the refund flag if the insights reports is in FAILED status and\nregenerates the insights report if the insights reports is in PROCESSING status\n", "operationId": "updateStatus", "parameters": [ { "name": "reportId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "statusId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "metadata": { "type": "array", "items": { "type": "object", "properties": { "fileTypeId": { "type": "integer", "format": "int32" }, "storagePath": { "type": "string" }, "sizeInBytes": { "type": "integer", "format": "int64" } } } } }, "description": "VO for updating the status of insights report files." }, "examples": { "UPDATE status to READY status": { "description": "UPDATE status to READY status", "value": { "metadata": [ { "fileTypeId": 1, "storagePath": "s3://bucket/path/to/report1.pdf", "sizeInBytes": 204800 }, { "fileTypeId": 2, "storagePath": "s3://bucket/path/to/report2.xlsx", "sizeInBytes": 102400 }, { "fileTypeId": 3, "storagePath": "s3://bucket/path/to/report2.xlsx", "sizeInBytes": 102400 } ] } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Insights reports updated successfully": { "description": "Insights reports updated successfully", "value": { "success": true, "data": { "message": "Insights report status updated successfully!" } } } } } } } } } }, "/api/v3/internal/ins/insights-report/update/status/{reportId}": { "patch": { "tags": [ "Insights API" ], "summary": "This API will update status with the reports link", "description": "This API updates the status of the schedulable reports like PLD, ICT and NLD and updates the file-size for the same if the report is in READY status", "operationId": "updateStatusForSchedulableReports", "parameters": [ { "name": "reportId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "required": [ "idempotencyKey" ], "type": "object", "properties": { "statusId": { "type": "integer", "format": "int32" }, "idempotencyKey": { "type": "string" }, "metadata": { "type": "array", "items": { "type": "object", "properties": { "fileTypeId": { "type": "integer", "format": "int32" }, "storagePath": { "type": "string" }, "sizeInBytes": { "type": "integer", "format": "int64" } } } } } }, "examples": { "UPDATE status to READY status": { "description": "UPDATE status to READY status", "value": { "statusId": 3, "idempotencyKey": "ict_123_456_scheduled", "metadata": [ { "fileTypeId": 1, "storagePath": "s3://bucket/path/to/report1.pdf", "sizeInBytes": 204800 }, { "fileTypeId": 2, "storagePath": "s3://bucket/path/to/report2.xlsx", "sizeInBytes": 102400 }, { "fileTypeId": 3, "storagePath": "s3://bucket/path/to/report2.xlsx", "sizeInBytes": 102400 } ] } }, "UPDATE status to FAILED status": { "description": "UPDATE status to FAILED status", "value": { "statusId": 1, "idempotencyKey": "nld_123_456_scheduled" } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Insights report updated successfully": { "description": "Insights report updated successfully", "value": { "success": true, "data": "Insights report updated successfully for id : 112 with status : READY" } } } } } } } } }, "/api/v3/internal/ins/audience/insights/basic-details": { "get": { "tags": [ "Insights API" ], "summary": "This api used to Fetch the basic insights details for given matched audience ids.", "description": "This API fetches insight status for the valid audience ids.", "operationId": "getInsightBasicDetailsForMatchedAudience", "parameters": [ { "name": "audienceIds", "in": "query", "description": "Comma separated eligible matched audience ids", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Successful retrieval of insight status ": { "description": "Successful retrieval of insight status ", "value": "{ \"success\": true, \"data\": { \"statusId\": 2, \"id: 784}" } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "examples": { "Unprocessable entity": { "description": "Unprocessable entity", "value": { "success": false, "errorObjects": [ { "error": "Please provide valid input." } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/ins/vld/campaigns": { "get": { "tags": [ "Insights API" ], "summary": "This API will provide a list of eligible campaigns for generation of VLD reports", "description": "This API will provide a list of eligible campaign IDs per status so that they could be used for generation of VLD reports", "operationId": "getStatusWiseCampaignsForVLDReports", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "For no eligible campaigns found": { "description": "For no eligible campaigns found", "value": { "success": true, "data": { "running": [], "paused": [], "expired": [] } } }, "For eligible campaigns found": { "description": "For eligible campaigns found", "value": { "success": true, "data": { "running": [ { "campaignId": 451351, "campaignVldTimezoneId": 29 } ], "paused": [ { "campaignId": 451350, "campaignVldTimezoneId": 29 } ], "expired": [ { "campaignId": 470839, "campaignVldTimezoneId": 29 } ] } } } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Invalid sortBy value." } ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/ins/vld-reports": { "get": { "tags": [ "Insights API" ], "summary": "This API provides a list of VLD reports in the Insight app.", "description": "API to get a list of vld report based on the provided searchField, pageSize, pageNo, and sortBy parameters.", "operationId": "getVLDReportList", "parameters": [ { "name": "searchField", "in": "query", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "pageNo", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "noOfEntries", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "default": 200 } }, { "name": "sortBy", "in": "query", "required": false, "schema": { "type": "string", "default": "reportId" } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "success": true, "data": { "totalRecords": 10, "vldReportDataList": [ { "vldId": 10, "vldName": "530667_VLD_Insights_7", "campaignName": "prod-campaign-21145", "campaignId": 21145, "vldStatusId": 3, "startDate": 1603152000, "endDate": 1603411200, "ioId": 5, "ioName": "Corporate, Inc.", "isCampaignEligible": false, "vldCreatedOn": 1721253632, "creativeTypeId": 11, "campaignVldTimezoneId": 29, "ioTypeId": 1 }, { "vldId": 9, "vldName": "530667_VLD_Insights_6", "campaignName": "Campaign-4949", "campaignId": 4949, "vldStatusId": 3, "startDate": 1603152000, "endDate": 1603411200, "ioId": 15, "ioName": "Quinton for Mayor", "isCampaignEligible": false, "vldCreatedOn": 1720325578, "creativeTypeId": 14, "campaignVldTimezoneId": 29, "ioTypeId": 1 } ], "filteredRecords": 10 } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/ins/static/template-status": { "get": { "tags": [ "Insights API" ], "summary": "Get all template statuses", "description": "This API returns all possible template statuses which are active with their IDs, names, display names and display orders.", "operationId": "getTemplateStatuses", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "Successfully fetched template statuses", "content": { "application/json": { "examples": { "Template Statuses Example": { "description": "Template Statuses Example", "value": { "success": true, "data": [ { "id": 1, "name": "active", "displayName": "Active", "order": 1 }, { "id": 2, "name": "inactive", "displayName": "Inactive", "order": 2 } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/ins/static/scheduling/frequencies": { "get": { "tags": [ "Insights API" ], "summary": "Delivery frequency metadata for scheduling templates", "description": "Returns static metadata required for the scheduling, including frequency types, sub-modes and shared reference lists (dayOfWeek, dayOfMonthType).", "operationId": "getFrequencyMetadata", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "Successfully returned frequency metadata", "content": { "application/json": { "examples": { "Delivery Frequency Metadata Example": { "description": "Delivery Frequency Metadata Example", "value": { "success": true, "data": { "frequencyTypes": [ { "id": 1, "name": "oneTime", "displayName": "One-Time", "order": 1, "fields": [], "modes": null }, { "id": 2, "name": "daily", "displayName": "Daily", "order": 2, "fields": [], "modes": null }, { "id": 3, "name": "weekly", "displayName": "Weekly", "order": 3, "fields": [ { "id": 301, "name": "dayOfWeek", "displayName": "Day of Week", "order": 1, "fieldType": "reference", "min": null, "max": null, "allowedValuesRef": "dayOfWeek" } ], "modes": null }, { "id": 4, "name": "monthly", "displayName": "Monthly", "order": 4, "fields": [ { "id": 401, "name": "dayOfMonthType", "displayName": "Day of Month Type", "order": 1, "fieldType": "reference", "min": null, "max": null, "allowedValuesRef": "dayOfMonthType" }, { "id": 402, "name": "dayOfMonth", "displayName": "Day of Month", "order": 2, "fieldType": "number", "min": 2, "max": 28, "allowedValuesRef": null } ], "modes": null }, { "id": 5, "name": "custom", "displayName": "Custom", "order": 5, "fields": null, "modes": [ { "id": 501, "name": "days", "displayName": "Day(s)", "order": 1, "fields": [ { "id": 50101, "name": "intervalValue", "displayName": "Repeats In", "order": 1, "fieldType": "number", "min": 1, "max": 365, "allowedValuesRef": null } ] }, { "id": 502, "name": "weeks", "displayName": "Week(s)", "order": 2, "fields": [ { "id": 50201, "name": "intervalValue", "displayName": "Repeats In", "order": 1, "fieldType": "number", "min": 1, "max": 52, "allowedValuesRef": null }, { "id": 50202, "name": "dayOfWeek", "displayName": "Day of Week", "order": 2, "fieldType": "reference", "min": null, "max": null, "allowedValuesRef": "dayOfWeek" } ] }, { "id": 503, "name": "months", "displayName": "Month(s)", "order": 3, "fields": [ { "id": 50301, "name": "intervalValue", "displayName": "Repeats In", "order": 1, "fieldType": "number", "min": 1, "max": 12, "allowedValuesRef": null }, { "id": 50302, "name": "dayOfMonthType", "displayName": "Day of Month Type", "order": 2, "fieldType": "reference", "min": null, "max": null, "allowedValuesRef": "dayOfMonthType" }, { "id": 50303, "name": "dayOfMonth", "displayName": "Day of Month", "order": 3, "fieldType": "number", "min": 2, "max": 28, "allowedValuesRef": null } ] } ] } ], "references": { "dayOfWeek": [ { "id": 1, "name": "monday", "displayName": "Monday", "order": 1 }, { "id": 2, "name": "tuesday", "displayName": "Tuesday", "order": 2 }, { "id": 3, "name": "wednesday", "displayName": "Wednesday", "order": 3 }, { "id": 4, "name": "thursday", "displayName": "Thursday", "order": 4 }, { "id": 5, "name": "friday", "displayName": "Friday", "order": 5 }, { "id": 6, "name": "saturday", "displayName": "Saturday", "order": 6 }, { "id": 7, "name": "sunday", "displayName": "Sunday", "order": 7 } ], "dayOfMonthType": [ { "id": 1, "name": "firstDay", "displayName": "First Day of Month", "order": 1 }, { "id": 2, "name": "nthDay", "displayName": "Specific Day (2-28)", "order": 2 }, { "id": 3, "name": "lastDay", "displayName": "Last Day of Month", "order": 3 } ] } } } } } } } }, "500": { "description": "Internal server error", "content": { "*/*": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "errorObjects": { "type": "array", "items": { "type": "object", "properties": { "error": { "type": "string" }, "reason": { "type": "string" }, "field": { "type": "string" } } } }, "data": { "type": "object", "properties": { "frequencyTypes": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "displayName": { "type": "string" }, "order": { "type": "integer", "format": "int32" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "displayName": { "type": "string" }, "order": { "type": "integer", "format": "int32" }, "fieldType": { "type": "string" }, "min": { "type": "integer", "format": "int32" }, "max": { "type": "integer", "format": "int32" }, "allowedValuesRef": { "type": "string" } } } }, "modes": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "displayName": { "type": "string" }, "order": { "type": "integer", "format": "int32" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "displayName": { "type": "string" }, "order": { "type": "integer", "format": "int32" }, "fieldType": { "type": "string" }, "min": { "type": "integer", "format": "int32" }, "max": { "type": "integer", "format": "int32" }, "allowedValuesRef": { "type": "string" } } } } } } } } } }, "references": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "displayName": { "type": "string" }, "order": { "type": "integer", "format": "int32" } } } } } } } } } } } } } } }, "/api/v3/ins/static/report-status": { "get": { "tags": [ "Insights API" ], "summary": "Get all report statuses", "description": "This API returns all possible report statuses which are active with their IDs, names, display names and display orders.", "operationId": "getReportStatuses", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "Successfully fetched report statuses", "content": { "application/json": { "examples": { "Report Statuses Example": { "description": "Report Statuses Example", "value": { "success": true, "data": [ { "id": 1, "name": "failed", "displayName": "Failed", "order": 1 }, { "id": 2, "name": "processing", "displayName": "Processing", "order": 2 }, { "id": 3, "name": "ready", "displayName": "Ready", "order": 3 }, { "id": 4, "name": "failed_insufficient_funds", "displayName": "Failed", "order": 4 } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/ins/static/insights/type/list": { "get": { "tags": [ "Insights API" ], "summary": "This API will provide the values of insights type.", "description": "This API will provide the values of insights type.\n\nValues of insights type : `Audiences` ", "operationId": "getInsightsType", "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "success": true, "data": { "totalRecords": 1, "filterRecords": 1, "insightsTypeData": [ { "id": 1, "name": "audienceInsights", "label": "Audience Insights", "order": 1 } ] } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/ins/static/insights/status/list": { "get": { "tags": [ "Insights API" ], "summary": "This API will provide the values of insights status.", "description": "This API will provide the values of insights status.\n\nValues of insights status : `Processing`,`Ready`,`Failed` ", "operationId": "getInsightsStatus", "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "success": true, "data": { "totalRecords": 3, "filterRecords": 3, "insightsStatusData": [ { "id": 1, "name": "processing", "label": "Processing", "order": 1 }, { "id": 2, "name": "ready", "label": "Ready", "order": 2 }, { "id": 3, "name": "failed", "label": "Failed", "order": 3 } ] } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/ins/static/insights/report/properties": { "get": { "tags": [ "Insights API" ], "summary": "This API provide environment wise default properties", "description": "This API provides the default value of certain parameters which will differ based on environment", "operationId": "getPropertiesOfReports", "parameters": [ { "name": "insightsTypeId", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "PLD Report properties for stage": { "description": "PLD Report properties for stage", "value": { "success": true, "data": { "defaultReportEndDateFromCurrentDay": 1, "defaultReportStartDateFromReportEndDate": 30, "defaultSuperRate": 3, "defaultWorkspaceMarkupType": 1, "defaultWorkspaceMarkupValue": 0, "defaultEffectiveRate": 3, "discountSuperRate": 10, "discountWorkspaceMarkupType": 2, "discountWorkspaceMarkupTypeValue": 20, "discountEffectiveRate": 12, "defaultSortBy": "pldId", "maxReportSizeToMail": 100000 } } }, "VLD Report properties for stage": { "description": "VLD Report properties for stage", "value": { "success": true, "data": { "defaultReportEndDateFromCurrentDay": 1, "defaultSuperRate": 3, "defaultWorkspaceMarkupType": 1, "defaultWorkspaceMarkupValue": 0, "defaultEffectiveRate": 3, "defaultSortBy": "vldId" } } }, "SLS Report properties for stage": { "description": "SLS Report properties for stage", "value": { "success": true, "data": { "discountSuperRate": 3, "defaultWorkspaceMarkupType": 1, "defaultSortBy": "-slsId", "defaultReportEndDateFromCurrentDay": 1, "defaultWorkspaceMarkupValue": 0, "maxReportSizeToMail": 100000, "defaultSuperRate": 3, "discountWorkspaceMarkupTypeValue": 0, "discountEffectiveRate": 3, "discountWorkspaceMarkupType": 1, "defaultEffectiveRate": 3 } } }, "AQS Report properties for stage": { "description": "AQS Report properties for stage", "value": { "success": true, "data": { "discountSuperRate": 3, "defaultWorkspaceMarkupType": 1, "defaultSortBy": "-id", "defaultReportEndDateFromCurrentDay": 1, "defaultWorkspaceMarkupValue": 0, "maxReportSizeToMail": 100000, "defaultSuperRate": 3, "discountWorkspaceMarkupTypeValue": 0, "discountEffectiveRate": 3, "discountWorkspaceMarkupType": 1, "defaultEffectiveRate": 3 } } } } } } } } } }, "/api/v3/ins/static/aqs-reports/report-types": { "get": { "tags": [ "Insights API" ], "summary": "This API will fetch available AQS report types", "description": "This API will fetch available AQS report types. Returns a list of report types that can be generated. Only users from Advertiser organizations are authorized to access this API.", "operationId": "getAQSReportTypes", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "AQS report types listing": { "description": "AQS report types listing", "value": { "success": true, "data": { "reportTypeData": [ { "id": 1, "name": "audience", "label": "Audience", "order": 1 }, { "id": 2, "name": "Campaign", "label": "Campaign", "order": 2 } ], "totalRecords": 2, "filteredRecords": 2 } } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/ins/sls-reports/validate/name": { "get": { "tags": [ "Insights API" ], "summary": "This API will validate the report name for generation of SLS reports", "description": "This API will validate the constraints for report name provided while generation of SLS reports\n---\n\n#### Request Body Detail\n\n| **Field** | **Type** | **Description** |\n| --- | --- | --- |\n| reportName | String | **Name** of report.|\n", "operationId": "validateSlsReportName", "parameters": [ { "name": "reportName", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Valid SLS report name": { "description": "Valid SLS report name", "value": { "success": true, "data": { "available": true, "message": "This SLS report name is valid" } } }, "Already used AQS report name": { "description": "Already used AQS report name", "value": { "success": true, "data": { "available": false, "message": "The name 'report_name' is already used by another report, kindly update the name" } } } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "examples": { "Invalid AQS report name": { "description": "Invalid AQS report name", "value": { "success": false, "errorObjects": [ { "error": "Please provide name with at least 3 characters and maximum of 100 characters" } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/ins/sls-reports/campaigns": { "get": { "tags": [ "Insights API" ], "summary": "This API will provide a status-wise list of eligible campaigns for generation of SLS reports", "description": "This API will provide a status-wise list of eligible campaignIDs so that they could be used for generation of SLS reports", "operationId": "getStatusWiseCampaignsForSLSReports", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "For no eligible campaigns found": { "description": "For no eligible campaigns found", "value": "{\n \"success\": true,\n \"data\": {\" +\n \"running\": [],\n \"paused\": [],\n \"expired\": []\n }\n}\n" }, "For eligible campaigns found": { "description": "For eligible campaigns found", "value": { "success": true, "data": { "running": [ { "campaignId": 516038, "campaignSlsTimezoneId": 29 } ], "paused": [ { "campaignId": 523630, "campaignSlsTimezoneId": 29 } ], "expired": [ { "campaignId": 500291, "campaignSlsTimezoneId": 29 } ] } } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/ins/pld-reports": { "get": { "tags": [ "Insights API" ], "summary": "This API provides a list of PLD reports in the Insight app.", "description": "API to get a list of pld report based on the provided searchField, pageSize, pageNo, and sortBy parameters.", "operationId": "getPLDReportList", "parameters": [ { "name": "searchField", "in": "query", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "pageNo", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "noOfEntries", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "default": 200 } }, { "name": "sortBy", "in": "query", "required": false, "schema": { "type": "string", "default": "reportId" } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "success": true, "data": { "totalRecords": 10, "pldReportDataList": [ { "pldId": 10, "pldName": "530667_PLD_Insights_7", "campaignName": "prod-campaign-21145", "campaignId": 21145, "pldStatusId": 3, "startDate": 1732165200000, "endDate": 1732424399000, "ioId": 5, "ioName": "Corporate, Inc.", "isCampaignEligible": false, "pldCreatedOn": 1721253632, "creativeTypeId": 11, "campaignPldTimezoneId": 29, "ioTypeId": 1 }, { "pldId": 9, "pldName": "530667_PLD_Insights_6", "campaignName": "Campaign-4949", "campaignId": 4949, "pldStatusId": 3, "startDate": 1732165200000, "endDate": 1732424399000, "ioId": 15, "ioName": "Quinton for Mayor", "isCampaignEligible": false, "pldCreatedOn": 1720325578, "creativeTypeId": 14, "campaignPldTimezoneId": 29, "ioTypeId": 1 } ], "filteredRecords": 10 } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } }, "delete": { "tags": [ "Insights API" ], "summary": "Delete Failed PLD Reports", "description": "This API deletes PLD reports that are not marked as deleted and have a 'failed' status. It requires the user to be authorized and checks if the provided PLD IDs are valid.", "operationId": "deleteFailedPLDReport", "parameters": [ { "name": "pldIds", "in": "query", "description": "Comma-separated list of PLD IDs to delete.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "individual PLD report successfully deleted.", "content": { "application/json": { "examples": { "Success response": { "description": "Success response", "value": { "success": true, "data": { "message": "255944_PLD_Insights_2 deleted successfully" } } } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Invalid sortBy value." } ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } }, "deprecated": true } }, "/api/v3/ins/pld-reports/interval": { "get": { "tags": [ "Insights API" ], "summary": "Retrieves the reporting interval for a given template ID and trigger time.(Used for internal purpose only)", "description": "This API fetches the reporting interval details for a specific template ID and trigger time in epoch format.", "operationId": "getReportInterval", "parameters": [ { "name": "templateId", "in": "query", "description": "The ID of the template for which the reporting interval is to be fetched.", "required": true, "schema": { "type": "integer" } }, { "name": "triggerTimeEpoch", "in": "query", "description": "The epoch time (in milliseconds) representing the trigger time.", "required": true, "schema": { "type": "long" } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "Successfully retrieved the reporting interval.", "content": { "application/json": { "schema": { "type": "object", "properties": { "startDateEpoch": { "type": "integer", "format": "int64" }, "endDateEpoch": { "type": "integer", "format": "int64" }, "nextRunDateEpoch": { "type": "integer", "format": "int64" } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/ins/pld-reports/campaigns": { "get": { "tags": [ "Insights API" ], "summary": "This API will provide a status-wise list of eligible campaigns for generation of PLD reports", "description": "This API will provide a status-wise list of eligible campaignIDs so that they could be used for generation of PLD reports", "operationId": "getStatusWiseCampaignsForPLDReports", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "For no eligible campaigns found": { "description": "For no eligible campaigns found", "value": { "success": true, "data": { "running": [], "paused": [], "expired": [] } } }, "For eligible campaigns found": { "description": "For eligible campaigns found", "value": { "success": true, "data": { "running": [ { "campaignId": 451351, "campaignPldTimezoneId": 29 } ], "paused": [ { "campaignId": 451350, "campaignPldTimezoneId": 29 } ], "expired": [ { "campaignId": 470839, "campaignPldTimezoneId": 29 } ] } } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } }, "deprecated": true } }, "/api/v3/ins/insights/type-wise-count": { "get": { "tags": [ "Insights API" ], "summary": "It will provide count of insights available in database.", "description": "This API will provide insights count.It gives the data in form of key value pair where `key` represents `type_id` which is the type of insights and `value` represents the count of insights against the type_id. type_id should be as referenced in [get-insights-type](?path=/Insights%20API/getInsightsType) |\n", "operationId": "getInsightsTypeWiseCount", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "success": true, "data": { "1": 32, "3": 20 } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/ins/insights/list": { "get": { "tags": [ "Insights API" ], "summary": "It will provide list of insights available in database.", "description": "This API will provide insights details list based on requested search and pagination data. ", "operationId": "getInsightsDetailList", "parameters": [ { "name": "searchField", "in": "query", "description": "Search the result by provided keyword in the searchField. Search insights by insights name and id.", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "pageSize", "in": "query", "description": "The maximum number of returned results per page. ", "required": false, "schema": { "type": "integer", "format": "int32", "default": 20 } }, { "name": "pageNo", "in": "query", "description": "Page number for the required data. ", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "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, sourceId, createdAt", "required": false, "schema": { "type": "string", "default": "-id" } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "success": true, "data": { "totalRecords": 1, "filterRecords": 1, "insightsData": [ { "id": 123, "typeId": 1, "statusId": 2, "name": "demo_insights", "sourceId": 123, "createdAt": 1687848574780 } ] } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Invalid sortBy value." } ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/ins/insights/eligible-campaigns": { "get": { "tags": [ "Insights API" ], "summary": "This API will provide a status-wise list of eligible campaigns for generation of insights reports", "description": "This API will provide a status-wise list of eligible campaignIDs so that they could be used for generation of insights reports", "operationId": "getStatusWiseCampaignsForInsightsReports", "parameters": [ { "name": "reportType", "in": "query", "description": "Type of the report", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "For no eligible campaigns found": { "description": "For no eligible campaigns found", "value": { "success": true, "data": { "running": [], "paused": [], "expired": [] } } }, "For eligible campaigns found": { "description": "For eligible campaigns found", "value": { "success": true, "data": { "running": [ { "campaignId": 451351, "campaignTimezoneId": 29 } ], "paused": [ { "campaignId": 451350, "campaignTimezoneId": 29 } ], "expired": [ { "campaignId": 470839, "campaignTimezoneId": 29 } ] } } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "examples": { "Invalid report type provided": { "description": "Invalid report type provided", "value": { "success": false, "errorObjects": [ { "error": "Invalid report type provided : vlds" } ] } }, "Report is disabled for organisation": { "description": "Report is disabled for organisation", "value": { "success": false, "errorObjects": [ { "error": "Organization is restricted to access the ICT reports" } ] } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "examples": { "For unauthorized access": { "description": "For unauthorized access", "value": { "success": false, "errorObjects": [ { "error": "User is not authorized to access this API." } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/ins/campaign/bid-insights/{campaignId}": { "get": { "tags": [ "Insights API" ], "summary": "Get the Campaign bidding insights data for given campaign id", "description": "This API fetches the data required for bidding insights of campaign with the given campaign id.Given the date range in input it will fetch the rejection reasons along with the rejected bids per reason.It will also fetch total wins during the date range.Date range cannot be more than 2 weeks for this API.Date range should be given in epoch (millisecond format).", "operationId": "getCampaignBiddingInsight", "parameters": [ { "name": "dateRangeStart", "in": "query", "description": "Start of the date range in millisecond", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "dateRangeEnd", "in": "query", "description": "End of the date range in millisecond", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "campaignId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "success": true, "data": { "totalRequests": 100, "rejectionList": { "campaignSettings": { "title": "Campaign Settings", "rejectedBids": 0, "description": "Campaign is filtered due to Campaign Settings set in the campaign.", "subReasonInfo": { } }, "ioBudget": { "title": "IO Budget", "rejectedBids": 0, "description": null, "subReasonInfo": { } }, "inventoryTargeting": { "title": "Inventory Targeting", "rejectedBids": 0, "description": "Campaign is filtered due to Inventory Targeting.", "subReasonInfo": { } }, "campaignBidPrice": { "title": "Campaign Bid Price", "rejectedBids": 0, "description": "Campaign is filtered because the bid price is lower than the floor price received from the exchange.", "subReasonInfo": { } }, "locationTargeting": { "title": "Location Targeting", "rejectedBids": 0, "description": "Campaign is filtered due to Location Targeting.", "subReasonInfo": { } }, "deviceTargeting": { "title": "Device Targeting", "rejectedBids": 0, "description": "Campaign is filtered due to Device Targeting.", "subReasonInfo": { } }, "creativeSettings": { "label": "Creative Settings", "rejectedBids": 100, "description": "Campaign is filtered due to non-matching creative dimensions found in the request", "subReasonInfo": { "creativeDimension": { "label": "Creative Dimensions", "droppedRequests": 100, "description": "Campaign is filtered due to non-matching creative dimensions found in the request." } } }, "advanceTargeting": { "title": "Advanced Targeting", "rejectedBids": 0, "description": null, "subReasonInfo": { } }, "audienceTargeting": { "title": "Audience Targeting", "rejectedBids": 0, "description": "Campaign is filtered due to Audience Targeting.", "subReasonInfo": { } }, "bidStrategy": { "title": "Bid Strategy", "rejectedBids": 0, "description": "Campaign is filtered due to bid strategy setting applied in campaign.", "subReasonInfo": { } }, "campaignBudget": { "title": "Campaign Budget", "rejectedBids": 0, "description": "Campaign is filtered because the campaign budget is now unavailable for further bidding.", "subReasonInfo": { } }, "demographicsTargeting": { "title": "Demographics Targeting", "rejectedBids": 0, "description": "Campaign is filtered due to Demographics Targeting.", "subReasonInfo": { } }, "undefined": { "title": "Undefined", "rejectedBids": 0, "description": "Campaign is filtered due to Undefined reasons.", "subReasonInfo": { } } }, "topMainReasons": { "creativeSettings": 100 }, "topSubReasons": { "creativeDimension": 100 }, "totalBids": 0, "lostBids": 0, "totalWins": 0 } } } } }, "422": { "description": "Unprocessable Entity ", "content": { "application/json": { "examples": { "Invalid start date.": { "description": "Invalid start date.", "value": { "success": false, "errorObjects": [ { "error": "Date Range End must be greater than Date Range Start" } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/ins/audiences/list": { "get": { "tags": [ "Insights API" ], "summary": "It will provide list of eligible audience which has 10k uniques(minimum) and type should be matched audience.", "description": "This API will provide list of eligible audience which has 10k uniques(minimum) and type should be matched audience. ", "operationId": "getInsightsCreateEligibleAudienceList", "parameters": [ { "name": "searchField", "in": "query", "description": "Search the result by provided keyword in the searchField. Search audience by audience name and id.", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "pageSize", "in": "query", "description": "The maximum number of returned results per page. ", "required": false, "schema": { "type": "integer", "format": "int32", "default": 20 } }, { "name": "pageNo", "in": "query", "description": "Page number for the required data. ", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "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(name of audience), matchRate, uniques", "required": false, "schema": { "type": "string", "default": "-id" } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "success": true, "data": { "totalRecords": 10, "filteredRecords": 3, "insightsData": [ { "id": 12345, "audienceName": "audience1", "matchRate": 58.99, "uniques": 52432 }, { "id": 12365, "audienceName": "audience2", "matchRate": 78.88, "uniques": 72786 }, { "id": 12376, "audienceName": "audience3", "matchRate": 34.88, "uniques": 31122 } ] } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Invalid sortBy value." } ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/ins/aqs-reports/validate/name": { "get": { "tags": [ "Insights API" ], "summary": "This API will validate the report name for generation of AQS reports", "description": "This API will validate the report name for generation of AQS reports.It checks if the name meets length requirements and ensures uniqueness within the organization.", "operationId": "validateAQSReportName", "parameters": [ { "name": "reportName", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Valid AQS report name": { "description": "Valid AQS report name", "value": { "success": true, "data": { "available": true, "message": "This AQS report name is valid" } } }, "Already used AQS report name": { "description": "Already used AQS report name", "value": { "success": true, "data": { "available": false, "message": "The name 'report_name' is already used by another report, kindly update the name" } } } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "examples": { "Invalid AQS report name": { "description": "Invalid AQS report name", "value": { "success": false, "errorObjects": [ { "error": "Please provide name with at least 3 characters and maximum of 100 characters" } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/ins/aqs-reports/campaigns": { "get": { "tags": [ "Insights API" ], "summary": "This API will provide a status-wise list of eligible campaigns for generation of AQS reports", "description": "This API will provide a status-wise list of eligible campaignIDs so that they could be used for generation of AQS reports", "operationId": "getStatusWiseCampaignsForReports", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "For no eligible campaigns found": { "description": "For no eligible campaigns found", "value": { "success": true, "data": { "running": [], "paused": [], "expired": [] } } }, "For eligible campaigns found": { "description": "For eligible campaigns found", "value": { "success": true, "data": { "running": [ { "campaignId": 451351, "campaignTimezoneId": 29 } ], "paused": [ { "campaignId": 451350, "campaignTimezoneId": 29 } ], "expired": [ { "campaignId": 470839, "campaignTimezoneId": 29 } ] } } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/internal/ins/audience/insights/delete": { "delete": { "tags": [ "Insights API" ], "summary": "This API deletes the insights for the given audienceIds.", "description": "This API deletes the insights on deletion of audience for the given audience ids.", "operationId": "deleteInsightsByAudienceIds", "parameters": [ { "name": "audienceIds", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "owId", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Deletion success response": { "description": "Deletion success response", "value": { "success": true, "data": { "deletedIds": { "1003660": 807 }, "invalidIds": [123123] } } }, "422_UnProcessable_Entity": { "description": "422_UnProcessable_Entity", "value": { "success": false, "errorObjects": [ { "error": "error message." } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/ins/report": { "delete": { "tags": [ "Insights API" ], "summary": "Delete Failed Reports", "description": "This API deletes reports that are not marked as deleted and have a 'failed' status. It requires the user to be authorized and checks if the provided report IDs are valid.", "operationId": "deleteFailedReport", "parameters": [ { "name": "reportIds", "in": "query", "description": "Comma-separated list of report IDs to delete.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "Individual report successfully deleted.", "content": { "application/json": { "examples": { "Success response": { "description": "Success response", "value": { "success": true, "data": { "message": "255944_PLD_Insights_2 deleted successfully" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden !" } ] } } } }, "422": { "description": "Invalid Report IDs provided", "content": { "application/json": { "examples": { "Null report IDs provided": { "description": "Null report IDs provided", "value": { "success": false, "data": { "message": "Report IDs cannot be empty" } } }, "Invalid report IDs provided": { "description": "Invalid report IDs provided", "value": { "success": false, "data": { "message": "Please provide valid insights id value." } } }, "Insight report IDs not found in valid state - non-deleted and having failed status": { "description": "Insight report IDs not found in valid state - non-deleted and having failed status", "value": { "success": false, "errorObjects": [ { "error": "Some of the provided NLD ID(s) are either already deleted, do not exist, or do not have a 'failed' status." } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/ins/insights/delete": { "delete": { "tags": [ "Insights API" ], "summary": "It will delete the records for given insights ids.", "description": "This API will provide delete the records from database for valid insightIds passed in the list.", "operationId": "deleteInsights", "parameters": [ { "name": "insightIds", "in": "query", "description": "List of InsightIds to be deleted.", "required": true, "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "success": true, "data": { "deletedIds": [35, 34], "invalidIds": [33, 1] } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "The provided list of insightIds is empty." } ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/das/dashboard/{dashboardId}": { "put": { "tags": [ "Dashboard API" ], "summary": "Update Dashboard API", "description": "This API allows user to update label and configuration of dashboard of an already created dashboard configuration.", "operationId": "updateDashboardAPI", "parameters": [ { "name": "dashboardId", "in": "path", "description": "Dashboard Id for which the dashboard configuration needs to be updated.", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" } ], "requestBody": { "description": "Map of configuration which needs to be updated mandatory keys (label, data)", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "label": { "type": "string" }, "data": { "type": "object", "additionalProperties": { "type": "object" } } } }, "examples": { "Request body for updating label and data": { "description": "Request body for updating label and data", "value": { "dashboardName": "Dashboard Name", "data": { "freeze": { "rows": 0, "columns": 0 }, "metric": { "id": 9, "key": "CTR", "label": "CTR", "order": 1, "value": "CTR", "description": "Click-through rate is the percentage of Clicks received per the Impressions served", "fieldDataType": "percent", "defaultEnabled": true, "aggregationType": "avg" }, "search": "", "status": { "label": "All (1428)", "value": "all" }, "timezone": { "id": 29, "label": "US/Eastern", "value": "US/Eastern" }, "dimension": { "id": 1, "key": "campaign", "label": "Campaign", "order": 1, "value": "campaign", "groupId": 1, "description": "Campaign Name", "fieldDataType": "text", "isRowToColumn": false, "isFilterSupported": true, "isCustomerDependent": true }, "tableLevel": { "label": "Campaign Groups", "value": "groups" }, "lastModified": 1692167373, "sortingColumns": [ { "label": "ID", "value": "campaignId", "active": true, "alwaysEnabled": true, "draggableGroup": 1 }, { "label": "Campaign Name", "value": "campaignName", "active": true, "alwaysEnabled": true, "draggableGroup": 1 }, { "label": "VCR(%)", "value": "VCR", "active": true }, { "label": "WinRate(%)", "value": "winRate", "active": true } ], "filteredGroupsIds": [135120], "filteredCampaignsIds": [334656, 334651, 334650, 334649], "sortingGroupsColumns": [ { "label": "ID", "value": "campaignGroupId", "alwaysEnabled": true, "draggableGroup": 1 }, { "label": "WinRate(%)", "value": "winRate", "active": true } ], "selectedCampaignTypes": [], "isSelectingCampaignsByGroup": true } } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "examples": { "Update Dashboard": { "description": "Update Dashboard", "value": { "success": true, "data": { "message": "sample-1 has been saved" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden !" } ] } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "examples": { "Invalid Dashboard Id for update": { "description": "Invalid Dashboard Id for update", "value": { "success": false, "errorObjects": [ { "error": "Dashboard id is invalid for update" } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/das/report/by-workspace": { "post": { "tags": [ "Dashboard API" ], "summary": "Get campaign's performance by IO workspace report data.", "description": "This API fetches campaign's performance by workspace report data as per the given filters in the request body.", "operationId": "dashboard-report-by-workspace", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "sortCriteriaMap": { "type": "object", "additionalProperties": { "type": "string" } }, "columns": { "type": "array", "items": { "type": "object", "additionalProperties": { "type": "object" } } }, "startDate": { "type": "integer", "format": "int64" }, "endDate": { "type": "integer", "format": "int64" }, "timezoneId": { "type": "integer", "format": "int32" }, "timezoneName": { "type": "string" }, "resultType": { "type": "string" }, "campaignStatus": { "type": "string" }, "campaignStatusList": { "type": "array", "items": { "type": "string" } }, "creativeTypeIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "owIds": { "type": "string" }, "owIdsList": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "workspaceOwIdsList": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "customerOwIdsList": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "tab": { "type": "string" }, "dayDiff": { "type": "integer", "format": "int64" }, "download": { "type": "boolean" }, "fileType": { "type": "string" }, "fileName": { "type": "string" }, "campaignIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "campaignGroupIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "isAudienceFlagsRequired": { "type": "boolean" }, "loggedInUowId": { "type": "integer", "format": "int32" }, "graphType": { "type": "string" }, "ioIdsList": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "ioStatusIdsList": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "ids": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "budgetTypeIdList": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "campaignTypeIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "organizationType": { "type": "string" }, "campaignRequest": { "type": "boolean" }, "dataQueryEligible": { "type": "boolean" }, "totalQueryEligible": { "type": "boolean" }, "pageNo": { "type": "integer", "format": "int32" }, "noOfEntries": { "type": "integer", "format": "int32" }, "sortBy": { "type": "string" }, "searchField": { "type": "string" }, "order": { "type": "string", "enum": [ "SortOrderEnum[id=1, name='asc', symbol='+']", "SortOrderEnum[id=2, name='desc', symbol='-']" ] }, "isGraph": { "type": "boolean" }, "isBetaUser": { "type": "boolean" } } }, "examples": { "Total of report data": { "description": "Total of report data", "value": { "startDate": "1660834800000", "endDate": "1660834800001", "timezoneId": 1, "campaignStatus": "all", "creativeTypeIds": "", "searchField": "", "sortBy": "impressions", "order": "DESC", "owIds": "1,2,3,4", "pageNo": 1, "noOfEntries": 50, "resultType": "total" } }, "Report data": { "description": "Report data", "value": { "startDate": "1660834800000", "endDate": "1660834800001", "timezoneId": 1, "campaignStatus": "all", "creativeTypeIds": "", "searchField": "", "sortBy": "impressions", "order": "DESC", "owIds": "1,2,3,4", "pageNo": 1, "noOfEntries": 50, "resultType": "data" } }, "Report and total of report data": { "description": "Report and total of report data", "value": { "startDate": "1660834800000", "endDate": "1660834800001", "timezoneId": 1, "campaignStatus": "all", "creativeTypeIds": "", "searchField": "", "sortBy": "impressions", "order": "DESC", "owIds": "1,2,3,4", "pageNo": 1, "noOfEntries": 50 } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Total of report data": { "description": "Total of report data", "value": { "success": true, "data": { "totalRecords": 57, "filteredRecords": 57, "recordsTotal": { "clicks": 0, "totalCount": 57, "winRate": 0, "logoURL": null, "avatarURL": null, "budgetDay": 1.8985625880766135e+307, "budgetSpent": 60000, "budgetTotal": 5.9e+307, "dataCost": 0, "mediaBudget": 7, "owId": 0, "orgId": 0, "impressions": 0, "industry": 0, "mediaSpent": 0, "spent": 0, "workspaceSpent": 0, "platformSpent": 0, "customerSpent": 0, "platformMediaEarning": 0, "platformBidShadingEarning": 0, "platformTotalEarning": 0, "workspaceMediaEarning": 0, "workspaceBidShadingEarning": 0, "workspaceTotalEarning": 0, "organizationBidShadingSaving": 0, "organizationName": null, "companySize": 0, "workspaceName": null, "workspaceId": 0, "workspaceDomain": null, "workspaceOrganizationName": null, "bidImpressions": 0, "startCount": 0, "firstCount": 0, "midCount": 0, "thirdCount": 0, "completeCount": 0, "audioVideoActualBids": 0, "audioVideoActualImpressions": 0, "eCPC": 0, "totalECPC": 0, "eCPM": 0, "totalECPM": 0, "eCPI": 0, "eCPCV": 0, "eCPV": 0, "totalAttributedConversion": 0, "totalAttributedViewThroughConversion": 0, "totalAttributedClickThroughConversion": 0, "costPerAttributedConversion": 0, "totalAttributedConversionRate": 0, "reach": 0, "frequency": 0, "date": null, "campaignId": 0, "campaignName": null, "maxBid": 0, "startTime": 0, "endTime": 0, "campaignType": null, "status": null, "mappingDataCost": 0, "mappingSpent": 0, "campaignTimezone": null, "creativeType": null, "budgetPacing": false, "isCampaignFromNewPlatform": false, "percentageOfTotalSpent": 0, "vldInsightsCost": null, "workspaceVLDInsightsEarnings": null, "platformVLDInsightsEarnings": null, "pldInsightsCost": null, "workspacePLDInsightsEarnings": null, "platformPLDInsightsEarnings": null, "slsInsightsCost": null, "workspaceSLSInsightsEarnings": null, "platformSLSInsightsEarnings": null, "uowId": 0, "audioVideoViewed": 0, "ioId": 0, "ioName": null, "ioTimezone": 0, "ioBudgetDistributionMethod": 0, "exchangeId": 0, "exchangeName": null, "autoSumToTotalBudget": false, "adServingCost": 0, "thirdPartyCost": 2.75, "CTR": 0, "VCR": 0, "CVR": 0 } } } }, "Report data": { "description": "Report data", "value": { "success": true, "data": { "totalRecords": 57, "filteredRecords": 57, "recordsList": [ { "clicks": 0, "totalCount": 0, "winRate": 0, "logoURL": null, "avatarURL": "https://sample-domain.com/avatar/TM.png", "budgetDay": 65.69, "budgetSpent": 10000, "budgetTotal": 1000, "dataCost": 0, "mediaBudget": 1, "owId": 202161, "orgId": 5565, "impressions": 0, "industry": 1, "mediaSpent": 0, "spent": 0, "workspaceSpent": 0, "platformSpent": 0, "customerSpent": 0, "platformMediaEarning": 0, "platformBidShadingEarning": 0, "platformTotalEarning": 0, "workspaceMediaEarning": 0, "workspaceBidShadingEarning": 0, "workspaceTotalEarning": 0, "organizationBidShadingSaving": 0, "organizationName": "Test Organisation - Meera", "companySize": 1, "workspaceName": "stageadv1", "workspaceId": 1053, "workspaceDomain": "stageadv1.stage.applift.com", "workspaceOrganizationName": null, "bidImpressions": 0, "startCount": 0, "firstCount": 0, "midCount": 0, "thirdCount": 0, "completeCount": 0, "audioVideoActualBids": 0, "audioVideoActualImpressions": 0, "eCPC": 0, "totalECPC": 0, "eCPM": 0, "totalECPM": 0, "eCPI": 0, "eCPCV": 0, "eCPV": 0, "totalAttributedConversion": 0, "totalAttributedViewThroughConversion": 0, "totalAttributedClickThroughConversion": 0, "costPerAttributedConversion": 0, "totalAttributedConversionRate": 0, "reach": 0, "frequency": 0, "date": null, "campaignId": 0, "campaignName": null, "maxBid": 0, "startTime": 0, "endTime": 0, "campaignType": null, "status": null, "mappingDataCost": 0, "mappingSpent": 0, "campaignTimezone": null, "creativeType": null, "budgetPacing": false, "isCampaignFromNewPlatform": false, "percentageOfTotalSpent": 0, "vldInsightsCost": 12.33, "workspaceVLDInsightsEarnings": 2.33, "platformVLDInsightsEarnings": 10, "pldInsightsCost": 12.33, "workspacePLDInsightsEarnings": 2.33, "platformPLDInsightsEarnings": 10, "slsInsightsCost": 12.33, "workspaceSLSInsightsEarnings": 2.33, "platformSLSInsightsEarnings": 10, "uowId": 0, "audioVideoViewed": 0, "ioId": 0, "ioName": null, "ioTimezone": 0, "ioBudgetDistributionMethod": 0, "exchangeId": 0, "exchangeName": null, "autoSumToTotalBudget": false, "adServingCost": 0, "thirdPartyCost": 2.75, "CTR": 0, "VCR": 0, "CVR": 0 } ] } } }, "Report and total of report data": { "description": "Report and total of report data", "value": { "success": true, "data": { "totalRecords": 57, "filteredRecords": 57, "recordsTotal": { "clicks": 0, "totalCount": 57, "winRate": 0, "logoURL": null, "avatarURL": null, "budgetDay": 1.8985625880766135e+307, "budgetSpent": 60000, "budgetTotal": 5.9e+307, "dataCost": 0, "mediaBudget": 7, "owId": 0, "orgId": 0, "impressions": 0, "industry": 0, "mediaSpent": 0, "spent": 0, "workspaceSpent": 0, "platformSpent": 0, "customerSpent": 0, "platformMediaEarning": 0, "platformBidShadingEarning": 0, "platformTotalEarning": 0, "workspaceMediaEarning": 0, "workspaceBidShadingEarning": 0, "workspaceTotalEarning": 0, "organizationBidShadingSaving": 0, "organizationName": null, "companySize": 0, "workspaceName": null, "workspaceId": 0, "workspaceDomain": null, "workspaceOrganizationName": null, "bidImpressions": 0, "startCount": 0, "firstCount": 0, "midCount": 0, "thirdCount": 0, "completeCount": 0, "audioVideoActualBids": 0, "audioVideoActualImpressions": 0, "eCPC": 0, "totalECPC": 0, "eCPM": 0, "totalECPM": 0, "eCPI": 0, "eCPCV": 0, "eCPV": 0, "totalAttributedConversion": 0, "totalAttributedViewThroughConversion": 0, "totalAttributedClickThroughConversion": 0, "costPerAttributedConversion": 0, "totalAttributedConversionRate": 0, "reach": 0, "frequency": 0, "date": null, "campaignId": 0, "campaignName": null, "maxBid": 0, "startTime": 0, "endTime": 0, "campaignType": null, "status": null, "mappingDataCost": 0, "mappingSpent": 0, "campaignTimezone": null, "creativeType": null, "budgetPacing": false, "isCampaignFromNewPlatform": false, "percentageOfTotalSpent": 0, "vldInsightsCost": 12.33, "workspaceVLDInsightsEarnings": 2.33, "platformVLDInsightsEarnings": 10, "pldInsightsCost": 12.33, "workspacePLDInsightsEarnings": 2.33, "platformPLDInsightsEarnings": 10, "slsInsightsCost": 12.33, "workspaceSLSInsightsEarnings": 2.33, "platformSLSInsightsEarnings": 10, "uowId": 0, "audioVideoViewed": 0, "ioId": 0, "ioName": null, "ioTimezone": 0, "ioBudgetDistributionMethod": 0, "exchangeId": 0, "exchangeName": null, "autoSumToTotalBudget": false, "adServingCost": 0, "thirdPartyCost": 2.75, "CTR": 0, "VCR": 0, "CVR": 0 }, "recordsList": [ { "clicks": 0, "totalCount": 0, "winRate": 0, "logoURL": null, "avatarURL": "https://sample-domain.com/avatar/TM.png", "budgetDay": 65.69, "budgetSpent": 10000, "budgetTotal": 1000, "dataCost": 0, "mediaBudget": 1, "owId": 202161, "orgId": 5565, "impressions": 0, "industry": 1, "mediaSpent": 0, "spent": 0, "workspaceSpent": 0, "platformSpent": 0, "customerSpent": 0, "platformMediaEarning": 0, "platformBidShadingEarning": 0, "platformTotalEarning": 0, "workspaceMediaEarning": 0, "workspaceBidShadingEarning": 0, "workspaceTotalEarning": 0, "organizationBidShadingSaving": 0, "organizationName": "Test Organisation - Meera", "companySize": 1, "workspaceName": "stageadv1", "workspaceId": 1053, "workspaceDomain": "stageadv1.stage.applift.com", "workspaceOrganizationName": null, "bidImpressions": 0, "startCount": 0, "firstCount": 0, "midCount": 0, "thirdCount": 0, "completeCount": 0, "audioVideoActualBids": 0, "audioVideoActualImpressions": 0, "eCPC": 0, "totalECPC": 0, "eCPM": 0, "totalECPM": 0, "eCPI": 0, "eCPCV": 0, "eCPV": 0, "totalAttributedConversion": 0, "totalAttributedViewThroughConversion": 0, "totalAttributedClickThroughConversion": 0, "costPerAttributedConversion": 0, "totalAttributedConversionRate": 0, "reach": 0, "frequency": 0, "date": null, "campaignId": 0, "campaignName": null, "maxBid": 0, "startTime": 0, "endTime": 0, "campaignType": null, "status": null, "mappingDataCost": 0, "mappingSpent": 0, "campaignTimezone": null, "creativeType": null, "budgetPacing": false, "isCampaignFromNewPlatform": false, "percentageOfTotalSpent": 0, "vldInsightsCost": 12.33, "workspaceVLDInsightsEarnings": 2.33, "platformVLDInsightsEarnings": 10, "pldInsightsCost": 12.33, "workspacePLDInsightsEarnings": 2.33, "platformPLDInsightsEarnings": 10, "slsInsightsCost": 12.33, "workspaceSLSInsightsEarnings": 2.33, "platformSLSInsightsEarnings": 10, "uowId": 0, "audioVideoViewed": 0, "ioId": 0, "ioName": null, "ioTimezone": 0, "ioBudgetDistributionMethod": 0, "exchangeId": 0, "exchangeName": null, "autoSumToTotalBudget": false, "adServingCost": 0, "thirdPartyCost": 2.75, "CTR": 0, "VCR": 0, "CVR": 0 } ] } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden !" } ] } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Invalid sortBy value." } ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/das/report/by-io": { "post": { "tags": [ "Dashboard API" ], "summary": "Get campaign's performance by IO (Insertion-Order) report data.", "description": "This API fetches campaign's performance by IO (Insertion-Order) report data as per the given filters in the request body.", "operationId": "dashboard-report-by-io", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "sortCriteriaMap": { "type": "object", "additionalProperties": { "type": "string" } }, "columns": { "type": "array", "items": { "type": "object", "additionalProperties": { "type": "object" } } }, "startDate": { "type": "integer", "format": "int64" }, "endDate": { "type": "integer", "format": "int64" }, "timezoneId": { "type": "integer", "format": "int32" }, "timezoneName": { "type": "string" }, "resultType": { "type": "string" }, "campaignStatus": { "type": "string" }, "campaignStatusList": { "type": "array", "items": { "type": "string" } }, "creativeTypeIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "owIds": { "type": "string" }, "owIdsList": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "workspaceOwIdsList": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "customerOwIdsList": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "tab": { "type": "string" }, "dayDiff": { "type": "integer", "format": "int64" }, "download": { "type": "boolean" }, "fileType": { "type": "string" }, "fileName": { "type": "string" }, "campaignIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "campaignGroupIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "isAudienceFlagsRequired": { "type": "boolean" }, "loggedInUowId": { "type": "integer", "format": "int32" }, "graphType": { "type": "string" }, "ioIdsList": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "ioStatusIdsList": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "ids": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "budgetTypeIdList": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "campaignTypeIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "organizationType": { "type": "string" }, "campaignRequest": { "type": "boolean" }, "dataQueryEligible": { "type": "boolean" }, "totalQueryEligible": { "type": "boolean" }, "pageNo": { "type": "integer", "format": "int32" }, "noOfEntries": { "type": "integer", "format": "int32" }, "sortBy": { "type": "string" }, "searchField": { "type": "string" }, "order": { "type": "string", "enum": [ "SortOrderEnum[id=1, name='asc', symbol='+']", "SortOrderEnum[id=2, name='desc', symbol='-']" ] }, "isGraph": { "type": "boolean" }, "isBetaUser": { "type": "boolean" } } }, "examples": { "Total of report data": { "description": "Total of report data", "value": { "startDate": "1660834800000", "endDate": "1660834800001", "timezoneId": 1, "campaignStatus": "all", "creativeTypeIds": "11,12", "searchField": "sample", "sortBy": "impressions", "order": "DESC", "owIds": "1,2,3,4", "pageNo": 1, "noOfEntries": 50, "resultType": "total", "ioIdsList": [1, 2, 3], "budgetTypeIdList": [1, 2], "ioStatusIdsList": [1, 2] } }, "Report data": { "description": "Report data", "value": { "startDate": "1660834800000", "endDate": "1660834800001", "timezoneId": 1, "campaignStatus": "all", "creativeTypeIds": "", "searchField": "", "sortBy": "impressions", "order": "DESC", "owIds": "1,2,3,4", "pageNo": 1, "noOfEntries": 50, "resultType": "data", "ioIdsList": [], "ioStatusIdsList": [] } }, "Report and total of report data": { "description": "Report and total of report data", "value": { "startDate": "1660834800000", "endDate": "1660834800001", "timezoneId": 1, "campaignStatus": "all", "creativeTypeIds": "", "searchField": "", "sortBy": "impressions", "order": "DESC", "owIds": "1,2,3,4", "pageNo": 1, "noOfEntries": 50, "ioIdsList": [], "ioStatusIdsList": [] } }, "Report Download": { "description": "Report Download", "value": { "startDate": "1660834800000", "endDate": "1660834800001", "timezoneId": 1, "campaignStatus": "all", "creativeTypeIds": "", "searchField": "", "sortBy": "impressions", "order": "DESC", "owIds": "1,2,3,4", "ioIdsList": [], "download": true, "fileType": "csv", "fileName": "sample io reports", "columns": [ { "label": "id", "value": "ioId" }, { "label": "IO Name", "value": "ioName" }, { "label": "Start date", "value": "ioStartTime" }, { "label": "End date", "value": "ioEndTime" } ] } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Total of report data": { "description": "Total of report data", "value": { "success": true, "data": { "recordsTotal": { "clicks": 0, "totalCount": 26, "winRate": 0, "logoURL": null, "avatarURL": null, "budgetDay": 0, "budgetSpent": 0, "ioTotalBudget": 98461.95, "dataCost": 0, "mediaBudget": 0, "owId": 0, "orgId": 0, "impressions": 0, "industry": 0, "mediaSpent": 0, "spent": 0, "workspaceSpent": 0, "platformSpent": 0, "customerSpent": 0, "platformEarning": 0, "workspaceEarning": 0, "organizationName": null, "companySize": 0, "workspaceName": null, "workspaceId": 0, "workspaceDomain": null, "workspaceOrganizationName": null, "bidImpressions": 0, "startCount": 0, "firstCount": 0, "midCount": 0, "thirdCount": 0, "completeCount": 0, "audioVideoActualBids": 0, "audioVideoActualImpressions": 0, "eCPC": 0, "totalECPC": 0, "eCPM": 0, "totalECPM": 0, "eCPI": 0, "eCPCV": 0, "eCPV": 0, "reach": null, "frequency": null, "totalAttributedConversion": 0, "totalAttributedViewThroughConversion": 0, "totalAttributedClickThroughConversion": 0, "costPerAttributedConversion": 0, "totalAttributedConversionRate": 0, "date": null, "campaignId": 0, "campaignName": null, "maxBid": 0, "ioStartTime": 0, "ioEndTime": 0, "campaignType": null, "status": null, "mappingDataCost": 0, "mappingSpent": 0, "campaignTimezone": null, "creativeType": null, "budgetPacing": false, "isCampaignFromNewPlatform": false, "percentageOfTotalSpent": 0, "uowId": 0, "audioVideoViewed": 0, "ioId": 0, "ioName": null, "ioTimezone": 0, "ioBudgetTypeId": 1, "ioStatusId": 1, "campaignsCount": 0, "ioTotalImpressions": 2934, "ioPacingPercentage": null, "ioActualSpent": 0, "ioExpectedSpent": 0, "ioDuration": 0, "ioRemainingDuration": 0, "ioBudgetDistributionMethod": 0, "exchangeId": 0, "exchangeName": null, "isAutoSumToTotalBudget": false, "vldInsightsCost": 12.33, "slsInsightsCost": 12.33, "ictInsightsCost": 12.33, "nldInsightsCost": 12.33, "pldInsightsCost": 12.33, "workspaceVLDInsightsEarnings": 1.3, "platformVLDInsightsEarnings": 0.33, "workspacePLDInsightsEarnings": 11.9, "platformPLDInsightsEarnings": 6.67, "workspaceICTInsightsEarnings": 11.9, "platformICTInsightsEarnings": 6.67, "workspaceNLDInsightsEarnings": 11.9, "platformNLDInsightsEarnings": 6.67, "workspaceSLSInsightsEarnings": 12, "platformSLSInsightsEarnings": 10, "isEligibleForPLDInsightsReport": true, "isEligibleForVLDInsightsReport": false, "isEligibleForSLSInsightsReport": true, "isEligibleForICTInsightsReport": true, "isEligibleForNLDInsightsReport": true, "budgetTotalCombined": 0, "budgetDayCombined": 0, "ioTotalBudgetCombined": 1000, "adServingCost": 0, "thirdPartyCost": 2.75, "CTR": 0, "VCR": 0, "CVR": 0 } } } }, "Report data": { "description": "Report data", "value": { "success": true, "data": { "totalRecords": 1, "filteredRecords": 1, "recordsList": [ { "clicks": 0, "totalCount": 0, "winRate": 0, "logoURL": null, "avatarURL": null, "budgetDay": 0, "budgetSpent": 0, "ioTotalBudget": 3041, "dataCost": 0, "mediaBudget": 0, "owId": 1, "orgId": 0, "impressions": 0, "industry": 0, "mediaSpent": 0, "spent": 0, "workspaceSpent": 0, "platformSpent": 0, "customerSpent": 0, "platformEarning": 0, "workspaceEarning": 0, "organizationName": "organization 1", "companySize": 0, "workspaceName": null, "workspaceId": 0, "workspaceDomain": null, "workspaceOrganizationName": null, "bidImpressions": 0, "startCount": 0, "firstCount": 0, "midCount": 0, "thirdCount": 0, "completeCount": 0, "audioVideoActualBids": 0, "audioVideoActualImpressions": 0, "eCPC": 0, "totalECPC": 0, "eCPM": 0, "totalECPM": 0, "eCPI": 0, "eCPCV": 0, "eCPV": 0, "reach": 0, "frequency": 0, "totalAttributedConversion": 0, "totalAttributedViewThroughConversion": 0, "totalAttributedClickThroughConversion": 0, "costPerAttributedConversion": 0, "totalAttributedConversionRate": 0, "date": null, "campaignId": 0, "campaignName": null, "maxBid": 0, "ioStartTime": 1521185580000, "ioEndTime": 1580495100000, "campaignType": null, "status": null, "mappingDataCost": 0, "mappingSpent": 0, "campaignTimezone": null, "creativeType": null, "budgetPacing": false, "isCampaignFromNewPlatform": false, "percentageOfTotalSpent": 0.000426744869779677, "uowId": 0, "audioVideoViewed": 0, "ioId": 1, "ioName": "Sample io", "ioTimezone": 29, "ioBudgetTypeId": 1, "ioTotalImpressions": 2934, "ioPacingPercentage": 29.45, "ioActualSpent": 293, "ioExpectedSpent": 388, "ioDuration": 293, "ioRemainingDuration": 29, "ioStatusId": 1, "campaignsCount": 6, "ioBudgetDistributionMethod": 1, "exchangeId": 0, "exchangeName": null, "isAutoSumToTotalBudget": false, "vldInsightsCost": 12.33, "slsInsightsCost": 12.33, "ictInsightsCost": 12.33, "nldInsightsCost": 12.33, "pldInsightsCost": 12.33, "workspaceVLDInsightsEarnings": 1.3, "platformVLDInsightsEarnings": 0.33, "workspacePLDInsightsEarnings": 11.9, "platformPLDInsightsEarnings": 6.67, "workspaceICTInsightsEarnings": 11.9, "platformICTInsightsEarnings": 6.67, "workspaceNLDInsightsEarnings": 11.9, "platformNLDInsightsEarnings": 6.67, "workspaceSLSInsightsEarnings": 12, "platformSLSInsightsEarnings": 10, "isEligibleForPLDInsightsReport": true, "isEligibleForVLDInsightsReport": false, "isEligibleForSLSInsightsReport": true, "isEligibleForICTInsightsReport": true, "isEligibleForNLDInsightsReport": true, "budgetTotalCombined": 0, "budgetDayCombined": 0, "ioTotalBudgetCombined": 1000, "adServingCost": 0, "thirdPartyCost": 2.75, "CTR": 0, "VCR": 0, "CVR": 0 } ] } } }, "Report and total of report data For Super admin": { "description": "Report and total of report data For Super admin", "value": { "success": true, "data": { "totalRecords": 26, "filteredRecords": 26, "recordsTotal": { "clicks": 0, "totalCount": 26, "winRate": 0, "logoURL": null, "avatarURL": null, "budgetDay": 0, "budgetSpent": 0, "ioTotalBudget": 98461.95, "dataCost": 0, "mediaBudget": 0, "owId": 0, "orgId": 0, "impressions": 0, "ivtImpressions": 0, "ivtClicks": 0, "industry": 0, "mediaSpent": 0, "spent": 0, "workspaceSpent": 0, "platformSpent": 0, "customerSpent": 0, "platformEarning": 0, "workspaceEarning": 0, "organizationName": "organization 3", "companySize": 0, "workspaceName": null, "workspaceId": 0, "workspaceDomain": null, "workspaceOrganizationName": null, "bidImpressions": 0, "startCount": 0, "firstCount": 0, "midCount": 0, "thirdCount": 0, "completeCount": 0, "audioVideoActualBids": 0, "audioVideoActualImpressions": 0, "eCPC": 0, "totalECPC": 0, "eCPM": 0, "totalECPM": 0, "eCPI": 0, "eCPCV": 0, "eCPV": 0, "reach": null, "frequency": null, "totalAttributedConversion": 0, "totalAttributedViewThroughConversion": 0, "totalAttributedClickThroughConversion": 0, "costPerAttributedConversion": 0, "totalAttributedConversionRate": 0, "date": null, "campaignId": 0, "campaignName": null, "maxBid": 0, "ioStartTime": 0, "ioEndTime": 0, "campaignType": null, "status": null, "mappingDataCost": 0, "mappingSpent": 0, "campaignTimezone": null, "creativeType": null, "budgetPacing": false, "isCampaignFromNewPlatform": false, "percentageOfTotalSpent": 0, "uowId": 0, "audioVideoViewed": 0, "ioId": 0, "ioName": null, "ioTimezone": 0, "ioBudgetTypeId": 1, "ioTotalImpressions": 2934, "ioPacingPercentage": null, "ioActualSpent": 0, "ioExpectedSpent": 0, "ioDuration": 0, "ioRemainingDuration": 0, "ioStatusId": 0, "campaignsCount": 0, "ioBudgetDistributionMethod": 0, "exchangeId": 0, "exchangeName": null, "isAutoSumToTotalBudget": false, "vldInsightsCost": 12.33, "slsInsightsCost": 12.33, "ictInsightsCost": 12.33, "nldInsightsCost": 12.33, "pldInsightsCost": 12.33, "workspaceVLDInsightsEarnings": 1.3, "platformVLDInsightsEarnings": 0.33, "workspacePLDInsightsEarnings": 11.9, "platformPLDInsightsEarnings": 6.67, "workspaceICTInsightsEarnings": 11.9, "platformICTInsightsEarnings": 6.67, "workspaceNLDInsightsEarnings": 11.9, "platformNLDInsightsEarnings": 6.67, "workspaceSLSInsightsEarnings": 12, "platformSLSInsightsEarnings": 10, "isEligibleForPLDInsightsReport": true, "isEligibleForVLDInsightsReport": false, "isEligibleForSLSInsightsReport": true, "isEligibleForICTInsightsReport": true, "isEligibleForNLDInsightsReport": true, "budgetTotalCombined": 0, "budgetDayCombined": 0, "ioTotalBudgetCombined": 1000, "adServingCost": 0, "thirdPartyCost": 2.75, "CTR": 0, "VCR": 0, "CVR": 0 }, "recordsList": [ { "clicks": 0, "totalCount": 0, "winRate": 0, "logoURL": null, "avatarURL": null, "budgetDay": 0, "budgetSpent": 0, "ioTotalBudget": 3041, "dataCost": 0, "mediaBudget": 0, "owId": 1, "orgId": 0, "impressions": 0, "ivtImpressions": 0, "ivtClicks": 0, "industry": 0, "mediaSpent": 0, "spent": 0, "workspaceSpent": 0, "platformSpent": 0, "customerSpent": 0, "platformEarning": 0, "workspaceEarning": 0, "organizationName": "organization 3", "companySize": 0, "workspaceName": null, "workspaceId": 0, "workspaceDomain": null, "workspaceOrganizationName": null, "bidImpressions": 0, "startCount": 0, "firstCount": 0, "midCount": 0, "thirdCount": 0, "completeCount": 0, "audioVideoActualBids": 0, "audioVideoActualImpressions": 0, "eCPC": 0, "totalECPC": 0, "eCPM": 0, "totalECPM": 0, "eCPI": 0, "eCPCV": 0, "eCPV": 0, "reach": 0, "frequency": 0, "totalAttributedConversion": 0, "totalAttributedViewThroughConversion": 0, "totalAttributedClickThroughConversion": 0, "costPerAttributedConversion": 0, "totalAttributedConversionRate": 0, "date": null, "campaignId": 0, "campaignName": null, "maxBid": 0, "ioStartTime": 1521185580000, "ioEndTime": 1580495100000, "campaignType": null, "status": null, "mappingDataCost": 0, "mappingSpent": 0, "campaignTimezone": null, "creativeType": null, "budgetPacing": false, "isCampaignFromNewPlatform": false, "percentageOfTotalSpent": 0.000426744869779677, "uowId": 0, "audioVideoViewed": 0, "ioId": 1, "ioName": "Sample io", "ioTimezone": 29, "ioBudgetTypeId": 1, "ioStatusId": 1, "campaignsCount": 6, "ioTotalImpressions": 2934, "ioPacingPercentage": 29.45, "ioActualSpent": 293, "ioExpectedSpent": 388, "ioDuration": 293, "ioRemainingDuration": 29, "ioBudgetDistributionMethod": 1, "exchangeId": 0, "exchangeName": null, "isAutoSumToTotalBudget": false, "vldInsightsCost": 12.33, "slsInsightsCost": 12.33, "ictInsightsCost": 12.33, "nldInsightsCost": 12.33, "pldInsightsCost": 12.33, "workspaceVLDInsightsEarnings": 1.3, "platformVLDInsightsEarnings": 0.33, "workspacePLDInsightsEarnings": 11.9, "platformPLDInsightsEarnings": 6.67, "workspaceICTInsightsEarnings": 11.9, "platformICTInsightsEarnings": 6.67, "workspaceNLDInsightsEarnings": 11.9, "platformNLDInsightsEarnings": 6.67, "workspaceSLSInsightsEarnings": 12, "platformSLSInsightsEarnings": 10, "isEligibleForPLDInsightsReport": true, "isEligibleForVLDInsightsReport": false, "isEligibleForSLSInsightsReport": true, "isEligibleForICTInsightsReport": true, "isEligibleForNLDInsightsReport": true, "budgetTotalCombined": 0, "budgetDayCombined": 0, "ioTotalBudgetCombined": 1000, "adServingCost": 0, "thirdPartyCost": 2.75, "CTR": 0, "VCR": 0, "CVR": 0 } ] } } }, "Report Download": { "description": "Report Download", "value": { "success": true, "data": { "url": "https://example.com/sample-csv-file" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden !" } ] } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Invalid sortBy value." } ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/das/report/by-exchange": { "post": { "tags": [ "Dashboard API" ], "summary": "Get campaign's performance by exchange's report data.", "description": "This API fetches campaign's performance by exchange's report data as per the given filters in the request body.", "operationId": "dashboard-report-by-exchanges", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "sortCriteriaMap": { "type": "object", "additionalProperties": { "type": "string" } }, "columns": { "type": "array", "items": { "type": "object", "additionalProperties": { "type": "object" } } }, "startDate": { "type": "integer", "format": "int64" }, "endDate": { "type": "integer", "format": "int64" }, "timezoneId": { "type": "integer", "format": "int32" }, "timezoneName": { "type": "string" }, "resultType": { "type": "string" }, "campaignStatus": { "type": "string" }, "campaignStatusList": { "type": "array", "items": { "type": "string" } }, "creativeTypeIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "owIds": { "type": "string" }, "owIdsList": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "workspaceOwIdsList": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "customerOwIdsList": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "tab": { "type": "string" }, "dayDiff": { "type": "integer", "format": "int64" }, "download": { "type": "boolean" }, "fileType": { "type": "string" }, "fileName": { "type": "string" }, "campaignIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "campaignGroupIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "isAudienceFlagsRequired": { "type": "boolean" }, "loggedInUowId": { "type": "integer", "format": "int32" }, "graphType": { "type": "string" }, "ioIdsList": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "ioStatusIdsList": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "ids": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "budgetTypeIdList": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "campaignTypeIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "organizationType": { "type": "string" }, "campaignRequest": { "type": "boolean" }, "dataQueryEligible": { "type": "boolean" }, "totalQueryEligible": { "type": "boolean" }, "pageNo": { "type": "integer", "format": "int32" }, "noOfEntries": { "type": "integer", "format": "int32" }, "sortBy": { "type": "string" }, "searchField": { "type": "string" }, "order": { "type": "string", "enum": [ "SortOrderEnum[id=1, name='asc', symbol='+']", "SortOrderEnum[id=2, name='desc', symbol='-']" ] }, "isGraph": { "type": "boolean" }, "isBetaUser": { "type": "boolean" } } }, "examples": { "Total of report data": { "description": "Total of report data", "value": { "startDate": "1660834800000", "endDate": "1660834800001", "timezoneId": 1, "campaignStatus": "all", "creativeTypeIds": "", "searchField": "", "sortBy": "impressions", "order": "DESC", "owIds": "1,2,3,4", "pageNo": 1, "noOfEntries": 50, "resultType": "total" } }, "Report data": { "description": "Report data", "value": { "startDate": "1660834800000", "endDate": "1660834800001", "timezoneId": 1, "campaignStatus": "all", "creativeTypeIds": "", "searchField": "", "sortBy": "impressions", "order": "DESC", "owIds": "1,2,3,4", "pageNo": 1, "noOfEntries": 50, "resultType": "data" } }, "Report and total of report data": { "description": "Report and total of report data", "value": { "startDate": "1660834800000", "endDate": "1660834800001", "timezoneId": 1, "campaignStatus": "all", "creativeTypeIds": "", "searchField": "", "sortBy": "impressions", "order": "DESC", "owIds": "1,2,3,4", "pageNo": 1, "noOfEntries": 50 } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Total of report data": { "description": "Total of report data", "value": { "success": true, "data": { "totalRecords": 322, "filteredRecords": 322, "recordsTotal": { "clicks": 0, "totalCount": 0, "winRate": 0, "logoURL": null, "avatarURL": null, "budgetDay": 0, "budgetSpent": 0, "budgetTotal": 0, "dataCost": 0, "mediaBudget": 0, "owId": 0, "orgId": 0, "impressions": 0, "industry": 0, "mediaSpent": 0, "spent": 0, "workspaceSpent": 0, "platformSpent": 0, "customerSpent": 0, "platformMediaEarning": 0, "platformBidShadingEarning": 0, "platformTotalEarning": 0, "workspaceMediaEarning": 0, "workspaceBidShadingEarning": 0, "workspaceTotalEarning": 0, "organizationBidShadingSaving": 0, "organizationName": null, "companySize": 0, "workspaceName": null, "workspaceId": 0, "workspaceDomain": null, "workspaceOrganizationName": null, "bidImpressions": 0, "startCount": 0, "firstCount": 0, "midCount": 0, "thirdCount": 0, "completeCount": 0, "audioVideoActualBids": 0, "audioVideoActualImpressions": 0, "eCPC": 0, "totalECPC": 0, "eCPM": 0, "totalECPM": 0, "eCPI": 0, "eCPCV": 0, "eCPV": 0, "conversionCount": 0, "conversionValue": 0, "conversionCPA": 0, "conversionRate": 0, "reach": 0, "frequency": 0, "date": null, "campaignId": 0, "campaignName": null, "maxBid": 0, "startTime": 0, "endTime": 0, "campaignType": null, "status": null, "mappingDataCost": 0, "mappingSpent": 0, "campaignTimezone": null, "creativeType": null, "budgetPacing": false, "isCampaignFromNewPlatform": false, "percentageOfTotalSpent": 0, "uowId": 0, "audioVideoViewed": 0, "campaignGroupId": 0, "campaignGroupName": null, "exchangeId": 0, "exchangeName": null, "CTR": 0, "VCR": 0, "CVR": 0 } } } }, "Report data": { "description": "Report data", "value": { "success": true, "data": { "totalRecords": 322, "filteredRecords": 322, "recordsList": [ { "clicks": 42, "totalCount": 0, "winRate": 20.0147641550609, "logoURL": null, "avatarURL": null, "budgetDay": 0, "budgetSpent": 0, "budgetTotal": 0, "dataCost": 65.024605, "mediaBudget": 0, "owId": 0, "orgId": 0, "impressions": 47326, "industry": 0, "mediaSpent": 573.44745, "spent": 638.47205, "workspaceSpent": 177.74794, "platformSpent": 141.48848, "customerSpent": 0, "platformMediaEarning": 0, "platformBidShadingEarning": 0, "platformTotalEarning": 0, "workspaceMediaEarning": 0, "workspaceBidShadingEarning": 0, "workspaceTotalEarning": 0, "organizationBidShadingSaving": 0, "organizationName": null, "companySize": 0, "workspaceName": null, "workspaceId": 0, "workspaceDomain": null, "workspaceOrganizationName": null, "bidImpressions": 257778, "startCount": 17900, "firstCount": 16272, "midCount": 15483, "thirdCount": 14854, "completeCount": 14363, "audioVideoActualBids": 0, "audioVideoActualImpressions": 0, "eCPC": 0.00952604068648144, "totalECPC": 0.01520171548, "eCPM": 9.52604075470119, "totalECPM": 13.1115207781211, "eCPI": 0, "eCPCV": 0, "eCPV": 0, "conversionCount": 0, "conversionValue": 0, "conversionCPA": 0, "conversionRate": 0, "reach": 0, "frequency": 0, "date": null, "campaignId": 0, "campaignName": null, "maxBid": 0, "startTime": 0, "endTime": 0, "campaignType": null, "status": null, "mappingDataCost": 0, "mappingSpent": 0, "campaignTimezone": null, "creativeType": null, "budgetPacing": false, "isCampaignFromNewPlatform": false, "percentageOfTotalSpent": 0, "uowId": 0, "audioVideoViewed": 0, "campaignGroupId": 0, "campaignGroupName": null, "exchangeId": 1, "exchangeName": "Exchange 1", "CTR": 0.191493133257851, "VCR": 24.277690496106, "CVR": 0 }, { "clicks": 14, "totalCount": 0, "winRate": 18.1628700683176, "logoURL": null, "avatarURL": null, "budgetDay": 0, "budgetSpent": 0, "budgetTotal": 0, "dataCost": 28.599503, "mediaBudget": 0, "owId": 0, "orgId": 0, "impressions": 20605, "industry": 0, "mediaSpent": 278.63135, "spent": 307.2309, "workspaceSpent": 98.12187, "platformSpent": 87.63805, "customerSpent": 0, "platformMediaEarning": 0, "platformBidShadingEarning": 0, "platformTotalEarning": 0, "workspaceMediaEarning": 0, "workspaceBidShadingEarning": 0, "workspaceTotalEarning": 0, "organizationBidShadingSaving": 0, "organizationName": null, "companySize": 0, "workspaceName": null, "workspaceId": 0, "workspaceDomain": null, "workspaceOrganizationName": null, "bidImpressions": 134428, "startCount": 7788, "firstCount": 7004, "midCount": 6662, "thirdCount": 6423, "completeCount": 6156, "audioVideoActualBids": 0, "audioVideoActualImpressions": 0, "eCPC": 0.00900570098207163, "totalECPC": 0.02194506429, "totalECPM": 14.9129001705316, "eCPI": 0, "eCPCV": 0, "eCPV": 0, "conversionCount": 0, "conversionValue": 0, "conversionCPA": 0, "conversionRate": 0, "reach": 0, "frequency": 0, "date": null, "campaignId": 0, "campaignName": null, "maxBid": 0, "startTime": 0, "endTime": 0, "campaignType": null, "status": null, "mappingDataCost": 0, "mappingSpent": 0, "campaignTimezone": null, "creativeType": null, "budgetPacing": false, "isCampaignFromNewPlatform": false, "percentageOfTotalSpent": 0, "uowId": 0, "audioVideoViewed": 0, "campaignGroupId": 0, "campaignGroupName": null, "exchangeId": 2, "exchangeName": "Exchange 2", "CTR": 0.0470159142788607, "VCR": 21.7142313801422, "CVR": 0 } ] } } }, "Report and total of report data for super": { "description": "Report and total of report data for super", "value": { "success": true, "data": { "totalRecords": 322, "filteredRecords": 322, "recordsTotal": { "clicks": 99, "totalCount": 9, "winRate": 13.5186911644907, "logoURL": null, "avatarURL": null, "budgetDay": 0, "budgetSpent": 0, "budgetTotal": 0, "dataCost": 142.7183, "mediaBudget": 0, "owId": 0, "orgId": 0, "impressions": 105709, "ivtImpressions": 0, "ivtClicks": 0, "industry": 0, "mediaSpent": 1695.103, "spent": 1837.8215, "workspaceSpent": 623.59644, "platformSpent": 541.08276, "customerSpent": 0, "platformMediaEarning": 0, "platformBidShadingEarning": 0, "platformTotalEarning": 0, "workspaceMediaEarning": 0, "workspaceBidShadingEarning": 0, "workspaceTotalEarning": 0, "organizationBidShadingSaving": 0, "organizationName": null, "companySize": 0, "workspaceName": null, "workspaceId": 0, "workspaceDomain": null, "workspaceOrganizationName": null, "bidImpressions": 781947, "startCount": 49181, "firstCount": 46060, "midCount": 44608, "thirdCount": 43425, "completeCount": 42343, "audioVideoActualBids": 0, "audioVideoActualImpressions": 0, "eCPC": 0.0160355601447724, "totalECPC": 0.01856385354, "eCPM": 16.0355601447724, "totalECPM": 17.3887638446015, "eCPI": 0, "eCPCV": 0, "eCPV": 0, "conversionCount": 0, "conversionValue": 0, "conversionCPA": 0, "conversionRate": 0, "reach": 0, "frequency": 0, "date": null, "campaignId": 0, "campaignName": null, "maxBid": 0, "startTime": 0, "endTime": 0, "campaignType": null, "status": null, "mappingDataCost": 0, "mappingSpent": 0, "campaignTimezone": null, "creativeType": null, "budgetPacing": false, "isCampaignFromNewPlatform": false, "percentageOfTotalSpent": 0, "uowId": 0, "audioVideoViewed": 0, "campaignGroupId": 0, "campaignGroupName": null, "exchangeId": 0, "exchangeName": null, "CTR": 0.0936533313152144, "VCR": 86.096256684492, "CVR": 0 }, "recordsList": [ { "clicks": 42, "totalCount": 0, "winRate": 20.0147641550609, "logoURL": null, "avatarURL": null, "budgetDay": 0, "budgetSpent": 0, "budgetTotal": 0, "dataCost": 65.024605, "mediaBudget": 0, "owId": 0, "orgId": 0, "impressions": 47326, "ivtImpressions": 0, "ivtClicks": 0, "industry": 0, "mediaSpent": 573.44745, "spent": 638.47205, "workspaceSpent": 177.74794, "platformSpent": 141.48848, "customerSpent": 0, "platformMediaEarning": 0, "platformBidShadingEarning": 0, "platformTotalEarning": 0, "workspaceMediaEarning": 0, "workspaceBidShadingEarning": 0, "workspaceTotalEarning": 0, "organizationBidShadingSaving": 0, "organizationName": null, "companySize": 0, "workspaceName": null, "workspaceId": 0, "workspaceDomain": null, "workspaceOrganizationName": null, "bidImpressions": 257778, "startCount": 17900, "firstCount": 16272, "midCount": 15483, "thirdCount": 14854, "completeCount": 14363, "audioVideoActualBids": 0, "audioVideoActualImpressions": 0, "eCPC": 0.00952604068648144, "totalECPC": 0.01520171548, "eCPM": 9.52604075470119, "totalECPM": 13.4852158379692, "eCPI": 0, "eCPCV": 0, "eCPV": 0, "conversionCount": 0, "conversionValue": 0, "conversionCPA": 0, "conversionRate": 0, "reach": 0, "frequency": 0, "date": null, "campaignId": 0, "campaignName": null, "maxBid": 0, "startTime": 0, "endTime": 0, "campaignType": null, "status": null, "mappingDataCost": 0, "mappingSpent": 0, "campaignTimezone": null, "creativeType": null, "budgetPacing": false, "isCampaignFromNewPlatform": false, "percentageOfTotalSpent": 0, "uowId": 0, "audioVideoViewed": 0, "campaignGroupId": 0, "campaignGroupName": null, "exchangeId": 1, "exchangeName": "Exchange 1", "CTR": 0.191493133257851, "VCR": 24.277690496106, "CVR": 0 }, { "clicks": 14, "totalCount": 0, "winRate": 18.1628700683176, "logoURL": null, "avatarURL": null, "budgetDay": 0, "budgetSpent": 0, "budgetTotal": 0, "dataCost": 28.599503, "mediaBudget": 0, "owId": 0, "orgId": 0, "impressions": 20605, "industry": 0, "mediaSpent": 278.63135, "spent": 307.2309, "workspaceSpent": 98.12187, "platformSpent": 87.63805, "customerSpent": 0, "platformMediaEarning": 0, "platformBidShadingEarning": 0, "platformTotalEarning": 0, "workspaceMediaEarning": 0, "workspaceBidShadingEarning": 0, "workspaceTotalEarning": 0, "organizationBidShadingSaving": 0, "organizationName": null, "companySize": 0, "workspaceName": null, "workspaceId": 0, "workspaceDomain": null, "workspaceOrganizationName": null, "bidImpressions": 134428, "startCount": 7788, "firstCount": 7004, "midCount": 6662, "thirdCount": 6423, "completeCount": 6156, "audioVideoActualBids": 0, "audioVideoActualImpressions": 0, "eCPC": 0.00900570098207163, "totalECPC": 0.01990223929, "eCPM": 9.00570106088064, "totalECPM": 14.9157574599679, "eCPI": 0, "eCPCV": 0, "eCPV": 0, "conversionCount": 0, "conversionValue": 0, "conversionCPA": 0, "conversionRate": 0, "reach": 0, "frequency": 0, "date": null, "campaignId": 0, "campaignName": null, "maxBid": 0, "startTime": 0, "endTime": 0, "campaignType": null, "status": null, "mappingDataCost": 0, "mappingSpent": 0, "campaignTimezone": null, "creativeType": null, "budgetPacing": false, "isCampaignFromNewPlatform": false, "percentageOfTotalSpent": 0, "uowId": 0, "audioVideoViewed": 0, "campaignGroupId": 0, "campaignGroupName": null, "exchangeId": 2, "exchangeName": "Exchange 2", "CTR": 0.0470159142788607, "VCR": 21.7142313801422, "CVR": 0 } ] } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden !" } ] } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Invalid sortBy value." } ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/das/report/by-customer": { "post": { "tags": [ "Dashboard API" ], "summary": "Get campaign's performance by customer's(advertiser) report data.", "description": "This API fetches campaign's performance by customer's(advertiser) report data as per the given filters in the request body.", "operationId": "dashboard-report-by-customers", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "sortCriteriaMap": { "type": "object", "additionalProperties": { "type": "string" } }, "columns": { "type": "array", "items": { "type": "object", "additionalProperties": { "type": "object" } } }, "startDate": { "type": "integer", "format": "int64" }, "endDate": { "type": "integer", "format": "int64" }, "timezoneId": { "type": "integer", "format": "int32" }, "timezoneName": { "type": "string" }, "resultType": { "type": "string" }, "campaignStatus": { "type": "string" }, "campaignStatusList": { "type": "array", "items": { "type": "string" } }, "creativeTypeIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "owIds": { "type": "string" }, "owIdsList": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "workspaceOwIdsList": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "customerOwIdsList": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "tab": { "type": "string" }, "dayDiff": { "type": "integer", "format": "int64" }, "download": { "type": "boolean" }, "fileType": { "type": "string" }, "fileName": { "type": "string" }, "campaignIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "campaignGroupIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "isAudienceFlagsRequired": { "type": "boolean" }, "loggedInUowId": { "type": "integer", "format": "int32" }, "graphType": { "type": "string" }, "ioIdsList": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "ioStatusIdsList": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "ids": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "budgetTypeIdList": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "campaignTypeIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "organizationType": { "type": "string" }, "campaignRequest": { "type": "boolean" }, "dataQueryEligible": { "type": "boolean" }, "totalQueryEligible": { "type": "boolean" }, "pageNo": { "type": "integer", "format": "int32" }, "noOfEntries": { "type": "integer", "format": "int32" }, "sortBy": { "type": "string" }, "searchField": { "type": "string" }, "order": { "type": "string", "enum": [ "SortOrderEnum[id=1, name='asc', symbol='+']", "SortOrderEnum[id=2, name='desc', symbol='-']" ] }, "isGraph": { "type": "boolean" }, "isBetaUser": { "type": "boolean" } } }, "examples": { "Total of report data": { "description": "Total of report data", "value": { "startDate": "1660834800000", "endDate": "1660834800001", "timezoneId": 1, "campaignStatus": "all", "creativeTypeIds": "", "campaignTypeIds": [1], "budgetTypeIdList": [1], "searchField": "", "sortBy": "impressions", "order": "DESC", "owIds": "1,2,3,4", "pageNo": 1, "noOfEntries": 50, "resultType": "total" } }, "Report data": { "description": "Report data", "value": { "startDate": "1660834800000", "endDate": "1660834800001", "timezoneId": 1, "campaignStatus": "all", "creativeTypeIds": "", "campaignTypeIds": [1], "budgetTypeIdList": [1], "searchField": "", "sortBy": "impressions", "order": "DESC", "owIds": "1,2,3,4", "pageNo": 1, "noOfEntries": 50, "resultType": "data" } }, "Report and total of report data": { "description": "Report and total of report data", "value": { "startDate": "1660834800000", "endDate": "1660834800001", "timezoneId": 1, "campaignStatus": "all", "creativeTypeIds": "", "campaignTypeIds": [1], "budgetTypeIdList": [1], "searchField": "", "sortBy": "impressions", "order": "DESC", "owIds": "1,2,3,4", "pageNo": 1, "noOfEntries": 50 } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Total of report data": { "description": "Total of report data", "value": { "success": true, "data": { "totalRecords": 322, "filteredRecords": 322, "recordsTotal": { "clicks": 0, "totalCount": 322, "winRate": 0, "logoURL": null, "avatarURL": null, "budgetDay": 1.8985625880766135e+307, "budgetSpent": 3000, "budgetTotal": 5.9e+307, "dataCost": 0, "mediaBudget": 4, "owId": 0, "orgId": 0, "impressions": 0, "industry": 0, "mediaSpent": 0, "spent": 0, "workspaceSpent": 0, "platformSpent": 0, "customerSpent": 0, "platformMediaEarning": 0, "platformBidShadingEarning": 0, "platformTotalEarning": 0, "workspaceMediaEarning": 0, "workspaceBidShadingEarning": 0, "workspaceTotalEarning": 0, "organizationBidShadingSaving": 0, "organizationName": null, "companySize": 0, "workspaceName": null, "workspaceId": 0, "workspaceDomain": null, "workspaceOrganizationName": null, "bidImpressions": 0, "startCount": 0, "firstCount": 0, "midCount": 0, "thirdCount": 0, "completeCount": 0, "audioVideoActualBids": 0, "audioVideoActualImpressions": 0, "eCPC": 0, "eCPM": 0, "eCPI": 0, "eCPCV": 0, "eCPV": 0, "totalAttributedConversion": 0, "totalAttributedViewThroughConversion": 0, "totalAttributedClickThroughConversion": 0, "costPerAttributedConversion": 0, "totalAttributedConversionRate": 0, "reach": 0, "frequency": 0, "date": null, "campaignId": 0, "campaignName": null, "maxBid": 0, "startTime": 0, "endTime": 0, "campaignType": null, "status": null, "mappingDataCost": 0, "mappingSpent": 0, "campaignTimezone": null, "creativeType": null, "budgetPacing": false, "isCampaignFromNewPlatform": false, "percentageOfTotalSpent": 0, "vldInsightsCost": null, "workspaceVLDInsightsEarnings": null, "platformVLDInsightsEarnings": null, "pldInsightsCost": null, "workspacePLDInsightsEarnings": null, "platformPLDInsightsEarnings": null, "slsInsightsCost": null, "workspaceSLSInsightsEarnings": null, "platformSLSInsightsEarnings": null, "uowId": 0, "audioVideoViewed": 0, "ioId": 0, "ioName": null, "ioTimezone": 0, "ioBudgetDistributionMethod": 0, "exchangeId": 0, "exchangeName": null, "autoSumToTotalBudget": false, "adServingCost": 0, "thirdPartyCost": 2.75, "CTR": 0, "VCR": 0, "CVR": 0 } } } }, "Report data": { "description": "Report data", "value": { "success": true, "data": { "totalRecords": 322, "filteredRecords": 322, "recordsList": [ { "clicks": 0, "totalCount": 0, "winRate": 0, "logoURL": null, "avatarURL": "https://sample.png", "budgetDay": 65.69, "budgetSpent": 0, "budgetTotal": 1000, "dataCost": 0, "mediaBudget": 0, "owId": 202162, "orgId": 5566, "impressions": 0, "industry": 0, "mediaSpent": 0, "spent": 0, "workspaceSpent": 0, "platformSpent": 0, "customerSpent": 0, "platformEarning": 0, "workspaceEarning": 0, "organizationName": "Test Adv account", "companySize": 0, "workspaceName": "stageadv1", "workspaceId": 1053, "workspaceDomain": "stageadv1.stage.applift.com", "workspaceOrganizationName": "Test Organisation - Meera", "bidImpressions": 0, "startCount": 0, "firstCount": 0, "midCount": 0, "thirdCount": 0, "completeCount": 0, "audioVideoActualBids": 0, "audioVideoActualImpressions": 0, "eCPC": 0, "eCPM": 0, "eCPI": 0, "eCPCV": 0, "eCPV": 0, "totalAttributedConversion": 0, "totalAttributedViewThroughConversion": 0, "totalAttributedClickThroughConversion": 0, "costPerAttributedConversion": 0, "totalAttributedConversionRate": 0, "reach": 0, "frequency": 0, "date": null, "campaignId": 0, "campaignName": null, "maxBid": 0, "startTime": 0, "endTime": 0, "campaignType": null, "status": null, "mappingDataCost": 0, "mappingSpent": 0, "campaignTimezone": null, "creativeType": null, "budgetPacing": false, "isCampaignFromNewPlatform": false, "percentageOfTotalSpent": 0, "vldInsightsCost": 12.33, "workspaceVLDInsightsEarnings": 2.33, "platformVLDInsightsEarnings": 10, "pldInsightsCost": 12.33, "workspacePLDInsightsEarnings": 2.33, "platformPLDInsightsEarnings": 10, "slsInsightsCost": 12.33, "workspaceSLSInsightsEarnings": 2.33, "platformSLSInsightsEarnings": 10, "uowId": 0, "audioVideoViewed": 0, "ioId": 0, "ioName": null, "ioTimezone": 0, "ioBudgetDistributionMethod": 0, "exchangeId": 0, "exchangeName": null, "autoSumToTotalBudget": false, "adServingCost": 0, "thirdPartyCost": 2.75, "CTR": 0, "VCR": 0, "CVR": 0 } ] } } }, "Report and total of report data": { "description": "Report and total of report data", "value": { "success": true, "data": { "totalRecords": 322, "filteredRecords": 322, "recordsTotal": { "clicks": 0, "totalCount": 322, "winRate": 0, "logoURL": null, "avatarURL": null, "budgetDay": 1.8985625880766135e+307, "budgetSpent": 3000, "budgetTotal": 5.9e+307, "dataCost": 0, "mediaBudget": 4, "owId": 0, "orgId": 0, "impressions": 0, "industry": 0, "mediaSpent": 0, "spent": 0, "workspaceSpent": 0, "platformSpent": 0, "customerSpent": 0, "platformMediaEarning": 0, "platformBidShadingEarning": 0, "platformTotalEarning": 0, "workspaceMediaEarning": 0, "workspaceBidShadingEarning": 0, "workspaceTotalEarning": 0, "organizationBidShadingSaving": 0, "organizationName": null, "companySize": 0, "workspaceName": null, "workspaceId": 0, "workspaceDomain": null, "workspaceOrganizationName": null, "bidImpressions": 0, "startCount": 0, "firstCount": 0, "midCount": 0, "thirdCount": 0, "completeCount": 0, "audioVideoActualBids": 0, "audioVideoActualImpressions": 0, "eCPC": 0, "eCPM": 0, "eCPI": 0, "eCPCV": 0, "eCPV": 0, "totalAttributedConversion": 0, "totalAttributedViewThroughConversion": 0, "totalAttributedClickThroughConversion": 0, "costPerAttributedConversion": 0, "totalAttributedConversionRate": 0, "reach": 0, "frequency": 0, "date": null, "campaignId": 0, "campaignName": null, "maxBid": 0, "startTime": 0, "endTime": 0, "campaignType": null, "status": null, "mappingDataCost": 0, "mappingSpent": 0, "campaignTimezone": null, "creativeType": null, "budgetPacing": false, "isCampaignFromNewPlatform": false, "percentageOfTotalSpent": 0, "vldInsightsCost": 12.33, "workspaceVLDInsightsEarnings": 2.33, "platformVLDInsightsEarnings": 10, "pldInsightsCost": 12.33, "workspacePLDInsightsEarnings": 2.33, "platformPLDInsightsEarnings": 10, "slsInsightsCost": 12.33, "workspaceSLSInsightsEarnings": 2.33, "platformSLSInsightsEarnings": 10, "uowId": 0, "audioVideoViewed": 0, "ioId": 0, "ioName": null, "ioTimezone": 0, "ioBudgetDistributionMethod": 0, "exchangeId": 0, "exchangeName": null, "autoSumToTotalBudget": false, "adServingCost": 0, "thirdPartyCost": 2.75, "CTR": 0, "VCR": 0, "CVR": 0 }, "recordsList": [ { "clicks": 0, "totalCount": 0, "winRate": 0, "logoURL": null, "avatarURL": "https://iqm-web-assets-c92d6b6cbde1-stage.s3.amazonaws.com/avatar/TA.png", "budgetDay": 65.69, "budgetSpent": 0, "budgetTotal": 1000, "dataCost": 0, "mediaBudget": 0, "owId": 202162, "orgId": 5566, "impressions": 0, "industry": 0, "mediaSpent": 0, "spent": 0, "workspaceSpent": 0, "platformSpent": 0, "customerSpent": 0, "platformMediaEarning": 0, "platformBidShadingEarning": 0, "platformTotalEarning": 0, "workspaceMediaEarning": 0, "workspaceBidShadingEarning": 0, "workspaceTotalEarning": 0, "organizationBidShadingSaving": 0, "organizationName": "Test Adv account", "companySize": 0, "workspaceName": "stageadv1", "workspaceId": 1053, "workspaceDomain": "stageadv1.stage.applift.com", "workspaceOrganizationName": "Test Organisation - Meera", "bidImpressions": 0, "startCount": 0, "firstCount": 0, "midCount": 0, "thirdCount": 0, "completeCount": 0, "audioVideoActualBids": 0, "audioVideoActualImpressions": 0, "eCPC": 0, "eCPM": 0, "eCPI": 0, "eCPCV": 0, "eCPV": 0, "totalAttributedConversion": 0, "totalAttributedViewThroughConversion": 0, "totalAttributedClickThroughConversion": 0, "costPerAttributedConversion": 0, "totalAttributedConversionRate": 0, "reach": 0, "frequency": 0, "date": null, "campaignId": 0, "campaignName": null, "maxBid": 0, "startTime": 0, "endTime": 0, "campaignType": null, "status": null, "mappingDataCost": 0, "mappingSpent": 0, "campaignTimezone": null, "creativeType": null, "budgetPacing": false, "isCampaignFromNewPlatform": false, "percentageOfTotalSpent": 0, "vldInsightsCost": 12.33, "workspaceVLDInsightsEarnings": 2.33, "platformVLDInsightsEarnings": 10, "pldInsightsCost": 12.33, "workspacePLDInsightsEarnings": 2.33, "platformPLDInsightsEarnings": 10, "slsInsightsCost": 12.33, "workspaceSLSInsightsEarnings": 2.33, "platformSLSInsightsEarnings": 10, "uowId": 0, "audioVideoViewed": 0, "ioId": 0, "ioName": null, "ioTimezone": 0, "ioBudgetDistributionMethod": 0, "exchangeId": 0, "exchangeName": null, "autoSumToTotalBudget": false, "adServingCost": 0, "thirdPartyCost": 2.75, "CTR": 0, "VCR": 0, "CVR": 0 } ] } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden !" } ] } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Invalid sortBy value." } ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/das/report/by-campaign": { "post": { "tags": [ "Dashboard API" ], "summary": "Get campaign's performance by campaign's report data.", "description": "This API fetches campaign's performance by campaign's report data as per the given filters in the request body.", "operationId": "dashboard-report-by-campaign", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "sortCriteriaMap": { "type": "object", "additionalProperties": { "type": "string" } }, "columns": { "type": "array", "items": { "type": "object", "additionalProperties": { "type": "object" } } }, "startDate": { "type": "integer", "format": "int64" }, "endDate": { "type": "integer", "format": "int64" }, "timezoneId": { "type": "integer", "format": "int32" }, "timezoneName": { "type": "string" }, "resultType": { "type": "string" }, "campaignStatus": { "type": "string" }, "campaignStatusList": { "type": "array", "items": { "type": "string" } }, "creativeTypeIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "owIds": { "type": "string" }, "owIdsList": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "workspaceOwIdsList": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "customerOwIdsList": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "tab": { "type": "string" }, "dayDiff": { "type": "integer", "format": "int64" }, "download": { "type": "boolean" }, "fileType": { "type": "string" }, "fileName": { "type": "string" }, "campaignIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "campaignGroupIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "isAudienceFlagsRequired": { "type": "boolean" }, "loggedInUowId": { "type": "integer", "format": "int32" }, "graphType": { "type": "string" }, "ioIdsList": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "ioStatusIdsList": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "ids": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "budgetTypeIdList": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "campaignTypeIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "organizationType": { "type": "string" }, "campaignRequest": { "type": "boolean" }, "dataQueryEligible": { "type": "boolean" }, "totalQueryEligible": { "type": "boolean" }, "pageNo": { "type": "integer", "format": "int32" }, "noOfEntries": { "type": "integer", "format": "int32" }, "sortBy": { "type": "string" }, "searchField": { "type": "string" }, "order": { "type": "string", "enum": [ "SortOrderEnum[id=1, name='asc', symbol='+']", "SortOrderEnum[id=2, name='desc', symbol='-']" ] }, "isGraph": { "type": "boolean" }, "isBetaUser": { "type": "boolean" } } }, "examples": { "Total of report data": { "description": "Total of report data", "value": { "startDate": "1660834800000", "endDate": "1660834800001", "timezoneId": 1, "campaignStatus": "all", "creativeTypeIds": "", "searchField": "", "sortBy": "impressions", "order": "DESC", "owIds": "1,2,3,4", "pageNo": 1, "noOfEntries": 50, "resultType": "total", "ioIdsList": [1, 2, 3], "campaignTypeIds": [1], "campaignIds": "1,2,3" } }, "Report data": { "description": "Report data", "value": { "startDate": "1660834800000", "endDate": "1660834800001", "timezoneId": 1, "campaignStatus": "all", "creativeTypeIds": "", "searchField": "", "sortBy": "impressions", "order": "DESC", "owIds": "1,2,3,4", "pageNo": 1, "noOfEntries": 50, "resultType": "data", "ioIdsList": [1, 2, 3], "campaignTypeIds": [1], "campaignIds": "1,2,3" } }, "Report and total of report data": { "description": "Report and total of report data", "value": { "startDate": "1660834800000", "endDate": "1660834800001", "timezoneId": 1, "campaignStatus": "all", "creativeTypeIds": "", "searchField": "", "sortBy": "impressions", "order": "DESC", "owIds": "1,2,3,4", "pageNo": 1, "noOfEntries": 50, "campaignTypeIds": [1], "ioIdsList": [1, 2, 3] } }, "Report data for particular campaign id at top": { "description": "Report data for particular campaign id at top", "value": { "startDate": "1660834800000", "endDate": "1660834800001", "timezoneId": 1, "campaignStatus": "all", "ids": [1, 2], "creativeTypeIds": "", "searchField": "", "sortBy": "impressions", "order": "DESC", "owIds": "1,2,3,4", "pageNo": 1, "noOfEntries": 50, "resultType": "data", "budgetTypeIdList": [1, 2], "campaignTypeIds": [1], "ioIdsList": [1, 2, 3] } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Total of report data": { "description": "Total of report data", "value": { "success": true, "data": { "totalRecords": 1, "filteredRecords": 1, "recordsTotal": { "clicks": 0, "totalCount": 1, "winRate": 0, "logoURL": null, "avatarURL": null, "budgetDay": 4.55, "budgetSpent": 0, "budgetTotal": 100, "dataCost": 0, "mediaBudget": 0, "owId": 0, "orgId": 0, "impressions": 0, "industry": 0, "mediaSpent": 0, "spent": 0, "workspaceSpent": 0, "platformSpent": 0, "customerSpent": 0, "adServingCost": 0, "thirdPartyCost": 2.75, "organizationBidShadingSaving": 0, "platformMediaEarning": 0, "platformBidShadingEarning": 0, "platformTotalEarning": 0, "workspaceMediaEarning": 0, "workspaceBidShadingEarning": 0, "workspaceTotalEarning": 0, "organizationName": null, "companySize": 0, "workspaceName": null, "workspaceId": 0, "workspaceDomain": null, "workspaceOrganizationName": null, "bidImpressions": 0, "startCount": 0, "firstCount": 0, "midCount": 0, "thirdCount": 0, "completeCount": 0, "audioVideoActualBids": 0, "audioVideoActualImpressions": 0, "eCPC": 0, "totalECPC": 0, "eCPM": 0, "totalECPM": 0, "eCPI": 0, "eCPCV": 0, "eCPV": 0, "dailyImpression": 202, "totalAttributedConversion": 0, "totalAttributedViewThroughConversion": 0, "totalAttributedClickThroughConversion": 0, "costPerAttributedConversion": 0, "totalAttributedConversionRate": 0, "reach": null, "frequency": null, "date": null, "campaignId": 0, "campaignName": null, "maxBid": 0, "minBid": 0, "baseBid": 0, "startTime": 0, "endTime": 0, "campaignType": null, "status": null, "mappingDataCost": 0, "mappingSpent": 0, "campaignTimezone": null, "creativeType": null, "budgetPacing": false, "isCampaignFromNewPlatform": false, "percentageOfTotalSpent": 0, "uowId": 0, "audioVideoViewed": 0, "ioId": 0, "ioName": null, "ioTimezone": 0, "ioBudgetDistributionMethod": 0, "ioStartTime": 0, "ioStatusId": 0, "ioEndTime": 0, "ioTotalBudget": 0, "pacingPercentage": null, "actualSpent": 0, "expectedSpent": 0, "campaignDuration": null, "remainingDuration": 0, "dailyPacingPercentage": null, "expectedDailySpent": 0, "actualDailySpent": 0, "isAutoSumIoTotalBudget": false, "exchangeId": 0, "budgetTypeId": 0, "campaignTypeId": 0, "isEligibleForVLDInsightsReport": false, "vldInsightsCost": null, "workspaceVLDInsightsEarnings": null, "platformVLDInsightsEarnings": null, "isEligibleForSLSInsightsReport": false, "slsInsightsCost": 12.33, "workspaceSLSInsightsEarnings": 2.33, "platformSLSInsightsEarnings": 10, "isEligibleForICTInsightsReport": false, "ictInsightsCost": 12.33, "workspaceICTInsightsEarnings": 2.33, "platformICTInsightsEarnings": 10, "isEligibleForNLDInsightsReport": false, "nldInsightsCost": 12.33, "workspaceNLDInsightsEarnings": 2.33, "platformNLDInsightsEarnings": 10, "pldInsightsCost": 12.33, "workspacePLDInsightsEarnings": 2.33, "platformPLDInsightsEarnings": 10, "isEligibleForPLDInsightsReport": true, "targetImpression": 132629714, "creativesCount": 0, "budgetTotalCombined": 100, "budgetDayCombined": 10, "ioTotalBudgetCombined": 0, "campaignPriority": null, "bidModelDataId": 0, "exchangeName": null, "CTR": 0, "VCR": 0, "CVR": 0 } } } }, "Report data": { "description": "Report data", "value": { "success": true, "data": { "totalRecords": 0, "filteredRecords": 0, "recordsList": [ { "clicks": 0, "totalCount": 0, "winRate": 0, "logoURL": null, "avatarURL": null, "budgetDay": 4.55, "budgetSpent": 0, "budgetTotal": 100, "dataCost": 0, "mediaBudget": 0, "owId": 201427, "orgId": 0, "impressions": 0, "industry": 0, "mediaSpent": 0, "spent": 0, "workspaceSpent": 0, "platformSpent": 0, "organizationBidShadingSaving": 0, "customerSpent": 0, "platformMediaEarning": 0, "platformBidShadingEarning": 0, "platformTotalEarning": 0, "workspaceMediaEarning": 0, "workspaceBidShadingEarning": 0, "workspaceTotalEarning": 0, "organizationName": "Stage Shared AdvertiserX", "companySize": 0, "workspaceName": null, "workspaceId": 0, "workspaceDomain": null, "workspaceOrganizationName": null, "bidImpressions": 0, "startCount": 0, "firstCount": 0, "midCount": 0, "thirdCount": 0, "completeCount": 0, "audioVideoActualBids": 0, "audioVideoActualImpressions": 0, "eCPC": 0, "totalECPC": 0, "eCPM": 0, "totalECPM": 0, "eCPI": 0, "eCPCV": 0, "eCPV": 0, "totalAttributedConversion": 0, "totalAttributedViewThroughConversion": 0, "totalAttributedClickThroughConversion": 0, "costPerAttributedConversion": 0, "totalAttributedConversionRate": 0, "reach": 0, "frequency": 0, "date": null, "campaignId": 334740, "campaignName": "Campaign 2", "maxBid": 10.25, "minBid": 5.34, "baseBid": 5, "startTime": 1692194400, "endTime": 1693461600, "campaignType": "cpv", "status": "pending", "mappingDataCost": 0, "mappingSpent": 0, "campaignTimezone": "US/Mountain", "creativeType": "Video", "budgetPacing": true, "isCampaignFromNewPlatform": true, "percentageOfTotalSpent": 0, "adServingCost": 0, "thirdPartyCost": 2.75, "uowId": 9481, "audioVideoViewed": 0, "dailyImpression": 202, "ioId": 625, "ioName": "IO name-1", "budgetTypeId": 2, "campaignTypeId": 1, "isEligibleForVLDInsightsReport": true, "vldInsightsCost": null, "workspaceVLDInsightsEarnings": null, "platformVLDInsightsEarnings": null, "isEligibleForSLSInsightsReport": true, "slsInsightsCost": 12.33, "workspaceSLSInsightsEarnings": 2.33, "platformSLSInsightsEarnings": 10, "isEligibleForICTInsightsReport": false, "ictInsightsCost": 12.33, "workspaceICTInsightsEarnings": 2.33, "platformICTInsightsEarnings": 10, "pldInsightsCost": 12.33, "workspacePLDInsightsEarnings": 2.33, "platformPLDInsightsEarnings": 10, "isEligibleForPLDInsightsReport": true, "targetImpression": 1326, "creativesCount": 4, "ioTimezone": 29, "ioStatusId": 1, "ioBudgetDistributionMethod": 0, "ioStartTime": 1691735117664, "ioEndTime": 1691821517664, "ioTotalBudget": 0, "pacingPercentage": 12.31, "actualSpent": 123, "expectedSpent": 212, "campaignDuration": 5, "remainingDuration": 2, "dailyPacingPercentage": null, "expectedDailySpent": 123, "actualDailySpent": 0, "isAutoSumIoTotalBudget": false, "exchangeId": 0, "exchangeName": null, "budgetTotalCombined": 100, "budgetDayCombined": 10, "ioTotalBudgetCombined": 0, "campaignPriority": 2, "bidModelDataId": 965, "modelledDimensionIds": [1, 2, 3], "aiGoalId": 1, "CTR": 0, "VCR": 0, "CVR": 0 } ] } } }, "Report and total of report data with no prioritise campaign": { "description": "Report and total of report data with no prioritise campaign", "value": "{\n \"success\": true,\n \"data\": {\n \"totalRecords\": 1,\n \"filteredRecords\": 1,\n \"recordsTotal\": {\n \"clicks\": 0,\n \"totalCount\": 1,\n \"winRate\": 0,\n \"logoURL\": null,\n \"avatarURL\": null,\n \"budgetDay\": 4.55,\n \"budgetSpent\": 0,\n \"budgetTotal\": 100,\n \"dataCost\": 0,\n \"mediaBudget\": 0,\n \"owId\": 0,\n \"orgId\": 0,\n \"impressions\": 0,\n \"ivtImpressions\": 0,\n \"ivtClicks\": 0,\n \"industry\": 0,\n \"mediaSpent\": 0,\n \"spent\": 0,\n \"dailyImpression\": 202,\n \"workspaceSpent\": 0,\n \"platformSpent\": 0,\n \"organizationBidShadingSaving\": 0,\n \"customerSpent\": 0,\n \"platformMediaEarning\": 0,\n \"platformBidShadingEarning\": 0,\n \"platformTotalEarning\": 0,\n \"workspaceMediaEarning\": 0,\n \"workspaceBidShadingEarning\": 0,\n \"workspaceTotalEarning\": 0,\n \"organizationName\": null,\n \"companySize\": 0,\n \"workspaceName\": null,\n \"workspaceId\": 0,\n \"workspaceDomain\": null,\n \"workspaceOrganizationName\": null,\n \"bidImpressions\": 0,\n \"startCount\": 0,\n \"firstCount\": 0,\n \"midCount\": 0,\n \"thirdCount\": 0,\n \"completeCount\": 0,\n \"audioVideoActualBids\": 0,\n \"audioVideoActualImpressions\": 0,\n \"eCPC\": 0,\n \"totalECPC\": 0.0,\n \"eCPM\": 0,\n \"totalECPM\": 0,\n \"eCPI\": 0,\n \"eCPCV\": 0,\n \"eCPV\": 0,\n \"totalAttributedConversion\": 0,\n \"totalAttributedViewThroughConversion\": 0,\n \"totalAttributedClickThroughConversion\": 0,\n \"costPerAttributedConversion\": 0,\n \"totalAttributedConversionRate\": 0,\n \"reach\": null,\n \"frequency\": null,\n \"date\": null,\n \"campaignId\": 0,\n \"campaignName\": null,\n \"maxBid\": 0,\n \"minBid\": 0,\n \"baseBid\": 0,\n \"startTime\": 0,\n \"endTime\": 0,\n \"campaignType\": null,\n \"status\": null,\n \"mappingDataCost\": 0,\n \"mappingSpent\": 0,\n \"campaignTimezone\": null,\n \"creativeType\": null,\n \"budgetPacing\": false,\n \"isCampaignFromNewPlatform\": false,\n \"percentageOfTotalSpent\": 0,\n \"uowId\": 0,\n \"audioVideoViewed\": 0,\n \"ioId\": 0,\n \"ioName\": null,\n \"ioTimezone\": 0,\n \"ioBudgetDistributionMethod\": 0,\n \"ioStartTime\": 0,\n \"ioEndTime\": 0,\n \"ioStatusId\": 0,\n \"ioTotalBudget\": 0,\n \"pacingPercentage\": null,\n \"actualSpent\": 0,\n \"expectedSpent\": 0,\n \"campaignDuration\": null,\n \"remainingDuration\": 0,\n \"dailyPacingPercentage\": null,\n \"expectedDailySpent\": 0,\n \"actualDailySpent\": 0,\n \"isAutoSumIoTotalBudget\": false,\n \"exchangeId\": 0,\n \"budgetTypeId\": 0,\n \"campaignTypeId\": 0,\n \"isEligibleForVLDInsightsReport\": true,\n \"vldInsightsCost\": null,\n \"workspaceVLDInsightsEarnings\": null,\n \"platformVLDInsightsEarnings\": null,\n \"isEligibleForSLSInsightsReport\": true,\n \"slsInsightsCost\": 12.33,\n \"workspaceSLSInsightsEarnings\": 2.33,\n \"platformSLSInsightsEarnings\": 10,\n \"isEligibleForICTInsightsReport\": false,\n \"ictInsightsCost\": 12.33,\n \"workspaceICTInsightsEarnings\": 2.33,\n \"platformICTInsightsEarnings\": 10,\n \"isEligibleForNLDInsightsReport\": false,\n \"nldInsightsCost\": 12.33,\n \"workspaceNLDInsightsEarnings\": 2.33,\n \"platformNLDInsightsEarnings\": 10,\n \"pldInsightsCost\": 12.33,\n \"workspacePLDInsightsEarnings\": 2.33,\n \"platformPLDInsightsEarnings\": 10,\n \"isEligibleForPLDInsightsReport\": true,\n \"budgetTotalCombined\": 100,\n \"budgetDayCombined\": 10,\n \"ioTotalBudgetCombined\": 0,\n \"campaignPriority\": null,\n \"bidModelDataId\": 0,\n \"targetImpression\": 132629714,\n \"creativesCount\": 0,\n \"exchangeName\": null,\n \"adServingCost\" : 0.0,\n \"thirdPartyCost\": 2.75,\n \"CTR\": 0,\n \"VCR\": 0,\n \"CVR\": 0\n },\n \"recordsList\": [\n {\n \"clicks\": 0,\n \"totalCount\": 0,\n \"winRate\": 0,\n \"logoURL\": null,\n \"avatarURL\": null,\n \"budgetDay\": 4.55,\n \"budgetSpent\": 0,\n \"budgetTotal\": 100,\n \"dataCost\": 0,\n \"mediaBudget\": 0,\n \"owId\": 201427,\n \"orgId\": 0,\n \"impressions\": 0,\n \"ivtImpressions\": 0,\n \"ivtClicks\": 0,\n \"industry\": 0,\n \"mediaSpent\": 0,\n \"spent\": 0,\n \"workspaceSpent\": 0,\n \"platformSpent\": 0,\n \"customerSpent\": 0,\n \"platformMediaEarning\": 0,\n \"platformBidShadingEarning\": 0,\n \"platformTotalEarning\": 0,\n \"workspaceMediaEarning\": 0,\n \"workspaceBidShadingEarning\": 0,\n \"workspaceTotalEarning\": 0,\n \"organizationBidShadingSaving\": 0,\n \"dailyImpression\": 202,\n \"organizationName\": \"Stage Shared AdvertiserX\",\n \"companySize\": 0,\n \"workspaceName\": null,\n \"workspaceId\": 0,\n \"workspaceDomain\": null,\n \"workspaceOrganizationName\": null,\n \"bidImpressions\": 0,\n \"startCount\": 0,\n \"firstCount\": 0,\n \"midCount\": 0,\n \"thirdCount\": 0,\n \"completeCount\": 0,\n \"audioVideoActualBids\": 0,\n \"audioVideoActualImpressions\": 0,\n \"eCPC\": 0,\n \"totalECPC\": 0.0,\n \"eCPM\": 0,\n \"totalECPM\": 0,\n \"eCPI\": 0,\n \"eCPCV\": 0,\n \"eCPV\": 0,\n \"totalAttributedConversion\": 0,\n \"totalAttributedViewThroughConversion\": 0,\n \"totalAttributedClickThroughConversion\": 0,\n \"costPerAttributedConversion\": 0,\n \"totalAttributedConversionRate\": 0,\n \"reach\": 0,\n \"frequency\": 0,\n \"date\": null,\n \"campaignId\": 334740,\n \"campaignName\": \"Campaign 2\",\n \"maxBid\": 10.25,\n \"minBid\": 5.34,\n \"baseBid\": 5,\n \"startTime\": 1692194400,\n \"endTime\": 1693461600,\n \"campaignType\": \"cpv\",\n \"status\": \"pending\",\n \"mappingDataCost\": 0,\n \"mappingSpent\": 0,\n \"campaignTimezone\": \"US/Mountain\",\n \"creativeType\": \"Video\",\n \"budgetPacing\": true,\n \"isCampaignFromNewPlatform\": true,\n \"percentageOfTotalSpent\": 0,\n \"uowId\": 9481,\n \"audioVideoViewed\": 0,\n \"ioId\": 625,\n \"ioName\": \"IO Name-1\",\n \"ioTimezone\": 29,\n \"ioStatusId\": 1,\n \"ioBudgetDistributionMethod\": 0,\n \"ioStartTime\": 1691735117664,\n \"ioEndTime\": 1691821517664,\n \"ioTotalBudget\": 0,\n \"pacingPercentage\": 12.31,\n \"actualSpent\": 123,\n \"expectedSpent\": 212,\n \"campaignDuration\": 5,\n \"remainingDuration\": 2,\n \"dailyPacingPercentage\": null,\n \"expectedDailySpent\": 123,\n \"actualDailySpent\": 0,\n \"isAutoSumIoTotalBudget\": false,\n \"budgetTypeId\": 1,\n \"campaignTypeId\": 1,\n \"isEligibleForVLDInsightsReport\": true,\n \"vldInsightsCost\": 12.33,\n \"workspaceVLDInsightsEarnings\": 2.33,\n \"platformVLDInsightsEarnings\": 10,\n \"isEligibleForSLSInsightsReport\": true,\n \"slsInsightsCost\": 12.33,\n \"workspaceSLSInsightsEarnings\": 2.33,\n \"platformSLSInsightsEarnings\": 10,\n isEligibleForICTInsightsReport\": false,\n \"ictInsightsCost\": 12.33,\n \"workspaceICTInsightsEarnings\": 2.33,\n \"platformICTInsightsEarnings\": 10,\n \"pldInsightsCost\": 12.33,\n \"workspacePLDInsightsEarnings\": 2.33,\n \"platformPLDInsightsEarnings\": 10,\n \"isEligibleForPLDInsightsReport\": true,\n \"targetImpression\": null,\n \"creativesCount\": 2,\n \"exchangeId\": 0,\n \"exchangeName\": null,\n \"budgetTotalCombined\": 100,\n \"budgetDayCombined\": 10,\n \"ioTotalBudgetCombined\": 0,\n \"adServingCost\" : 0.0,\n \"thirdPartyCost\": 2.75,\n \"campaignPriority\": null,\n \"bidModelDataId\": 0,\n \"modelledDimensionIds\": [1,2,3],\n \"aiGoalId\": 1,\n \"CTR\": 0,\n \"VCR\": 0,\n \"CVR\": 0\n }\n ]\n }\n}\n" } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden !" } ] } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Invalid sortBy value." } ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/das/dashboard": { "post": { "tags": [ "Dashboard API" ], "summary": "Create Dashboard API", "description": "This API allows user to create/store a dashboard configuration.", "operationId": "createDashboardAPI", "parameters": [ { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" } ], "requestBody": { "description": "Request Body for Create Dashboard Configuration", "content": { "application/json": { "schema": { "type": "object", "properties": { "label": { "type": "string" }, "data": { "type": "object", "additionalProperties": { "type": "object" } } } }, "examples": { "Map of Dashboard Configuration": { "description": "Map of Dashboard Configuration", "value": { "dashboardName": "sample name", "data": { "timezone": { "label": "US/Eastern", "value": "US/Eastern", "id": 29 }, "dimension": { "id": 1, "label": "Campaign", "order": 1, "fieldDataType": "text", "description": "Campaign Name", "tooltipDescription": null, "groupId": 1, "key": "campaign", "isFilterSupported": true, "isCustomerDependent": true, "isRowToColumn": false, "value": "campaign" }, "metric": { "id": 9, "label": "CTR", "order": 5, "fieldDataType": "percent", "aggregationType": "avg", "description": "Click-through rate is the percentage of Clicks received per the Impressions served", "defaultEnabled": true, "key": "CTR", "dependentDimensions": null, "value": "CTR" }, "filteredCampaignsIds": [], "selectedCampaigns": [], "selectedInsertionOrders": [], "ioBudgetTypes": [], "campaignTypeIds": [], "advertisersOwIds": "", "workspacesOwIds": "", "isAllAdvertisersSelected": true, "sidebarOpened": false, "lastModified": 1768302164, "sortingGroupsColumns": [], "filteredGroupsIds": [] } } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "examples": { "Create Dashboard example": { "description": "Create Dashboard example", "value": { "success": true, "data": { "id": 960, "message": "qwerty-1-34 has been created!" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden !" } ] } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "examples": { "dashboard name empty error": { "description": "dashboard name empty error", "value": { "success": false, "errorObjects": [ { "error": "Dashboard name cannot be empty" } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } }, "delete": { "tags": [ "Dashboard API" ], "summary": "Delete Dashboard API", "description": "This API allows the user to delete valid dashboard configuration of a user.", "operationId": "deleteDashboardAPI", "parameters": [ { "name": "id", "in": "query", "description": "Dashboard Id which needs to be deleted.", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "examples": { "Response Message for Delete Dashboard": { "description": "Response Message for Delete Dashboard", "value": { "success": true, "data": { "message": "sample dashboard has been deleted" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden !" } ] } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "examples": { "Invalid Dashboard Id for Delete": { "description": "Invalid Dashboard Id for Delete", "value": { "success": false, "errorObjects": [ { "error": "Dashboard not found for delete" } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/internal/das/io/campaign/budget-impression/info": { "get": { "tags": [ "Dashboard API" ], "summary": "Get IOs campaign's budget and spent information.", "description": "This API provides the IOs campaign's budget and spent.", "operationId": "getCampaignIOBudgetImpressionInfo", "parameters": [ { "name": "ioIds", "in": "query", "description": "string of comma separated io ids.", "required": true, "schema": { "type": "string" } }, { "name": "owId", "in": "query", "description": "ow id of the IO Ids.", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Successful API response sample": { "description": "Successful API response sample", "value": { "success": true, "data": { "1": { "totalAllocatedBudget": 0.01154397815666, "totalSpentBudget": 0.01154397815666, "totalAllocatedImpression": 0, "totalSpentImpression": 0, "totalImpressions": 0, "totalBudget": 0.011543 }, "2": { "totalAllocatedBudget": 5, "totalSpentBudget": 0, "totalAllocatedImpression": 0, "totalSpentImpression": 0, "totalImpressions": 0, "totalBudget": 6 }, "3": { "totalAllocatedBudget": 5, "totalSpentBudget": 0, "totalAllocatedImpression": 0, "totalSpentImpression": 0, "totalImpressions": 0, "totalBudget": 9 } } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden !" } ] } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "examples": { "Unprocessable entity": { "description": "Unprocessable entity", "value": { "success": false, "errorObjects": [ { "error": "Invalid owId." } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/das/goal-ai/optimization-report/campaign/{campaign_id}": { "get": { "tags": [ "Dashboard API" ], "summary": "Get Campaign Goal-AI Graph Data", "description": "This API fetches campaign's goal-ai Goal's performance by campaign", "operationId": "getGoalAIOptimizationReport", "parameters": [ { "name": "campaign_id", "in": "path", "description": "Unique Identifier for Campaign", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Goal-AI Optimization Report": { "description": "Goal-AI Optimization Report", "value": "{\n \"success\": true,\n \"data\": {\n \"average\": 88.0,\n \"withAI\": 20.45.0,\n \"withoutAI\": 68.45.0,\n \"lift\": 51.01,\n \"graphData\": [\n {\n \"date\": 12399999000,\n \"actualKPI\": 45.34\n },\n {\n \"date\": 12399989000,\n \"actualKPI\": 88.34\n }\n ],\n \"campaignOptimization\": {\n \"aiObjectiveId\": 2,\n \"aiGoalId\": 10,\n \"aiTargetKpi\": 60.0\n }\n }\n }\n" } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden !" } ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/das/goal-ai/optimization-activity/campaign/{campaignId}": { "get": { "tags": [ "Dashboard API" ], "summary": "Get the Goal-AI Optimization Activities for Campaign", "description": "This API fetches the Goal-AI Optimization Activities for a given Campaign", "operationId": "getGoalAIOptimizationActivities", "parameters": [ { "name": "campaignId", "in": "path", "description": "Unique Identifier for Campaign", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "dayEpoch", "in": "query", "description": "Day Epoch for which activities are to be fetched", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "searchField", "in": "query", "description": "Search field to filter activities", "required": true, "schema": { "type": "string" } }, { "name": "pageNo", "in": "query", "description": "Page number for pagination", "required": true, "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "noOfEntries", "in": "query", "description": "Number of entries per page", "required": true, "schema": { "type": "integer", "format": "int32", "default": 50 } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Goal-AI Optimization Activities": { "description": "Goal-AI Optimization Activities", "value": { "success": true, "data": { "activities": [ { "date": "2025-11-12", "time": "12:20:07", "action": "Spent Ratio Updated", "dimension": "Zip Code: 10796", "value": "54%", "timeEpoch": 1762930207 }, { "date": "2025-11-12", "time": "12:20:07", "action": "Spent Ratio Updated", "dimension": "City: Brooklyn, NY", "value": "87%", "timeEpoch": 1762930207 }, { "date": "2025-11-12", "time": "12:20:07", "action": "Spent Ratio Updated", "dimension": "Exchange: Pubmatic", "value": "24%", "timeEpoch": 1762930207 } ] } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden !" } ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/das/goal-ai/optimization-activity/campaign/{campaignId}/download": { "get": { "tags": [ "Dashboard API" ], "summary": "Get the Goal-AI Optimization Activities for Campaign Download in a File", "description": "This API fetches the Goal-AI Optimization Activities for a given Campaign Download as per the file type", "operationId": "getGoalAIOptimizationActivitiesDownload", "parameters": [ { "name": "campaignId", "in": "path", "description": "Unique Identifier for Campaign", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "dayEpoch", "in": "query", "description": "Day Epoch for which activities are to be fetched", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "searchField", "in": "query", "description": "Search field to filter activities", "required": true, "schema": { "type": "string" } }, { "name": "fileType", "in": "query", "description": "File type for download - currently supported file type is 'csv'", "required": true, "schema": { "type": "string", "default": "csv" } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Goal-AI Optimization Activities file download URL": { "description": "Goal-AI Optimization Activities file download URL", "value": { "success": true, "data": { "url": "https://url.sample.com" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden !" } ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/das/dashboards": { "get": { "tags": [ "Dashboard API" ], "summary": "Dashboard listing API for user", "description": "This API provides list of dashboard configurations for user.", "operationId": "getDashBoardList", "parameters": [ { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "examples": { "List of Dashboard Configurations": { "description": "List of Dashboard Configurations", "value": { "success": true, "data": { "totalRecords": 1, "filteredRecords": 1, "items": [ { "data": { "freeze": { "rows": 0, "columns": 0 }, "metric": { "id": 9, "key": "CTR", "label": "CTR", "order": 5, "value": "CTR", "description": "Click-through rate is the percentage of Clicks received per the Impressions served", "fieldDataType": "percent", "defaultEnabled": true, "aggregationType": "avg" }, "search": "578469", "status": { "label": "Running (1091)", "value": "running" }, "timezone": { "id": 29, "label": "US/Eastern", "value": "US/Eastern" }, "dimension": { "id": 1, "key": "campaign", "label": "Campaign", "order": 1, "value": "campaign", "groupId": 1, "description": "Campaign Name", "fieldDataType": "text", "isRowToColumn": false, "isFilterSupported": true, "isCustomerDependent": true }, "tableLevel": { "label": "Campaigns", "value": "campaigns" }, "lastModified": 1767770721, "ioBudgetTypes": [], "sidebarOpened": false, "sortingColumns": [ { "label": "ID", "value": "campaignId", "active": true, "alwaysEnabled": true, "draggableGroup": 1 }, { "label": "Campaign Name", "value": "campaignName", "active": true, "alwaysEnabled": true, "draggableGroup": 1 }, { "deep": 1, "label": "Pre-bid Cost ($)", "value": "prebidCost", "active": true, "isActive": false } ], "campaignTypeIds": [], "workspacesOwIds": "", "advertisersOwIds": "", "filteredGroupsIds": [], "selectedCampaigns": [], "filteredCampaignsIds": [], "sortingGroupsColumns": [], "selectedCreativeTypes": [], "selectedInsertionOrders": [], "sortingExchangesColumns": [ { "label": "ID", "value": "exchangeId", "active": true, "alwaysEnabled": true, "draggableGroup": 1 }, { "label": "Exchange Name", "value": "exchangeName", "active": true, "alwaysEnabled": true, "draggableGroup": 1 }, { "label": "Pre-bid Cost ($)", "value": "prebidCost", "active": true } ], "isAllAdvertisersSelected": true, "sortingWorkspacesColumns": [ { "label": "ID", "value": "workspaceId", "active": true, "alwaysEnabled": true, "draggableGroup": 1 }, { "label": "Workspace VLD Insights Earnings ($)", "value": "workspaceVLDInsightsEarnings", "active": true } ], "sortingAdvertisersColumns": [ { "label": "ID", "value": "owId", "active": true, "alwaysEnabled": true, "draggableGroup": 1 }, { "label": "Workspace VLD Insights Earnings ($)", "value": "workspaceVLDInsightsEarnings", "active": true } ], "sortingInsertionOrdersColumns": [ { "label": "ID", "order": 1, "value": "ioId", "active": true, "alwaysEnabled": true, "draggableGroup": 1 }, { "label": "Impressions", "order": 31, "value": "impressions", "active": true }, { "label": "Clicks", "order": 33, "value": "clicks", "active": true }, { "label": "Attributed Conversions", "order": 37, "value": "totalAttributedConversion", "active": true } ] }, "created": 1758108745, "modifiedDate": "2025-09-17T06:02:25.568+00:00", "id": 753, "label": "DV Prebid dashboard" } ] } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden !" } ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/asset": { "post": { "tags": [ "Asset API" ], "summary": "Add Multiple Assets to the System", "description": "This API is used for adding multiple assets to the system. It accepts an array of multipart files along with their associated metadata in JSON format.\n1. The 'files' parameter should contain the files to be uploaded.\n2. The 'filesMetadata' parameter should be a JSON string that provides metadata for each file. This metadata includes the attached file name,\noriginal file name and an optional key (default set to false) for whether the file is disposable.\n3. The API returns a map where each key is the original file name and the value is an AddAssetResponseVO containing details about the uploaded asset.\n4. Appropriate error responses are provided for invalid inputs or unauthorized access.\n", "operationId": "addAssets", "parameters": [ { "name": "files", "in": "query", "description": "An array of multipart files to be uploaded as assets.", "required": true, "schema": { "type": "array", "format": "binary" } }, { "name": "filesMetadata", "in": "query", "description": "A JSON string representing the metadata associated with the files.", "required": true, "schema": { "type": "string" }, "example": [ { "attachedFileName": "a0a1b3ca-2455-4bf5-9950-87c74455ead9~image.png", "originalFileName": "image.png", "disposable": true } ] }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "examples": { "Assets added successfully": { "description": "Assets added successfully", "value": { "success": true, "data": { "9d41a99a-9761-44cf-a3db-307a57b65795.jpg": { "assetID": 697, "assetCDNURL": "https://cdn.example.com/assets/123456/IHp2jMI_1704987233847.jpg" } } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden !" } ] } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "examples": { "File metadata not provided": { "description": "File metadata not provided", "value": { "success": false, "errorObjects": [ { "error": "Please pass File(s) metaData" } ] } }, "Multipart files not provided": { "description": "Multipart files not provided", "value": { "success": false, "errorObjects": [ { "error": "Please attach file(s)" } ] } }, "File metadata is not a valid JSON": { "description": "File metadata is not a valid JSON", "value": { "success": false, "errorObjects": [ { "error": "Please pass correct File(s) MetaData" } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/asset/{assetId}": { "get": { "tags": [ "Asset API" ], "summary": "Fetch Asset Details by Asset ID", "description": "This API is used for fetching the details of a single asset identified by its AssetID.\n1. The 'assetId' parameter should contain the ID of the asset to be fetched.\n2. The API returns the details of the asset including its storage path, CDN URL, creation timestamp, modification timestamp, and whether it is disposable.\n3. For HTML5 creative assets, the response includes assetDimensions (stored in JSONB format) and iframeHtml (ready-to-use iframe code).\n4. Appropriate error responses are provided for invalid inputs or unauthorized access.\n", "operationId": "getAssetDetails", "parameters": [ { "name": "assetId", "in": "path", "description": "The ID of the asset to fetch.", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "The unique identifier of the asset.", "format": "int32", "example": 12345 }, "storagePath": { "type": "string", "description": "The storage path of the asset file.", "example": "new/path/to/asset.jpg" }, "cdnUrl": { "type": "string", "description": "The CDN URL of the asset file.", "example": "https://cdn.example.com/assets/12345" }, "created": { "type": "integer", "description": "The timestamp epoch in milliseconds when the asset was created.", "format": "int64", "example": 1627847261000 }, "modifiedDate": { "type": "string", "description": "The timestamp when the asset was last modified.", "format": "date-time" }, "owId": { "type": "integer", "description": "The Organization Workspace ID associated with the asset.", "format": "int32", "example": 1001 }, "createdByUowId": { "type": "integer", "description": "The User Organization Workspace ID of the user who created the asset.", "format": "int32", "example": 2002 }, "modifiedByUowId": { "type": "integer", "description": "The User Organization Workspace ID of the user who last modified the asset.", "format": "int32", "example": 2003 }, "assetDimensions": { "type": "object", "properties": { "width": { "type": "integer", "format": "int32" }, "height": { "type": "integer", "format": "int32" } }, "description": "Dimensions of the asset (for HTML5 creatives). Contains width and height." }, "iframeHtml": { "type": "string", "description": "Ready-to-use iframe HTML code for HTML5 creatives. Only present for HTML5 creatives.", "example": "\u003Ciframe src=\"https://cdn.example.com/creative/index.html\" width=\"300\" height=\"250\" frameborder=\"0\" scrolling=\"no\" marginheight=\"0\" marginwidth=\"0\"\u003E\u003C/iframe\u003E" }, "zipFile": { "type": "boolean" }, "disposable": { "type": "boolean" }, "html5Creative": { "type": "boolean" } }, "description": "Response object representing the details of an asset." }, "examples": { "Regular asset details fetched successfully": { "description": "Regular asset details fetched successfully", "value": { "success": true, "data": { "id": 1, "storagePath": "assets/201427/tfteBYO_1704204958735.jpg", "cdnUrl": "https://cdn.example.com/assets/201427/tfteBYO_1704204958735.jpg", "created": 1704204961147, "modifiedDate": "2024-01-18T06:03:23.8230000", "isDisposable": true, "isZipFile": false, "isHtml5Creative": false, "assetDimensions": null, "iframeHtml": null } } }, "HTML5 creative asset details fetched successfully": { "description": "HTML5 creative asset details fetched successfully", "value": { "success": true, "data": { "id": 2, "storagePath": "assets/201427/randomPath/index.html", "cdnUrl": "https://cdn.example.com/assets/201427/randomPath/index.html", "created": 1704204971010, "modifiedDate": "2024-01-18T06:03:23.8230000", "isDisposable": false, "isZipFile": true, "isHtml5Creative": true, "assetDimensions": "{\"width\": \"300\", \"height\": \"250\"}", "iframeHtml": "\u003Ciframe src=\"https://cdn.example.com/assets/201427/randomPath/index.html\" width=\"300\" height=\"250\" frameborder=\"0\" scrolling=\"no\" marginheight=\"0\" marginwidth=\"0\"\u003E\u003C/iframe\u003E" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden !" } ] } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "examples": { "Asset not found": { "description": "Asset not found", "value": { "success": false, "errorObjects": [ { "error": "No Asset found with the Asset ID provided. Please provide a valid ID." } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } }, "delete": { "tags": [ "Asset API" ], "summary": "Delete Asset by Asset ID", "description": "This API is used for deleting a single asset identified by its AssetID.\n1. The 'assetId' parameter should contain the ID of the asset to be deleted.\n2. The API returns a confirmation message upon successful deletion of the asset.\n3. Appropriate error responses are provided for invalid inputs or unauthorized access.\n4. It is a soft delete; the asset is marked as deleted in the system but not permanently removed from storage.\n", "operationId": "deleteAsset", "parameters": [ { "name": "assetId", "in": "path", "description": "The ID of the asset to delete.", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "examples": { "Asset deleted successfully": { "description": "Asset deleted successfully", "value": { "success": true, "data": "Asset deleted successfully." } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden !" } ] } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "examples": { "Asset Not Found Response": { "description": "Asset Not Found Response", "value": { "success": false, "errorObjects": [ { "error": "No Asset found with the Asset ID provided. Please provide a valid ID." } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } }, "patch": { "tags": [ "Asset API" ], "summary": "Update Asset Details by Asset ID", "description": "This API is used for updating the details of a single asset identified by its AssetID.\n1. The 'assetId' parameter should contain the ID of the asset to be updated.\n2. The request body should contain the new details for the asset, including storage path, CDN URL,\nand optional disposable status.\n3. The API returns a confirmation message upon successful update of the asset details.\n4. Appropriate error responses are provided for invalid inputs or unauthorized access.\n", "operationId": "updateAssetDetails", "parameters": [ { "name": "assetId", "in": "path", "description": "The ID of the asset to update.", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "description": "The new details for the asset.", "content": { "application/json": { "schema": { "required": [ "cdnUrl", "storagePath" ], "type": "object", "properties": { "storagePath": { "type": "string", "description": "The storage path of the asset file.", "example": "updated/path/to/asset.jpg" }, "cdnUrl": { "type": "string", "description": "The CDN URL of the asset file.", "example": "https://cdn.example.com/updated/assets/12345" }, "disposable": { "type": "boolean", "description": "Indicates whether the asset is disposable.", "example": true } }, "description": "Request object for updating asset details." }, "examples": { "Asset Update Request Example": { "description": "Asset Update Request Example", "value": { "storagePath": "updated/path/to/asset.jpg", "cdnUrl": "https://cdn.example.com/updated/assets/12345", "disposable": true } } } } }, "required": true }, "responses": { "200": { "description": "Successful Update Response", "content": { "application/json": { "examples": { "Asset updated successfully": { "description": "Asset updated successfully", "value": { "success": true, "data": { "message": "Asset updated successfully" } } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "examples": { "Storage path not provided": { "description": "Storage path not provided", "value": { "success": false, "errorObjects": [ { "error": "Storage path is required and can not be empty.", "field": "storagePath" } ] } }, "CDN URL not provided": { "description": "CDN URL not provided", "value": { "success": false, "errorObjects": [ { "error": "CDN URL is required and can not be empty.", "field": "cdnUrl" } ] } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden !" } ] } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "examples": { "Asset not found": { "description": "Asset not found", "value": { "success": false, "errorObjects": [ { "error": "No Asset found with the Asset ID provided. Please provide a valid ID." } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/asset/list": { "get": { "tags": [ "Asset API" ], "summary": "List All Assets by Organization Workspace ID", "description": "This API is used for fetching the list of all assets associated with a specific Organization Workspace ID.\n1. The API retrieves all assets linked to the Organization Workspace ID of the logged-in user.\n2. The response includes a list of assets, each containing details such as id, storage path, CDN URL,\ncreation timestamp, modification timestamp, and whether it is disposable.\n3. For HTML5 creative assets, the response includes assetDimensions (stored in JSONB format) and iframeHtml (ready-to-use iframe code).\n4. Appropriate error responses are provided for unauthorized access.\n", "operationId": "getAllAssets", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "The unique identifier of the asset.", "format": "int32", "example": 12345 }, "storagePath": { "type": "string", "description": "The storage path of the asset file.", "example": "new/path/to/asset.jpg" }, "cdnUrl": { "type": "string", "description": "The CDN URL of the asset file.", "example": "https://cdn.example.com/assets/12345" }, "created": { "type": "integer", "description": "The timestamp epoch in milliseconds when the asset was created.", "format": "int64", "example": 1627847261000 }, "modifiedDate": { "type": "string", "description": "The timestamp when the asset was last modified.", "format": "date-time" }, "owId": { "type": "integer", "description": "The Organization Workspace ID associated with the asset.", "format": "int32", "example": 1001 }, "createdByUowId": { "type": "integer", "description": "The User Organization Workspace ID of the user who created the asset.", "format": "int32", "example": 2002 }, "modifiedByUowId": { "type": "integer", "description": "The User Organization Workspace ID of the user who last modified the asset.", "format": "int32", "example": 2003 }, "assetDimensions": { "type": "object", "properties": { "width": { "type": "integer", "format": "int32" }, "height": { "type": "integer", "format": "int32" } }, "description": "Dimensions of the asset (for HTML5 creatives). Contains width and height." }, "iframeHtml": { "type": "string", "description": "Ready-to-use iframe HTML code for HTML5 creatives. Only present for HTML5 creatives.", "example": "\u003Ciframe src=\"https://cdn.example.com/creative/index.html\" width=\"300\" height=\"250\" frameborder=\"0\" scrolling=\"no\" marginheight=\"0\" marginwidth=\"0\"\u003E\u003C/iframe\u003E" }, "zipFile": { "type": "boolean" }, "disposable": { "type": "boolean" }, "html5Creative": { "type": "boolean" } }, "description": "Response object representing the details of an asset." }, "examples": { "List of all assets fetched successfully (mixed types)": { "description": "List of all assets fetched successfully (mixed types)", "value": { "success": true, "data": [ { "id": 1, "storagePath": "assets/201427/tfteBYO_1704204958735.jpg", "cdnUrl": "https://cdn.example.com/assets/201427/tfteBYO_1704204958735.jpg", "created": 1704204961147, "modifiedDate": "2024-01-02T14:16:08.7260000", "isDisposable": false, "isZipFile": false, "isHtml5Creative": false, "assetDimensions": null, "iframeHtml": null }, { "id": 2, "storagePath": "assets/201427/randomPath/index.html", "cdnUrl": "https://cdn.example.com/assets/201427/randomPath/index.html", "created": 1704204971010, "modifiedDate": "2024-01-02T14:16:11.3750000", "isDisposable": true, "isZipFile": true, "isHtml5Creative": true, "assetDimensions": "{\"width\": \"300\", \"height\": \"250\"}", "iframeHtml": "\u003Ciframe src=\"https://cdn.example.com/assets/201427/randomPath/index.html\" width=\"300\" height=\"250\" frameborder=\"0\" scrolling=\"no\" marginheight=\"0\" marginwidth=\"0\"\u003E\u003C/iframe\u003E" }, { "id": 3, "storagePath": "assets/201427/2mBGamD_1704205759807.jpg", "cdnUrl": "https://cdn.example.com/assets/201427/2mBGamD_1704205759807.jpg", "created": 1704205761106, "modifiedDate": "2024-01-02T08:59:21.5080000", "isDisposable": false, "isZipFile": false, "isHtml5Creative": false, "assetDimensions": null, "iframeHtml": null } ] } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden !" } ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/internal/bm/campaigns/{campaignId}/bid-models/{dimensionId}": { "put": { "tags": [ "Bid Model API" ], "summary": "Manage internal bid modelling attributes for a campaign and dimension", "description": "This internal API allows advertisers to manage bid modelling configurations for campaigns, providing full Create, Update, and Delete operations on bid modelling attributes. These attributes control campaign prioritization and spending distribution across various dimensions such as:\n\n**Supported Dimensions**\n- Creative\n- Location: State, City, Zip Code\n- Inventory: Open Exchange, Publisher Category, Deal IDs\n- Device: Traffic Type, Device Type\n- AdExchange\n\n**Bid model attributes include:**\n- Priority: The priority of the bid model.\n- Bid Multiplier: The multiplier applied to the base bid.\n- Spend Ratio: The ratio of spend allocated to the bid model.\n- Spend Ratio Type: The type of spend ratio.\n\n**Bundle support details:**\n- Bundles can be created to group entities together for bid modelling.\n- Entities can be bundled or unbundled as needed.\n- Bundles can be added, updated, or deleted in the bid modelling configuration.\n- Bundle's bid modelling attributes are propagated to all entities present in the bundle.\n\n**The API supports the following actions:**\n- ADD: Add new bid model entities or bundles.\n- DELETE: Remove existing bid model entities or bundles.\n- UPDATE: Modify existing bid model entities or bundles.\n- INCLUDE/EXCLUDE: Set inclusion or exclusion for entities in the bid modelling configuration.\n- Base Bid: Update the base bid for the campaign.\n", "operationId": "manageBidModelling", "parameters": [ { "name": "campaignId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "dimensionId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "bidModelRequests": { "type": "array", "items": { "required": [ "action" ], "type": "object", "properties": { "bidModelData": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "priority": { "maximum": 10, "minimum": 1, "type": "integer", "format": "int32" }, "bidMultiplier": { "maximum": 100, "exclusiveMaximum": false, "minimum": 0.1, "exclusiveMinimum": false, "type": "number", "format": "float" }, "spendRatio": { "maximum": 100, "minimum": 0, "type": "integer", "format": "int32" }, "spendRatioTypeId": { "maximum": 2, "minimum": 1, "type": "integer", "format": "int32" } } }, "dimensionEntityMappings": { "type": "array", "items": { "type": "object", "properties": { "campaignId": { "type": "integer", "format": "int32" }, "dimensionId": { "type": "integer", "format": "int32" }, "entityId": { "type": "integer", "format": "int32" }, "bidModelDataId": { "type": "integer", "format": "int32" } } } }, "action": { "type": "string", "enum": [ "ADD", "UPDATE", "DELETE" ] }, "bidModelDataIds": { "type": "array", "items": { "type": "integer", "format": "int32" } } } } }, "baseBid": { "minimum": 0.01, "exclusiveMinimum": false, "type": "number", "format": "double" }, "excludeDimensionEntityMappings": { "type": "array", "items": { "type": "object", "properties": { "sortCriteriaMap": { "type": "object", "additionalProperties": { "type": "string" } }, "campaignId": { "type": "integer", "format": "int32" }, "ids": { "type": "string" }, "isExcluded": { "type": "integer", "format": "int32" }, "dimensionId": { "type": "integer", "format": "int32" }, "pageNo": { "type": "integer", "format": "int32" }, "noOfEntries": { "type": "integer", "format": "int32" }, "sortBy": { "type": "string" }, "searchField": { "type": "string" }, "order": { "type": "string", "enum": [ "SortOrderEnum[id=1, name='asc', symbol='+']", "SortOrderEnum[id=2, name='desc', symbol='-']" ] } } } } } }, "examples": { "Full bid modelling update request": { "description": "Full bid modelling update request", "value": { "actionWiseBidModelEntities": { "ADD": { "bidModelEntityDetails": [ { "entityId": 50, "entityTypeId": 1, "priority": 1, "bidMultiplier": 2, "spendRatio": 100, "spendRatioTypeId": 1 }, { "entityId": -2, "entityTypeId": 2, "priority": 1, "bidMultiplier": 2, "spendRatio": 100, "spendRatioTypeId": 1, "bundleName": "bundle-1", "entityIds": [1, 2, 3] }, { "entityId": 232, "entityTypeId": 2, "priority": 1, "bidMultiplier": 2, "spendRatio": 100, "spendRatioTypeId": 1, "bundleName": "bundle-1", "entityIds": [1, 2, 3] } ] }, "DELETE": { "bidModelDataId": [1, 2, 3, 4], "bundleIds": [1, 2, 3] }, "UPDATE": { "bidModelEntityDetails": [ { "bidModelDataId": 50, "priority": 1, "bidMultiplier": 2, "spendRatio": 100, "spendRatioTypeId": 1, "bundleName": "Bundle-1", "entityIds": [1, 2, 3, 4, 5] }, { "bidModelDataId": 51, "priority": 1, "bidMultiplier": 2, "spendRatio": 100, "spendRatioTypeId": 1 }, { "bidModelDataId": 52, "priority": 1, "spendRatio": 100 }, { "bidModelDataId": 53, "bundleName": "Bundle-1", "entityIds": [1, 2, 3, 4, 5] } ] } }, "inclusionExclusionEntityMap": { "INCLUDE": [1], "EXCLUDE": [2, 3, 4] }, "baseBid": 3 } }, "Add bid modelling (initial setup)": { "description": "Add bid modelling (initial setup)", "value": { "actionWiseBidModelEntities": { "ADD": { "bidModelEntityDetails": [ { "entityId": 50, "entityTypeId": 1, "priority": 1, "bidMultiplier": 2, "spendRatio": 100, "spendRatioTypeId": 1 }, { "entityId": -2, "entityTypeId": 2, "priority": 1, "bidMultiplier": 2, "spendRatio": 100, "spendRatioTypeId": 1, "bundleName": "bundle-1", "entityIds": [1, 2, 3] }, { "entityId": 232, "entityTypeId": 2, "priority": 1, "bidMultiplier": 2, "spendRatio": 100, "spendRatioTypeId": 1, "bundleName": "bundle-1", "entityIds": [1, 2, 3] } ] } } } }, "Update existing bid modelling": { "description": "Update existing bid modelling", "value": { "actionWiseBidModelEntities": { "UPDATE": { "bidModelEntityDetails": [ { "bidModelDataId": 50, "priority": 1, "bidMultiplier": 2, "spendRatio": 100, "spendRatioTypeId": 1, "bundleName": "Bundle-1", "bundleId": 52, "entityIds": [1, 2, 3, 4, 5] }, { "bidModelDataId": 51, "priority": 1, "bidMultiplier": 2, "spendRatio": 100, "spendRatioTypeId": 1 }, { "bidModelDataId": 52, "priority": 1, "spendRatio": 100 }, { "bidModelDataId": 53, "bundleName": "Bundle-1", "entityIds": [1, 2, 3, 4, 5] } ] } } } }, "Update specific attributes in bid modelling": { "description": "Update specific attributes in bid modelling", "value": { "actionWiseBidModelEntities": { "UPDATE": { "bidModelEntityDetails": [ { "bidModelDataId": 50, "priority": 1 }, { "bidModelDataId": 51, "bidMultiplier": 2 }, { "bidModelDataId": 52, "priority": 1, "spendRatio": 100 }, { "bidModelDataId": 53, "bundleName": "Bundle-1", "entityIds": [1, 2, 3, 4, 5] }, { "bidModelDataId": 51, "priority": 1, "bidMultiplier": 2, "spendRatio": 100, "spendRatioTypeId": 1 }, { "bidModelDataId": 51, "priority": 1, "bidMultiplier": 2, "spendRatio": 100, "spendRatioTypeId": 1, "bundleName": "Bundle-1", "entityIds": [1, 2, 3, 4, 5] } ] } } } }, "Remove existing bid modelling entities - removes bid model data from bid modelling": { "description": "Remove existing bid modelling entities - removes bid model data from bid modelling", "value": { "actionWiseBidModelEntities": { "DELETE": { "bidModelDataId": [1, 2, 3, 4] } } } }, "Delete bundles from bid modelling - removes bundles from bid modelling and unbundles entities": { "description": "Delete bundles from bid modelling - removes bundles from bid modelling and unbundles entities", "value": { "actionWiseBidModelEntities": { "DELETE": { "bundleIds": [1, 2, 3, 4] } } } }, "Unbundle entities in bid modelling": { "description": "Unbundle entities in bid modelling", "value": { "actionWiseBidModelEntities": { "ADD": { "bidModelEntityDetails": [ { "entityId": 50, "entityTypeId": 1, "priority": 1, "bidMultiplier": 2, "spendRatio": 100, "spendRatioTypeId": 1 }, { "entityId": 51, "entityTypeId": 1, "priority": 1, "bidMultiplier": 2, "spendRatio": 100, "spendRatioTypeId": 1 }, { "entityId": -1, "entityTypeId": 3, "priority": 1, "bidMultiplier": 2, "spendRatio": 100, "spendRatioTypeId": 1 } ] }, "DELETE": { "bundleIds": [1] } } } }, "Set include/exclude entities": { "description": "Set include/exclude entities", "value": { "inclusionExclusionEntityMap": { "INCLUDE": [1], "EXCLUDE": [2, 3, 4] } } }, "Update base bid with include/exclude entities": { "description": "Update base bid with include/exclude entities", "value": { "inclusionExclusionEntityMap": { "INCLUDE": [1], "EXCLUDE": [2, 3, 4] }, "baseBid": 3 } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Success Response": { "description": "Success Response", "value": { "success": true, "data": "Bid Modelling updated successfully!" } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden !" } ] } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "examples": { "Invalid bundle ids are provided": { "description": "Invalid bundle ids are provided", "value": { "success": false, "errorObjects": [ { "error": "Some provided bundle ids are not valid or not part of the campaign/modelling" } ] } }, "Modelling does contain 'other' type of entities": { "description": "Modelling does contain 'other' type of entities", "value": { "success": false, "errorObjects": [ { "error": "At least one 'Other' entity is required if there are modelled entities" } ] } }, "Invalid include/exclude entities": { "description": "Invalid include/exclude entities", "value": { "success": false, "errorObjects": [ { "error": "Must provide valid include or exclude entity IDs" } ] } }, "Invalid spend ratios for flexible type": { "description": "Invalid spend ratios for flexible type", "value": { "success": false, "errorObjects": [ { "error": "Total spend ratio must be at least 100 for flexible type" } ] } }, "Base bid exceeds max bid": { "description": "Base bid exceeds max bid", "value": { "success": false, "errorObjects": [ { "error": "Base bid should not exceed max bid" } ] } }, "Bid modifier should be 1 when max bid is not available": { "description": "Bid modifier should be 1 when max bid is not available", "value": { "success": false, "errorObjects": [ { "error": "Bid modifier should be 1 as max bid is not available." } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/bm/io/{ioId}/bid-models": { "put": { "tags": [ "Bid Model API" ], "description": "This API is used to add, update and delete priority of multiple campaigns in single api.All the objects inside request body are not compulsory.", "operationId": "managePriorityToCampaign", "parameters": [ { "name": "ioId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "bidModelRequests": { "type": "array", "items": { "required": [ "action" ], "type": "object", "properties": { "bidModelData": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "priority": { "maximum": 10, "minimum": 1, "type": "integer", "format": "int32" }, "bidMultiplier": { "maximum": 100, "exclusiveMaximum": false, "minimum": 0.1, "exclusiveMinimum": false, "type": "number", "format": "float" }, "spendRatio": { "maximum": 100, "minimum": 0, "type": "integer", "format": "int32" }, "spendRatioTypeId": { "maximum": 2, "minimum": 1, "type": "integer", "format": "int32" } } }, "dimensionEntityMappings": { "type": "array", "items": { "type": "object", "properties": { "campaignId": { "type": "integer", "format": "int32" }, "dimensionId": { "type": "integer", "format": "int32" }, "entityId": { "type": "integer", "format": "int32" }, "bidModelDataId": { "type": "integer", "format": "int32" } } } }, "action": { "type": "string", "enum": [ "ADD", "UPDATE", "DELETE" ] }, "bidModelDataIds": { "type": "array", "items": { "type": "integer", "format": "int32" } } } } }, "baseBid": { "minimum": 0.01, "exclusiveMinimum": false, "type": "number", "format": "double" }, "excludeDimensionEntityMappings": { "type": "array", "items": { "type": "object", "properties": { "sortCriteriaMap": { "type": "object", "additionalProperties": { "type": "string" } }, "campaignId": { "type": "integer", "format": "int32" }, "ids": { "type": "string" }, "isExcluded": { "type": "integer", "format": "int32" }, "dimensionId": { "type": "integer", "format": "int32" }, "pageNo": { "type": "integer", "format": "int32" }, "noOfEntries": { "type": "integer", "format": "int32" }, "sortBy": { "type": "string" }, "searchField": { "type": "string" }, "order": { "type": "string", "enum": [ "SortOrderEnum[id=1, name='asc', symbol='+']", "SortOrderEnum[id=2, name='desc', symbol='-']" ] } } } } } }, "examples": { "Valid Request": { "description": "Valid Request", "value": { "bidModelRequests": [ { "action": "ADD", "bidModelData": { "priority": 1 }, "dimensionEntityMappings": [ { "campaignId": 1 } ] }, { "action": "UPDATE", "bidModelData": { "id": 3677, "priority": 2 } }, { "action": "DELETE", "bidModelDataIds": [893] } ] } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Success Response": { "description": "Success Response", "value": { "success": true, "data": "Priority Updated Successfully" } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden !" } ] } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "examples": { "Invalid Priority Response": { "description": "Invalid Priority Response", "value": { "success": false, "errorObjects": [ { "error": "Cannot assign priority as campaign is in invalid status" } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } }, "post": { "tags": [ "Bid Model API" ], "description": "This API is used to assign priority to multiple campaigns", "operationId": "addPriorityToCampaign", "parameters": [ { "name": "ioId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" } ], "requestBody": { "content": { "application/json": { "schema": { "required": [ "campaignIds", "priority" ], "type": "object", "properties": { "priority": { "maximum": 10, "minimum": 1, "type": "integer", "format": "int32" }, "campaignIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } } } }, "examples": { "Valid Request": { "description": "Valid Request", "value": { "priority": 1, "campaignIdList": [1, 2, 3, 4] } }, "Invalid Request of Invalid Priority": { "description": "Invalid Request of Invalid Priority", "value": { "priority": 11, "campaignIds": [1, 2, 3, 4] } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Success Response": { "description": "Success Response", "value": { "success": true, "data": "Priority Updated Successfully" } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden !" } ] } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "examples": { "Invalid Priority Response": { "description": "Invalid Priority Response", "value": { "success": false, "errorObjects": [ { "error": "Invalid Priority Value" } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } }, "delete": { "tags": [ "Bid Model API" ], "description": "This API is used to delete priority for multiple campaigns", "operationId": "deletePriorityToCampaign", "parameters": [ { "name": "campaignIds", "in": "query", "description": "Multiple campaignsIds separated with comma", "required": false, "schema": { "type": "string" } }, { "name": "ioId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Success Response": { "description": "Success Response", "value": { "success": true, "data": "Priority Deleted Successfully" } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden !" } ] } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "examples": { "Invalid Priority Response": { "description": "Invalid Priority Response", "value": { "success": false, "errorObjects": [ { "error": "Invalid Priority Value" } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } }, "patch": { "tags": [ "Bid Model API" ], "description": "This API is used to update priority to multiple campaigns", "operationId": "updatePriorityToCampaign", "parameters": [ { "name": "ioId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" } ], "requestBody": { "content": { "application/json": { "schema": { "required": [ "campaignIds", "priority" ], "type": "object", "properties": { "priority": { "maximum": 10, "minimum": 1, "type": "integer", "format": "int32" }, "campaignIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } } } }, "examples": { "Valid Request": { "description": "Valid Request", "value": { "priority": 1, "campaignIds": [1, 2, 3, 4] } }, "Invalid Request of Invalid Priority": { "description": "Invalid Request of Invalid Priority", "value": { "priority": 11, "campaignIds": [1, 2, 3, 4] } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Success Response": { "description": "Success Response", "value": { "success": true, "data": "Priority Updated Successfully" } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden !" } ] } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "examples": { "Invalid Priority Response": { "description": "Invalid Priority Response", "value": { "success": false, "errorObjects": [ { "error": "Invalid Priority Value" } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/bm/campaigns/{campaignId}/bid-models/{dimensionId}": { "put": { "tags": [ "Bid Model API" ], "summary": "Manage bid modelling attributes for a campaign and dimension", "description": "This API allows advertisers to manage bid modelling configurations for campaigns, providing full Create, Update, and Delete operations on bid modelling attributes. These attributes control campaign prioritization and spending distribution across various dimensions such as:\n\n**Supported Dimensions**\n- Creative\n- Location: State, City, Zip Code\n- Inventory: Open Exchange, Publisher Category, Deal IDs\n- Device: Traffic Type, Device Type\n- AdExchange\n\n**Bid model attributes include:**\n- Priority: The priority of the bid model.\n- Bid Multiplier: The multiplier applied to the base bid.\n- Spend Ratio: The ratio of spend allocated to the bid model.\n- Spend Ratio Type: The type of spend ratio.\n\n**Bundle support details:**\n- Bundles can be created to group entities together for bid modelling.\n- Entities can be bundled or unbundled as needed.\n- Bundles can be added, updated, or deleted in the bid modelling configuration.\n- Bundle's bid modelling attributes are propagated to all entities present in the bundle.\n\n**The API supports the following actions:**\n- ADD: Add new bid model entities or bundles.\n- DELETE: Remove existing bid model entities or bundles.\n- UPDATE: Modify existing bid model entities or bundles.\n- INCLUDE/EXCLUDE: Set inclusion or exclusion for entities in the bid modelling configuration.\n- Base Bid: Update the base bid for the campaign.\n", "operationId": "manageBidModelling_1", "parameters": [ { "name": "campaignId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "dimensionId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "bidModelRequests": { "type": "array", "items": { "required": [ "action" ], "type": "object", "properties": { "bidModelData": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "priority": { "maximum": 10, "minimum": 1, "type": "integer", "format": "int32" }, "bidMultiplier": { "maximum": 100, "exclusiveMaximum": false, "minimum": 0.1, "exclusiveMinimum": false, "type": "number", "format": "float" }, "spendRatio": { "maximum": 100, "minimum": 0, "type": "integer", "format": "int32" }, "spendRatioTypeId": { "maximum": 2, "minimum": 1, "type": "integer", "format": "int32" } } }, "dimensionEntityMappings": { "type": "array", "items": { "type": "object", "properties": { "campaignId": { "type": "integer", "format": "int32" }, "dimensionId": { "type": "integer", "format": "int32" }, "entityId": { "type": "integer", "format": "int32" }, "bidModelDataId": { "type": "integer", "format": "int32" } } } }, "action": { "type": "string", "enum": [ "ADD", "UPDATE", "DELETE" ] }, "bidModelDataIds": { "type": "array", "items": { "type": "integer", "format": "int32" } } } } }, "baseBid": { "minimum": 0.01, "exclusiveMinimum": false, "type": "number", "format": "double" }, "excludeDimensionEntityMappings": { "type": "array", "items": { "type": "object", "properties": { "sortCriteriaMap": { "type": "object", "additionalProperties": { "type": "string" } }, "campaignId": { "type": "integer", "format": "int32" }, "ids": { "type": "string" }, "isExcluded": { "type": "integer", "format": "int32" }, "dimensionId": { "type": "integer", "format": "int32" }, "pageNo": { "type": "integer", "format": "int32" }, "noOfEntries": { "type": "integer", "format": "int32" }, "sortBy": { "type": "string" }, "searchField": { "type": "string" }, "order": { "type": "string", "enum": [ "SortOrderEnum[id=1, name='asc', symbol='+']", "SortOrderEnum[id=2, name='desc', symbol='-']" ] } } } } } }, "examples": { "Full bid modelling update request": { "description": "Full bid modelling update request", "value": { "actionWiseBidModelEntities": { "ADD": { "bidModelEntityDetails": [ { "entityId": 50, "entityTypeId": 1, "priority": 1, "bidMultiplier": 2, "spendRatio": 100, "spendRatioTypeId": 1 }, { "entityId": -2, "entityTypeId": 2, "priority": 1, "bidMultiplier": 2, "spendRatio": 100, "spendRatioTypeId": 1, "bundleName": "bundle-1", "entityIds": [1, 2, 3] }, { "entityId": 232, "entityTypeId": 2, "priority": 1, "bidMultiplier": 2, "spendRatio": 100, "spendRatioTypeId": 1, "bundleName": "bundle-1", "entityIds": [1, 2, 3] } ] }, "DELETE": { "bidModelDataId": [1, 2, 3, 4], "bundleIds": [1, 2, 3] }, "UPDATE": { "bidModelEntityDetails": [ { "bidModelDataId": 50, "priority": 1, "bidMultiplier": 2, "spendRatio": 100, "spendRatioTypeId": 1, "bundleName": "Bundle-1", "entityIds": [1, 2, 3, 4, 5] }, { "bidModelDataId": 51, "priority": 1, "bidMultiplier": 2, "spendRatio": 100, "spendRatioTypeId": 1 }, { "bidModelDataId": 52, "priority": 1, "spendRatio": 100 }, { "bidModelDataId": 53, "bundleName": "Bundle-1", "entityIds": [1, 2, 3, 4, 5] } ] } }, "inclusionExclusionEntityMap": { "INCLUDE": [1], "EXCLUDE": [2, 3, 4] }, "baseBid": 3 } }, "Add bid modelling (initial setup)": { "description": "Add bid modelling (initial setup)", "value": { "actionWiseBidModelEntities": { "ADD": { "bidModelEntityDetails": [ { "entityId": 50, "entityTypeId": 1, "priority": 1, "bidMultiplier": 2, "spendRatio": 100, "spendRatioTypeId": 1 }, { "entityId": -2, "entityTypeId": 2, "priority": 1, "bidMultiplier": 2, "spendRatio": 100, "spendRatioTypeId": 1, "bundleName": "bundle-1", "entityIds": [1, 2, 3] }, { "entityId": 232, "entityTypeId": 2, "priority": 1, "bidMultiplier": 2, "spendRatio": 100, "spendRatioTypeId": 1, "bundleName": "bundle-1", "entityIds": [1, 2, 3] } ] } } } }, "Update existing bid modelling": { "description": "Update existing bid modelling", "value": { "actionWiseBidModelEntities": { "UPDATE": { "bidModelEntityDetails": [ { "bidModelDataId": 50, "priority": 1, "bidMultiplier": 2, "spendRatio": 100, "spendRatioTypeId": 1, "bundleName": "Bundle-1", "bundleId": 52, "entityIds": [1, 2, 3, 4, 5] }, { "bidModelDataId": 51, "priority": 1, "bidMultiplier": 2, "spendRatio": 100, "spendRatioTypeId": 1 }, { "bidModelDataId": 52, "priority": 1, "spendRatio": 100 }, { "bidModelDataId": 53, "bundleName": "Bundle-1", "entityIds": [1, 2, 3, 4, 5] } ] } } } }, "Update specific attributes in bid modelling": { "description": "Update specific attributes in bid modelling", "value": { "actionWiseBidModelEntities": { "UPDATE": { "bidModelEntityDetails": [ { "bidModelDataId": 50, "priority": 1 }, { "bidModelDataId": 51, "bidMultiplier": 2 }, { "bidModelDataId": 52, "priority": 1, "spendRatio": 100 }, { "bidModelDataId": 53, "bundleName": "Bundle-1", "entityIds": [1, 2, 3, 4, 5] }, { "bidModelDataId": 51, "priority": 1, "bidMultiplier": 2, "spendRatio": 100, "spendRatioTypeId": 1 }, { "bidModelDataId": 51, "priority": 1, "bidMultiplier": 2, "spendRatio": 100, "spendRatioTypeId": 1, "bundleName": "Bundle-1", "entityIds": [1, 2, 3, 4, 5] } ] } } } }, "Remove existing bid modelling entities - removes bid model data from bid modelling": { "description": "Remove existing bid modelling entities - removes bid model data from bid modelling", "value": { "actionWiseBidModelEntities": { "DELETE": { "bidModelDataId": [1, 2, 3, 4] } } } }, "Delete bundles from bid modelling - removes bundles from bid modelling and unbundles entities": { "description": "Delete bundles from bid modelling - removes bundles from bid modelling and unbundles entities", "value": { "actionWiseBidModelEntities": { "DELETE": { "bundleIds": [1, 2, 3, 4] } } } }, "Unbundle entities in bid modelling": { "description": "Unbundle entities in bid modelling", "value": { "actionWiseBidModelEntities": { "ADD": { "bidModelEntityDetails": [ { "entityId": 50, "entityTypeId": 1, "priority": 1, "bidMultiplier": 2, "spendRatio": 100, "spendRatioTypeId": 1 }, { "entityId": 51, "entityTypeId": 1, "priority": 1, "bidMultiplier": 2, "spendRatio": 100, "spendRatioTypeId": 1 }, { "entityId": -1, "entityTypeId": 3, "priority": 1, "bidMultiplier": 2, "spendRatio": 100, "spendRatioTypeId": 1 } ] }, "DELETE": { "bundleIds": [1] } } } }, "Set include/exclude entities": { "description": "Set include/exclude entities", "value": { "inclusionExclusionEntityMap": { "INCLUDE": [1], "EXCLUDE": [2, 3, 4] } } }, "Update base bid with include/exclude entities": { "description": "Update base bid with include/exclude entities", "value": { "inclusionExclusionEntityMap": { "INCLUDE": [1], "EXCLUDE": [2, 3, 4] }, "baseBid": 3 } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Success Response": { "description": "Success Response", "value": { "success": true, "data": "Bid Modelling updated successfully!" } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden !" } ] } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "examples": { "Invalid bundle ids are provided": { "description": "Invalid bundle ids are provided", "value": { "success": false, "errorObjects": [ { "error": "Some provided bundle ids are not valid or not part of the campaign/modelling" } ] } }, "Modelling does contain 'other' type of entities": { "description": "Modelling does contain 'other' type of entities", "value": { "success": false, "errorObjects": [ { "error": "At least one 'Other' entity is required if there are modelled entities" } ] } }, "Invalid include/exclude entities": { "description": "Invalid include/exclude entities", "value": { "success": false, "errorObjects": [ { "error": "Must provide valid include or exclude entity IDs" } ] } }, "Invalid spend ratios for flexible type": { "description": "Invalid spend ratios for flexible type", "value": { "success": false, "errorObjects": [ { "error": "Total spend ratio must be at least 100 for flexible type" } ] } }, "Base bid exceeds max bid": { "description": "Base bid exceeds max bid", "value": { "success": false, "errorObjects": [ { "error": "Base bid should not exceed max bid" } ] } }, "Bid modifier should be 1 when max bid is not available": { "description": "Bid modifier should be 1 when max bid is not available", "value": { "success": false, "errorObjects": [ { "error": "Bid modifier should be 1 as max bid is not available." } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/internal/bm/campaigns/{campaignId}/dimensions/{dimensionId}/bundles": { "post": { "tags": [ "Bid Model API" ], "summary": "Create Bundle for Campaign and Dimension [Internal]", "description": "This internal API is used to create a bundle for a specific campaign and dimension. It allows the user to group entities into a bundle. The request body should contain the details of the bundle to be created, including the entities and their associated data. This endpoint is intended for internal system usage only.", "operationId": "createBundle", "parameters": [ { "name": "campaignId", "in": "path", "required": true, "schema": { "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "dimensionId", "in": "path", "required": true, "schema": { "minimum": 1, "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "bundleId": { "type": "integer", "format": "int32" }, "bundleName": { "type": "string" }, "entityIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "modellingApplied": { "type": "boolean" }, "dimensionId": { "type": "integer", "format": "int32" }, "campaignOptimizationTypeId": { "type": "integer", "format": "int32" } } }, "examples": { "Create bundle request body": { "description": "Create bundle request body", "value": { "bundleName": "Bundle for campaign 1", "entityIds": [10895823] } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Success Response": { "description": "Success Response", "value": { "success": true, "data": { "message": "Bundle created successfully", "id": 5 } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden !" } ] } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "examples": { "Entity IDs do not exist": { "description": "Entity IDs do not exist", "value": { "success": false, "errorObjects": [ { "error": "Some entity IDs do not exist in the campaign targeting or serving data." } ] } }, "Maximum Bundles Exceeded": { "description": "Maximum Bundles Exceeded", "value": { "success": false, "errorObjects": [ { "error": "You can only create a maximum of 10 bundles" } ] } }, "Bundle Name Required and Length Exceeded": { "description": "Bundle Name Required and Length Exceeded", "value": { "success": false, "errorObjects": [ { "error": "Bundle name is required and should not exceed 255 characters" } ] } }, "Maximum Entity IDs Exceeded": { "description": "Maximum Entity IDs Exceeded", "value": { "success": false, "errorObjects": [ { "error": "You can only create a bundle with a maximum of 1000 entity IDs." } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } }, "delete": { "tags": [ "Bid Model API" ], "summary": "Delete Bundle for Campaign and Dimension", "description": "This internal API is used for delete a bundle for a specific campaign and dimension. It allows the user to remove a bundle and its associated entities from the system. The request body should contain the details of the bundle to be deleted.", "operationId": "deleteBundle", "parameters": [ { "name": "campaignId", "in": "path", "required": true, "schema": { "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "dimensionId", "in": "path", "required": true, "schema": { "minimum": 1, "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "bundleIds": { "type": "array", "items": { "type": "integer", "format": "int32" } } } }, "examples": { "Delete single bundle": { "description": "Delete single bundle", "value": { "bundleIds": [1] } }, "Delete multiple bundle": { "description": "Delete multiple bundle", "value": { "bundleIds": [1, 2, 3, 4, 5] } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Delete single bundle Response": { "description": "Delete single bundle Response", "value": { "success": true, "data": "Bundle removed successfully" } }, "Delete multiple bundle Response": { "description": "Delete multiple bundle Response", "value": { "success": true, "data": "2 Bundles removed successfully" } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden !" } ] } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "examples": { "Bundle Not Found": { "description": "Bundle Not Found", "value": { "success": false, "errorObjects": [ { "error": "Some of the bundles do not exist in the campaign and dimension specified." } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } }, "patch": { "tags": [ "Bid Model API" ], "summary": "Update Bundle for Campaign and Dimension [Internal]", "description": "This internal API is used to update an existing bundle for a specific campaign and dimension. It allows the user to modify the bundle's name and the entities associated with it. The request body should contain the updated details of the bundle. This endpoint is intended for internal system usage only.", "operationId": "updateBundleDetails", "parameters": [ { "name": "campaignId", "in": "path", "required": true, "schema": { "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "dimensionId", "in": "path", "required": true, "schema": { "minimum": 1, "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "bundleId": { "type": "integer", "format": "int32" }, "bundleName": { "type": "string" }, "entityIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "modellingApplied": { "type": "boolean" }, "dimensionId": { "type": "integer", "format": "int32" }, "campaignOptimizationTypeId": { "type": "integer", "format": "int32" } } }, "examples": { "Update bundle request body": { "description": "Update bundle request body", "value": { "bundleDetailList": [ { "bundleId": 3, "bundleName": "Bundle#3", "entityIds": [30, 31] }, { "bundleId": 4, "bundleName": "Bundle#4" }, { "bundleId": 5, "entityIds": [13, 14] } ] } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Single Bundle Update Response": { "description": "Single Bundle Update Response", "value": { "success": true, "data": "Bundle updated successfully" } }, "Bundle Name Update Response": { "description": "Bundle Name Update Response", "value": { "success": true, "data": "Bundle name updated successfully" } }, "Multiple Bundle Update Response": { "description": "Multiple Bundle Update Response", "value": { "success": true, "data": "Bundles updated successfully" } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden !" } ] } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "examples": { "Entity IDs do not exist": { "description": "Entity IDs do not exist", "value": { "success": false, "errorObjects": [ { "error": "Some entity IDs do not exist in the campaign targeting or serving data." } ] } }, "Bundle Already Modelled": { "description": "Bundle Already Modelled", "value": { "success": false, "errorObjects": [ { "error": "Bundle Id : 5 is already modelled and cannot be updated through this API" } ] } }, "Bundle Name Length Exceeded": { "description": "Bundle Name Length Exceeded", "value": { "success": false, "errorObjects": [ { "error": "Invalid bundle name. It must be non-empty and within the allowed character limit." } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/bm/campaigns/{campaignId}/reports/{dimensionId}": { "post": { "tags": [ "Bid Model API" ], "summary": "Fetch campaign metrics report by dimension Id", "description": "Fetches and returns a detailed metrics report for a specified campaign and dimension,\nproviding granular insights such as impressions, clicks, eCPM, conversions, and additional breakdowns by the selected dimension.\nSupports advanced filtering, sorting, and pagination, and can return either downloadable report URLs or in-depth data tables depending on the request parameters.\n", "operationId": "fetchCampaignMetricsByDimension", "parameters": [ { "name": "campaignId", "in": "path", "description": "The campaign ID for which the report is being generated", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "dimensionId", "in": "path", "description": "The dimension ID for which the report is being generated", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "description": "Contains filter criteria and parameters for generating the report", "content": { "application/json": { "schema": { "type": "object", "properties": { "sortCriteriaMap": { "type": "object", "additionalProperties": { "type": "string" } }, "responseType": { "type": "string", "enum": [ "default", "total", "list", "bundle" ] }, "startDate": { "type": "integer", "format": "int64" }, "endDate": { "type": "integer", "format": "int64" }, "timezoneId": { "type": "integer", "format": "int32" }, "isExcluded": { "type": "integer", "format": "int32" }, "inventoryTypes": { "type": "array", "items": { "type": "string" } }, "download": { "type": "object", "properties": { "columns": { "type": "array", "items": { "type": "object", "additionalProperties": { "type": "object" } } }, "fileType": { "type": "string" }, "fileName": { "type": "string" } } }, "skipReporting": { "type": "boolean" }, "bundleIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "searchKeywords": { "type": "array", "items": { "type": "string" } }, "performanceFilters": { "type": "object", "properties": { "conditions": { "type": "array", "items": { "type": "object", "properties": { "column": { "type": "string" }, "condition": { "type": "string", "enum": [ "=", "!=", "\u003C", "\u003E", "\u003C=", "\u003E=" ] }, "value": { "type": "number", "format": "double" } } } }, "operation": { "type": "string", "enum": [ "and", "or" ] } } }, "pageNo": { "type": "integer", "format": "int32" }, "noOfEntries": { "type": "integer", "format": "int32" }, "sortBy": { "type": "string" }, "searchField": { "type": "string" }, "order": { "type": "string", "enum": [ "SortOrderEnum[id=1, name='asc', symbol='+']", "SortOrderEnum[id=2, name='desc', symbol='-']" ] } } }, "examples": { "Simple Listing, default sorting": { "description": "Simple Listing, default sorting", "value": { "startDate": 1751001600000, "endDate": 1753593599000, "timeZoneId": 29, "pageNo": 1 } }, "Simple Listing, Sorting by impressions ascending": { "description": "Simple Listing, Sorting by impressions ascending", "value": { "startDate": 1751001600000, "endDate": 1753593599000, "timeZoneId": 29, "pageNo": 1, "sortBy": "+impressions" } }, "Basic Search": { "description": "Basic Search", "value": { "startDate": 1751001600000, "endDate": 1753593599000, "timeZoneId": 29, "pageNo": 1, "sortBy": "+impressions", "searchField": ".com" } }, "Bundle filter": { "description": "Bundle filter", "value": { "startDate": 1751001600000, "endDate": 1753593599000, "timeZoneId": 29, "pageNo": 1, "sortBy": "-impressions", "bundleIds": [187, 186] } }, "Advance Search": { "description": "Advance Search", "value": { "startDate": 1750651200000, "endDate": 1752724799000, "timeZoneId": 29, "sortBy": "+impressions", "pageNo": 1, "searchKeywords": [ "9171361", "keyword 1", "33126", "keyword N" ] } }, "Performance Filter multiple": { "description": "Performance Filter multiple", "value": { "startDate": 1749873600000, "endDate": 1752551999000, "timeZoneId": 29, "sortBy": "+impressions", "pageNo": 1, "performanceFilters": { "operation": "AND", "conditions": [ { "column": "impressions", "condition": "\u003C", "value": 1000 }, { "column": "clicks", "condition": "!=", "value": 2000 } ] } } }, "Performance Filter single": { "description": "Performance Filter single", "value": { "startDate": 1749873600000, "endDate": 1752551999000, "timeZoneId": 29, "sortBy": "+impressions", "pageNo": 1, "performanceFilters": { "conditions": [ { "column": "impressions", "condition": "\u003C", "value": 1000 } ] } } }, "Simple Listing Download file CSV ": { "description": "Simple Listing Download file CSV ", "value": { "startDate": 1751001600000, "endDate": 1753593599000, "timeZoneId": 29, "pageNo": 1, "sortBy": "-impressions", "download": { "fileType": "csv", "columns": [ { "label": "ID", "value": "id" }, { "label": "Inventory Name", "value": "name" }, { "label": "Type", "value": "inventoryType" }, { "label": "Modeling", "value": "modelled" }, { "label": "Impressions", "value": "impressions" }, { "label": "Clicks", "value": "clicks" }, { "label": "Win Rate", "value": "winRate" }, { "label": "CTR", "value": "CTR" }, { "label": "Media eCPM", "value": "eCPM" }, { "label": "Total eCPM", "value": "totalECPM" }, { "label": "Media eCPC", "value": "eCPC" }, { "label": "Total eCPC", "value": "totalECPC" }, { "label": "Media Cost", "value": "mediaSpent" }, { "label": "Data Cost", "value": "dataCost" }, { "label": "Pre-bid Cost", "value": "prebidCost" }, { "label": "Total Spent", "value": "spent" }, { "label": "Total Attributed Conversion Value", "value": "conversionValue" }, { "label": "Total Attributed Conversions", "value": "conversionCount" }, { "label": "Return On Ad Spend", "value": "returnOnAdSpend" }, { "label": "Attributed Click Through Conversions", "value": "attributedClickThroughConversions" }, { "label": "Attributed View Through Conversions", "value": "attributedViewThroughConversions" }, { "label": "Cost Per Attributed Conversions", "value": "costPerAttributedConversions" }, { "label": "Attributed Conversions Rate", "value": "attributedConversionsRate" } ] } } } } } }, "required": true }, "responses": { "200": { "description": "Operation successful", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "errorObjects": { "type": "array", "items": { "type": "object", "properties": { "error": { "type": "string" }, "reason": { "type": "string" }, "field": { "type": "string" } } } }, "data": { "type": "object" } } }, "examples": { "Case 1: Simple Listing": { "description": "Case 1: Simple Listing", "value": { "success": true, "data": { "recordsTotal": { "totalCount": 1, "impressions": 25712, "dataCost": 0, "winRate": 99.4276875483372, "clicks": 25651, "eCPM": 1, "totalECPM": 1, "eCPC": 0.00100237807492885, "totalECPC": 0.00100237807492885, "mediaSpent": 25.712, "CTR": 99.7627566894835, "spent": 25.712, "conversionCount": 0, "conversionValue": 0, "attributedClickThroughConversions": 0, "attributedViewThroughConversions": 0, "costPerAttributedConversions": 0, "attributedConversionsRate": 0, "returnOnAdSpend": 0, "VCR": 0, "eCPV": 0, "eCPCV": 0, "startCount": 0, "firstCount": 0, "midCount": 0, "thirdCount": 0, "completeCount": 0, "bidImpressions": 25860, "audioVideoViewed": 0, "prebidCost": 0 }, "recordsList": [ { "id": 1001662598, "name": "b.fast-stories.com", "isExcluded": 0, "modelled": false, "inventoryTrafficType": "web", "inventoryType": "Site", "blocked": false, "targeted": false, "impressions": 25712, "dataCost": 0, "winRate": 99.4276875483372, "clicks": 25651, "eCPM": 1, "totalECPM": 1, "eCPC": 0.00100237807492885, "totalECPC": 0.00100237807492885, "mediaSpent": 25.712, "CTR": 99.7627566894835, "spent": 25.712, "conversionCount": 0, "conversionValue": 0, "attributedClickThroughConversions": 0, "attributedViewThroughConversions": 0, "costPerAttributedConversions": 0, "attributedConversionsRate": 0, "returnOnAdSpend": 0, "VCR": 0, "eCPV": 0, "eCPCV": 0, "startCount": 0, "firstCount": 0, "midCount": 0, "thirdCount": 0, "completeCount": 0, "bidImpressions": 25860, "audioVideoViewed": 0, "prebidCost": 0 }, { "id": 1001662599, "name": "b.fast-stories.com", "isExcluded": 0, "modelled": false, "inventoryTrafficType": "web", "inventoryType": "Site", "blocked": false, "targeted": false, "impressions": 25712, "dataCost": 0, "winRate": 99.4276875483372, "clicks": 25651, "eCPM": 1, "totalECPM": 1, "eCPC": 0.00100237807492885, "totalECPC": 0.00100237807492885, "mediaSpent": 25.712, "CTR": 99.7627566894835, "spent": 25.712, "conversionCount": 0, "conversionValue": 0, "attributedClickThroughConversions": 0, "attributedViewThroughConversions": 0, "costPerAttributedConversions": 0, "attributedConversionsRate": 0, "returnOnAdSpend": 0, "VCR": 0, "eCPV": 0, "eCPCV": 0, "startCount": 0, "firstCount": 0, "midCount": 0, "thirdCount": 0, "completeCount": 0, "bidImpressions": 25860, "audioVideoViewed": 0, "prebidCost": 0 } ], "totalRecords": 2, "filteredRecords": 2 } } }, "Bundle Listing": { "description": "Bundle Listing", "value": { "success": true, "data": { "recordsTotal": { "totalCount": 1, "impressions": 25712, "dataCost": 0, "winRate": 99.4276875483372, "clicks": 25651, "eCPM": 1, "totalECPM": 1, "eCPC": 0.00100237807492885, "totalECPC": 0.00100237807492885, "mediaSpent": 25.712, "CTR": 99.7627566894835, "spent": 25.712, "conversionCount": 0, "conversionValue": 0, "attributedClickThroughConversions": 0, "attributedViewThroughConversions": 0, "costPerAttributedConversions": 0, "attributedConversionsRate": 0, "returnOnAdSpend": 0, "VCR": 0, "eCPV": 0, "eCPCV": 0, "startCount": 0, "firstCount": 0, "midCount": 0, "thirdCount": 0, "completeCount": 0, "bidImpressions": 25860, "audioVideoViewed": 0, "prebidCost": 0 }, "recordsList": [ { "bundleId": 1, "bundleName": "bundle1", "bundleEntityIds": [1, 2, 3], "impressions": 25712, "dataCost": 0, "winRate": 99.4276875483372, "clicks": 25651, "eCPM": 1, "totalECPM": 1, "eCPC": 0.00100237807492885, "totalECPC": 0.00100237807492885, "mediaSpent": 25.712, "CTR": 99.7627566894835, "spent": 25.712, "conversionCount": 0, "conversionValue": 0, "attributedClickThroughConversions": 0, "attributedViewThroughConversions": 0, "costPerAttributedConversions": 0, "attributedConversionsRate": 0, "returnOnAdSpend": 0, "VCR": 0, "eCPV": 0, "eCPCV": 0, "startCount": 0, "firstCount": 0, "midCount": 0, "thirdCount": 0, "completeCount": 0, "bidImpressions": 25860, "audioVideoViewed": 0, "prebidCost": 0, "entityRecordsList": [ { "id": 1001662596, "name": "b.fast-stories.com", "isExcluded": 0, "modelled": false, "inventoryTrafficType": "web", "inventoryType": "Site", "blocked": false, "targeted": false, "impressions": 25712, "dataCost": 0, "winRate": 99.4276875483372, "clicks": 25651, "eCPM": 1, "totalECPM": 1, "eCPC": 0.00100237807492885, "totalECPC": 0.00100237807492885, "mediaSpent": 25.712, "CTR": 99.7627566894835, "spent": 25.712, "conversionCount": 0, "conversionValue": 0, "attributedClickThroughConversions": 0, "attributedViewThroughConversions": 0, "costPerAttributedConversions": 0, "attributedConversionsRate": 0, "returnOnAdSpend": 0, "VCR": 0, "eCPV": 0, "eCPCV": 0, "startCount": 0, "firstCount": 0, "midCount": 0, "thirdCount": 0, "completeCount": 0, "bidImpressions": 25860, "audioVideoViewed": 0, "prebidCost": 0 }, { "id": 1001662597, "name": "b.fast-stories.com", "isExcluded": 0, "modelled": false, "inventoryTrafficType": "web", "inventoryType": "Site", "blocked": false, "targeted": false, "impressions": 25712, "dataCost": 0, "winRate": 99.4276875483372, "clicks": 25651, "eCPM": 1, "totalECPM": 1, "eCPC": 0.00100237807492885, "totalECPC": 0.00100237807492885, "mediaSpent": 25.712, "CTR": 99.7627566894835, "spent": 25.712, "conversionCount": 0, "conversionValue": 0, "attributedClickThroughConversions": 0, "attributedViewThroughConversions": 0, "costPerAttributedConversions": 0, "attributedConversionsRate": 0, "returnOnAdSpend": 0, "VCR": 0, "eCPV": 0, "eCPCV": 0, "startCount": 0, "firstCount": 0, "midCount": 0, "thirdCount": 0, "completeCount": 0, "bidImpressions": 25860, "audioVideoViewed": 0, "prebidCost": 0 } ] }, { "id": 1001662598, "name": "b.fast-stories.com", "isExcluded": 0, "modelled": false, "inventoryTrafficType": "web", "inventoryType": "Site", "blocked": false, "targeted": false, "impressions": 25712, "dataCost": 0, "winRate": 99.4276875483372, "clicks": 25651, "eCPM": 1, "totalECPM": 1, "eCPC": 0.00100237807492885, "totalECPC": 0.00100237807492885, "mediaSpent": 25.712, "CTR": 99.7627566894835, "spent": 25.712, "conversionCount": 0, "conversionValue": 0, "attributedClickThroughConversions": 0, "attributedViewThroughConversions": 0, "costPerAttributedConversions": 0, "attributedConversionsRate": 0, "returnOnAdSpend": 0, "VCR": 0, "eCPV": 0, "eCPCV": 0, "startCount": 0, "firstCount": 0, "midCount": 0, "thirdCount": 0, "completeCount": 0, "bidImpressions": 25860, "audioVideoViewed": 0, "prebidCost": 0 }, { "id": 1001662599, "name": "b.fast-stories.com", "isExcluded": 0, "modelled": false, "inventoryTrafficType": "web", "inventoryType": "Site", "blocked": false, "targeted": false, "impressions": 25712, "dataCost": 0, "winRate": 99.4276875483372, "clicks": 25651, "eCPM": 1, "totalECPM": 1, "eCPC": 0.00100237807492885, "totalECPC": 0.00100237807492885, "mediaSpent": 25.712, "CTR": 99.7627566894835, "spent": 25.712, "conversionCount": 0, "conversionValue": 0, "attributedClickThroughConversions": 0, "attributedViewThroughConversions": 0, "costPerAttributedConversions": 0, "attributedConversionsRate": 0, "returnOnAdSpend": 0, "VCR": 0, "eCPV": 0, "eCPCV": 0, "startCount": 0, "firstCount": 0, "midCount": 0, "thirdCount": 0, "completeCount": 0, "bidImpressions": 25860, "audioVideoViewed": 0, "prebidCost": 0 } ], "totalRecords": 4, "filteredRecords": 4 } } }, "Report download CSV or XLS": { "description": "Report download CSV or XLS", "value": { "success": true, "data": { "url": "DownloadURL" } } } } } } }, "401": { "description": "Unauthorized access", "content": { "*/*": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "errorObjects": { "type": "array", "items": { "type": "object", "properties": { "error": { "type": "string" }, "reason": { "type": "string" }, "field": { "type": "string" } } } }, "data": { "type": "object" } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden !" } ] } } } }, "422": { "description": "Unprocessable Entity, invalid input data", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "errorObjects": { "type": "array", "items": { "type": "object", "properties": { "error": { "type": "string" }, "reason": { "type": "string" }, "field": { "type": "string" } } } }, "data": { "type": "object" } } }, "examples": { "Invalid campaignId Response": { "description": "Invalid campaignId Response", "value": { "success": false, "errorObjects": [ { "error": "The campaign ID is missing or invalid. Please provide a valid campaign ID." } ] } }, "Invalid dimensionId Response": { "description": "Invalid dimensionId Response", "value": { "success": false, "errorObjects": [ { "error": "The dimension ID is invalid. Please provide a valid dimension ID." } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/bm/campaigns/{campaignId}/include-exclude/dimensions/{dimensionId}": { "post": { "tags": [ "Bid Model API" ], "summary": "Include/Exclude entities from a campaign", "description": "This API allows clients to include or exclude entities from a campaign by updating their status.", "operationId": "toggleCampaignDimensionStatus", "parameters": [ { "name": "campaignId", "in": "path", "description": "ID of the campaign", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "dimensionId", "in": "path", "description": "ID of the dimension", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "description": "Request object containing ID(s) of entities and exclusion status", "content": { "application/json": { "schema": { "type": "object", "properties": { "sortCriteriaMap": { "type": "object", "additionalProperties": { "type": "string" } }, "campaignId": { "type": "integer", "format": "int32" }, "ids": { "type": "string" }, "isExcluded": { "type": "integer", "format": "int32" }, "pageNo": { "type": "integer", "format": "int32" }, "noOfEntries": { "type": "integer", "format": "int32" }, "sortBy": { "type": "string" }, "searchField": { "type": "string" }, "order": { "type": "string", "enum": [ "SortOrderEnum[id=1, name='asc', symbol='+']", "SortOrderEnum[id=2, name='desc', symbol='-']" ] } } }, "examples": { "Target Creatives for campaign": { "description": "Target Creatives for campaign", "value": { "ids": "604675,604084", "isExcluded": 0 } }, "Block Creatives from campaign": { "description": "Block Creatives from campaign", "value": { "ids": "604675,604084", "isExcluded": 1 } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Target Creatives for campaign": { "description": "Target Creatives for campaign", "value": { "success": true, "data": "Creatives successfully targeted for the campaign." } }, "Block Creatives from campaign": { "description": "Block Creatives from campaign", "value": { "success": true, "data": "Creatives successfully blocked from the campaign." } } } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "errorObjects": { "type": "array", "items": { "type": "object", "properties": { "error": { "type": "string" }, "reason": { "type": "string" }, "field": { "type": "string" } } } }, "data": { "type": "string" } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden !" } ] } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "examples": { "Missing required field in RequestBody": { "description": "Missing required field in RequestBody", "value": { "success": false, "errorObjects": [ { "error": "IDs cannot be empty. Please provide a valid list of IDs" } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/bm/campaigns/{campaignId}/dimensions/{dimensionId}/bundles": { "post": { "tags": [ "Bid Model API" ], "summary": "Create Bundle for Campaign and Dimension", "description": "This API is used to create a bundle for a specific campaign and dimension. It allows the user to group entities into a bundle for advanced modelling. The request body should contain the details of the bundle to be created, including the entities and their associated data.", "operationId": "createBundle_1", "parameters": [ { "name": "campaignId", "in": "path", "required": true, "schema": { "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "dimensionId", "in": "path", "required": true, "schema": { "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "bundleId": { "type": "integer", "format": "int32" }, "bundleName": { "type": "string" }, "entityIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "modellingApplied": { "type": "boolean" }, "dimensionId": { "type": "integer", "format": "int32" }, "campaignOptimizationTypeId": { "type": "integer", "format": "int32" } } }, "examples": { "Create bundle request body": { "description": "Create bundle request body", "value": { "bundleName": "Bundle for campaign 1", "entityIds": [10895823] } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Success Response": { "description": "Success Response", "value": { "success": true, "data": { "message": "Bundle created successfully", "id": 5 } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden !" } ] } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "examples": { "Entity IDs do not exist": { "description": "Entity IDs do not exist", "value": { "success": false, "errorObjects": [ { "error": "Some entity IDs do not exist in the campaign targeting or serving data." } ] } }, "Maximum Bundles Exceeded": { "description": "Maximum Bundles Exceeded", "value": { "success": false, "errorObjects": [ { "error": "You can only create a maximum of 10 bundles" } ] } }, "Bundle Name Required and Length Exceeded": { "description": "Bundle Name Required and Length Exceeded", "value": { "success": false, "errorObjects": [ { "error": "Bundle name is required and should not exceed 255 characters" } ] } }, "Maximum Entity IDs Exceeded": { "description": "Maximum Entity IDs Exceeded", "value": { "success": false, "errorObjects": [ { "error": "You can only create a bundle with a maximum of 1000 entity IDs." } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } }, "delete": { "tags": [ "Bid Model API" ], "summary": "Delete Bundle for Campaign and Dimension", "description": "This API is used to delete a bundle for a specific campaign and dimension. It allows the user to remove a bundle and its associated entities from the system. The request body should contain the details of the bundle to be deleted.", "operationId": "deleteBundle_1", "parameters": [ { "name": "campaignId", "in": "path", "required": true, "schema": { "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "dimensionId", "in": "path", "required": true, "schema": { "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "bundleIds": { "type": "array", "items": { "type": "integer", "format": "int32" } } } }, "examples": { "Delete single bundle": { "description": "Delete single bundle", "value": { "bundleIds": [1] } }, "Delete multiple bundle": { "description": "Delete multiple bundle", "value": { "bundleIds": [1, 2, 3, 4, 5] } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Delete single bundle Response": { "description": "Delete single bundle Response", "value": { "success": true, "data": "Bundle removed successfully" } }, "Delete multiple bundle Response": { "description": "Delete multiple bundle Response", "value": { "success": true, "data": "2 Bundles removed successfully" } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden !" } ] } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "examples": { "Bundle Not Found": { "description": "Bundle Not Found", "value": { "success": false, "errorObjects": [ { "error": "Some of the bundles do not exist in the campaign and dimension specified." } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } }, "patch": { "tags": [ "Bid Model API" ], "summary": "Update Bundle for Campaign and Dimension", "description": "This API is used to update an existing bundle for a specific campaign and dimension. It allows the user to modify the bundle's name and the entities associated with it. The request body should contain the updated details of the bundle.", "operationId": "updateBundleDetails_1", "parameters": [ { "name": "campaignId", "in": "path", "required": true, "schema": { "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "dimensionId", "in": "path", "required": true, "schema": { "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "bundleId": { "type": "integer", "format": "int32" }, "bundleName": { "type": "string" }, "entityIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "modellingApplied": { "type": "boolean" }, "dimensionId": { "type": "integer", "format": "int32" }, "campaignOptimizationTypeId": { "type": "integer", "format": "int32" } } }, "examples": { "Update bundle request body": { "description": "Update bundle request body", "value": { "bundleDetailList": [ { "bundleId": 3, "bundleName": "Bundle#3", "entityIds": [30, 31] }, { "bundleId": 4, "bundleName": "Bundle#4" }, { "bundleId": 5, "entityIds": [13, 14] } ] } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Single Bundle Update Response": { "description": "Single Bundle Update Response", "value": { "success": true, "data": "Bundle updated successfully" } }, "Bundle Name Update Response": { "description": "Bundle Name Update Response", "value": { "success": true, "data": "Bundle name updated successfully" } }, "Multiple Bundle Update Response": { "description": "Multiple Bundle Update Response", "value": { "success": true, "data": "Bundles updated successfully" } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden !" } ] } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "examples": { "Entity IDs do not exist": { "description": "Entity IDs do not exist", "value": { "success": false, "errorObjects": [ { "error": "Some entity IDs do not exist in the campaign targeting or serving data." } ] } }, "Bundle Already Modelled": { "description": "Bundle Already Modelled", "value": { "success": false, "errorObjects": [ { "error": "Bundle Id : 5 is already modelled and cannot be updated through this API" } ] } }, "Bundle Name Length Exceeded": { "description": "Bundle Name Length Exceeded", "value": { "success": false, "errorObjects": [ { "error": "Invalid bundle name. It must be non-empty and within the allowed character limit." } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/bm/campaigns/{campaignId}/bid-models/dimensions/{dimensionId}": { "post": { "tags": [ "Bid Model API" ], "summary": "List modelled entities reporting with modelling data for a campaign", "description": "Retrieves a list of modelled entities with reporting and their associated modelling data for the provided campaign ID.\nThe modelling data includes priority, spend ratio, spend ratio type, and bid multiplier for each dimension.\nAlso Bundle details are included if available with modelling data.\n", "operationId": "getModelledItemsForCampaignAndDimensionId", "parameters": [ { "name": "campaignId", "in": "path", "description": "The campaign ID for which the report is being generated", "required": true, "schema": { "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "dimensionId", "in": "path", "description": "The dimension ID for which the report is being generated", "required": true, "schema": { "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "description": "Contains filter criteria and parameters for generating the report", "content": { "application/json": { "schema": { "type": "object", "properties": { "sortCriteriaMap": { "type": "object", "additionalProperties": { "type": "string" } }, "responseType": { "type": "string", "enum": [ "default", "total", "list", "bundle" ] }, "startDate": { "type": "integer", "format": "int64" }, "endDate": { "type": "integer", "format": "int64" }, "timezoneId": { "type": "integer", "format": "int32" }, "isExcluded": { "type": "integer", "format": "int32" }, "inventoryTypes": { "type": "array", "items": { "type": "string" } }, "download": { "type": "object", "properties": { "columns": { "type": "array", "items": { "type": "object", "additionalProperties": { "type": "object" } } }, "fileType": { "type": "string" }, "fileName": { "type": "string" } } }, "skipReporting": { "type": "boolean" }, "bundleIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "searchKeywords": { "type": "array", "items": { "type": "string" } }, "performanceFilters": { "type": "object", "properties": { "conditions": { "type": "array", "items": { "type": "object", "properties": { "column": { "type": "string" }, "condition": { "type": "string", "enum": [ "=", "!=", "\u003C", "\u003E", "\u003C=", "\u003E=" ] }, "value": { "type": "number", "format": "double" } } } }, "operation": { "type": "string", "enum": [ "and", "or" ] } } }, "pageNo": { "type": "integer", "format": "int32" }, "noOfEntries": { "type": "integer", "format": "int32" }, "sortBy": { "type": "string" }, "searchField": { "type": "string" }, "order": { "type": "string", "enum": [ "SortOrderEnum[id=1, name='asc', symbol='+']", "SortOrderEnum[id=2, name='desc', symbol='-']" ] } } }, "examples": { "Simple Listing, default sorting": { "description": "Simple Listing, default sorting", "value": { "startDate": 1751001600000, "endDate": 1753593599000, "timeZoneId": 29, "pageNo": 1 } }, "Simple Listing, Sorting by impressions ascending": { "description": "Simple Listing, Sorting by impressions ascending", "value": { "startDate": 1751001600000, "endDate": 1753593599000, "timeZoneId": 29, "pageNo": 1, "sortBy": "+impressions" } }, "Basic Search": { "description": "Basic Search", "value": { "startDate": 1751001600000, "endDate": 1753593599000, "timeZoneId": 29, "pageNo": 1, "sortBy": "+impressions", "searchField": ".com" } }, "Bundle filter": { "description": "Bundle filter", "value": { "startDate": 1751001600000, "endDate": 1753593599000, "timeZoneId": 29, "pageNo": 1, "sortBy": "-impressions", "bundleIds": [187, 186] } }, "Advance Search": { "description": "Advance Search", "value": { "startDate": 1750651200000, "endDate": 1752724799000, "timeZoneId": 29, "sortBy": "+impressions", "pageNo": 1, "searchKeywords": [ "9171361", "keyword 1", "33126", "keyword N" ] } }, "Simple Listing Download file CSV ": { "description": "Simple Listing Download file CSV ", "value": { "startDate": 1751001600000, "endDate": 1753593599000, "timeZoneId": 29, "pageNo": 1, "sortBy": "-impressions", "download": { "fileType": "csv", "columns": [ { "label": "ID", "value": "id" }, { "label": "Inventory Name", "value": "name" }, { "label": "Type", "value": "inventoryType" }, { "label": "Modeling", "value": "modelled" }, { "label": "Impressions", "value": "impressions" }, { "label": "Clicks", "value": "clicks" }, { "label": "Win Rate", "value": "winRate" }, { "label": "CTR", "value": "CTR" }, { "label": "Media eCPM", "value": "eCPM" }, { "label": "Total eCPM", "value": "totalECPM" }, { "label": "Media eCPC", "value": "eCPC" }, { "label": "Total eCPC", "value": "totalECPC" }, { "label": "Media Cost", "value": "mediaSpent" }, { "label": "Data Cost", "value": "dataCost" }, { "label": "Pre-bid Cost", "value": "prebidCost" }, { "label": "Total Spent", "value": "spent" }, { "label": "Total Attributed Conversion Value", "value": "conversionValue" }, { "label": "Total Attributed Conversions", "value": "conversionCount" }, { "label": "Return On Ad Spend", "value": "returnOnAdSpend" }, { "label": "Attributed Click Through Conversions", "value": "attributedClickThroughConversions" }, { "label": "Attributed View Through Conversions", "value": "attributedViewThroughConversions" }, { "label": "Cost Per Attributed Conversions", "value": "costPerAttributedConversions" }, { "label": "Attributed Conversions Rate", "value": "attributedConversionsRate" } ] } } }, "Performance Filter multiple": { "description": "Performance Filter multiple", "value": { "startDate": 1749873600000, "endDate": 1752551999000, "timeZoneId": 29, "sortBy": "+impressions", "pageNo": 1, "performanceFilters": { "operation": "AND", "conditions": [ { "column": "impressions", "condition": "\u003C", "value": 1000 }, { "column": "clicks", "condition": "!=", "value": 2000 } ] } } }, "Performance Filter single": { "description": "Performance Filter single", "value": { "startDate": 1749873600000, "endDate": 1752551999000, "timeZoneId": 29, "sortBy": "+impressions", "pageNo": 1, "performanceFilters": { "conditions": [ { "column": "impressions", "condition": "\u003C", "value": 1000 } ] } } } } } }, "required": true }, "responses": { "200": { "description": "Operation successful", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "errorObjects": { "type": "array", "items": { "type": "object", "properties": { "error": { "type": "string" }, "reason": { "type": "string" }, "field": { "type": "string" } } } }, "data": { "type": "object" } } }, "examples": { "Case 1: Simple Listing": { "description": "Case 1: Simple Listing", "value": "{\n \"success\": true,\n \"data\": {\n \"recordsTotal\": {\n \"totalCount\": 1,\n \"impressions\": 25712,\n \"dataCost\": 0.0,\n \"winRate\": 99.4276875483372,\n \"clicks\": 25651,\n \"eCPM\": 1.0000000000000002,\n \"totalECPM\": 1.0000000000000002,\n \"eCPC\": 0.0010023780749288528,\n \"totalECPC\": 0.0010023780749288528,\n \"mediaSpent\": 25.712000000000003,\n \"CTR\": 99.76275668948351,\n \"spent\": 25.712000000000003,\n \"conversionCount\": 0,\n \"conversionValue\": 0,\n \"attributedClickThroughConversions\": 0,\n \"attributedViewThroughConversions\": 0,\n \"costPerAttributedConversions\": 0.0,\n \"attributedConversionsRate\": 0.0,\n \"returnOnAdSpend\": 0.0,\n \"VCR\": 0.0,\n \"eCPV\": 0.0,\n \"eCPCV\": 0.0,\n \"startCount\": 0,\n \"firstCount\": 0,\n \"midCount\": 0,\n \"thirdCount\": 0,\n \"completeCount\": 0,\n \"bidImpressions\": 25860,\n \"audioVideoViewed\": 0.0,\n \"prebidCost\": 0.0\n },\n \"recordsList\": [\n {\n \"id\": 1001662598,\n \"name\": \"b.fast-stories.com\",\n \"isExcluded\": 0,\n \"modelled\": false,\n \"inventoryTrafficType\": \"web\",\n \"inventoryType\": \"Site\",\n \"blocked\": false,\n \"targeted\": false,\n \"impressions\": 25712,\n \"dataCost\": 0.0,\n \"winRate\": 99.4276875483372,\n \"clicks\": 25651,\n \"eCPM\": 1.0000000000000002,\n \"totalECPM\": 1.0000000000000002,\n \"eCPC\": 0.0010023780749288528,\n \"totalECPC\": 0.0010023780749288528,\n \"mediaSpent\": 25.712000000000003,\n \"CTR\": 99.76275668948351,\n \"spent\": 25.712000000000003,\n \"conversionCount\": 0,\n \"conversionValue\": 0,\n \"attributedClickThroughConversions\": 0,\n \"attributedViewThroughConversions\": 0,\n \"costPerAttributedConversions\": 0.0,\n \"attributedConversionsRate\": 0.0,\n \"returnOnAdSpend\": 0.0,\n \"VCR\": 0.0,\n \"eCPV\": 0.0,\n \"eCPCV\": 0.0,\n \"startCount\": 0,\n \"firstCount\": 0,\n \"midCount\": 0,\n \"thirdCount\": 0,\n \"completeCount\": 0,\n \"bidImpressions\": 25860,\n \"audioVideoViewed\": 0.0,\n \"prebidCost\": 0.0,\n \"bidModelData\": {\n \"id\": 19322,\n \"priority\": 3,\n \"bidMultiplier\": 1.0,\n \"spendRatio\": 100,\n \"spendRatioTypeId\": 1\n },\n },\n {\n \"id\": 1001662599,\n \"name\": \"b.fast-stories.com\",\n \"isExcluded\": 0,\n \"modelled\": false,\n \"inventoryTrafficType\": \"web\",\n \"inventoryType\": \"Site\",\n \"blocked\": false,\n \"targeted\": false,\n \"impressions\": 25712,\n \"dataCost\": 0.0,\n \"winRate\": 99.4276875483372,\n \"clicks\": 25651,\n \"eCPM\": 1.0000000000000002,\n \"totalECPM\": 1.0000000000000002,\n \"eCPC\": 0.0010023780749288528,\n \"totalECPC\": 0.0010023780749288528,\n \"mediaSpent\": 25.712000000000003,\n \"CTR\": 99.76275668948351,\n \"spent\": 25.712000000000003,\n \"conversionCount\": 0,\n \"conversionValue\": 0,\n \"attributedClickThroughConversions\": 0,\n \"attributedViewThroughConversions\": 0,\n \"costPerAttributedConversions\": 0.0,\n \"attributedConversionsRate\": 0.0,\n \"returnOnAdSpend\": 0.0,\n \"VCR\": 0.0,\n \"eCPV\": 0.0,\n \"eCPCV\": 0.0,\n \"startCount\": 0,\n \"firstCount\": 0,\n \"midCount\": 0,\n \"thirdCount\": 0,\n \"completeCount\": 0,\n \"bidImpressions\": 25860,\n \"audioVideoViewed\": 0.0,\n \"prebidCost\": 0.0,\n \"bidModelData\": {\n \"id\": 19324,\n \"priority\": 3,\n \"bidMultiplier\": 1.0,\n \"spendRatio\": 100,\n \"spendRatioTypeId\": 1\n },\n }\n ],\n \"totalRecords\": 2,\n \"filteredRecords\": 2,\n \"campaignBidDetails\": {\n \"baseBid\": 1.0,\n \"lastPerformanceCheck\": 1752642013474,\n \"maxBid\": 1.0,\n \"currentPriority\": 10,\n \"nextPerformanceCheck\": 1752728400000\n }\n }\n}\n" }, "Bundle Listing": { "description": "Bundle Listing", "value": "{\n \"success\": true,\n \"data\": {\n \"recordsTotal\": {\n \"totalCount\": 1,\n \"impressions\": 25712,\n \"dataCost\": 0.0,\n \"winRate\": 99.4276875483372,\n \"clicks\": 25651,\n \"eCPM\": 1.0000000000000002,\n \"totalECPM\": 1.0000000000000002,\n \"eCPC\": 0.0010023780749288528,\n \"totalECPC\": 0.0010023780749288528,\n \"mediaSpent\": 25.712000000000003,\n \"CTR\": 99.76275668948351,\n \"spent\": 25.712000000000003,\n \"conversionCount\": 0,\n \"conversionValue\": 0,\n \"attributedClickThroughConversions\": 0,\n \"attributedViewThroughConversions\": 0,\n \"costPerAttributedConversions\": 0.0,\n \"attributedConversionsRate\": 0.0,\n \"returnOnAdSpend\": 0.0,\n \"VCR\": 0.0,\n \"eCPV\": 0.0,\n \"eCPCV\": 0.0,\n \"startCount\": 0,\n \"firstCount\": 0,\n \"midCount\": 0,\n \"thirdCount\": 0,\n \"completeCount\": 0,\n \"bidImpressions\": 25860,\n \"audioVideoViewed\": 0.0,\n \"prebidCost\": 0.0\n },\n \"recordsList\": [\n {\n \"bundleId\": 1,\n \"bundleName\": \"bundle1\",\n \"bundleEntityIds\": [1, 2, 3],\n \"impressions\": 25712,\n \"dataCost\": 0.0,\n \"winRate\": 99.4276875483372,\n \"clicks\": 25651,\n \"eCPM\": 1.0000000000000002,\n \"totalECPM\": 1.0000000000000002,\n \"eCPC\": 0.0010023780749288528,\n \"totalECPC\": 0.0010023780749288528,\n \"mediaSpent\": 25.712000000000003,\n \"CTR\": 99.76275668948351,\n \"spent\": 25.712000000000003,\n \"conversionCount\": 0,\n \"conversionValue\": 0,\n \"attributedClickThroughConversions\": 0,\n \"attributedViewThroughConversions\": 0,\n \"costPerAttributedConversions\": 0.0,\n \"attributedConversionsRate\": 0.0,\n \"returnOnAdSpend\": 0.0,\n \"VCR\": 0.0,\n \"eCPV\": 0.0,\n \"eCPCV\": 0.0,\n \"startCount\": 0,\n \"firstCount\": 0,\n \"midCount\": 0,\n \"thirdCount\": 0,\n \"completeCount\": 0,\n \"bidImpressions\": 25860,\n \"audioVideoViewed\": 0.0,\n \"prebidCost\": 0.0,\n \"entityRecordsList\": [\n {\n \"id\": 1001662596,\n \"name\": \"b.fast-stories.com\",\n \"isExcluded\": 0,\n \"modelled\": false,\n \"inventoryTrafficType\": \"web\",\n \"inventoryType\": \"Site\",\n \"blocked\": false,\n \"targeted\": false,\n \"impressions\": 25712,\n \"dataCost\": 0.0,\n \"winRate\": 99.4276875483372,\n \"clicks\": 25651,\n \"eCPM\": 1.0000000000000002,\n \"totalECPM\": 1.0000000000000002,\n \"eCPC\": 0.0010023780749288528,\n \"totalECPC\": 0.0010023780749288528,\n \"mediaSpent\": 25.712000000000003,\n \"CTR\": 99.76275668948351,\n \"spent\": 25.712000000000003,\n \"conversionCount\": 0,\n \"conversionValue\": 0,\n \"attributedClickThroughConversions\": 0,\n \"attributedViewThroughConversions\": 0,\n \"costPerAttributedConversions\": 0.0,\n \"attributedConversionsRate\": 0.0,\n \"returnOnAdSpend\": 0.0,\n \"VCR\": 0.0,\n \"eCPV\": 0.0,\n \"eCPCV\": 0.0,\n \"startCount\": 0,\n \"firstCount\": 0,\n \"midCount\": 0,\n \"thirdCount\": 0,\n \"completeCount\": 0,\n \"bidImpressions\": 25860,\n \"audioVideoViewed\": 0.0,\n \"prebidCost\": 0.0\n },\n {\n \"id\": 1001662597,\n \"name\": \"b.fast-stories.com\",\n \"isExcluded\": 0,\n \"modelled\": false,\n \"inventoryTrafficType\": \"web\",\n \"inventoryType\": \"Site\",\n \"blocked\": false,\n \"targeted\": false,\n \"impressions\": 25712,\n \"dataCost\": 0.0,\n \"winRate\": 99.4276875483372,\n \"clicks\": 25651,\n \"eCPM\": 1.0000000000000002,\n \"totalECPM\": 1.0000000000000002,\n \"eCPC\": 0.0010023780749288528,\n \"totalECPC\": 0.0010023780749288528,\n \"mediaSpent\": 25.712000000000003,\n \"CTR\": 99.76275668948351,\n \"spent\": 25.712000000000003,\n \"conversionCount\": 0,\n \"conversionValue\": 0,\n \"attributedClickThroughConversions\": 0,\n \"attributedViewThroughConversions\": 0,\n \"costPerAttributedConversions\": 0.0,\n \"attributedConversionsRate\": 0.0,\n \"returnOnAdSpend\": 0.0,\n \"VCR\": 0.0,\n \"eCPV\": 0.0,\n \"eCPCV\": 0.0,\n \"startCount\": 0,\n \"firstCount\": 0,\n \"midCount\": 0,\n \"thirdCount\": 0,\n \"completeCount\": 0,\n \"bidImpressions\": 25860,\n \"audioVideoViewed\": 0.0,\n \"prebidCost\": 0.0\n }\n ],\n \"bidModelData\": {\n \"id\": 19324,\n \"priority\": 3,\n \"bidMultiplier\": 1.0,\n \"spendRatio\": 100,\n \"spendRatioTypeId\": 1\n },\n },\n {\n \"id\": 1001662598,\n \"name\": \"b.fast-stories.com\",\n \"isExcluded\": 0,\n \"modelled\": false,\n \"inventoryTrafficType\": \"web\",\n \"inventoryType\": \"Site\",\n \"blocked\": false,\n \"targeted\": false,\n \"impressions\": 25712,\n \"dataCost\": 0.0,\n \"winRate\": 99.4276875483372,\n \"clicks\": 25651,\n \"eCPM\": 1.0000000000000002,\n \"totalECPM\": 1.0000000000000002,\n \"eCPC\": 0.0010023780749288528,\n \"totalECPC\": 0.0010023780749288528,\n \"mediaSpent\": 25.712000000000003,\n \"CTR\": 99.76275668948351,\n \"spent\": 25.712000000000003,\n \"conversionCount\": 0,\n \"conversionValue\": 0,\n \"attributedClickThroughConversions\": 0,\n \"attributedViewThroughConversions\": 0,\n \"costPerAttributedConversions\": 0.0,\n \"attributedConversionsRate\": 0.0,\n \"returnOnAdSpend\": 0.0,\n \"VCR\": 0.0,\n \"eCPV\": 0.0,\n \"eCPCV\": 0.0,\n \"startCount\": 0,\n \"firstCount\": 0,\n \"midCount\": 0,\n \"thirdCount\": 0,\n \"completeCount\": 0,\n \"bidImpressions\": 25860,\n \"audioVideoViewed\": 0.0,\n \"prebidCost\": 0.0,\n \"bidModelData\": {\n \"id\": 19323,\n \"priority\": 3,\n \"bidMultiplier\": 1.0,\n \"spendRatio\": 100,\n \"spendRatioTypeId\": 1\n },\n },\n {\n \"id\": 1001662599,\n \"name\": \"b.fast-stories.com\",\n \"isExcluded\": 0,\n \"modelled\": false,\n \"inventoryTrafficType\": \"web\",\n \"inventoryType\": \"Site\",\n \"blocked\": false,\n \"targeted\": false,\n \"impressions\": 25712,\n \"dataCost\": 0.0,\n \"winRate\": 99.4276875483372,\n \"clicks\": 25651,\n \"eCPM\": 1.0000000000000002,\n \"totalECPM\": 1.0000000000000002,\n \"eCPC\": 0.0010023780749288528,\n \"totalECPC\": 0.0010023780749288528,\n \"mediaSpent\": 25.712000000000003,\n \"CTR\": 99.76275668948351,\n \"spent\": 25.712000000000003,\n \"conversionCount\": 0,\n \"conversionValue\": 0,\n \"attributedClickThroughConversions\": 0,\n \"attributedViewThroughConversions\": 0,\n \"costPerAttributedConversions\": 0.0,\n \"attributedConversionsRate\": 0.0,\n \"returnOnAdSpend\": 0.0,\n \"VCR\": 0.0,\n \"eCPV\": 0.0,\n \"eCPCV\": 0.0,\n \"startCount\": 0,\n \"firstCount\": 0,\n \"midCount\": 0,\n \"thirdCount\": 0,\n \"completeCount\": 0,\n \"bidImpressions\": 25860,\n \"audioVideoViewed\": 0.0,\n \"prebidCost\": 0.0,\n \"bidModelData\": {\n \"id\": 19325,\n \"priority\": 3,\n \"bidMultiplier\": 1.0,\n \"spendRatio\": 100,\n \"spendRatioTypeId\": 1\n },\n }\n ],\n \"totalRecords\": 4,\n \"filteredRecords\": 4\n }\n}\n" }, "Report download CSV or XLS": { "description": "Report download CSV or XLS", "value": { "success": true, "data": { "url": "DownloadURL" } } } } } } }, "401": { "description": "Unauthorized access", "content": { "*/*": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "errorObjects": { "type": "array", "items": { "type": "object", "properties": { "error": { "type": "string" }, "reason": { "type": "string" }, "field": { "type": "string" } } } }, "data": { "type": "object" } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden !" } ] } } } }, "422": { "description": "Unprocessable Entity, invalid input data", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "errorObjects": { "type": "array", "items": { "type": "object", "properties": { "error": { "type": "string" }, "reason": { "type": "string" }, "field": { "type": "string" } } } }, "data": { "type": "object" } } }, "examples": { "Invalid campaignId Response": { "description": "Invalid campaignId Response", "value": { "success": false, "errorObjects": [ { "error": "The campaign ID is missing or invalid. Please provide a valid campaign ID." } ] } }, "Invalid dimensionId Response": { "description": "Invalid dimensionId Response", "value": { "success": false, "errorObjects": [ { "error": "The dimension ID is invalid. Please provide a valid dimension ID." } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/bm/bid-models/dimension/entity": { "post": { "tags": [ "Bid Model API" ], "description": "Retrieves the modelled entity for given dimension and entity ids with campaign data", "operationId": "getModelledEntityData", "parameters": [ { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "dimensionId": { "type": "integer", "format": "int32" }, "entityIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "removeEntityIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "campaignId": { "type": "integer", "format": "int32" }, "includeCampaignInfo": { "type": "boolean" }, "groupIdBased": { "type": "boolean" } } }, "examples": { "Request with valid dimensionId and entityIds for only getting modelled entity": { "description": "Request with valid dimensionId and entityIds for only getting modelled entity", "value": { "dimensionId": 10, "entityIds": [30200036, 30200031, 30200105, 4695] } }, "Request with valid dimensionId and entityIds for getting modelled entity and campaign data": { "description": "Request with valid dimensionId and entityIds for getting modelled entity and campaign data", "value": { "dimensionId": 10, "entityIds": [30200036, 30200031, 30200105, 4695], "includeCampaignInfo": true } }, "Request with valid dimensionId and entityIds for getting modelled entity and campaign data and entityIds passed as groupIds": { "description": "Request with valid dimensionId and entityIds for getting modelled entity and campaign data and entityIds passed as groupIds", "value": { "dimensionId": 10, "entityIds": [30200036, 30200031, 30200105, 4695], "includeCampaignInfo": true, "groupIdBased": true } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/mediaType": { "examples": { "Successful Message": { "description": "Successful Message", "value": { "success": true, "data": { "modelledEntityIds": [30200036, 30200031, 30200105], "modelledCampaignDetails": [ { "entityId": 30200036, "campaignIds": [555804, 556956, 556891, 557141, 560100] }, { "entityId": 30200031, "campaignIds": [556979, 555927, 555926, 560102, 555925, 555748] }, { "entityId": 30200105, "campaignIds": [555787] }, { "entityId": 4695, "campaignIds": [] } ] } } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "examples": { "Validation error": { "description": "Validation error", "value": { "success": false, "errorObjects": { "error": "The dimension ID is invalid. Please provide a valid dimension ID." } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden !" } ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/internal/bm/bundles/entities/mappings/removals": { "patch": { "tags": [ "Bid Model API" ], "summary": "Update campaign bundles by removing entities based on removal data provided", "description": "This API removes specific entities from campaign bundles based on the provided targeting removal data.\nIt supports removal at the dimension level and includes special handling for Deal Groups by translating group IDs into individual Deal IDs before processing.\nIf all entities of a bundle are removed, the entire bundle is marked for deletion.\nOtherwise, only the specified entity mappings are removed\n", "operationId": "removeEntitiesFromBundle", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "bundleIds": { "type": "array", "items": { "type": "integer", "format": "int32" } } } }, "examples": { "Only Group-Based Deal Removal": { "description": "Only Group-Based Deal Removal", "value": { "dimensionToBundleRemovalEntities": [ { "dimensionId": 3, "removedEntityIds": [190392, 190393], "groupIdBased": true, "campaignId": 449823 } ] } }, "Remove entity-to-bundle mappings for multiple dimensions": { "description": "Remove entity-to-bundle mappings for multiple dimensions", "value": { "dimensionToBundleRemovalEntities": [ { "dimensionId": 5, "removedEntityIds": [12, 13, 14], "groupIdBased": false, "campaignId": 449823 }, { "dimensionId": 1, "removedEntityIds": [1, 3, 2], "groupIdBased": false, "campaignId": 449823 } ] } }, "Mixed Dimensions with Group and Non-group Based Entities": { "description": "Mixed Dimensions with Group and Non-group Based Entities", "value": { "dimensionToBundleRemovalEntities": [ { "dimensionId": 4, "removedEntityIds": [1, 2, 3], "groupIdBased": false, "campaignId": 449823 }, { "dimensionId": 3, "removedEntityIds": [4, 5, 6], "groupIdBased": true, "campaignId": 449823 } ] } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Success Response": { "description": "Success Response", "value": { "success": true, "data": "Entities removed from bundles successfully" } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden !" } ] } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "examples": { "Bundle Not Found": { "description": "Bundle Not Found", "value": { "success": false, "errorObjects": [ { "error": "Dimension to bundle removal entities cannot be empty or null." } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/internal/bm/campaigns/{campaignId}/dimension/{dimensionId}/spent": { "get": { "tags": [ "Bid Model API" ], "summary": "Retrieves the total spent dimension-wise for a specified campaign", "description": "Retrieves the total spent dimension-wise for a specified campaign, supporting filtering by dimension ID through a query parameter", "operationId": "getDimensionWiseEntitySpentForCampaign", "parameters": [ { "name": "campaignId", "in": "path", "description": "The campaign ID to fetch the total spent for", "required": true, "schema": { "type": "integer" } }, { "name": "dimensionId", "in": "path", "description": "The dimension ID to fetch the total spent for", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successfully retrieved the dimension-wise spent of all dimensions items", "content": { "application/json": { "examples": { "Response for Creative Spent Values Dimension": { "description": "Response for Creative Spent Values Dimension", "value": { "success": true, "data": { "entityWiseSpent": { "1": 5.1, "2": 5.76, "3": 5.34 } } } }, "Response for No Spent Values Dimension": { "description": "Response for No Spent Values Dimension", "value": { "success": true, "data": { "entityWiseSpent": { } } } } } } } }, "422": { "description": "No campaign found with the given ID", "content": { "application/json": { "examples": { "Invalid campaignId Response": { "description": "Invalid campaignId Response", "value": { "success": false, "errorObjects": [ { "error": "The campaign ID is missing or invalid. Please provide a valid campaign ID." } ] } }, "Invalid dimensionId Response": { "description": "Invalid dimensionId Response", "value": { "success": false, "errorObjects": [ { "error": "The dimension ID is invalid. Please provide a valid dimension ID." } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/internal/bm/campaigns/{campaignId}/bundles": { "get": { "tags": [ "Bid Model API" ], "summary": "This API fetches list of bundles linked to a specific campaign and dimension, along with their entities details and modelling status [Internal].\nIt supports optional filtering by bundle name, bundle ID, and dimension ID\n", "description": "This internal API retrieves bundle details for a given campaign and dimension.\nIt returns a list of bundles, including their associated entities and modelling status.\nYou can optionally filter results by bundle name or ID using the search field.\nAdditionally, you can filter by dimension ID — if not provided, all bundles for the campaign are returned.\nThis endpoint is intended for internal system usage only.\n", "operationId": "getBundleDetailsList", "parameters": [ { "name": "DimensionId", "in": "query", "description": "Optional dimension ID to filter bundles by a specific dimension. If not provided, it returns all bundles for the campaign.", "required": true }, { "name": "searchField", "in": "query", "description": "Optional search field to filter bundles by name or ID. If provided, it filters bundles whose names or IDs match the search term.", "required": false, "schema": { "type": "string" } }, { "name": "dimensionId", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "campaignId", "in": "path", "required": true, "schema": { "minimum": 1, "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Success Response without Dimension ID and search field filter": { "description": "Success Response without Dimension ID and search field filter", "value": { "success": true, "data": [ { "bundleId": 12, "bundleName": "bundle#1", "dimensionId": 1, "entityIds": [7, 8, 9], "modellingApplied": false }, { "bundleId": 13, "bundleName": "bundle#2", "dimensionId": 2, "entityIds": [1, 2, 3], "modellingApplied": true } ] } }, "Success response when filtering bundles by Dimension ID 1": { "description": "Success response when filtering bundles by Dimension ID 1", "value": "{\n \"success\": true,\n \"data\": [\n {\n \"bundleId\": 12,\n \"bundleName\": \"bundle#1\",\n \"dimensionId:1,\n \"entityIds\": [\n 7,\n 8,\n 9\n ],\n \"modellingApplied\": false\n },\n {\n \"bundleId\": 13,\n \"bundleName\": \"bundle#2\",\n \"dimensionId\":1,\n \"entityIds\": [\n 1,\n 2,\n 3\n ],\n \"modellingApplied\": true\n }\n ]\n}\n" }, "Success response when filtering bundles with the search term 'bundle'": { "description": "Success response when filtering bundles with the search term 'bundle'", "value": "{\n \"success\": true,\n \"data\": [\n {\n \"bundleId\": 12,\n \"bundleName\": \"bundle#1\",\n \"dimensionId:1,\n \"entityIds\": [\n 7,\n 8,\n 9\n ],\n \"modellingApplied\": false\n },\n {\n \"bundleId\": 13,\n \"bundleName\": \"bundle#2\",\n \"dimensionId\":1,\n \"entityIds\": [\n 1,\n 2,\n 3\n ],\n \"modellingApplied\": true\n }\n ]\n}\n" } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden !" } ] } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "examples": { "Invalid Campaign ID or Dimension ID": { "description": "Invalid Campaign ID or Dimension ID", "value": { "success": false, "errorObjects": [ { "error": "The campaign ID is missing or invalid. Please provide a valid campaign ID." } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/internal/bm/campaigns/{campaignId}/bid-model-data": { "get": { "tags": [ "Bid Model API" ], "summary": "Get Goal AI Bid Modelling Details", "description": "Retrieves the Goal AI bid modelling details for a specific campaign and its dimensions.\nThis endpoint provides information about the entities modelled based on the selected dimensions.\n- If no dimension IDs are provided, it defaults to all valid dimension IDs: [1, 11, 10, 12, 3, 4, 5, 7, 8, 13].\n- Valid dimension IDs are: [1, 11, 10, 12, 3, 4, 5, 7, 8, 13].\n- The response includes details such as entity ID, priority, bid multiplier, spend ratio, dimension ID,\n bid model data ID, bundle name (if applicable), entity IDs (for bundles), bundle ID (if applicable), and entity type ID.\n- The endpoint is designed for internal use and is not intended for public consumption.\n- This API is specifically for campaigns using AI-based optimization.\n", "operationId": "getGoalAIBidModellingDetails", "parameters": [ { "name": "campaignId", "in": "path", "description": "Unique Identifier for Campaign", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "dimensionIds", "in": "query", "description": "Comma separated Dimension IDs to filter the response. Valid dimension IDs are: [1, 11, 10, 12, 3, 4, 5, 7, 8, 13]. If not provided, defaults to [1, 11, 10, 12, 3, 4, 5, 7, 8, 13]", "required": true, "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "List of modelled entities": { "description": "List of modelled entities", "value": { "success": true, "data": [ { "dimensionId": 3, "bidModelData": [ { "entityId": -1, "priority": 10, "bidMultiplier": 1, "spendRatio": 100, "spendRatioTypeId": 1, "bidModelDataId": 26, "entityTypeId": 3 }, { "entityId": 2127, "priority": 1, "bidMultiplier": 1, "spendRatio": 100, "spendRatioTypeId": 1, "bidModelDataId": 27, "entityTypeId": 1 }, { "entityId": 19, "priority": 1, "bidMultiplier": 1, "spendRatio": 100, "spendRatioTypeId": 1, "bidModelDataId": 28, "bundleName": "bundle-goal-ai", "entityIds": [1, 2, 3, 4, 5], "bundleId": 19, "entityTypeId": 2 } ] } ] } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden !" } ] } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "examples": { "Bundle Not Found": { "description": "Bundle Not Found", "value": { "success": false, "errorObjects": [ { "error": "Some of the provided dimension IDs are invalid. Valid dimension IDs are: [1,2,4,5,6]" } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/bm/static/dimensions": { "get": { "tags": [ "Bid Model API" ], "summary": "This API will provide the list of bid-model dimensions .", "description": "This API will provide values of bid-model dimensions and sub-dimensions", "operationId": "getDimensions", "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "success": true, "data": { "totalRecords": 5, "filteredRecords": 5, "dimensions": [ { "name": "creative", "id": 1, "label": "Creative", "order": 1, "modellingEnabled": true }, { "name": "inventory", "id": 2, "label": "Inventory", "order": 2, "modellingEnabled": false, "subdimensions": [ { "name": "deal_id", "id": 3, "label": "Deal ID", "order": 1, "modellingEnabled": false }, { "name": "open_exchange", "id": 4, "label": "Open Exchange", "order": 2, "modellingEnabled": false }, { "name": "publisher_category", "id": 5, "label": "Publisher Category", "order": 3, "modellingEnabled": false } ] }, { "name": "device", "id": 6, "label": "Device", "order": 3, "modellingEnabled": false, "subdimensions": [ { "name": "traffic_type", "id": 7, "label": "Traffic Type", "order": 1, "modellingEnabled": false }, { "name": "device_type", "id": 8, "label": "Device Type", "order": 2, "modellingEnabled": false } ] }, { "name": "location", "id": 9, "label": "Location", "order": 4, "modellingEnabled": false, "subdimensions": [ { "name": "state", "id": 10, "label": "State", "order": 1, "modellingEnabled": false }, { "name": "city", "id": 11, "label": "City", "order": 2, "modellingEnabled": false }, { "name": "zip", "id": 12, "label": "Zip", "order": 3, "modellingEnabled": false } ] }, { "name": "exchange", "id": 13, "label": "Exchange", "order": 5, "modellingEnabled": false } ] } } } } } } } }, "/api/v3/bm/campaigns/{campaignId}/dimension/{dimensionId}/spent": { "get": { "tags": [ "Bid Model API" ], "summary": "Retrieves the total spent dimension-wise for a specified campaign", "description": "Retrieves the total spent dimension-wise for a specified campaign, supporting filtering by dimension ID through a query parameter, For ", "operationId": "getDimensionWiseEntitySpentForCampaign_1", "parameters": [ { "name": "campaignId", "in": "path", "description": "The campaign ID to fetch the total spent for", "required": true, "schema": { "type": "integer" } }, { "name": "dimensionId", "in": "path", "description": "The dimension ID to fetch the total spent for", "required": true, "schema": { "type": "integer" } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "Successfully retrieved the dimension-wise spent of all dimensions items", "content": { "application/json": { "examples": { "Response for Creative Spent Values Dimension": { "description": "Response for Creative Spent Values Dimension", "value": { "success": true, "data": { "entityWiseSpent": { "1": 5.1, "2": 5.76, "3": 5.34 } } } }, "Response for No Spent Values Dimension": { "description": "Response for No Spent Values Dimension", "value": { "success": true, "data": { "entityWiseSpent": { } } } } } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "errorObjects": { "type": "array", "items": { "type": "object", "properties": { "error": { "type": "string" }, "reason": { "type": "string" }, "field": { "type": "string" } } } }, "data": { "type": "object", "properties": { "entityWiseSpent": { "type": "object", "additionalProperties": { "type": "number", "format": "double" } } } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden !" } ] } } } }, "422": { "description": "No campaign found with the given ID", "content": { "application/json": { "examples": { "Invalid campaignId Response": { "description": "Invalid campaignId Response", "value": { "success": false, "errorObjects": [ { "error": "The campaign ID is missing or invalid. Please provide a valid campaign ID." } ] } }, "Invalid dimensionId Response": { "description": "Invalid dimensionId Response", "value": { "success": false, "errorObjects": [ { "error": "The dimension ID is invalid. Please provide a valid dimension ID." } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/bm/campaigns/{campaignId}/bundles": { "get": { "tags": [ "Bid Model API" ], "summary": "This API fetches list of bundles linked to a specific campaign and dimension, along with their entities details and modelling status.\nIt supports optional filtering by bundle name, bundle ID, and dimension ID\n", "description": "This API retrieves bundle details for a given campaign and dimension.\nIt returns a list of bundles, including their associated entities and modelling status.\nYou can optionally filter results by bundle name or ID using the search field.\nAdditionally, you can filter by dimension ID — if not provided, all bundles for the campaign are returned\n", "operationId": "getBundleDetailsList_1", "parameters": [ { "name": "DimensionId", "in": "query", "description": "Optional dimension ID to filter bundles by a specific dimension. If not provided, it returns all bundles for the campaign.", "required": true }, { "name": "searchField", "in": "query", "description": "Optional search field to filter bundles by name or ID. If provided, it filters bundles whose names or IDs match the search term.", "required": false, "schema": { "type": "string" } }, { "name": "dimensionId", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "campaignId", "in": "path", "required": true, "schema": { "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Success Response without Dimension ID and search field filter": { "description": "Success Response without Dimension ID and search field filter", "value": { "success": true, "data": [ { "bundleId": 12, "bundleName": "bundle#1", "dimensionId": 1, "entityIds": [7, 8, 9], "modellingApplied": false }, { "bundleId": 13, "bundleName": "bundle#2", "dimensionId": 2, "entityIds": [1, 2, 3], "modellingApplied": true } ] } }, "Success response when filtering bundles by Dimension ID 1": { "description": "Success response when filtering bundles by Dimension ID 1", "value": "{\n \"success\": true,\n \"data\": [\n {\n \"bundleId\": 12,\n \"bundleName\": \"bundle#1\",\n \"dimensionId:1,\n \"entityIds\": [\n 7,\n 8,\n 9\n ],\n \"modellingApplied\": false\n },\n {\n \"bundleId\": 13,\n \"bundleName\": \"bundle#2\",\n \"dimensionId\":1,\n \"entityIds\": [\n 1,\n 2,\n 3\n ],\n \"modellingApplied\": true\n }\n ]\n}\n" }, "Success response when filtering bundles with the search term 'bundle'": { "description": "Success response when filtering bundles with the search term 'bundle'", "value": "{\n \"success\": true,\n \"data\": [\n {\n \"bundleId\": 12,\n \"bundleName\": \"bundle#1\",\n \"dimensionId:1,\n \"entityIds\": [\n 7,\n 8,\n 9\n ],\n \"modellingApplied\": false\n },\n {\n \"bundleId\": 13,\n \"bundleName\": \"bundle#2\",\n \"dimensionId\":1,\n \"entityIds\": [\n 1,\n 2,\n 3\n ],\n \"modellingApplied\": true\n }\n ]\n}\n" } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden !" } ] } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "examples": { "Invalid Campaign ID or Dimension ID": { "description": "Invalid Campaign ID or Dimension ID", "value": { "success": false, "errorObjects": [ { "error": "The campaign ID is missing or invalid. Please provide a valid campaign ID." } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/bm/campaign/{campaignId}/dimensions/bid-models/count": { "get": { "tags": [ "Bid Model API" ], "summary": "Retrieves the total count(number of items associate with campaign), dimension-wise id and count of modelled items for a specified campaign", "description": "This retrieves dimension statistics for a campaign :\nDimension Statistics includes :\n * dimension : Dimension ID (creative, state, city, deal... etc\n * Total count : Total number of entities in a dimension, ex : state : number of status attach to campaign id.\n * Modelled count : Number of entities modelled in a dimension\n * modelledIds : List of modelled entity ids.\nParameters :\n * campaignId : The campaign ID to fetch the total spent for\n * startDate : The start date for the spent\n * endDate : The end date for the spent\nThrough startDate & endDate we will get total count(target + serve) for campaign.\n", "operationId": "getDimensionStatistics", "parameters": [ { "name": "campaignId", "in": "path", "description": "The campaign ID to fetch the dimension statistics", "required": true, "schema": { "type": "integer" } }, { "name": "startDate", "in": "query", "description": "Start date(in milliseconds epoch) for the total count", "required": true, "schema": { "type": "long" } }, { "name": "endDate", "in": "query", "description": "End date(in milliseconds epoch) for the total count", "required": true, "schema": { "type": "long" } }, { "name": "attributes", "in": "query", "description": "List of attributes to be fetched, valid values are : [\"totalCount\",\"modelledCount\",\"modelledIds\"]", "required": true, "schema": { "type": "string" } }, { "name": "dimensionIds", "in": "query", "description": "List of comma separated dimension IDs to fetch statistics for, valid values are : [1 - Creative, 10 - State, 11 - City, 12 - Zip, 3 - Deal, 4 - Open Exchange, 5 - Publisher Category, 13 - Exchange, 7 - Traffic Type, 8 - Device Type]", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Successfully retrieved of dimension statistics with attributes passed [\"totalCount\",\"modelledCount\",\"modelledIds\"]": { "description": "Successfully retrieved of dimension statistics with attributes passed [\"totalCount\",\"modelledCount\",\"modelledIds\"]", "value": { "success": true, "data": { "1": { "totalCount": 5, "modelledCount": 3, "modelledIds": [1, 2, 3] }, "3": { "totalCount": 0, "modelledCount": 0, "modelledIds": null }, "4": { "totalCount": 10, "modelledCount": 5, "modelledIds": [1, 2, 3, 4, 5] }, "5": { "totalCount": 0, "modelledCount": 0, "modelledIds": null }, "11": { "totalCount": 0, "modelledCount": 0, "modelledIds": null }, "12": { "totalCount": 0, "modelledCount": 0, "modelledIds": null }, "13": { "totalCount": 0, "modelledCount": 0, "modelledIds": null } } } }, "Successfully retrieved of dimension statistics with attributes passed [\"totalCount\"]": { "description": "Successfully retrieved of dimension statistics with attributes passed [\"totalCount\"]", "value": { "success": true, "data": { "1": { "totalCount": 5 }, "3": { "totalCount": 0 }, "4": { "totalCount": 10 }, "5": { "totalCount": 0 }, "11": { "totalCount": 0 }, "12": { "totalCount": 0 }, "13": { "totalCount": 0 } } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden !" } ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/internal/bm/campaigns/{campaignId}/bid-models": { "delete": { "tags": [ "Bid Model API" ], "summary": "Delete all bid modelling data for a specific campaign", "description": "This API deletes all bid modelling data for a specific campaign. It removes all associated dimensions and bid model data, and re-evaluates the campaign's serving priority.", "operationId": "deleteBidModelling", "parameters": [ { "name": "campaignId", "in": "path", "description": "Unique Identifier for Campaign", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Success Response": { "description": "Success Response", "value": { "success": true, "data": "Bid Modelling deleted successfully!" } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden !" } ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/plan/hcp/proposal/{planId}": { "put": { "tags": [ "Planner API" ], "summary": "API to edit plan for the HCP planner", "description": "Validates user access, retrieves vertical type, and creates ready proposal.", "operationId": "editProposal", "parameters": [ { "name": "planId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "Request body containing the details of the ready proposal", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "startTime": { "type": "integer", "format": "int64" }, "endTime": { "type": "integer", "format": "int64" }, "timezoneId": { "type": "integer", "format": "int64" }, "budgetTypeId": { "type": "integer", "format": "int32" }, "owId": { "type": "integer", "format": "int32" }, "createdAt": { "type": "integer", "format": "int64" }, "updatedAt": { "type": "integer", "format": "int64" }, "minBudget": { "type": "number" }, "budget": { "type": "number" }, "maxBudget": { "type": "number" }, "reach": { "type": "integer", "format": "int64" }, "maxReach": { "type": "integer", "format": "int64" }, "minImpressions": { "type": "integer", "format": "int64" }, "impressions": { "type": "integer", "format": "int64" }, "maxImpressions": { "type": "integer", "format": "int64" }, "frequencyCap": { "type": "integer", "format": "int32" }, "statusId": { "type": "integer", "format": "int32" }, "audienceBlocks": { "type": "array", "items": { "type": "object", "properties": { "audienceSelectionMethodId": { "type": "integer", "format": "int32" }, "npiTypeIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "speciality": { "type": "object", "properties": { "specialityIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "allSpecialitiesSelected": { "type": "boolean" } } }, "account": { "type": "object", "properties": { "accountIds": { "type": "array", "items": { "type": "integer", "format": "int64" } }, "allAccountsSelected": { "type": "boolean" } } }, "accountType": { "type": "object", "properties": { "accountTypeIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "allAccountTypesSelected": { "type": "boolean" } } }, "healthSystem": { "type": "object", "properties": { "healthSystemIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "allHealthSystemsSelected": { "type": "boolean" } } }, "title": { "type": "object", "properties": { "titleIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "allTitlesSelected": { "type": "boolean" } } }, "locations": { "required": [ "countryId" ], "type": "object", "properties": { "countryId": { "type": "integer", "format": "int32" }, "whiteListedStateIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "blackListedStateIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "whiteListedCityIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "blackListedCityIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "whiteListedZipcodeIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "blackListedZipcodeIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "whiteListedZipcodes": { "type": "array", "items": { "type": "string" } }, "blackListedZipcodes": { "type": "array", "items": { "type": "string" } } } }, "dataPartners": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "reach": { "type": "integer", "format": "int64" }, "priority": { "type": "integer", "format": "int32" }, "selected": { "type": "boolean" }, "incrementalReach": { "type": "integer", "format": "int64" } } } }, "storagePathId": { "type": "integer", "format": "int32" }, "storagePath": { "type": "string" }, "storageFileName": { "type": "string" }, "storageFileSize": { "type": "integer", "format": "int64" }, "storageFileRows": { "type": "integer", "format": "int32" }, "includeAudienceIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "excludeAudienceIds": { "type": "array", "items": { "type": "integer", "format": "int32" } } } } }, "planLevelTargeting": { "type": "object", "properties": { "devices": { "type": "object", "properties": { "deviceTypeIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "allDeviceTypesSelected": { "type": "boolean" } } }, "channels": { "type": "object", "properties": { "channelTypeIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "allChannelTypesSelected": { "type": "boolean" } } }, "creativeTypes": { "type": "object", "properties": { "creativeTypeIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "allCreativeTypesSelected": { "type": "boolean" }, "isTvAutoBuying": { "type": "boolean" } } }, "inventory": { "type": "object", "properties": { "openExchanges": { "type": "object", "properties": { "exchangeIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "allExchangesSelected": { "type": "boolean" }, "iabCategoryIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "allIabCategoriesSelected": { "type": "boolean" } } }, "inventoryGroup": { "type": "object", "properties": { "inventoryGroupIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "allInventoryGroupsSelected": { "type": "boolean" } } } } } } }, "splitStrategy": { "type": "array", "items": { "type": "object", "properties": { "splitDimensionTypeId": { "type": "integer", "format": "int32" }, "selectedValueIds": { "type": "array", "items": { "type": "integer", "format": "int32" } } } } }, "campaigns": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "startTime": { "type": "integer", "format": "int64" }, "endTime": { "type": "integer", "format": "int64" }, "frequencyCap": { "type": "integer", "format": "int32" }, "minMediaCpm": { "type": "number" }, "mediaCpm": { "type": "number" }, "maxMediaCpm": { "type": "number" }, "dataCpm": { "type": "number" }, "minBudget": { "type": "number" }, "budget": { "type": "number" }, "maxBudget": { "type": "number" }, "minReach": { "type": "integer", "format": "int64" }, "reach": { "type": "integer", "format": "int64" }, "maxReach": { "type": "integer", "format": "int64" }, "minImpressions": { "type": "integer", "format": "int64" }, "impressions": { "type": "integer", "format": "int64" }, "maxImpressions": { "type": "integer", "format": "int64" }, "strategy": { "type": "string" }, "targeting": { "type": "object", "properties": { "dataPartnerIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "creativeTypeId": { "type": "integer", "format": "int32" }, "deviceTypeIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "npiTypeId": { "type": "integer", "format": "int32" }, "audienceTypeIds": { "type": "array", "items": { "type": "integer", "format": "int32" } } } }, "campaignId": { "type": "integer", "format": "int32" }, "isAbm": { "type": "boolean" } } } }, "ioId": { "type": "integer", "format": "int32" } } }, "examples": { "Edit Plan Request": { "description": "Edit Plan Request", "value": { "id": 123, "name": "Sample HCP Planner Request", "startTime": 1735124399000, "endTime": 1757534400000, "timezoneId": 4, "budgetTypeId": 1, "budget": 75000, "maxBudget": 80000, "reach": 250000, "maxReach": 300000, "impression": 1000000, "maxImpressions": 1200000, "frequencyCap": 5, "audienceBlocks": [ { "audienceSelectionMethodId": 1, "npiTypeIds": [1, 2], "speciality": { "specialityIds": [101, 102], "allSpecialitiesSelected": false }, "account": { "accountIds": [1, 2], "allAccountsSelected": false }, "healthSystem": { "healthSystemIds": [], "allHealthSystemsSelected": true }, "title": { "titleIds": [], "allTitlesSelected": true }, "accountType": { "accountTypeIds": [], "allAccountTypesSelected": true }, "locations": { "countryId": 1, "whiteListedStateIds": [501, 502], "blackListedStateIds": [], "whiteListedCityIds": [], "blackListedCityIds": [], "whiteListedZipcodes": [90210, 10001], "blackListedZipcodes": [] }, "dataPartners": { "dataPartnerIds": [1, 2], "allDataPartnersSelected": false }, "storagePathId": null, "includeAudienceIds": null, "excludeAudienceIds": null }, { "audienceSelectionMethodId": 2, "npiTypeIds": [1], "speciality": { "specialityIds": [101, 102], "allSpecialitiesSelected": false }, "accounts": null, "locations": { "countryId": 1, "whiteListedStateIds": [501, 502], "blackListedStateIds": [], "whiteListedCityIds": [], "blackListedCityIds": [], "whiteListedZipcodes": [90210, 10001], "blackListedZipcodes": [] }, "dataPartners": { "dataPartnerIds": [1, 2], "allDataPartnersSelected": false }, "storagePathId": 1, "includeAudienceIds": null, "excludeAudienceIds": null }, { "audienceSelectionMethodId": 3, "npiTypeIds": null, "speciality": null, "accounts": null, "locations": null, "dataPartners": null, "storagePathId": null, "includeAudienceIds": [301, 302], "excludeAudienceIds": [401] } ], "planLevelTargeting": { "devices": { "deviceTypeIds": [1, 2], "allDeviceTypesSelected": false }, "channels": { "channelTypeIds": [1, 2], "allChannelTypesSelected": false }, "creativeTypes": { "creativeTypeIds": [10, 11], "allCreativeTypesSelected": false, "isTvAutoBuying": true }, "inventory": { "openExchanges": { "exchangeIds": [1, 2], "allExchangesSelected": false, "iabCategoryIds": [1, 2], "allIabCategoriesSelected": false }, "inventoryGroup": { "inventoryGroupIds": [1, 2], "allInventoryGroupsSelected": false } } }, "splitStrategy": [ { "splitDimensionTypeId": 1, "selectedValueIds": [10, 11] } ], "campaigns": [ { "id": null, "name": "Campaign A", "startTime": 1754942400000, "endTime": 1757534400000, "budget": 37500, "maxBudget": 40000, "mediaCpm": 50, "dataCpm": 15, "reach": 125000, "maxReach": 150000, "impressions": 500000, "maxImpressions": 600000, "isAbm": false, "targeting": { "dataPartnerIds": [1], "creativeTypeId": 10, "deviceTypeIds": [1], "npiTypeId": 1, "audienceTypeIds": [1] } } ] } } } } }, "required": true }, "responses": { "200": { "description": "Proposal created successfully", "content": { "application/json": { "examples": { "Success response": { "description": "Success response", "value": { "success": true, "data": { "message": "Sample proposal updated successfully", "id": 123 } } } } } } }, "400": { "description": "Bad request due to invalid input", "content": { "application/json": { "examples": { "Validation error response": { "description": "Validation error response", "value": { "success": false, "errorObjects": [ { "error": "Invalid input data", "field": "name" } ] } } } } } }, "403": { "description": "Forbidden vertical ID", "content": { "application/json": { "examples": { "Forbidden vertical response": { "description": "Forbidden vertical response", "value": { "success": false, "errorObjects": [ { "error": "Request for forbidden vertical" } ] } } } } } } } } }, "/api/v3/plan/proposal/{proposalId}/duplicate": { "post": { "tags": [ "Planner API" ], "summary": "API to duplicate proposal", "description": "This API duplicates the proposal with the provided proposal id and creates a new proposal with the same details except the name, start time, and end time.", "operationId": "createDuplicateProposal", "parameters": [ { "name": "proposalId", "in": "path", "description": "Proposal ID to duplicate", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "content": { "application/json": { "schema": { "required": [ "endTime", "proposalName", "startTime" ], "type": "object", "properties": { "proposalName": { "type": "string" }, "startTime": { "type": "integer", "format": "int64" }, "endTime": { "type": "integer", "format": "int64" } } }, "examples": { "Duplicate Proposal Request": { "description": "Duplicate Proposal Request", "value": { "proposalName": "Copy of proposal 3", "startTime": 1732023982000, "endTime": 1732053982000 } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Proposal duplicated successfully": { "description": "Proposal duplicated successfully", "value": { "success": true, "data": { "message": "Proposal duplicated successfully", "proposalId": 189 } } } } } } } } } }, "/api/v3/plan/proposal/{proposalId}/campaigns": { "post": { "tags": [ "Planner API" ], "summary": "This API initiates the process of generating campaigns for the Ready Proposal", "description": "This API validates the proposal details and updates it status to in-progress and then starts to generate campaign", "operationId": "generateIOCampaigns", "parameters": [ { "name": "proposalId", "in": "query", "description": "Unique Identifier for Proposal" }, { "name": "proposalId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Proposal updated successfully": { "description": "Proposal updated successfully", "value": { "success": true, "data": { "message": "Campaign generation is in progress" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden !" } ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/plan/proposal/draft": { "post": { "tags": [ "Planner API" ], "summary": "API to create a proposal in draft state.", "description": "This API validate the targeting data if provided, insert proposal data into database and create proposal in draft state", "operationId": "addDraftProposal", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "startTime": { "type": "integer", "format": "int64" }, "endTime": { "type": "integer", "format": "int64" }, "politicalAdvertiserId": { "type": "integer", "format": "int32" }, "location": { "required": [ "country" ], "type": "object", "properties": { "country": { "type": "integer", "format": "int32" }, "states": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "dma": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "city": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "county": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "congressionalDistricts": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "stateHouse": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "stateSenate": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "zipCodes": { "type": "string" }, "isAdvanceTargeted": { "type": "boolean" }, "locationAdvanceTargeted": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } } } }, "margin": { "type": "number", "format": "double" }, "audience": { "type": "object", "properties": { "audienceSegmentIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "isAdvanceTargeted": { "type": "boolean" } } }, "creative": { "type": "object", "properties": { "creativeTypeIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "isTvAutoBuying": { "type": "boolean" } } }, "inventory": { "type": "object", "properties": { "openExchangeInventory": { "type": "object", "properties": { "iabCategories": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "exchanges": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } } } }, "inventoryGroupIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "isAdvanceTargeted": { "type": "boolean" } } }, "device": { "type": "object", "properties": { "deviceTypesTargetedIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "channelTypesTargetedIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "deviceTypesAdvanceTargetedIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "isAdvanceTargeted": { "type": "boolean" } } }, "isPoliticalAdvertiser": { "type": "boolean" } } }, "examples": { "Proposal Request to create draft": { "description": "Proposal Request to create draft", "value": "{\n {\n \"name\": \"sample_planner\",\n \"startTime\": 1730658720000,\n \"endTime\": 1733250720000,\n \"advertiserId\": 644,\n \"margin\": 10,\n \"location\": {\n \"country\": 30100001,\n \"states\": [30200001,30200002,30200003],\n \"dma\": [30900001,30900002],\n \"city\": [30400001,30400002,30400003],\n \"county\": [30300001,30300002,30300003],\n \"congressionalDistricts\": [30600001],\n \"stateHouse\": [30800001,30800002],\n \"stateSenate\": [30700001,30700002,30700003],\n \"zipCodes\": \"167820,78656\",\n \"isAdvanceTargeted\": true,\n \"locationAdvanceTargeted\": [302,304,309]\n },\n \"audience\": {\n \"audienceSegmentIds\": [6387630,6387631,6387632,6387633,6387634],\n \"isAdvanceTargeted\": true\n },\n \"creative\": {\n \"creativeTypeIds\": [11,13,14],\n \"isTvAutoBuying\": true\n },\n \"inventory\": {\n \"openExchangeInventory\": {\n \"iabCategories\": [1,2],\n \"exchanges\": [11,16,19,1]\n },\n \"inventoryGroupIds\": [134523,134522,134436],\n \"isAdvanceTargeted\": true\n },\n \"device\": {\n \"deviceTypesTargetedIds\": [20300001,20300004\n ],\n \"channelTypesTargetedIds\": [],\n \"isAdvanceTargeted\": true,\n \"deviceTypesAdvanceTargetedIds\": [20300002,20300004\n ]\n }\n }\n" } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Proposal added successfully": { "description": "Proposal added successfully", "value": "{\n \"success\": true,\n \"data\": {\n \"id\": 11\n \"message\": \"sample_planner generated successfully\"\n }\n}\n" } } } } } } } }, "/api/v3/plan/proposal/add": { "post": { "tags": [ "Planner API" ], "summary": "API to create a proposal in ready state.", "description": "This API validate the targeting data if provided, insert proposal data into database and create proposal in ready state", "operationId": "createProposal", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "startTime": { "type": "integer", "format": "int64" }, "endTime": { "type": "integer", "format": "int64" }, "politicalAdvertiserId": { "type": "integer", "format": "int32" }, "location": { "required": [ "country" ], "type": "object", "properties": { "country": { "type": "integer", "format": "int32" }, "states": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "dma": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "city": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "county": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "congressionalDistricts": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "stateHouse": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "stateSenate": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "zipCodes": { "type": "string" }, "isAdvanceTargeted": { "type": "boolean" }, "locationAdvanceTargeted": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } } } }, "margin": { "type": "number", "format": "double" }, "audience": { "type": "object", "properties": { "audienceSegmentIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "isAdvanceTargeted": { "type": "boolean" } } }, "creative": { "type": "object", "properties": { "creativeTypeIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "isTvAutoBuying": { "type": "boolean" } } }, "inventory": { "type": "object", "properties": { "openExchangeInventory": { "type": "object", "properties": { "iabCategories": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "exchanges": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } } } }, "inventoryGroupIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "isAdvanceTargeted": { "type": "boolean" } } }, "device": { "type": "object", "properties": { "deviceTypesTargetedIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "channelTypesTargetedIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "deviceTypesAdvanceTargetedIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "isAdvanceTargeted": { "type": "boolean" } } }, "id": { "type": "integer", "format": "int32" }, "reach": { "type": "integer", "format": "int64" }, "maxReach": { "type": "integer", "format": "int64" }, "impressions": { "type": "integer", "format": "int64" }, "maxImpressions": { "type": "integer", "format": "int64" }, "frequencyCap": { "type": "integer", "format": "int32" }, "budget": { "type": "number", "format": "double" }, "maxBudget": { "type": "number", "format": "double" }, "isPoliticalAdvertiser": { "type": "boolean" } } }, "examples": { "Proposal Request to create proposal": { "description": "Proposal Request to create proposal", "value": { "id": "11", "name": "sample_planner", "startTime": 1730658720000, "endTime": 1733250720000, "advertiserId": 644, "margin": 10, "location": { "country": 30100001, "states": [30200001, 30200002, 30200003], "dma": [30900001, 30900002], "city": [30400001, 30400002, 30400003], "county": [30300001, 30300002, 30300003], "congressionalDistricts": [30600001], "stateHouse": [30800001, 30800002], "stateSenate": [30700001, 30700002, 30700003], "zipCodes": "167820,78656", "isAdvanceTargeted": true, "locationAdvanceTargeted": [302, 304, 309] }, "audience": { "audienceSegmentIds": [6387630, 6387631, 6387632, 6387633, 6387634], "isAdvanceTargeted": true }, "creative": { "creativeTypeIds": [11, 13, 14], "isTvAutoBuying": true }, "inventory": { "openExchangeInventory": { "iabCategories": [1, 2], "exchanges": [11, 16, 19, 1] }, "inventoryGroupIds": [134523, 134522, 134436], "isAdvanceTargeted": true }, "device": { "deviceTypesTargetedIds": [20300001, 20300002, 20300002, 20300004], "channelTypesTargetedIds": [], "isAdvanceTargeted": true, "deviceTypesAdvanceTargetedIds": [20300002, 20300004] } } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Proposal added successfully": { "description": "Proposal added successfully", "value": { "success": true, "data": { "id": 11, "message": "sample_planner generated successfully" } } } } } } } } } }, "/api/v3/plan/proposal-summary/reach-impressions": { "post": { "tags": [ "Planner API" ], "summary": "Reach and impressions of proposal", "description": "This API provides maximum of reach and impressions for different targeting in proposal based on statistics and historical serving data", "operationId": "getReachAndImpressions", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "proposalId": { "type": "integer", "format": "int32" }, "location": { "required": [ "country" ], "type": "object", "properties": { "country": { "type": "integer", "format": "int32" }, "states": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "dma": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "city": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "county": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "congressionalDistricts": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "stateHouse": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "stateSenate": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "zipCodes": { "type": "string" }, "isAdvanceTargeted": { "type": "boolean" }, "locationAdvanceTargeted": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } } } }, "audience": { "type": "object", "properties": { "audienceSegmentIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "isAdvanceTargeted": { "type": "boolean" } } }, "creative": { "type": "object", "properties": { "creativeTypeIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "isTvAutoBuying": { "type": "boolean" } } }, "inventory": { "type": "object", "properties": { "openExchangeInventory": { "type": "object", "properties": { "iabCategories": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "exchanges": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } } } }, "inventoryGroupIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "isAdvanceTargeted": { "type": "boolean" } } }, "device": { "type": "object", "properties": { "deviceTypesTargetedIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "channelTypesTargetedIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "deviceTypesAdvanceTargetedIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "isAdvanceTargeted": { "type": "boolean" } } } } }, "examples": { "Request containing all the parameters": { "description": "Request containing all the parameters", "value": { "location": { "country": 30100001, "states": [30200001, 30200002, 30200003], "dma": [30900001, 30900002], "city": [30400001, 30400002, 30400003], "county": [30300001, 30300002, 30300003], "congressionalDistricts": [30600001], "stateHouse": [30800001, 30800002], "stateSenate": [30700001, 30700002, 30700003], "zipCodes": "167820,78656" }, "audience": { "audienceSegmentIds": [6387630, 6387631, 6387632, 6387633, 6387634] }, "creative": { "creativeTypeIds": [11, 13, 14] }, "inventory": { "openExchangeInventory": { "iabCategories": [1, 2], "exchanges": [11, 16, 19, 1] }, "inventoryGroupIds": [134523, 134522, 134436] }, "device": { "deviceTypesTargetedIds": [20300001, 20300002, 20300002, 20300004], "channelTypesTargetedIds": [11, 12] } } }, "Proposal ID provided to fetch the cached values": { "description": "Proposal ID provided to fetch the cached values", "value": { "proposalId": 1 } } } } }, "required": true }, "responses": { "200": { "description": "Success Responses ", "content": { "application/json": { "examples": { "Success Response": { "description": "Success Response", "value": { "success": true, "data": { "impressions": 105409776517, "reach": 210368111 } } } } } } } } } }, "/api/v3/plan/proposal-summary/device-type": { "post": { "tags": [ "Planner API" ], "summary": "Device type data in the proposal summary", "description": "This API provides distribution of impressions for different device types targeted in proposal summary", "operationId": "getDeviceTypeData", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "proposalId": { "type": "integer", "format": "int32" }, "location": { "required": [ "country" ], "type": "object", "properties": { "country": { "type": "integer", "format": "int32" }, "states": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "dma": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "city": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "county": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "congressionalDistricts": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "stateHouse": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "stateSenate": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "zipCodes": { "type": "string" }, "isAdvanceTargeted": { "type": "boolean" }, "locationAdvanceTargeted": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } } } }, "audience": { "type": "object", "properties": { "audienceSegmentIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "isAdvanceTargeted": { "type": "boolean" } } }, "creative": { "type": "object", "properties": { "creativeTypeIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "isTvAutoBuying": { "type": "boolean" } } }, "inventory": { "type": "object", "properties": { "openExchangeInventory": { "type": "object", "properties": { "iabCategories": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "exchanges": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } } } }, "inventoryGroupIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "isAdvanceTargeted": { "type": "boolean" } } }, "device": { "type": "object", "properties": { "deviceTypesTargetedIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "channelTypesTargetedIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "deviceTypesAdvanceTargetedIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "isAdvanceTargeted": { "type": "boolean" } } } } }, "examples": { "Request containing all the parameters": { "description": "Request containing all the parameters", "value": { "location": { "country": 30100001, "states": [30200001, 30200002, 30200003], "dma": [30900001, 30900002], "city": [30400001, 30400002, 30400003], "county": [30300001, 30300002, 30300003], "congressionalDistricts": [30600001], "stateHouse": [30800001, 30800002], "stateSenate": [30700001, 30700002, 30700003], "zipCodes": "167820,78656" }, "audience": { "audienceSegmentIds": [6387630, 6387631, 6387632, 6387633, 6387634] }, "creative": { "creativeTypeIds": [11, 13, 14] }, "inventory": { "openExchangeInventory": { "iabCategories": [1, 2], "exchanges": [11, 16, 19, 1] }, "inventoryGroupIds": [134523, 134522, 134436] }, "device": { "deviceTypesTargetedIds": [20300001, 20300002, 20300002, 20300004], "channelTypesTargetedIds": [11, 12] } } }, "Proposal ID provided to fetch the cached values": { "description": "Proposal ID provided to fetch the cached values", "value": { "proposalId": 1 } } } } }, "required": true }, "responses": { "200": { "description": "Success Responses ", "content": { "application/json": { "examples": { "Success Response": { "description": "Success Response", "value": { "success": true, "data": { "deviceTypes": [ { "device": "Mobile", "percentage": 38.86, "impressions": 21402990540 }, { "device": "Desktop", "percentage": 11.63, "impressions": 6399597393 }, { "device": "CTV", "percentage": 47.89, "impressions": 26376959052 }, { "device": "Tablet", "percentage": 1.63, "impressions": 898221564 } ] } } } } } } } } } }, "/api/v3/plan/proposal-summary/channel-type": { "post": { "tags": [ "Planner API" ], "summary": "Channel type data in the proposal summary", "description": "This API provides distribution of impressions for different channel types targeted in proposal summary", "operationId": "getChannelTypeData", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "proposalId": { "type": "integer", "format": "int32" }, "location": { "required": [ "country" ], "type": "object", "properties": { "country": { "type": "integer", "format": "int32" }, "states": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "dma": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "city": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "county": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "congressionalDistricts": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "stateHouse": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "stateSenate": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "zipCodes": { "type": "string" }, "isAdvanceTargeted": { "type": "boolean" }, "locationAdvanceTargeted": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } } } }, "audience": { "type": "object", "properties": { "audienceSegmentIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "isAdvanceTargeted": { "type": "boolean" } } }, "creative": { "type": "object", "properties": { "creativeTypeIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "isTvAutoBuying": { "type": "boolean" } } }, "inventory": { "type": "object", "properties": { "openExchangeInventory": { "type": "object", "properties": { "iabCategories": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "exchanges": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } } } }, "inventoryGroupIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "isAdvanceTargeted": { "type": "boolean" } } }, "device": { "type": "object", "properties": { "deviceTypesTargetedIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "channelTypesTargetedIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "deviceTypesAdvanceTargetedIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "isAdvanceTargeted": { "type": "boolean" } } } } }, "examples": { "Request containing all the parameters": { "description": "Request containing all the parameters", "value": { "location": { "country": 30100001, "states": [30200001, 30200002, 30200003], "dma": [30900001, 30900002], "city": [30400001, 30400002, 30400003], "county": [30300001, 30300002, 30300003], "congressionalDistricts": [30600001], "stateHouse": [30800001, 30800002], "stateSenate": [30700001, 30700002, 30700003], "zipCodes": "167820,78656" }, "audience": { "audienceSegmentIds": [6387630, 6387631, 6387632, 6387633, 6387634] }, "creative": { "creativeTypeIds": [11, 13, 14] }, "inventory": { "openExchangeInventory": { "iabCategories": [1, 2], "exchanges": [11, 16, 19, 1] }, "inventoryGroupIds": [134523, 134522, 134436] }, "device": { "deviceTypesTargetedIds": [20300001, 20300002, 20300002, 20300004], "channelTypesTargetedIds": [11, 12] } } }, "Proposal ID provided to fetch the cached values": { "description": "Proposal ID provided to fetch the cached values", "value": { "proposalId": 1 } } } } }, "required": true }, "responses": { "200": { "description": "Success Responses ", "content": { "application/json": { "examples": { "Success Response": { "description": "Success Response", "value": { "success": true, "data": { "channelTypes": [ { "channel": "App", "percentage": 22.36, "impressions": 12314443086 }, { "channel": "Web", "percentage": 29.65, "impressions": 16326324495 }, { "channel": "CTV", "percentage": 47.89, "impressions": 26376959052 }, { "channel": "OTT", "percentage": 0.11, "impressions": 60041916 } ] } } } } } } } } } }, "/api/v3/plan/proposal-summary/bid-landscape": { "post": { "tags": [ "Planner API" ], "summary": "Bid Landscape data in the proposal summary", "description": "This API provides distribution of impressions vs for different creatives types targeted in proposal summary", "operationId": "getBidLandscapeData", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "proposalId": { "type": "integer", "format": "int32" }, "location": { "required": [ "country" ], "type": "object", "properties": { "country": { "type": "integer", "format": "int32" }, "states": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "dma": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "city": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "county": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "congressionalDistricts": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "stateHouse": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "stateSenate": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "zipCodes": { "type": "string" }, "isAdvanceTargeted": { "type": "boolean" }, "locationAdvanceTargeted": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } } } }, "audience": { "type": "object", "properties": { "audienceSegmentIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "isAdvanceTargeted": { "type": "boolean" } } }, "creative": { "type": "object", "properties": { "creativeTypeIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "isTvAutoBuying": { "type": "boolean" } } }, "inventory": { "type": "object", "properties": { "openExchangeInventory": { "type": "object", "properties": { "iabCategories": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "exchanges": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } } } }, "inventoryGroupIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "isAdvanceTargeted": { "type": "boolean" } } }, "device": { "type": "object", "properties": { "deviceTypesTargetedIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "channelTypesTargetedIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "deviceTypesAdvanceTargetedIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "isAdvanceTargeted": { "type": "boolean" } } } } }, "examples": { "Request containing all the parameters": { "description": "Request containing all the parameters", "value": { "location": { "country": 30100001, "states": [30200001, 30200002, 30200003], "dma": [30900001, 30900002], "city": [30400001, 30400002, 30400003], "county": [30300001, 30300002, 30300003], "congressionalDistricts": [30600001], "stateHouse": [30800001, 30800002], "stateSenate": [30700001, 30700002, 30700003], "zipCodes": "167820,78656" }, "audience": { "audienceSegmentIds": [6387630, 6387631, 6387632, 6387633, 6387634] }, "creative": { "creativeTypeIds": [11, 13, 14] }, "inventory": { "openExchangeInventory": { "iabCategories": [1, 2], "exchanges": [11, 16, 19, 1] }, "inventoryGroupIds": [134523, 134522, 134436] }, "device": { "deviceTypesTargetedIds": [20300001, 20300002, 20300002, 20300004], "channelTypesTargetedIds": [11, 12] } } }, "Proposal ID provided to fetch the cached values": { "description": "Proposal ID provided to fetch the cached values", "value": { "proposalId": 1 } } } } }, "required": true }, "responses": { "200": { "description": "Success Responses ", "content": { "application/json": { "examples": { "Success Response": { "description": "Success Response", "value": { "success": true, "data": { "HTML": [ { "percentile": 0, "cpm": 0, "impressions": 0 }, { "percentile": 10, "cpm": 0.001, "impressions": 2719219 }, { "percentile": 20, "cpm": 0.01, "impressions": 27192810 }, { "percentile": 100, "cpm": 3.0072, "impressions": 271029139123 } ], "Video": [ { "percentile": 0, "cpm": 0, "impressions": 0 }, { "percentile": 10, "cpm": 0.003, "impressions": 2719219 }, { "percentile": 20, "cpm": 0.05, "impressions": 27192810 }, { "percentile": 100, "cpm": 10.372, "impressions": 271029139123 } ] } } } } } } } } } }, "/api/v3/plan/hcp/validate-name": { "post": { "tags": [ "Planner API" ], "summary": "This API validates the planner name", "description": "It checks if the provided planner name is available for use within the organization, along with the validation of character limits and vertical type.", "operationId": "validatePlannerName", "requestBody": { "description": "Request body containing the planner name to validate", "content": { "application/json": { "schema": { "required": [ "name" ], "type": "object", "properties": { "name": { "maxLength": 100, "minLength": 3, "type": "string" } } }, "examples": { "Name Validation Request": { "description": "Name Validation Request", "value": { "name": "New Healthcare Planner" } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Success response if name is available": { "description": "Success response if name is available", "value": { "success": true, "data": { "available": false } } } } } } }, "400": { "description": "Bad request due to null or empty planner name", "content": { "application/json": { "examples": { "Validation error response for null or empty name": { "description": "Validation error response for null or empty name", "value": { "success": false, "errorObjects": [ { "error": "Plan Name cannot be null or empty", "field": "name" } ] } } } } } }, "403": { "description": "Forbidden vertical ID", "content": { "application/json": { "examples": { "Validation error response for null or empty name": { "description": "Validation error response for null or empty name", "value": { "success": false, "errorObjects": [ { "error": "Request for forbidden vertical" } ] } } } } } }, "422": { "description": "Unprocessable entity due to validation errors", "content": { "application/json": { "examples": { "Validation error response for minimum length": { "description": "Validation error response for minimum length", "value": { "success": false, "errorObjects": [ { "error": "Planner name must be between 3 and 100 characters", "field": "name" } ] } }, "Validation error response for maximum length": { "description": "Validation error response for maximum length", "value": { "success": false, "errorObjects": [ { "error": "Planner name must be between 3 and 100 characters", "field": "name" } ] } } } } } } } } }, "/api/v3/plan/hcp/proposal/draft": { "post": { "tags": [ "Planner API" ], "summary": "API to add a draft proposal for the HCP planner", "description": "Validates user access, retrieves vertical type, and creates a draft proposal.", "operationId": "addDraftProposal_1", "requestBody": { "description": "Request body containing the details of the draft proposal", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "startTime": { "type": "integer", "format": "int64" }, "endTime": { "type": "integer", "format": "int64" }, "timezoneId": { "type": "integer", "format": "int64" }, "budgetTypeId": { "type": "integer", "format": "int32" }, "owId": { "type": "integer", "format": "int32" }, "createdAt": { "type": "integer", "format": "int64" }, "updatedAt": { "type": "integer", "format": "int64" }, "minBudget": { "type": "number" }, "budget": { "type": "number" }, "maxBudget": { "type": "number" }, "reach": { "type": "integer", "format": "int64" }, "maxReach": { "type": "integer", "format": "int64" }, "minImpressions": { "type": "integer", "format": "int64" }, "impressions": { "type": "integer", "format": "int64" }, "maxImpressions": { "type": "integer", "format": "int64" }, "frequencyCap": { "type": "integer", "format": "int32" }, "statusId": { "type": "integer", "format": "int32" }, "audienceBlocks": { "type": "array", "items": { "type": "object", "properties": { "audienceSelectionMethodId": { "type": "integer", "format": "int32" }, "npiTypeIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "speciality": { "type": "object", "properties": { "specialityIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "allSpecialitiesSelected": { "type": "boolean" } } }, "account": { "type": "object", "properties": { "accountIds": { "type": "array", "items": { "type": "integer", "format": "int64" } }, "allAccountsSelected": { "type": "boolean" } } }, "accountType": { "type": "object", "properties": { "accountTypeIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "allAccountTypesSelected": { "type": "boolean" } } }, "healthSystem": { "type": "object", "properties": { "healthSystemIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "allHealthSystemsSelected": { "type": "boolean" } } }, "title": { "type": "object", "properties": { "titleIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "allTitlesSelected": { "type": "boolean" } } }, "locations": { "required": [ "countryId" ], "type": "object", "properties": { "countryId": { "type": "integer", "format": "int32" }, "whiteListedStateIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "blackListedStateIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "whiteListedCityIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "blackListedCityIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "whiteListedZipcodeIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "blackListedZipcodeIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "whiteListedZipcodes": { "type": "array", "items": { "type": "string" } }, "blackListedZipcodes": { "type": "array", "items": { "type": "string" } } } }, "dataPartners": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "reach": { "type": "integer", "format": "int64" }, "priority": { "type": "integer", "format": "int32" }, "selected": { "type": "boolean" }, "incrementalReach": { "type": "integer", "format": "int64" } } } }, "storagePathId": { "type": "integer", "format": "int32" }, "storagePath": { "type": "string" }, "storageFileName": { "type": "string" }, "storageFileSize": { "type": "integer", "format": "int64" }, "storageFileRows": { "type": "integer", "format": "int32" }, "includeAudienceIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "excludeAudienceIds": { "type": "array", "items": { "type": "integer", "format": "int32" } } } } }, "planLevelTargeting": { "type": "object", "properties": { "devices": { "type": "object", "properties": { "deviceTypeIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "allDeviceTypesSelected": { "type": "boolean" } } }, "channels": { "type": "object", "properties": { "channelTypeIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "allChannelTypesSelected": { "type": "boolean" } } }, "creativeTypes": { "type": "object", "properties": { "creativeTypeIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "allCreativeTypesSelected": { "type": "boolean" }, "isTvAutoBuying": { "type": "boolean" } } }, "inventory": { "type": "object", "properties": { "openExchanges": { "type": "object", "properties": { "exchangeIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "allExchangesSelected": { "type": "boolean" }, "iabCategoryIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "allIabCategoriesSelected": { "type": "boolean" } } }, "inventoryGroup": { "type": "object", "properties": { "inventoryGroupIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "allInventoryGroupsSelected": { "type": "boolean" } } } } } } }, "splitStrategy": { "type": "array", "items": { "type": "object", "properties": { "splitDimensionTypeId": { "type": "integer", "format": "int32" }, "selectedValueIds": { "type": "array", "items": { "type": "integer", "format": "int32" } } } } }, "campaigns": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "startTime": { "type": "integer", "format": "int64" }, "endTime": { "type": "integer", "format": "int64" }, "frequencyCap": { "type": "integer", "format": "int32" }, "minMediaCpm": { "type": "number" }, "mediaCpm": { "type": "number" }, "maxMediaCpm": { "type": "number" }, "dataCpm": { "type": "number" }, "minBudget": { "type": "number" }, "budget": { "type": "number" }, "maxBudget": { "type": "number" }, "minReach": { "type": "integer", "format": "int64" }, "reach": { "type": "integer", "format": "int64" }, "maxReach": { "type": "integer", "format": "int64" }, "minImpressions": { "type": "integer", "format": "int64" }, "impressions": { "type": "integer", "format": "int64" }, "maxImpressions": { "type": "integer", "format": "int64" }, "strategy": { "type": "string" }, "targeting": { "type": "object", "properties": { "dataPartnerIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "creativeTypeId": { "type": "integer", "format": "int32" }, "deviceTypeIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "npiTypeId": { "type": "integer", "format": "int32" }, "audienceTypeIds": { "type": "array", "items": { "type": "integer", "format": "int32" } } } }, "campaignId": { "type": "integer", "format": "int32" }, "isAbm": { "type": "boolean" } } } }, "ioId": { "type": "integer", "format": "int32" } } }, "examples": { "Draft Proposal Request": { "description": "Draft Proposal Request", "value": { "name": "Sample HCP Planner Request", "startTime": 1735124399000, "endTime": 1757534400000, "timezoneId": 4, "budgetTypeId": 1, "budget": 75000, "maxBudget": 80000, "reach": 250000, "maxReach": 300000, "impression": 1000000, "maxImpressions": 1200000, "frequencyCap": 5, "audienceBlocks": [ { "audienceSelectionMethodId": 1, "npiTypeIds": [1, 2], "speciality": { "specialityIds": [101, 102], "allSpecialitiesSelected": false }, "account": { "accountIds": [1, 2], "allAccountsSelected": false }, "healthSystem": { "healthSystemIds": [], "allHealthSystemsSelected": true }, "title": { "titleIds": [], "allTitlesSelected": true }, "accountType": { "accountTypeIds": [], "allAccountTypesSelected": true }, "locations": { "countryId": 1, "whiteListedStateIds": [501, 502], "blackListedStateIds": [], "whiteListedCityIds": [], "blackListedCityIds": [], "whiteListedZipcodes": [90210, 10001], "blackListedZipcodes": [] }, "dataPartners": { "dataPartnerIds": [1, 2], "allDataPartnersSelected": false }, "storagePathId": null, "includeAudienceIds": null, "excludeAudienceIds": null }, { "audienceSelectionMethodId": 2, "npiTypeIds": [1], "speciality": { "specialityIds": [101, 102], "allSpecialitiesSelected": false }, "accounts": null, "locations": { "countryId": 1, "whiteListedStateIds": [501, 502], "blackListedStateIds": [], "whiteListedCityIds": [], "blackListedCityIds": [], "whiteListedZipcodes": [90210, 10001], "blackListedZipcodes": [] }, "dataPartners": { "dataPartnerIds": [1, 2], "allDataPartnersSelected": false }, "storagePathId": 1, "includeAudienceIds": null, "excludeAudienceIds": null }, { "audienceSelectionMethodId": 3, "npiTypeIds": null, "speciality": null, "accounts": null, "locations": null, "dataPartners": null, "storagePathId": null, "includeAudienceIds": [301, 302], "excludeAudienceIds": [401] } ], "planLevelTargeting": { "devices": { "deviceTypeIds": [1, 2], "allDeviceTypesSelected": false }, "channels": { "channelTypeIds": [1, 2], "allChannelTypesSelected": false }, "creativeTypes": { "creativeTypeIds": [10, 11], "allCreativeTypesSelected": false, "isTvAutoBuying": true }, "inventory": { "openExchanges": { "exchangeIds": [1, 2], "allExchangesSelected": false, "iabCategoryIds": [1, 2], "allIabCategoriesSelected": false }, "inventoryGroup": { "inventoryGroupIds": [1, 2], "allInventoryGroupsSelected": false } } }, "splitStrategy": [ { "splitDimensionTypeId": 1, "selectedValueIds": [10, 11] } ], "campaigns": [ { "id": null, "name": "Campaign A", "startTime": 1754942400000, "endTime": 1757534400000, "budget": 37500, "maxBudget": 40000, "mediaCpm": 50, "dataCpm": 15, "reach": 125000, "maxReach": 150000, "impressions": 500000, "maxImpressions": 600000, "isAbm": false, "targeting": { "dataPartnerIds": [1], "creativeTypeId": 10, "deviceTypeIds": [1], "npiTypeId": 1, "audienceTypeIds": [1] } } ] } } } } }, "required": true }, "responses": { "200": { "description": "Draft proposal created successfully", "content": { "application/json": { "examples": { "Success response": { "description": "Success response", "value": { "success": true, "data": { "message": "Sample proposal generated successfully", "id": 123 } } } } } } }, "400": { "description": "Bad request due to invalid input", "content": { "application/json": { "examples": { "Validation error response": { "description": "Validation error response", "value": { "success": false, "errorObjects": [ { "error": "Invalid input data", "field": "name" } ] } } } } } }, "403": { "description": "Forbidden vertical ID", "content": { "application/json": { "examples": { "Forbidden vertical response": { "description": "Forbidden vertical response", "value": { "success": false, "errorObjects": [ { "error": "Request for forbidden vertical" } ] } } } } } } } } }, "/api/v3/plan/hcp/proposal/add": { "post": { "tags": [ "Planner API" ], "summary": "API to create ready proposal for the HCP planner", "description": "Validates user access, retrieves vertical type, and creates ready proposal.", "operationId": "createProposal_1", "requestBody": { "description": "Request body containing the details of the ready proposal", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "startTime": { "type": "integer", "format": "int64" }, "endTime": { "type": "integer", "format": "int64" }, "timezoneId": { "type": "integer", "format": "int64" }, "budgetTypeId": { "type": "integer", "format": "int32" }, "owId": { "type": "integer", "format": "int32" }, "createdAt": { "type": "integer", "format": "int64" }, "updatedAt": { "type": "integer", "format": "int64" }, "minBudget": { "type": "number" }, "budget": { "type": "number" }, "maxBudget": { "type": "number" }, "reach": { "type": "integer", "format": "int64" }, "maxReach": { "type": "integer", "format": "int64" }, "minImpressions": { "type": "integer", "format": "int64" }, "impressions": { "type": "integer", "format": "int64" }, "maxImpressions": { "type": "integer", "format": "int64" }, "frequencyCap": { "type": "integer", "format": "int32" }, "statusId": { "type": "integer", "format": "int32" }, "audienceBlocks": { "type": "array", "items": { "type": "object", "properties": { "audienceSelectionMethodId": { "type": "integer", "format": "int32" }, "npiTypeIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "speciality": { "type": "object", "properties": { "specialityIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "allSpecialitiesSelected": { "type": "boolean" } } }, "account": { "type": "object", "properties": { "accountIds": { "type": "array", "items": { "type": "integer", "format": "int64" } }, "allAccountsSelected": { "type": "boolean" } } }, "accountType": { "type": "object", "properties": { "accountTypeIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "allAccountTypesSelected": { "type": "boolean" } } }, "healthSystem": { "type": "object", "properties": { "healthSystemIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "allHealthSystemsSelected": { "type": "boolean" } } }, "title": { "type": "object", "properties": { "titleIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "allTitlesSelected": { "type": "boolean" } } }, "locations": { "required": [ "countryId" ], "type": "object", "properties": { "countryId": { "type": "integer", "format": "int32" }, "whiteListedStateIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "blackListedStateIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "whiteListedCityIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "blackListedCityIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "whiteListedZipcodeIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "blackListedZipcodeIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "whiteListedZipcodes": { "type": "array", "items": { "type": "string" } }, "blackListedZipcodes": { "type": "array", "items": { "type": "string" } } } }, "dataPartners": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "reach": { "type": "integer", "format": "int64" }, "priority": { "type": "integer", "format": "int32" }, "selected": { "type": "boolean" }, "incrementalReach": { "type": "integer", "format": "int64" } } } }, "storagePathId": { "type": "integer", "format": "int32" }, "storagePath": { "type": "string" }, "storageFileName": { "type": "string" }, "storageFileSize": { "type": "integer", "format": "int64" }, "storageFileRows": { "type": "integer", "format": "int32" }, "includeAudienceIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "excludeAudienceIds": { "type": "array", "items": { "type": "integer", "format": "int32" } } } } }, "planLevelTargeting": { "type": "object", "properties": { "devices": { "type": "object", "properties": { "deviceTypeIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "allDeviceTypesSelected": { "type": "boolean" } } }, "channels": { "type": "object", "properties": { "channelTypeIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "allChannelTypesSelected": { "type": "boolean" } } }, "creativeTypes": { "type": "object", "properties": { "creativeTypeIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "allCreativeTypesSelected": { "type": "boolean" }, "isTvAutoBuying": { "type": "boolean" } } }, "inventory": { "type": "object", "properties": { "openExchanges": { "type": "object", "properties": { "exchangeIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "allExchangesSelected": { "type": "boolean" }, "iabCategoryIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "allIabCategoriesSelected": { "type": "boolean" } } }, "inventoryGroup": { "type": "object", "properties": { "inventoryGroupIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "allInventoryGroupsSelected": { "type": "boolean" } } } } } } }, "splitStrategy": { "type": "array", "items": { "type": "object", "properties": { "splitDimensionTypeId": { "type": "integer", "format": "int32" }, "selectedValueIds": { "type": "array", "items": { "type": "integer", "format": "int32" } } } } }, "campaigns": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "startTime": { "type": "integer", "format": "int64" }, "endTime": { "type": "integer", "format": "int64" }, "frequencyCap": { "type": "integer", "format": "int32" }, "minMediaCpm": { "type": "number" }, "mediaCpm": { "type": "number" }, "maxMediaCpm": { "type": "number" }, "dataCpm": { "type": "number" }, "minBudget": { "type": "number" }, "budget": { "type": "number" }, "maxBudget": { "type": "number" }, "minReach": { "type": "integer", "format": "int64" }, "reach": { "type": "integer", "format": "int64" }, "maxReach": { "type": "integer", "format": "int64" }, "minImpressions": { "type": "integer", "format": "int64" }, "impressions": { "type": "integer", "format": "int64" }, "maxImpressions": { "type": "integer", "format": "int64" }, "strategy": { "type": "string" }, "targeting": { "type": "object", "properties": { "dataPartnerIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "creativeTypeId": { "type": "integer", "format": "int32" }, "deviceTypeIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "npiTypeId": { "type": "integer", "format": "int32" }, "audienceTypeIds": { "type": "array", "items": { "type": "integer", "format": "int32" } } } }, "campaignId": { "type": "integer", "format": "int32" }, "isAbm": { "type": "boolean" } } } }, "ioId": { "type": "integer", "format": "int32" } } }, "examples": { "Create Ready Proposal Request": { "description": "Create Ready Proposal Request", "value": { "id": 123, "name": "Sample HCP Planner Request", "startTime": 1735124399000, "endTime": 1757534400000, "timezoneId": 4, "budgetTypeId": 1, "budget": 75000, "maxBudget": 80000, "reach": 250000, "maxReach": 300000, "impression": 1000000, "maxImpressions": 1200000, "frequencyCap": 5, "audienceBlocks": [ { "audienceSelectionMethodId": 1, "npiTypeIds": [1, 2], "speciality": { "specialityIds": [101, 102], "allSpecialitiesSelected": false }, "account": { "accountIds": [1, 2], "allAccountsSelected": false }, "healthSystem": { "healthSystemIds": [], "allHealthSystemsSelected": true }, "title": { "titleIds": [], "allTitlesSelected": true }, "accountType": { "accountTypeIds": [], "allAccountTypesSelected": true }, "locations": { "countryId": 1, "whiteListedStateIds": [501, 502], "blackListedStateIds": [], "whiteListedCityIds": [], "blackListedCityIds": [], "whiteListedZipcodes": [90210, 10001], "blackListedZipcodes": [] }, "dataPartners": { "dataPartnerIds": [1, 2], "allDataPartnersSelected": false }, "storagePathId": null, "includeAudienceIds": null, "excludeAudienceIds": null }, { "audienceSelectionMethodId": 2, "npiTypeIds": [1], "speciality": { "specialityIds": [101, 102], "allSpecialitiesSelected": false }, "accounts": null, "locations": { "countryId": 1, "whiteListedStateIds": [501, 502], "blackListedStateIds": [], "whiteListedCityIds": [], "blackListedCityIds": [], "whiteListedZipcodes": [90210, 10001], "blackListedZipcodes": [] }, "dataPartners": { "dataPartnerIds": [1, 2], "allDataPartnersSelected": false }, "storagePathId": 1, "includeAudienceIds": null, "excludeAudienceIds": null }, { "audienceSelectionMethodId": 3, "npiTypeIds": null, "speciality": null, "accounts": null, "locations": null, "dataPartners": null, "storagePathId": null, "includeAudienceIds": [301, 302], "excludeAudienceIds": [401] } ], "planLevelTargeting": { "devices": { "deviceTypeIds": [1, 2], "allDeviceTypesSelected": false }, "channels": { "channelTypeIds": [1, 2], "allChannelTypesSelected": false }, "creativeTypes": { "creativeTypeIds": [10, 11], "allCreativeTypesSelected": false, "isTvAutoBuying": true }, "inventory": { "openExchanges": { "exchangeIds": [1, 2], "allExchangesSelected": false, "iabCategoryIds": [1, 2], "allIabCategoriesSelected": false }, "inventoryGroup": { "inventoryGroupIds": [1, 2], "allInventoryGroupsSelected": false } } }, "splitStrategy": [ { "splitDimensionTypeId": 1, "selectedValueIds": [10, 11] } ], "campaigns": [ { "id": null, "name": "Campaign A", "startTime": 1754942400000, "endTime": 1757534400000, "budget": 37500, "maxBudget": 40000, "mediaCpm": 50, "dataCpm": 15, "reach": 125000, "maxReach": 150000, "impressions": 500000, "maxImpressions": 600000, "isAbm": false, "targeting": { "dataPartnerIds": [1], "creativeTypeId": 10, "deviceTypeIds": [1], "npiTypeId": 1, "audienceTypeIds": [1] } } ] } } } } }, "required": true }, "responses": { "200": { "description": "Proposal created successfully", "content": { "application/json": { "examples": { "Success response": { "description": "Success response", "value": { "success": true, "data": { "message": "Sample proposal generated successfully", "id": 123 } } } } } } }, "400": { "description": "Bad request due to invalid input", "content": { "application/json": { "examples": { "Validation error response": { "description": "Validation error response", "value": { "success": false, "errorObjects": [ { "error": "Invalid input data", "field": "name" } ] } } } } } }, "403": { "description": "Forbidden vertical ID", "content": { "application/json": { "examples": { "Forbidden vertical response": { "description": "Forbidden vertical response", "value": { "success": false, "errorObjects": [ { "error": "Request for forbidden vertical" } ] } } } } } } } } }, "/api/v3/plan/hcp/plan/download": { "post": { "tags": [ "Planner API" ], "summary": "API to download HCP plan details", "description": "This API downloads the details of a specific HCP plan based on the provided plan ID. It validates user access, vertical checks, and plan ID before generating and returning the download link for the plan details.", "operationId": "downloadPlan", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "description": "Request body containing the plan ID to be downloaded", "content": { "application/json": { "schema": { "type": "object", "properties": { "planId": { "type": "integer", "format": "int32" }, "fileTypeId": { "type": "integer", "format": "int32" } } }, "examples": { "Download HCP Plan Request": { "description": "Download HCP Plan Request", "value": { "planId": 123, "fileTypeId": 1 } } } } }, "required": true }, "responses": { "200": { "description": "Plan details downloaded successfully", "content": { "application/json": { "examples": { "Success response": { "description": "Success response", "value": { "success": true, "data": { "downloadUrl": "https://www.sample.com/downloadLink" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden !" } ] } } } }, "422": { "description": "Unprocessable Entity due to invalid plan ID", "content": { "application/json": { "examples": { "Invalid Plan ID provided": { "description": "Invalid Plan ID provided", "value": { "success": false, "errorObjects": [ { "error": "Proposal with proposal id 123 does not exist" } ] } }, "Invalid file type": { "description": "Invalid file type", "value": { "success": false, "errorObjects": [ { "error": "Invalid file type to download HCP Plan" } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/plan/hcp/plan-targeting-graphs": { "post": { "tags": [ "Planner API" ], "summary": "API to fetch targeting graphs for healthcare planners", "description": "This API retrieves targeting graphs based on the provided request data.", "operationId": "getTargetingGraphs", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "audienceBlocks": { "type": "array", "items": { "type": "object", "properties": { "audienceSelectionMethodId": { "type": "integer", "format": "int32" }, "npiTypeIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "speciality": { "type": "object", "properties": { "specialityIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "allSpecialitiesSelected": { "type": "boolean" } } }, "account": { "type": "object", "properties": { "accountIds": { "type": "array", "items": { "type": "integer", "format": "int64" } }, "allAccountsSelected": { "type": "boolean" } } }, "accountType": { "type": "object", "properties": { "accountTypeIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "allAccountTypesSelected": { "type": "boolean" } } }, "healthSystem": { "type": "object", "properties": { "healthSystemIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "allHealthSystemsSelected": { "type": "boolean" } } }, "title": { "type": "object", "properties": { "titleIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "allTitlesSelected": { "type": "boolean" } } }, "locations": { "required": [ "countryId" ], "type": "object", "properties": { "countryId": { "type": "integer", "format": "int32" }, "whiteListedStateIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "blackListedStateIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "whiteListedCityIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "blackListedCityIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "whiteListedZipcodeIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "blackListedZipcodeIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "whiteListedZipcodes": { "type": "array", "items": { "type": "string" } }, "blackListedZipcodes": { "type": "array", "items": { "type": "string" } } } }, "dataPartners": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "reach": { "type": "integer", "format": "int64" }, "priority": { "type": "integer", "format": "int32" }, "selected": { "type": "boolean" }, "incrementalReach": { "type": "integer", "format": "int64" } } } }, "storagePathId": { "type": "integer", "format": "int32" }, "storagePath": { "type": "string" }, "storageFileName": { "type": "string" }, "storageFileSize": { "type": "integer", "format": "int64" }, "storageFileRows": { "type": "integer", "format": "int32" }, "includeAudienceIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "excludeAudienceIds": { "type": "array", "items": { "type": "integer", "format": "int32" } } } } }, "planLevelTargeting": { "type": "object", "properties": { "devices": { "type": "object", "properties": { "deviceTypeIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "allDeviceTypesSelected": { "type": "boolean" } } }, "channels": { "type": "object", "properties": { "channelTypeIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "allChannelTypesSelected": { "type": "boolean" } } }, "creativeTypes": { "type": "object", "properties": { "creativeTypeIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "allCreativeTypesSelected": { "type": "boolean" }, "isTvAutoBuying": { "type": "boolean" } } }, "inventory": { "type": "object", "properties": { "openExchanges": { "type": "object", "properties": { "exchangeIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "allExchangesSelected": { "type": "boolean" }, "iabCategoryIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "allIabCategoriesSelected": { "type": "boolean" } } }, "inventoryGroup": { "type": "object", "properties": { "inventoryGroupIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "allInventoryGroupsSelected": { "type": "boolean" } } } } } } }, "owId": { "type": "integer", "format": "int32" } } } } }, "required": true }, "responses": { "200": { "description": "Successful retrieval of targeting graphs", "content": { "application/json": { "examples": { "Success response": { "description": "Success response", "value": "{\n {\n \"success\": true,\n \"data\": {\n \"deviceTypeDistribution\": {\n \"totalNPIs\": 2025510,\n \"breakdown\": [\n { \"deviceTypeId\": 1, \"percentage\": 20 },\n { \"deviceTypeId\": 2, \"percentage\": 35 },\n { \"deviceTypeId\": 3, \"percentage\": 15 },\n { \"deviceTypeId\": 4, \"percentage\": 30 }\n ]\n },\n \"creativeTypeDistribution\": [\n {\n \"creativeTypeId\": 1,\n \"impressions\": 1600000,\n \"cpm\": 72.0\n },\n {\n \"creativeTypeId\": 2,\n \"impressions\": 1200000,\n \"cpm\": 65.0\n }\n ],\n \"channelTypeDistribution\": {\n \"totalNPIs\": 2025510,\n \"breakdown\": [\n { \"channelTypeId\": 1, \"percentage\": 60 },\n { \"channelTypeId\": 2, \"percentage\": 40 }\n ]\n }\n }\n }\n }\n" } } } } }, "403": { "description": "Requesting targeting graphs for non healthcare vertical", "content": { "application/json": { "examples": { "Forbidden vertical response": { "description": "Forbidden vertical response", "value": { "success": false, "errorObjects": [ { "error": "Request for forbidden vertical" } ] } } } } } } } } }, "/api/v3/plan/hcp/generate-campaigns": { "post": { "tags": [ "Planner API" ], "summary": "This API primarily generates proposed campaigns for HCP based on the request parameters.", "description": "This API contains the logic to split the campaigns based on the split strategy provided in the request. It also validates the vertical ID for healthcare and ensures that the user has the necessary permissions to access this functionality.Along, with that the accurate reach for each campaigns is fetched making it budget friendly", "operationId": "generateHCPProposedCampaigns", "requestBody": { "description": "Request body containing the planner name to validate", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "startTime": { "type": "integer", "format": "int64" }, "endTime": { "type": "integer", "format": "int64" }, "timezoneId": { "type": "integer", "format": "int64" }, "budgetTypeId": { "type": "integer", "format": "int32" }, "owId": { "type": "integer", "format": "int32" }, "createdAt": { "type": "integer", "format": "int64" }, "updatedAt": { "type": "integer", "format": "int64" }, "minBudget": { "type": "number" }, "budget": { "type": "number" }, "maxBudget": { "type": "number" }, "reach": { "type": "integer", "format": "int64" }, "maxReach": { "type": "integer", "format": "int64" }, "minImpressions": { "type": "integer", "format": "int64" }, "impressions": { "type": "integer", "format": "int64" }, "maxImpressions": { "type": "integer", "format": "int64" }, "frequencyCap": { "type": "integer", "format": "int32" }, "statusId": { "type": "integer", "format": "int32" }, "audienceBlocks": { "type": "array", "items": { "type": "object", "properties": { "audienceSelectionMethodId": { "type": "integer", "format": "int32" }, "npiTypeIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "speciality": { "type": "object", "properties": { "specialityIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "allSpecialitiesSelected": { "type": "boolean" } } }, "account": { "type": "object", "properties": { "accountIds": { "type": "array", "items": { "type": "integer", "format": "int64" } }, "allAccountsSelected": { "type": "boolean" } } }, "accountType": { "type": "object", "properties": { "accountTypeIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "allAccountTypesSelected": { "type": "boolean" } } }, "healthSystem": { "type": "object", "properties": { "healthSystemIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "allHealthSystemsSelected": { "type": "boolean" } } }, "title": { "type": "object", "properties": { "titleIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "allTitlesSelected": { "type": "boolean" } } }, "locations": { "required": [ "countryId" ], "type": "object", "properties": { "countryId": { "type": "integer", "format": "int32" }, "whiteListedStateIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "blackListedStateIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "whiteListedCityIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "blackListedCityIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "whiteListedZipcodeIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "blackListedZipcodeIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "whiteListedZipcodes": { "type": "array", "items": { "type": "string" } }, "blackListedZipcodes": { "type": "array", "items": { "type": "string" } } } }, "dataPartners": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "reach": { "type": "integer", "format": "int64" }, "priority": { "type": "integer", "format": "int32" }, "selected": { "type": "boolean" }, "incrementalReach": { "type": "integer", "format": "int64" } } } }, "storagePathId": { "type": "integer", "format": "int32" }, "storagePath": { "type": "string" }, "storageFileName": { "type": "string" }, "storageFileSize": { "type": "integer", "format": "int64" }, "storageFileRows": { "type": "integer", "format": "int32" }, "includeAudienceIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "excludeAudienceIds": { "type": "array", "items": { "type": "integer", "format": "int32" } } } } }, "planLevelTargeting": { "type": "object", "properties": { "devices": { "type": "object", "properties": { "deviceTypeIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "allDeviceTypesSelected": { "type": "boolean" } } }, "channels": { "type": "object", "properties": { "channelTypeIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "allChannelTypesSelected": { "type": "boolean" } } }, "creativeTypes": { "type": "object", "properties": { "creativeTypeIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "allCreativeTypesSelected": { "type": "boolean" }, "isTvAutoBuying": { "type": "boolean" } } }, "inventory": { "type": "object", "properties": { "openExchanges": { "type": "object", "properties": { "exchangeIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "allExchangesSelected": { "type": "boolean" }, "iabCategoryIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "allIabCategoriesSelected": { "type": "boolean" } } }, "inventoryGroup": { "type": "object", "properties": { "inventoryGroupIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "allInventoryGroupsSelected": { "type": "boolean" } } } } } } }, "splitStrategy": { "type": "array", "items": { "type": "object", "properties": { "splitDimensionTypeId": { "type": "integer", "format": "int32" }, "selectedValueIds": { "type": "array", "items": { "type": "integer", "format": "int32" } } } } }, "campaigns": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "startTime": { "type": "integer", "format": "int64" }, "endTime": { "type": "integer", "format": "int64" }, "frequencyCap": { "type": "integer", "format": "int32" }, "minMediaCpm": { "type": "number" }, "mediaCpm": { "type": "number" }, "maxMediaCpm": { "type": "number" }, "dataCpm": { "type": "number" }, "minBudget": { "type": "number" }, "budget": { "type": "number" }, "maxBudget": { "type": "number" }, "minReach": { "type": "integer", "format": "int64" }, "reach": { "type": "integer", "format": "int64" }, "maxReach": { "type": "integer", "format": "int64" }, "minImpressions": { "type": "integer", "format": "int64" }, "impressions": { "type": "integer", "format": "int64" }, "maxImpressions": { "type": "integer", "format": "int64" }, "strategy": { "type": "string" }, "targeting": { "type": "object", "properties": { "dataPartnerIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "creativeTypeId": { "type": "integer", "format": "int32" }, "deviceTypeIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "npiTypeId": { "type": "integer", "format": "int32" }, "audienceTypeIds": { "type": "array", "items": { "type": "integer", "format": "int32" } } } }, "campaignId": { "type": "integer", "format": "int32" }, "isAbm": { "type": "boolean" } } } }, "ioId": { "type": "integer", "format": "int32" } } }, "examples": { "Name Validation Request": { "description": "Name Validation Request", "value": { "name": "Q4 Diabetes Awareness Campaign", "startTime": 1732707706666, "endTime": 1733312506666, "timezoneId": 3, "budgetTypeId": 1, "budget": 100000, "maxBudget": 120000, "reach": 50000, "maxReach": 70000, "impressions": 200000, "maxImpressions": 250000, "frequencyCap": 3, "audienceBlocks": [ { "audienceSelectionMethodId": 1, "npiTypeIds": [3, 4], "speciality": { "allSpecialitiesSelected": true }, "accounts": [ { "allAccountsSelected": true } ], "locations": { "countryId": 30100001 }, "dataPartners": { "allDataPartnersSelected": true }, "storagePath": null, "includeAudienceIds": [], "excludeAudienceIds": [] }, { "audienceSelectionMethodId": 2, "npiTypeIds": [3], "speciality": { "allSpecialitiesSelected": true }, "accounts": [ { "allAccountsSelected": true } ], "locations": { "countryId": 30100001 }, "dataPartners": { "allDataPartnersSelected": true }, "storagePath": "tmp/aud_uploads/upload_block2.csv", "includeAudienceIds": [], "excludeAudienceIds": [] }, { "audienceSelectionMethodId": 3, "npiTypeIds": null, "speciality": { "allSpecialitiesSelected": true }, "accounts": [ { "allAccountsSelected": true } ], "locations": { "countryId": 30100001 }, "dataPartners": { "allSpecialitiesSelected": true }, "storagePath": null, "includeAudienceIds": [1, 2, 3], "excludeAudienceIds": [1, 2, 3] } ], "planLevelTargeting": { "devices": { "allDeviceTypesSelected": true }, "channels": { "allChannelTypesSelected": true }, "creativeTypes": { "allCreativeTypesSelected": true }, "inventory": { "openExchangeVO": { "allExchangesSelected": true, "allIabCategoriesSelected": true }, "inventoryGroup": { "allInventoryGroupsSelected": true } } }, "splitStrategy": [ { "splitDimensionTypeId": 1, "selectedValueIds": [11, 13, 14, 15, 17] }, { "splitDimensionTypeId": 2, "selectedValueIds": [3, 4] }, { "splitDimensionTypeId": 3, "selectedValueIds": [7] }, { "splitDimensionTypeId": 4, "selectedValueIds": [11] }, { "splitDimensionTypeId": 5, "selectedValueIds": [] } ] } } } } }, "required": true }, "responses": { "200": { "description": "Successfully generated proposed campaigns for HCP", "content": { "application/json": { "examples": { "Proposed Campaigns Response": { "description": "Proposed Campaigns Response", "value": { "name": "Q4 Diabetes Awareness Campaign", "startTime": 1732707706666, "endTime": 1733312506666, "timezoneId": 3, "budgetTypeId": 1, "budget": 100000, "maxBudget": 120000, "reach": 50000, "maxReach": 70000, "impressions": 200000, "maxImpressions": 250000, "workspaceMarginPercentage": 20, "frequencyCap": 3, "audienceBlocks": [ { "audienceSelectionMethodId": 1, "npiTypeIds": [3, 4], "speciality": { "allSpecialitiesSelected": true }, "accounts": [ { "allAccountsSelected": true } ], "locations": { "countryId": 30100001 }, "dataPartners": { "allDataPartnersSelected": true }, "storagePath": null, "includeAudienceIds": [], "excludeAudienceIds": [] }, { "audienceSelectionMethodId": 2, "npiTypeIds": [3], "speciality": { "allSpecialitiesSelected": true }, "accounts": [ { "allAccountsSelected": true } ], "locations": { "countryId": 30100001 }, "dataPartners": { "allDataPartnersSelected": true }, "storagePath": "tmp/aud_uploads/upload_block2.csv", "includeAudienceIds": [], "excludeAudienceIds": [] }, { "audienceSelectionMethodId": 3, "npiTypeIds": null, "speciality": { "allSpecialitiesSelected": true }, "accounts": [ { "allAccountsSelected": true } ], "locations": { "countryId": 30100001 }, "dataPartners": { "allSpecialitiesSelected": true }, "storagePath": null, "includeAudienceIds": [1, 2, 3], "excludeAudienceIds": [1, 2, 3] } ], "planLevelTargeting": { "devices": { "allDeviceTypesSelected": true }, "channels": { "allChannelTypesSelected": true }, "creativeTypes": { "allCreativeTypesSelected": true }, "inventory": { "openExchangeVO": { "allExchangesSelected": true, "allIabCategoriesSelected": true }, "inventoryGroup": { "allInventoryGroupsSelected": true } } }, "splitStrategy": [ { "splitDimensionTypeId": 1, "selectedValueIds": [11, 13, 14, 15, 17] }, { "splitDimensionTypeId": 2, "selectedValueIds": [3, 4] }, { "splitDimensionTypeId": 3, "selectedValueIds": [7] }, { "splitDimensionTypeId": 4, "selectedValueIds": [11] }, { "splitDimensionTypeId": 5, "selectedValueIds": [] } ], "campaigns": [ { "id": null, "name": "Campaign_Image_HCP_Healthlink_Mobile", "startTime": 1732707706666, "endTime": 1733312506666, "frequencyCap": 0, "budget": null, "maxBudget": 0, "minMediaCpm": null, "mediaCpm": null, "maxMediaCpm": null, "dataCpm": null, "minReach": 0, "reach": null, "maxReach": 0, "impressions": null, "maxImpressions": 0, "strategy": "Image + HCP + Healthlink + Mobile", "targeting": { "dataPartnerIds": [7], "creativeTypeId": 11, "deviceTypeIds": [11], "npiTypeId": 3, "audienceTypeIds": [1, 2] }, "isAbm": false } ] } } } } } } } } }, "/api/v3/plan/hcp/generate-audiences": { "post": { "tags": [ "Planner API" ], "summary": "API to get generated audiences for HCP planner", "description": "This API generates audiences based on the provided criteria in the request body. It validates user access and vertical checks before processing the request.\nThe generated audiences include audience details such as name, type, data partner, NPI type, reach, eligibility, etc.\n", "operationId": "getGeneratedAudiences", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "description": "Request body containing the criteria for generating audiences", "content": { "application/json": { "schema": { "type": "object", "properties": { "planName": { "type": "string" }, "audienceBlocks": { "type": "array", "items": { "type": "object", "properties": { "audienceSelectionMethodId": { "type": "integer", "format": "int32" }, "npiTypeIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "speciality": { "type": "object", "properties": { "specialityIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "allSpecialitiesSelected": { "type": "boolean" } } }, "account": { "type": "object", "properties": { "accountIds": { "type": "array", "items": { "type": "integer", "format": "int64" } }, "allAccountsSelected": { "type": "boolean" } } }, "accountType": { "type": "object", "properties": { "accountTypeIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "allAccountTypesSelected": { "type": "boolean" } } }, "healthSystem": { "type": "object", "properties": { "healthSystemIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "allHealthSystemsSelected": { "type": "boolean" } } }, "title": { "type": "object", "properties": { "titleIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "allTitlesSelected": { "type": "boolean" } } }, "locations": { "required": [ "countryId" ], "type": "object", "properties": { "countryId": { "type": "integer", "format": "int32" }, "whiteListedStateIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "blackListedStateIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "whiteListedCityIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "blackListedCityIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "whiteListedZipcodeIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "blackListedZipcodeIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "whiteListedZipcodes": { "type": "array", "items": { "type": "string" } }, "blackListedZipcodes": { "type": "array", "items": { "type": "string" } } } }, "dataPartners": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "reach": { "type": "integer", "format": "int64" }, "priority": { "type": "integer", "format": "int32" }, "selected": { "type": "boolean" }, "incrementalReach": { "type": "integer", "format": "int64" } } } }, "storagePathId": { "type": "integer", "format": "int32" }, "storagePath": { "type": "string" }, "storageFileName": { "type": "string" }, "storageFileSize": { "type": "integer", "format": "int64" }, "storageFileRows": { "type": "integer", "format": "int32" }, "includeAudienceIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "excludeAudienceIds": { "type": "array", "items": { "type": "integer", "format": "int32" } } } } }, "sortBy": { "type": "string" } } }, "examples": { "HCP Planner Generated Audience Request": { "description": "HCP Planner Generated Audience Request", "value": { "planName": "test for aud summary", "sortBy": "+dataPartner,-reach", "audienceBlocks": [ { "audienceSelectionMethodId": 1, "npiTypeIds": [3, 4], "speciality": { "specialityIds": [406000022, 406000135, 406099999], "allSpecialitiesSelected": false }, "account": { "accountIds": [1, 2], "allAccountsSelected": false }, "healthSystem": { "healthSystemIds": [], "allHealthSystemsSelected": true }, "title": { "titleIds": [], "allTitlesSelected": true }, "accountType": { "accountTypeIds": [], "allAccountTypesSelected": true }, "locations": { "countryId": 30100001, "whiteListedStateIds": [30200035, 30200005], "blackListedStateIds": [], "whiteListedCityIds": [], "blackListedCityIds": [], "whiteListedZipcodes": [], "blackListedZipcodes": [] }, "dataPartners": [ { "id": 7, "reach": 449406, "incrementalReach": 449406, "priority": 1, "selected": true }, { "id": 8, "reach": 0, "incrementalReach": 0, "priority": 2, "selected": true }, { "id": 10, "reach": 0, "incrementalReach": 0, "priority": 3, "selected": true } ], "storagePathId": null, "storagePath": null, "storageFileName": null, "storageFileSize": null, "storageFileRows": null, "includeAudienceIds": [], "excludeAudienceIds": [] }, { "audienceSelectionMethodId": 4, "npiTypeIds": [], "speciality": { "specialityIds": [], "allSpecialitiesSelected": true }, "accounts": [], "locations": { "countryId": 30100001, "whiteListedStateIds": [], "blackListedStateIds": [], "whiteListedCityIds": [], "blackListedCityIds": [] }, "dataPartners": [ { "id": 7, "reach": 6539272, "incrementalReach": 6539272, "priority": 1, "selected": true } ], "storagePathId": null, "storagePath": null, "storageFileName": null, "storageFileSize": null, "storageFileRows": null, "includeAudienceIds": [], "excludeAudienceIds": [] } ] } } } } }, "required": true }, "responses": { "200": { "description": "Generated audiences retrieved successfully", "content": { "application/json": { "schema": { "type": "object", "properties": { "audienceId": { "type": "integer", "format": "int32" }, "audienceName": { "type": "string" }, "audienceTypeId": { "type": "integer", "format": "int32" }, "audienceSubtypeId": { "type": "integer", "format": "int32" }, "dataPartnerId": { "type": "integer", "format": "int32" }, "audienceStatusId": { "type": "integer", "format": "int32" }, "cpm": { "type": "number", "format": "double" }, "reach": { "type": "integer", "format": "int32" }, "targeting": { "type": "object", "properties": { "audienceSelectionMethodId": { "type": "integer", "format": "int32" }, "npiTypeIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "speciality": { "type": "object", "properties": { "specialityIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "allSpecialitiesSelected": { "type": "boolean" } } }, "account": { "type": "object", "properties": { "accountIds": { "type": "array", "items": { "type": "integer", "format": "int64" } }, "allAccountsSelected": { "type": "boolean" } } }, "accountType": { "type": "object", "properties": { "accountTypeIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "allAccountTypesSelected": { "type": "boolean" } } }, "healthSystem": { "type": "object", "properties": { "healthSystemIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "allHealthSystemsSelected": { "type": "boolean" } } }, "title": { "type": "object", "properties": { "titleIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "allTitlesSelected": { "type": "boolean" } } }, "locations": { "required": [ "countryId" ], "type": "object", "properties": { "countryId": { "type": "integer", "format": "int32" }, "whiteListedStateIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "blackListedStateIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "whiteListedCityIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "blackListedCityIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "whiteListedZipcodeIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "blackListedZipcodeIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "whiteListedZipcodes": { "type": "array", "items": { "type": "string" } }, "blackListedZipcodes": { "type": "array", "items": { "type": "string" } } } }, "dataPartners": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "reach": { "type": "integer", "format": "int64" }, "priority": { "type": "integer", "format": "int32" }, "selected": { "type": "boolean" }, "incrementalReach": { "type": "integer", "format": "int64" } } } }, "storagePathId": { "type": "integer", "format": "int32" }, "storagePath": { "type": "string" }, "storageFileName": { "type": "string" }, "storageFileSize": { "type": "integer", "format": "int64" }, "storageFileRows": { "type": "integer", "format": "int32" }, "includeAudienceIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "excludeAudienceIds": { "type": "array", "items": { "type": "integer", "format": "int32" } } } }, "audienceBlockId": { "type": "integer", "format": "int32" }, "ineligibilityReason": { "type": "string" }, "eligible": { "type": "boolean" } } }, "examples": { "Success response": { "description": "Success response", "value": { "success": true, "data": { "audiences": [ { "audienceId": -1, "audienceName": "test for aud summary_HCP_hld_Filtered", "audienceTypeId": 1, "audienceSubtypeId": 3, "dataPartnerId": 7, "audienceStatusId": 0, "cpm": null, "reach": 485207, "targeting": null, "audienceBlockId": 1, "ineligibilityReason": null, "eligible": true }, { "audienceId": -4, "audienceName": "test for aud summary_NPI Nurse_hld_Filtered", "audienceTypeId": 1, "audienceSubtypeId": 4, "dataPartnerId": 7, "audienceStatusId": 0, "cpm": null, "reach": 0, "targeting": null, "audienceBlockId": 1, "ineligibilityReason": "Minimum reach \u003C 10", "eligible": false } ] } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden !" } ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/plan/hcp/campaigns/publish": { "post": { "tags": [ "Planner API" ], "summary": "API to publish draft campaigns", "description": "This API publishes draft campaigns for a given HCP plan. The actual campaigns in draft status are created using this API. ", "operationId": "generateIOCampaigns_1", "parameters": [], "requestBody": { "description": "Request body containing the details of the proposal", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "startTime": { "type": "integer", "format": "int64" }, "endTime": { "type": "integer", "format": "int64" }, "timezoneId": { "type": "integer", "format": "int64" }, "budgetTypeId": { "type": "integer", "format": "int32" }, "owId": { "type": "integer", "format": "int32" }, "createdAt": { "type": "integer", "format": "int64" }, "updatedAt": { "type": "integer", "format": "int64" }, "minBudget": { "type": "number" }, "budget": { "type": "number" }, "maxBudget": { "type": "number" }, "reach": { "type": "integer", "format": "int64" }, "maxReach": { "type": "integer", "format": "int64" }, "minImpressions": { "type": "integer", "format": "int64" }, "impressions": { "type": "integer", "format": "int64" }, "maxImpressions": { "type": "integer", "format": "int64" }, "frequencyCap": { "type": "integer", "format": "int32" }, "statusId": { "type": "integer", "format": "int32" }, "audienceBlocks": { "type": "array", "items": { "type": "object", "properties": { "audienceSelectionMethodId": { "type": "integer", "format": "int32" }, "npiTypeIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "speciality": { "type": "object", "properties": { "specialityIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "allSpecialitiesSelected": { "type": "boolean" } } }, "account": { "type": "object", "properties": { "accountIds": { "type": "array", "items": { "type": "integer", "format": "int64" } }, "allAccountsSelected": { "type": "boolean" } } }, "accountType": { "type": "object", "properties": { "accountTypeIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "allAccountTypesSelected": { "type": "boolean" } } }, "healthSystem": { "type": "object", "properties": { "healthSystemIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "allHealthSystemsSelected": { "type": "boolean" } } }, "title": { "type": "object", "properties": { "titleIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "allTitlesSelected": { "type": "boolean" } } }, "locations": { "required": [ "countryId" ], "type": "object", "properties": { "countryId": { "type": "integer", "format": "int32" }, "whiteListedStateIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "blackListedStateIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "whiteListedCityIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "blackListedCityIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "whiteListedZipcodeIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "blackListedZipcodeIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "whiteListedZipcodes": { "type": "array", "items": { "type": "string" } }, "blackListedZipcodes": { "type": "array", "items": { "type": "string" } } } }, "dataPartners": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "reach": { "type": "integer", "format": "int64" }, "priority": { "type": "integer", "format": "int32" }, "selected": { "type": "boolean" }, "incrementalReach": { "type": "integer", "format": "int64" } } } }, "storagePathId": { "type": "integer", "format": "int32" }, "storagePath": { "type": "string" }, "storageFileName": { "type": "string" }, "storageFileSize": { "type": "integer", "format": "int64" }, "storageFileRows": { "type": "integer", "format": "int32" }, "includeAudienceIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "excludeAudienceIds": { "type": "array", "items": { "type": "integer", "format": "int32" } } } } }, "planLevelTargeting": { "type": "object", "properties": { "devices": { "type": "object", "properties": { "deviceTypeIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "allDeviceTypesSelected": { "type": "boolean" } } }, "channels": { "type": "object", "properties": { "channelTypeIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "allChannelTypesSelected": { "type": "boolean" } } }, "creativeTypes": { "type": "object", "properties": { "creativeTypeIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "allCreativeTypesSelected": { "type": "boolean" }, "isTvAutoBuying": { "type": "boolean" } } }, "inventory": { "type": "object", "properties": { "openExchanges": { "type": "object", "properties": { "exchangeIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "allExchangesSelected": { "type": "boolean" }, "iabCategoryIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "allIabCategoriesSelected": { "type": "boolean" } } }, "inventoryGroup": { "type": "object", "properties": { "inventoryGroupIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "allInventoryGroupsSelected": { "type": "boolean" } } } } } } }, "splitStrategy": { "type": "array", "items": { "type": "object", "properties": { "splitDimensionTypeId": { "type": "integer", "format": "int32" }, "selectedValueIds": { "type": "array", "items": { "type": "integer", "format": "int32" } } } } }, "campaigns": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "startTime": { "type": "integer", "format": "int64" }, "endTime": { "type": "integer", "format": "int64" }, "frequencyCap": { "type": "integer", "format": "int32" }, "minMediaCpm": { "type": "number" }, "mediaCpm": { "type": "number" }, "maxMediaCpm": { "type": "number" }, "dataCpm": { "type": "number" }, "minBudget": { "type": "number" }, "budget": { "type": "number" }, "maxBudget": { "type": "number" }, "minReach": { "type": "integer", "format": "int64" }, "reach": { "type": "integer", "format": "int64" }, "maxReach": { "type": "integer", "format": "int64" }, "minImpressions": { "type": "integer", "format": "int64" }, "impressions": { "type": "integer", "format": "int64" }, "maxImpressions": { "type": "integer", "format": "int64" }, "strategy": { "type": "string" }, "targeting": { "type": "object", "properties": { "dataPartnerIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "creativeTypeId": { "type": "integer", "format": "int32" }, "deviceTypeIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "npiTypeId": { "type": "integer", "format": "int32" }, "audienceTypeIds": { "type": "array", "items": { "type": "integer", "format": "int32" } } } }, "campaignId": { "type": "integer", "format": "int32" }, "isAbm": { "type": "boolean" } } } }, "ioId": { "type": "integer", "format": "int32" } } }, "examples": { "Publish Plan with request object": { "description": "Publish Plan with request object", "value": { "id": 123, "name": "Sample HCP Planner Request", "startTime": 1735124399000, "endTime": 1757534400000, "timezoneId": 4, "budgetTypeId": 1, "budget": 75000, "maxBudget": 80000, "reach": 250000, "maxReach": 300000, "impression": 1000000, "maxImpressions": 1200000, "frequencyCap": 5, "audienceBlocks": [ { "audienceSelectionMethodId": 1, "npiTypeIds": [1, 2], "speciality": { "specialityIds": [101, 102], "allSpecialitiesSelected": false }, "locations": { "countryId": 1, "whiteListedStateIds": [501, 502], "blackListedStateIds": [], "whiteListedCityIds": [], "blackListedCityIds": [], "whiteListedZipcodes": [90210, 10001], "blackListedZipcodes": [] }, "dataPartners": [ { "id": 7, "reach": 10000, "priority": 1, "isSelected": true, "incrementalReach": 5000 }, { "id": 8, "reach": 10000, "priority": 2, "isSelected": true, "incrementalReach": 5000 }, { "id": 10, "reach": 10000, "priority": 3, "isSelected": true, "incrementalReach": 5000 } ] }, { "audienceSelectionMethodId": 2, "npiTypeIds": [1, 2], "speciality": { "specialityIds": [101, 102], "allSpecialitiesSelected": false }, "locations": { "countryId": 1, "whiteListedStateIds": [501, 502], "blackListedStateIds": [], "whiteListedCityIds": [], "blackListedCityIds": [], "whiteListedZipcodes": [90210, 10001], "blackListedZipcodes": [] }, "dataPartners": [ { "id": 7, "reach": 10000, "priority": 1, "isSelected": true, "incrementalReach": 5000 }, { "id": 8, "reach": 10000, "priority": 2, "isSelected": true, "incrementalReach": 5000 }, { "id": 10, "reach": 10000, "priority": 3, "isSelected": true, "incrementalReach": 5000 } ], "storagePathId": 1 }, { "audienceSelectionMethodId": 3, "includeAudienceIds": [301, 302], "excludeAudienceIds": [401] }, { "audienceSelectionMethodId": 4, "npiTypeIds": [1, 2], "speciality": { "specialityIds": [101, 102], "allSpecialitiesSelected": false }, "accounts": [ { "accountTypeId": 1, "accountIds": [201, 202], "allAccountsSelected": false }, { "accountTypeId": 2, "accountIds": [], "allAccountsSelected": true } ], "locations": { "countryId": 1, "whiteListedStateIds": [501, 502], "blackListedStateIds": [], "whiteListedCityIds": [], "blackListedCityIds": [], "whiteListedZipcodes": [90210, 10001], "blackListedZipcodes": [] }, "dataPartners": [ { "id": 7, "reach": 10000, "priority": 1, "isSelected": true, "incrementalReach": 5000 }, { "id": 8, "reach": 10000, "priority": 2, "isSelected": true, "incrementalReach": 5000 }, { "id": 10, "reach": 10000, "priority": 3, "isSelected": true, "incrementalReach": 5000 } ] } ], "planLevelTargeting": { "devices": { "deviceTypeIds": [1, 2], "allDeviceTypesSelected": false }, "channels": { "channelTypeIds": [1, 2], "allChannelTypesSelected": false }, "creativeTypes": { "creativeTypeIds": [10, 11], "allCreativeTypesSelected": false, "isTvAutoBuying": true }, "inventory": { "openExchanges": { "exchangeIds": [1, 2], "allExchangesSelected": false, "iabCategoryIds": [1, 2], "allIabCategoriesSelected": false }, "inventoryGroup": { "inventoryGroupIds": [1, 2], "allInventoryGroupsSelected": false } } }, "splitStrategy": [ { "splitDimensionTypeId": 1, "selectedValueIds": [10, 11] } ], "campaigns": [ { "id": null, "name": "Campaign A", "startTime": 1754942400000, "endTime": 1757534400000, "budget": 37500, "maxBudget": 40000, "mediaCpm": 50, "dataCpm": 15, "reach": 125000, "maxReach": 150000, "impressions": 500000, "maxImpressions": 600000, "isAbm": false, "targeting": { "dataPartnerIds": [1], "creativeTypeId": 10, "deviceTypeIds": [1], "npiTypeId": 1, "audienceTypeIds": [1] } } ] } } } } }, "required": true }, "responses": { "200": { "description": "Proposal created successfully", "content": { "application/json": { "examples": { "Success response": { "description": "Success response", "value": { "success": true, "data": { "message": "Campaign generation is in progress" } } } } } } } } } }, "/api/v3/plan/hcp/audience/graph": { "post": { "tags": [ "Planner API" ], "summary": "API to fetch audience graph", "description": "This API retrieves the audience graph for healthcare planners based on the provided request parameters.", "operationId": "getAudienceGraph", "requestBody": { "description": "Request body containing the parameters for audience graph", "content": { "application/json": { "schema": { "type": "object", "properties": { "audienceSelectionMethodId": { "type": "integer", "format": "int32" }, "npiTypeIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "speciality": { "type": "object", "properties": { "specialityIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "allSpecialitiesSelected": { "type": "boolean" } } }, "account": { "type": "object", "properties": { "accountIds": { "type": "array", "items": { "type": "integer", "format": "int64" } }, "allAccountsSelected": { "type": "boolean" } } }, "accountType": { "type": "object", "properties": { "accountTypeIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "allAccountTypesSelected": { "type": "boolean" } } }, "healthSystem": { "type": "object", "properties": { "healthSystemIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "allHealthSystemsSelected": { "type": "boolean" } } }, "title": { "type": "object", "properties": { "titleIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "allTitlesSelected": { "type": "boolean" } } }, "locations": { "required": [ "countryId" ], "type": "object", "properties": { "countryId": { "type": "integer", "format": "int32" }, "whiteListedStateIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "blackListedStateIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "whiteListedCityIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "blackListedCityIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "whiteListedZipcodeIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "blackListedZipcodeIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "whiteListedZipcodes": { "type": "array", "items": { "type": "string" } }, "blackListedZipcodes": { "type": "array", "items": { "type": "string" } } } }, "dataPartners": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "reach": { "type": "integer", "format": "int64" }, "priority": { "type": "integer", "format": "int32" }, "selected": { "type": "boolean" }, "incrementalReach": { "type": "integer", "format": "int64" } } } }, "storagePathId": { "type": "integer", "format": "int32" }, "storagePath": { "type": "string" }, "storageFileName": { "type": "string" }, "storageFileSize": { "type": "integer", "format": "int64" }, "storageFileRows": { "type": "integer", "format": "int32" }, "includeAudienceIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "excludeAudienceIds": { "type": "array", "items": { "type": "integer", "format": "int32" } } } }, "examples": { "Audience Graph Request": { "description": "Audience Graph Request", "value": { "audienceSelectionMethodId": 1, "npiTypeIds": [1, 2], "speciality": { "specialityIds": [1, 2], "allSpecialitiesSelected": false }, "account": { "accountIds": [1, 2], "allAccountsSelected": false }, "healthSystem": { "healthSystemIds": [], "allHealthSystemsSelected": true }, "title": { "titleIds": [], "allTitlesSelected": true }, "accountType": { "accountTypeIds": [], "allAccountTypesSelected": true }, "locations": { "countryId": 1, "whiteListedStateIds": [], "blackListedStateIds": [], "whiteListedCityIds": [], "blackListedCityIds": [], "whiteListedZipcodes": [], "blackListedZipcodes": [] }, "dataPartners": { "dataPartnerIds": [1, 2], "allDataPartnersSelected": null }, "storagePathId": null, "storagePath": null, "storageFileName": null, "storageFileSize": null, "storageFileRows": null, "includeAudienceIds": [], "excludeAudienceIds": [] } } } } }, "required": true }, "responses": { "200": { "description": "Successful retrieval of audience graph", "content": { "application/json": { "examples": { "Success response": { "description": "Success response", "value": { "success": true, "data": { "npiTypes": [ { "id": 3, "reach": 2 } ], "specialties": [ { "id": 406099999, "reach": 2 }, { "id": 406000018, "reach": 2 }, { "id": 406000136, "reach": 1 }, { "id": 406000106, "reach": 1 } ], "accounts": [ { "id": 440023, "reach": 1 }, { "id": 440016, "reach": 1 } ], "accountTypes": [ { "id": 440023, "reach": 1 }, { "id": 440016, "reach": 1 } ], "healthSystems": [ { "id": 440023, "reach": 1 }, { "id": 440016, "reach": 1 } ], "titles": [ { "id": 440023, "reach": 1 }, { "id": 440016, "reach": 1 } ], "dataPartnerStats": { "partners": [ { "id": 7, "reach": 2, "priority": 3, "selected": true, "npiTypeReach": [ { "id": 3, "reach": 2 }, { "id": 4, "reach": 2 } ], "coverage": 100 }, { "id": 8, "reach": 2, "priority": 3, "selected": true, "npiTypeReach": [ { "id": 3, "reach": 2 }, { "id": 4, "reach": 2 } ], "coverage": 100 }, { "id": 10, "reach": 2, "priority": 3, "selected": true, "npiTypeReach": [ { "id": 3, "reach": 2 }, { "id": 4, "reach": 2 } ], "coverage": 100 } ], "venn": [ { "partnerIds": [7], "count": 0, "reach": 2, "npiTypeReach": [ { "id": 3, "reach": 95000 }, { "id": 4, "reach": 55000 } ], "coveragePercentage": 100, "intersectionPercentage": 100 }, { "partnerIds": [8], "count": 0, "reach": 2, "npiTypeReach": [ { "id": 3, "reach": 95000 }, { "id": 4, "reach": 55000 } ], "coveragePercentage": 100, "intersectionPercentage": 100 }, { "partnerIds": [10], "count": 0, "reach": 2, "npiTypeReach": [ { "id": 3, "reach": 95000 }, { "id": 4, "reach": 55000 } ], "coveragePercentage": 100, "intersectionPercentage": 100 }, { "partnerIds": [7, 8], "count": 0, "reach": 2, "npiTypeReach": [ { "id": 3, "reach": 95000 }, { "id": 4, "reach": 55000 } ], "coveragePercentage": 100, "intersectionPercentage": 100 }, { "partnerIds": [7, 10], "count": 0, "reach": 2, "npiTypeReach": [ { "id": 3, "reach": 95000 }, { "id": 4, "reach": 55000 } ], "coveragePercentage": 100, "intersectionPercentage": 100 }, { "partnerIds": [8, 10], "count": 0, "reach": 2, "npiTypeReach": [ { "id": 3, "reach": 95000 }, { "id": 4, "reach": 55000 } ], "coveragePercentage": 100, "intersectionPercentage": 100 }, { "partnerIds": [7, 8, 10], "count": 2, "reach": 2, "npiTypeReach": [ { "id": 3, "reach": 95000 }, { "id": 4, "reach": 55000 } ], "coveragePercentage": 100, "intersectionPercentage": 100 } ] } } } } } } } }, "403": { "description": "Forbidden vertical ID", "content": { "application/json": { "examples": { "Forbidden vertical response": { "description": "Forbidden vertical response", "value": { "success": false, "errorObjects": [ { "error": "Request for forbidden vertical" } ] } } } } } } } } }, "/api/v3/plan/proposals/restore": { "patch": { "tags": [ "Planner API" ], "summary": "This API updates the Ready Proposal", "description": "This API updates the Ready proposal with all the different types of proposal details and campaign in-line edit", "operationId": "restoreReadyProposal", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "content": { "application/json": { "schema": { "required": [ "endTime", "proposalIds", "startTime" ], "type": "object", "properties": { "proposalIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "startTime": { "type": "integer", "format": "int64" }, "endTime": { "type": "integer", "format": "int64" } } }, "examples": { "Proposal Request with all the parameters": { "description": "Proposal Request with all the parameters", "value": { "proposalIds": [2, 3], "startTime": 1212121212, "endTime": 1512121212 } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Proposal updated successfully": { "description": "Proposal updated successfully", "value": { "success": true, "data": { "message": "Proposal restored successfully" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden !" } ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/plan/proposal/{proposalId}": { "get": { "tags": [ "Planner API" ], "summary": "API to fetch Proposal details based on proposal id", "description": "This API retrieves Proposal details for given proposal id based on status of proposal.\nSo For draft proposal api reverts with proposal details and proposal targeting details and once\n it gets generated then api reverts with proposal details and generated campaigns details.\n", "operationId": "getProposalDetailsById", "parameters": [ { "name": "proposalId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "Success Responses ", "content": { "application/json": { "examples": { "For Draft Proposal": { "description": "For Draft Proposal", "value": "{\n \"success\": true,\n \"data\": {\n \"id\": 14,\n \"name\": sample,\n \"startTime\": 1730658720000,\n \"endTime\": 1733250720000,\n \"status\": 2,\n \"politicalAdvertiserId\": 0,\n \"marginValue\": null,\n \"owId\": 202500,\n \"proposalTargeting\": {\n \"location\": {\n \"country\": 1,\n \"states\": [\n 1,\n 2,\n 3\n ],\n \"dma\": [\n 1,\n 2,\n 3\n ],\n \"city\": [\n 1,\n 2,\n 3\n ],\n \"county\": [\n 1,\n 2,\n 3\n ],\n \"congressionalDistricts\": [\n 1,\n 2,\n 3\n ],\n \"stateHouse\": [\n 1,\n 2,\n 3\n ],\n \"stateSenate\": [\n 1,\n 2,\n 3\n ],\n \"zipCodes\": null,\n \"locationAdvanceTargeted\": [\n \"city\",\n \"state\"\n ],\n \"advanceTargeted\": false\n },\n \"audience\": {\n \"audienceSegmentIds\": [\n 6387630,\n 6387631,\n 6387632,\n 6387633,\n 6387634\n ],\n \"advanceTargeted\": false\n },\n \"creative\": {\n \"creativeTypeIds\": [\n 13\n ],\n \"tvAutoBuying\": false\n },\n \"inventory\": {\n \"openExchangeInventory\": {\n \"iabCategories\": [\n 1,\n 2\n ],\n \"exchanges\": [\n 11,\n 16,\n 19\n ]\n },\n \"inventoryGroupIds\": [],\n \"advanceTargeted\": false\n },\n \"device\": {\n \"deviceTypesTargetedIds\": [],\n \"channelTypesTargetedIds\": [],\n \"deviceTypesAdvanceTargetedIds\": [\n 1,\n 2\n ],\n \"advanceTargeted\": false\n }\n }\n }\n}" }, "For Ready Proposal (non-draft proposal)": { "description": "For Ready Proposal (non-draft proposal)", "value": " {\n \"success\": \"true\",\n \"data\": {\n \"id\": 14,\n \"name\": sample,\n \"startTime\": 1730658720000,\n \"endTime\": 1733250720000,\n \"status\": 3,\n \"targetedReach\": 2147483646,\n \"targetedImpressions\": 2147483646,\n \"maxTargetedReach\": 2147483646,\n \"maxTargetedImpressions\": 2147483646,\n \"budget\": 0.0,\n \"maxBudget\": 0.0,\n \"owId\": 202500,\n \"proposedCampaigns\": [\n {\n \"id\": 1234,\n \"name\": \"Demo_Campaign_For_proposal\",\n \"startTime\": 1730658720000,\n \"endTime\": 1733250720000,\n \"strategy\": \"strategy\",\n \"creativeTypeId\": 1,\n \"duration\": 30,\n \"modelType\": \"cpm\",\n \"targetedReach\": 1234,\n \"maxTargetedReach\": 12345566,\n \"frequencyCap\": 3,\n \"targetedImpressions\": 123,\n \"maxTargetedImpressions\": 12345,\n \"cpm\": 5.0,\n \"minCpm\": 3.5,\n \"maxCpm\": 1000.0,\n \"budget\": 1000.0,\n \"maxBudget\": 1000.0\n }\n ]\n }\n}" } } } } }, "403": { "description": "Unauthorized user", "content": { "application/json": { "examples": { "Logged-in user is super user/ workspace user": { "description": "Logged-in user is super user/ workspace user", "value": { "success": false, "errorObjects": [ { "error": "Requested Resource is not accessible for the user" } ] } }, "Logged-in user does not have access to requested proposal": { "description": "Logged-in user does not have access to requested proposal", "value": { "success": false, "errorObjects": [ { "error": "Requested Proposal details is not accessible to logged-in user" } ] } } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Invalid sortBy value." } ] } } } } } }, "patch": { "tags": [ "Planner API" ], "summary": "This API updates the Ready Proposal", "description": "This API updates the Ready proposal with all the different types of proposal details and campaign in-line edit", "operationId": "editReadyProposal", "parameters": [ { "name": "proposalId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "proposalId": { "type": "integer", "format": "int32" }, "proposalName": { "type": "string" }, "proposalStartTime": { "type": "integer", "format": "int64" }, "proposalEndTime": { "type": "integer", "format": "int64" }, "proposalStatusId": { "type": "integer", "format": "int32" }, "proposalReach": { "type": "integer", "format": "int64" }, "proposalMaxReach": { "type": "integer", "format": "int64" }, "proposalImpressions": { "type": "integer", "format": "int64" }, "proposalMaxImpressions": { "type": "integer", "format": "int64" }, "politicalAdvertiserId": { "type": "integer", "format": "int32" }, "proposalBudget": { "type": "number", "format": "double" }, "proposalMaxBudget": { "type": "number", "format": "double" }, "proposalOwId": { "type": "integer", "format": "int32" }, "campaigns": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "startTime": { "type": "integer", "format": "int64" }, "endTime": { "type": "integer", "format": "int64" }, "durationInDays": { "type": "integer", "format": "int32" }, "reach": { "type": "integer", "format": "int64" }, "maxReach": { "type": "integer", "format": "int64" }, "impressions": { "type": "integer", "format": "int64" }, "maxImpressions": { "type": "integer", "format": "int64" }, "cpm": { "type": "number", "format": "double" }, "minCpm": { "type": "number", "format": "double" }, "frequencyCap": { "type": "integer", "format": "int32" }, "budget": { "type": "number", "format": "double" }, "maxBudget": { "type": "number", "format": "double" }, "proposalId": { "type": "integer", "format": "int32" }, "campaignId": { "type": "integer", "format": "int32" }, "timeZoneId": { "type": "integer", "format": "int32" }, "owId": { "type": "integer", "format": "int32" }, "strategy": { "type": "string" }, "location": { "required": [ "country" ], "type": "object", "properties": { "country": { "type": "integer", "format": "int32" }, "states": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "dma": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "city": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "county": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "congressionalDistricts": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "stateHouse": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "stateSenate": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "zipCodes": { "type": "string" }, "isAdvanceTargeted": { "type": "boolean" }, "locationAdvanceTargeted": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } } } }, "audience": { "type": "object", "properties": { "audienceSegmentIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "isAdvanceTargeted": { "type": "boolean" } } }, "creative": { "type": "object", "properties": { "creativeTypeIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "isTvAutoBuying": { "type": "boolean" } } }, "inventory": { "type": "object", "properties": { "openExchangeInventory": { "type": "object", "properties": { "iabCategories": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "exchanges": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } } } }, "inventoryGroupIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "isAdvanceTargeted": { "type": "boolean" } } }, "device": { "type": "object", "properties": { "deviceTypesTargetedIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "channelTypesTargetedIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "deviceTypesAdvanceTargetedIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "isAdvanceTargeted": { "type": "boolean" } } }, "locationStrategy": { "type": "string" }, "audienceStrategy": { "type": "string" }, "inventoryStrategy": { "type": "string" }, "deviceStrategy": { "type": "string" }, "deleted": { "type": "boolean" } } } }, "deletedCampaignIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "proposalMargin": { "type": "integer", "format": "int32" }, "ioId": { "type": "integer", "format": "int32" }, "proposalCreatedByUowId": { "type": "integer", "format": "int32" }, "isPoliticalAdvertiser": { "type": "boolean" } } }, "examples": { "Proposal Request with all the parameters": { "description": "Proposal Request with all the parameters", "value": { "proposalName": "proposalName", "proposalStartTime": 1729449000000, "proposalEndTime": 1730313000000, "politicalAdvertiserId": 644, "proposalStatusId": 6, "proposalReach": 150000, "proposalMaxReach": 150000, "proposalImpressions": 112500000, "proposalMaxImpressions": 112500000, "proposalBudget": 1125000, "proposalMaxBudget": 1125000, "campaigns": [ { "id": 1, "name": "Proposal", "startTime": 1729449000000, "endTime": 1730313000000, "reach": 150000, "frequencyCap": 3, "impressions": 4500000, "cpm": 1, "budget": 4500 } ], "deletedCampaignIds": [3, 4] } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Proposal updated successfully": { "description": "Proposal updated successfully", "value": { "success": true, "data": { "message": "Proposal updated successfully" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden !" } ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/plan/proposal/draft/{proposalId}": { "patch": { "tags": [ "Planner API" ], "summary": "API to update the proposal in draft state.", "description": "This API validate the targeting data if provided, updated proposal data into database", "operationId": "updateDraftProposal", "parameters": [ { "name": "proposalId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "startTime": { "type": "integer", "format": "int64" }, "endTime": { "type": "integer", "format": "int64" }, "politicalAdvertiserId": { "type": "integer", "format": "int32" }, "location": { "required": [ "country" ], "type": "object", "properties": { "country": { "type": "integer", "format": "int32" }, "states": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "dma": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "city": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "county": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "congressionalDistricts": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "stateHouse": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "stateSenate": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "zipCodes": { "type": "string" }, "isAdvanceTargeted": { "type": "boolean" }, "locationAdvanceTargeted": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } } } }, "margin": { "type": "number", "format": "double" }, "audience": { "type": "object", "properties": { "audienceSegmentIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "isAdvanceTargeted": { "type": "boolean" } } }, "creative": { "type": "object", "properties": { "creativeTypeIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "isTvAutoBuying": { "type": "boolean" } } }, "inventory": { "type": "object", "properties": { "openExchangeInventory": { "type": "object", "properties": { "iabCategories": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "exchanges": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } } } }, "inventoryGroupIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "isAdvanceTargeted": { "type": "boolean" } } }, "device": { "type": "object", "properties": { "deviceTypesTargetedIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "channelTypesTargetedIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "deviceTypesAdvanceTargetedIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "isAdvanceTargeted": { "type": "boolean" } } }, "isPoliticalAdvertiser": { "type": "boolean" } } }, "examples": { "Proposal Request to update draft": { "description": "Proposal Request to update draft", "value": { "name": "sample_planner", "startTime": 1730658720000, "endTime": 1733250720000, "advertiserId": 644, "margin": 10, "location": { "country": 30100001, "states": [30200001, 30200002, 30200003], "dma": [30900001, 30900002], "city": [30400001, 30400002, 30400003], "county": [30300001, 30300002, 30300003], "congressionalDistricts": [30600001], "stateHouse": [30800001, 30800002], "stateSenate": [30700001, 30700002, 30700003], "zipCodes": "167820,78656", "isAdvanceTargeted": true, "locationAdvanceTargeted": [302, 304, 309] }, "audience": { "audienceSegmentIds": [6387630, 6387631, 6387632, 6387633, 6387634], "isAdvanceTargeted": true }, "creative": { "creativeTypeIds": [11, 13, 14], "isTvAutoBuying": true }, "inventory": { "openExchangeInventory": { "iabCategories": [1, 2], "exchanges": [11, 16, 19, 1] }, "inventoryGroupIds": [134523, 134522, 134436], "isAdvanceTargeted": true }, "device": { "deviceTypesTargetedIds": [20300001, 20300002, 20300002, 20300004], "channelTypesTargetedIds": [], "isAdvanceTargeted": true, "deviceTypesAdvanceTargetedIds": [20300002, 20300004] } } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Proposal updated successfully": { "description": "Proposal updated successfully", "value": { "success": true, "data": { "id": 11, "message": "sample_planner updated successfully" } } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/plan/type-wise-count": { "get": { "tags": [ "Planner API" ], "summary": "This API fetches the count of plans based on their type", "description": "This API fetches the count of plans based on their type for the logged-in user's organization", "operationId": "getPlanCountByType", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "Success Responses ", "content": { "application/json": { "examples": { "Success response": { "description": "Success response", "value": { "success": true, "data": { "1": 10, "2": 5, "3": 8 } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden !" } ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/plan/static/proposal/status": { "get": { "tags": [ "Planner API" ], "summary": "Static api for fetching proposal status.", "description": "This API fetches a static list of proposal status based on plannerTypeId from the database, sorted in ascending order by the default display_order column", "operationId": "ProposalStatusList", "parameters": [ { "name": "plannerTypeId", "in": "query", "description": "The planner type ID to filter the proposal status list. If not provided, it defaults to 1 (Generic Planner). For HCP Planner, use 2.", "required": false, "schema": { "type": "integer", "default": 1 } } ], "responses": { "200": { "description": "Proposal status list", "content": { "application/json": { "examples": { "Success response for generic planner": { "description": "Success response for generic planner", "value": { "success": true, "data": { "totalRecords": 6, "filteredRecords": 6, "proposalStatusList": [ { "name": "draft", "id": 2, "label": "Draft", "order": 1 }, { "name": "ready", "id": 6, "label": "Ready", "order": 2 }, { "name": "expired", "id": 3, "label": "Expired", "order": 3 }, { "name": "processing", "id": 5, "label": "Processing", "order": 4 }, { "name": "converted", "id": 1, "label": "Converted", "order": 5 }, { "name": "failed", "id": 4, "label": "Failed", "order": 6 } ] } } }, "Success response for HCP planner": { "description": "Success response for HCP planner", "value": { "success": true, "data": { "totalRecords": 5, "filteredRecords": 5, "proposalStatusList": [ { "id": 2, "name": "draft", "order": 1, "label": "Draft" }, { "id": 6, "name": "ready", "order": 2, "label": "Ready" }, { "id": 5, "name": "processing", "order": 4, "label": "Processing" }, { "id": 4, "name": "failed", "order": 6, "label": "Failed" }, { "id": 7, "name": "io_created", "order": 7, "label": "IO Created" } ] } } } } } } }, "422": { "description": "Invalid plannerTypeId provided", "content": { "application/json": { "examples": { "Error response": { "description": "Error response", "value": { "success": false, "errorObjects": [ { "error": "Provided planner type id is invalid", "field": "plannerTypeId" } ] } } } } } } } } }, "/api/v3/plan/proposals": { "get": { "tags": [ "Planner API" ], "summary": "Api for fetching proposal list", "description": "This API fetches a List all the proposals. Sorted by ID desc and search proposals by Id, Name and Created by", "operationId": "proposalDetailList", "parameters": [ { "name": "searchField", "in": "query", "description": "Search the result by provided keyword in the searchField. Search by proposal id or name or, createdBy.", "required": false, "schema": { "type": "string" } }, { "name": "noOfEntries", "in": "query", "description": "The maximum number of returned results per page. ", "required": false, "schema": { "type": "integer", "format": "int32", "default": 20 } }, { "name": "pageNo", "in": "query", "description": "Page number for the required data. ", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "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", "required": false, "schema": { "type": "string", "default": "-id" } }, { "name": "statusIds", "in": "query", "description": "Comma separated status type ids of proposal whose details needs to be fetched, Status values are 1(converted), 2(draft), 3(expired), 4(failed), 5(processing), 6(ready)", "required": false, "schema": { "type": "string", "default": "" } } ], "responses": { "200": { "description": "Proposal details list", "content": { "application/json": { "examples": { "Success response": { "description": "Success response", "value": { "success": true, "data": { "proposalDetailList": [ { "id": 6, "name": "planner-proposal-2", "statusId": 2, "createdOn": 1234567, "userAvatarUrl": "https://sample-c92d6b6cbde1.s3.com/avatar/sample.png", "reach": 4567, "impression": 345678, "ioId": null, "budget": 23423, "startDate": 1728890609000, "endDate": 1728990609000, "createdBy": "user1" }, { "id": 7, "name": "planner-proposal-3", "statusId": 1, "createdOn": 1234567, "userAvatarUrl": "https://sample-c92d6b6cbde1.s3.com/avatar/sample.png", "reach": 4567, "impression": 345678, "ioId": 1, "budget": 23423, "startDate": 1728890609000, "endDate": 1728990609000, "createdBy": "user2" } ], "totalRecords": 7, "filteredRecords": 7, "recordsTotal": { "totalBudget": 23, "totalImpressions": 3865464 } } } } } } } } } } }, "/api/v3/plan/proposal/{proposalId}/download": { "get": { "tags": [ "Planner API" ], "summary": "Download planner proposal", "description": "This API is used to download proposals with statuses: Ready, Failed, Converted, or Expired. The API generates a signed URL for downloading the proposal file.", "operationId": "generateS3LinkForDownloadProposal", "parameters": [ { "name": "fileType", "in": "query", "description": "Type of file to download. 1 for Excel, 2 for CSV", "required": true, "schema": { "type": "string" } }, { "name": "proposalId", "in": "path", "description": "Proposal ID to download", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "Bulk proposed campaign successfully deleted.", "content": { "application/json": { "examples": { "Success response": { "description": "Success response", "value": { "success": true, "data": { "proposalReportUrl": "https://example.s3.amazonaws.com/planner/proposal/report/34567890iuhgvbhjio987654456789oijhbvbjio9876" } } } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Invalid sortBy value." } ] } } } } } } }, "/api/v3/plan/proposal/margin": { "get": { "tags": [ "Planner API" ], "summary": "API to fetch user access details for logged-in user", "description": "This API retrieves user access details of logged-in organization's parent organizations. So API retrieves whether logged-in user has access to parent organizations of logged-in organization or not. ", "operationId": "getDefaultCustomerMargin", "parameters": [ { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "Success Responses ", "content": { "application/json": { "examples": { "Logged-in user has access of parent and admin organisation both": { "description": "Logged-in user has access of parent and admin organisation both", "value": { "success": true, "data": { "parentOrganisationAccess": true, "adminOrganisationAccess": true, "marginValue": 6 } } }, "Logged-in user has access of admin organisation only": { "description": "Logged-in user has access of admin organisation only", "value": { "success": true, "data": { "parentOrganisationAccess": false, "adminOrganisationAccess": true, "marginValue": 6 } } }, "Logged-in user has access of parent organisation only": { "description": "Logged-in user has access of parent organisation only", "value": { "success": true, "data": { "parentOrganisationAccess": true, "adminOrganisationAccess": false, "marginValue": 6 } } }, "Logged-in user does not have access to the parent or admin organization.": { "description": "Logged-in user does not have access to the parent or admin organization.", "value": { "success": true, "data": { "parentOrganisationAccess": false, "adminOrganisationAccess": false } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden !" } ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/plan/proposal-summary/supported-params": { "get": { "tags": [ "Planner API" ], "summary": "Supported parameters for fetching the proposal summary", "description": "This API provides a list of parameters for fetching proposal summary", "operationId": "getSupportedParameters", "responses": { "200": { "description": "Success Responses ", "content": { "application/json": { "example": { "success": true, "data": { "bidLandscape": { "location": { "countryIds": true, "cityIds": true, "countyIds": true, "senateDistrictIds": true, "houseDistrictIds": true, "congressionalDistrictIds": true, "dmaIds": true, "zipCodes": true }, "deviceTypes": true, "creativeTypes": true, "channelTypes": true, "segmentIds": true, "inventory": false }, "deviceGraph": { "location": { "countryIds": true, "cityIds": true, "countyIds": true, "senateDistrictIds": true, "houseDistrictIds": true, "congressionalDistrictIds": true, "dmaIds": true, "zipCodes": true }, "deviceTypes": true, "creativeTypes": true, "channelTypes": true, "segmentIds": true, "inventory": false }, "channelGraph": { "location": { "countryIds": true, "cityIds": true, "countyIds": true, "senateDistrictIds": true, "houseDistrictIds": true, "congressionalDistrictIds": true, "dmaIds": true, "zipCodes": true }, "deviceTypes": true, "creativeTypes": true, "channelTypes": true, "segmentIds": true, "inventory": false }, "reachImpressions": { "location": { "countryIds": true, "cityIds": true, "countyIds": true, "senateDistrictIds": true, "houseDistrictIds": true, "congressionalDistrictIds": true, "dmaIds": true, "zipCodes": true }, "deviceTypes": true, "creativeTypes": true, "channelTypes": true, "segmentIds": true, "inventory": false } } } } } } } } }, "/api/v3/plan/hcp/static/split-strategies": { "get": { "tags": [ "Planner API" ], "summary": " API to fetch split strategies for HCP planner", "description": " This API retrieves the split strategies available for HCP planners.", "operationId": "getSplitStrategiesForHcpPlanner", "responses": { "200": { "description": "Successful retrieval of split strategies", "content": { "application/json": { "examples": { "Success response": { "description": "Success response", "value": { "success": true, "data": [ { "id": 1, "name": "creative_type", "order": 1, "displayName": "Creative Type" }, { "id": 2, "name": "npi_type", "order": 2, "displayName": "NPI Type" }, { "id": 3, "name": "partner", "order": 3, "displayName": "Partner" }, { "id": 4, "name": "device_type", "order": 4, "displayName": "Device Type" }, { "id": 5, "name": "audience_type", "order": 5, "displayName": "Audience Type" } ] } } } } } }, "403": { "description": "Requesting audience split strategies non healthcare vertical", "content": { "application/json": { "examples": { "Forbidden vertical response": { "description": "Forbidden vertical response", "value": { "success": false, "errorObjects": [ { "error": "Request for forbidden vertical" } ] } } } } } } } } }, "/api/v3/plan/hcp/static/npi-types": { "get": { "tags": [ "Planner API" ], "summary": "API to fetch NPI types", "description": "This API retrieves the NPI types available for healthcare planners.", "operationId": "getNpiTypesList", "responses": { "200": { "description": "Successful retrieval of NPI types", "content": { "application/json": { "examples": { "Success response": { "description": "Success response", "value": { "success": true, "data": [ { "id": 3, "name": "hcp", "order": 3, "displayName": "HCP" }, { "id": 4, "name": "npi_nurse", "order": 4, "displayName": "NPI Nurse" } ] } } } } } }, "403": { "description": "Requesting NPI types for non healthcare vertical", "content": { "application/json": { "examples": { "Forbidden vertical response": { "description": "Forbidden vertical response", "value": { "success": false, "errorObjects": [ { "error": "Request for forbidden vertical" } ] } } } } } } } } }, "/api/v3/plan/hcp/static/geography-segments": { "get": { "tags": [ "Planner API" ], "summary": "API to fetch geography segments", "description": "This API retrieves the geography segments available for healthcare planners.", "operationId": "getGeographySegments", "responses": { "200": { "description": "Successful retrieval of geography segments", "content": { "application/json": { "examples": { "Success response": { "description": "Success response", "value": { "success": true, "data": [ { "id": 302, "name": null, "order": 1, "displayName": "State" }, { "id": 304, "name": null, "order": 4, "displayName": "City" } ] } } } } } }, "403": { "description": "Requesting geography segments for non healthcare vertical", "content": { "application/json": { "examples": { "Forbidden vertical response": { "description": "Forbidden vertical response", "value": { "success": false, "errorObjects": [ { "error": "Request for forbidden vertical" } ] } } } } } } } } }, "/api/v3/plan/hcp/static/data-partners": { "get": { "tags": [ "Planner API" ], "summary": "API to fetch data partners for HCP planner", "description": "This API retrieves the data partners available for HCP planners.", "operationId": "getDataPartnersForHcpPlanner", "responses": { "200": { "description": "Successful retrieval of a list of data partners", "content": { "application/json": { "examples": { "Success response": { "description": "Success response", "value": { "success": true, "data": [ { "id": 7, "name": "hl_npi_id", "order": 6, "displayName": "Healthlink ID", "dataCost": 10, "logoUrl": "https://advp0had0vuj7rad3niaw1eus2-stage.s3.us-east-1.amazonaws.com/data_partner/hld.png" }, { "id": 8, "name": "data360_npi_id", "order": 7, "displayName": "Data360 ID", "dataCost": 15, "logoUrl": "https://advp0had0vuj7rad3niaw1eus2-stage.s3.us-east-1.amazonaws.com/data_partner/D360.png" }, { "id": 10, "name": "iqvia_npi_id", "order": 9, "displayName": "IQVIA ID", "dataCost": 25, "logoUrl": "https://advp0had0vuj7rad3niaw1eus2-stage.s3.us-east-1.amazonaws.com/data_partner/iqvia.png" } ] } } } } } }, "403": { "description": "Requesting audience data partners non healthcare vertical", "content": { "application/json": { "examples": { "Forbidden vertical response": { "description": "Forbidden vertical response", "value": { "success": false, "errorObjects": [ { "error": "Request for forbidden vertical" } ] } } } } } } } } }, "/api/v3/plan/hcp/static/audience-selection-methods": { "get": { "tags": [ "Planner API" ], "summary": "API to fetch audience selection methods", "description": "This API retrieves the audience selection methods available for healthcare planners.", "operationId": "getAudienceSelectionMethods", "responses": { "200": { "description": "Successful retrieval of audience selection methods", "content": { "application/json": { "examples": { "Success response": { "description": "Success response", "value": { "success": true, "data": [ { "id": 1, "name": "filter_based", "order": 1, "displayName": "Filter Audience" }, { "id": 2, "name": "npi_upload", "order": 2, "displayName": "Upload NPI List" }, { "id": 3, "name": "existing_audience", "order": 3, "displayName": "Existing Audience" } ] } } } } } }, "403": { "description": "Requesting audience selection methods non healthcare vertical", "content": { "application/json": { "examples": { "Forbidden vertical response": { "description": "Forbidden vertical response", "value": { "success": false, "errorObjects": [ { "error": "Request for forbidden vertical" } ] } } } } } } } } }, "/api/v3/plan/hcp/specialities": { "get": { "tags": [ "Planner API" ], "summary": "API for fetching specialities list", "description": "This API fetches a list of all specialities. Sorted by the specified field and allows searching by name.", "operationId": "specialitiesList", "parameters": [ { "name": "pageNo", "in": "query", "description": "Page number for the required data. ", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "noOfEntries", "in": "query", "description": "The maximum number of returned results per page. ", "required": false, "schema": { "type": "integer", "format": "int32", "default": 50 } }, { "name": "searchField", "in": "query", "description": "Search the result by provided keyword in the searchField. Search by speciality name.", "required": false, "schema": { "type": "string" } }, { "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 - name, id, createdOn", "required": false, "schema": { "type": "string", "default": "+displayName" } }, { "name": "specialityIds", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } }, { "name": "dataPartnerIds", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } } ], "responses": { "200": { "description": "Specialities list", "content": { "application/json": { "examples": { "Success response": { "description": "Success response", "value": { "success": true, "data": { "specialitiesList": [ { "id": 40500003, "name": "Addiction Medicine", "displayName": "Addiction Medicine", "displayOrder": 3 }, { "id": 40500004, "name": "Addiction Medicine", "displayName": "Addiction Medicine", "displayOrder": 3 } ], "totalRecords": 2, "filteredRecords": 2 } } } } } } } }, "deprecated": true } }, "/api/v3/plan/hcp/plans": { "get": { "tags": [ "Planner API" ], "summary": "API for fetching HCP planners list", "description": "This API fetches a list of HCP planners with pagination, sorting, and filtering options.", "operationId": "hcpPlannerListing", "parameters": [ { "name": "pageNo", "in": "query", "description": "Page number for the required data. ", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "noOfEntries", "in": "query", "description": "The maximum number of returned results per page. ", "required": false, "schema": { "type": "integer", "format": "int32", "default": 50 } }, { "name": "searchField", "in": "query", "description": "Search the result by provided keyword in the searchField. Search by account name.", "required": false, "schema": { "type": "string" } }, { "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", "required": false, "schema": { "type": "string", "default": "-id" } }, { "name": "statusIds", "in": "query", "description": "Comma-separated list of status IDs to filter the planners by their status.", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "budgetTypeIds", "in": "query", "description": "Comma-separated list of budget type IDs to filter the planners by their budget type.", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "startDate", "in": "query", "description": "Start date for filtering planners, in epoch milliseconds format.", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "endDate", "in": "query", "description": "End date for filtering planners, in epoch milliseconds format.", "required": false, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Returns a paginated list of HCP planners. Supports filtering by status, budget type, start and end dates, and searching by name. The response includes total records, filtered records, and aggregated data such as total budget and impressions. Each planner entry contains details like id, name, status, creator, dates, reach, impression, budget, and campaign count.", "content": { "application/json": { "examples": { "Success response": { "description": "Success response", "value": { "success": true, "data": { "data": [ { "id": 2016, "name": "test", "statusId": 3, "createdOn": 1752836679704, "createdBy": "Harshita Bhambhani", "userAvatarUrl": "https://iqm-web-assets-c92d6b6cbde1-stage.s3.amazonaws.com/avatar/HB.png", "startDate": 1752838419000, "endDate": 1753934400000, "reach": 206567705, "impression": 37182186900, "budget": 334639683, "ioId": 0, "budgetTypeId": 1, "campaignCount": 0, "lastUpdated": 1752816878383 } ], "totalRecords": 1, "filteredRecords": 1 } } } } } } }, "422": { "description": "Error response for invalid parameters", "content": { "application/json": { "examples": { "Start date in future": { "description": "Start date in future", "value": { "success": false, "errorObjects": [ { "error": "Start date cannot be greater than current date", "field": "startDate" } ] } }, "End date in future": { "description": "End date in future", "value": { "success": false, "errorObjects": [ { "error": "End date cannot be greater than current date", "field": "endDate" } ] } }, "End date before start date": { "description": "End date before start date", "value": { "success": false, "errorObjects": [ { "error": "End date cannot be less than start date", "field": "endDate" } ] } }, "Invalid status IDs": { "description": "Invalid status IDs", "value": { "success": false, "errorObjects": [ { "error": "Invalid status ids provided: 999", "field": "statusIds" } ] } }, "Invalid budget type IDs": { "description": "Invalid budget type IDs", "value": { "success": false, "errorObjects": [ { "error": "Invalid budget type ids provided: [3, 4, 5]", "field": "budgetTypeIds" } ] } } } } } } } } }, "/api/v3/plan/hcp/plans/{planId}": { "get": { "tags": [ "Planner API" ], "summary": "API to fetch HCP plan by ID", "description": "This API retrieves a specific HCP plan based on the provided plan ID.", "operationId": "getHcpPlanById", "parameters": [ { "name": "planId", "in": "path", "description": "The ID of the HCP plan to retrieve.", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successful retrieval of HCP plan", "content": { "application/json": { "examples": { "Success response": { "description": "Success response", "value": "{\n {\n \"success\": true,\n \"data\": {\n \"id\": 1\n \"name\": \"Q4 Diabetes Awareness Campaign\",\n \"startDate\": 1732707706666,\n \"endDate\": 1733312506666,\n \"timezoneId\": 3,\n \"budgetModeId\": 1,\n \"budget\": 100000,\n \"maxBudget\": 120000,\n \"reach\": 50000,\n \"maxReach\": 70000,\n \"impressions\": 200000,\n \"maxImpressions\": 250000,\n \"frequencyCap\": 3\n \"audienceBlocks\": [\n {\n \"audienceSelectionMethodId\": 1,\n \"npiTypeIds\": [3,4],\n \"speciality\":{\n \"specialityIds\":[406000001, 406000002],\n \"allSpecialitiesSelected\": false\n },\n \"account\": {\n \"accountIds\": [1,2],\n \"allAccountsSelected\": false\n },\n \"healthSystem\": {\n \"healthSystemIds\": [],\n \"allHealthSystemsSelected\": true\n },\n \"title\": {\n \"titleIds\": [],\n \"allTitlesSelected\": true\n },\n \"accountType\": {\n \"accountTypeIds\": [],\n \"allAccountTypesSelected\": true\n },\n \"locations\": {\n \"countryId\": 30100001,\n \"whiteListedStateIds\": [],\n \"blackListedStateIds\": [],\n \"whiteListedCityIds\": [],\n \"blackListedCityIds\": [],\n \"whiteListedZipcodes\":[],\n \"blackListedZipcodes\":[]\n },\n \"dataPartners\": {\n \"dataPartnerIds\": [7,8],\n \"allDataPartnersSelected\": null\n },\n \"storagePathId\": null,\n \"storagePath\": null,\n \"storageFileName\": null,\n \"storageFileSize\": null,\n \"storageFileRows\": null,\n \"includeAudienceIds\": [],\n \"excludeAudienceIds\": []\n },\n {\n \"audienceSelectionMethodId\": 2,\n \"npiTypeIds\": [3],\n \"speciality\": null,\n \"accounts\": [],\n \"locations\": null,\n \"dataPartners\": {\n \"dataPartnerIds\": [8,10],\n \"allDataPartnersSelected\": null\n },\n \"storagePath\": \"tmp/aud_uploads/upload_block2.csv\",\n \"storagePathId\": 1234,\n \"storageFileName\": \"upload_block2.csv\",\n \"storageFileSize\": 200,\n \"storageFileRows\": 500,\n \"includeAudienceIds\": [],\n \"excludeAudienceIds\": []\n },\n {\n \"audienceSelectionMethodId\": 3,\n \"npiTypeIds\": [],\n \"speciality\": null,\n \"accounts\": [],\n \"locations\": null,\n \"dataPartners\": null,\n \"storagePath\": null,\n \"includeAudienceIds\": [1137702, 1101834, 1101831],\n \"excludeAudienceIds\": [1102476]\n }\n ],\n \"planLevelTargeting\": {\n \"devices\":{\n \"deviceTypeIds\": [20300001,20300002],\n \"allDeviceTypesSelected\": null\n },\n \"channels\":{\n \"channelTypeIds\": [11,12],\n \"allChannelTypesSelected\": null\n },\n \"creativeTypes\":{\n \"creativeTypeIds\":[11,14,15],\n \"allCreativeTypesSelected\": null\n },\n \"inventory\": {\n \"openExchangeVO\": {\n \"exchangeIds\": [16,19],\n \"allExchangesSelected\": null,\n \"iabCategoryIds\": [11,21],\n \"allIabCategoriesSelected\": null\n },\n \"inventoryGroup\": null\n }\n },\n \"splitStrategy\": [\n {\n \"splitDimensionType\": {\n \"id\":1,\n \"name\": \"creative_type\",\n \"displayName\": \"Split by Creative Type\",\n \"order\": 1\n },\n \"selectedValueIds\": [1, 2]\n },\n {\n \"splitDimensionType\": {\n \"id\":1,\n \"name\": \"creative_type\",\n \"displayName\": \"Split by Creative Type\",\n \"order\": 1\n },\n \"selectedValueIds\": [1, 3]\n }\n ],\n \"campaigns\": [\n {\n \"id\": 1,\n \"name\": \"Filter‑Block1•Device1•Creative1\",\n \"startDate\": 1732707706666,\n \"endDate\": 1733312506666,\n \"budget\": 16000,\n \"maxBudget\": 18000,\n \"mediaCpm\": 22.5,\n \"dataCpm\": 5.0,\n \"budgetPercentage\": 16.0,\n \"reach\": 11000,\n \"maxReach\": 70000,\n \"impressions\": 35000,\n \"maxImpressions\": 250000,\n \"isAbm\": false,\n \"targeting\": {\n \"dataPartnerIds\": [5, 7],\n \"creativeTypeIds\": 1,\n \"deviceTypeIds\": [1],\n \"npiTypeIds\": 1,\n \"audienceTypeIds\": []\n }\n }\n ]\n }\n }\n }\n" } } } } }, "422": { "description": "Unprocessable Entity - Invalid plan ID", "content": { "application/json": { "examples": { "Invalid Plan Id provided": { "description": "Invalid Plan Id provided", "value": { "success": false, "errorObjects": [ { "error": "Plan with plan id 3104 does not exist" } ] } } } } } } } } }, "/api/v3/plan/hcp/accounts": { "get": { "tags": [ "Planner API" ], "summary": "API for fetching accounts list", "description": "This API fetches a list of all accounts. Sorted by the specified field and allows searching by name.", "operationId": "accountsList", "parameters": [ { "name": "pageNo", "in": "query", "description": "Page number for the required data. ", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "noOfEntries", "in": "query", "description": "The maximum number of returned results per page. ", "required": false, "schema": { "type": "integer", "format": "int32", "default": 50 } }, { "name": "searchField", "in": "query", "description": "Search the result by provided keyword in the searchField. Search by account name.", "required": false, "schema": { "type": "string" } }, { "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 - name, id, createdOn", "required": false, "schema": { "type": "string", "default": "+displayName" } }, { "name": "accountTypeIds", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } }, { "name": "accountIds", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "integer", "format": "int64" } } } ], "responses": { "200": { "description": "Accounts list", "content": { "application/json": { "examples": { "Success response": { "description": "Success response", "value": { "success": true, "data": { "accountsList": [ { "id": 1, "name": "Account 1", "displayName": "Account 1", "displayOrder": 1, "accountTypeId": 1, "reach": 1000 }, { "id": 2, "name": "Account 2", "displayName": "Account 2", "displayOrder": 2, "accountTypeId": 1, "reach": 1000 } ], "totalRecords": 2, "filteredRecords": 2 } } } } } } } }, "deprecated": true } }, "/api/v3/plan/hcp/account-types": { "get": { "tags": [ "Planner API" ], "summary": "API for fetching account types list", "description": "This API fetches a list of all account types. Sorted by the specified field and allows searching by name.", "operationId": "accountTypesList", "parameters": [ { "name": "pageNo", "in": "query", "description": "Page number for the required data. ", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "noOfEntries", "in": "query", "description": "The maximum number of returned results per page. ", "required": false, "schema": { "type": "integer", "format": "int32", "default": 50 } }, { "name": "searchField", "in": "query", "description": "Search the result by provided keyword in the searchField. Search by account type name.", "required": false, "schema": { "type": "string" } }, { "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 - name, id, createdOn", "required": false, "schema": { "type": "string", "default": "-reach" } } ], "responses": { "200": { "description": "Account types list", "content": { "application/json": { "examples": { "Success response": { "description": "Success response", "value": { "success": true, "data": { "accountTypesList": [ { "id": 1, "name": "Individual", "displayName": "Individual", "displayOrder": 1, "accountCount": 1 }, { "id": 2, "name": "Organization", "displayName": "Organization", "displayOrder": 2, "accountCount": 1 } ], "totalRecords": 2, "filteredRecords": 2 } } } } } } } }, "deprecated": true } }, "/api/v3/plan/proposal": { "delete": { "tags": [ "Planner API" ], "summary": "Delete planner proposal", "description": "This API deletes proposal reports that are not marked as deleted and have a 'Draft', 'Ready', 'Failed', 'Expired' status. It requires the user to be authorized and checks if the provided proposal are valid.", "operationId": "softDeleteProposal", "parameters": [ { "name": "proposalIds", "in": "query", "description": "Comma-separated list of proposal IDs to delete.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "individual proposal successfully deleted.", "content": { "application/json": { "examples": { "Success response": { "description": "Success response", "value": { "success": true, "data": { "message": "sampleProposal deleted successfully." } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden !" } ] } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Invalid sortBy value." } ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/plan/hcp/plan": { "delete": { "tags": [ "Planner API" ], "summary": "API to delete HCP proposals", "description": "This API deletes proposals based on the provided proposal IDs. It validates user access, vertical checks and proposal IDs and then deletes the specified proposals and its targeting data.", "operationId": "deleteProposals", "parameters": [ { "name": "proposalIds", "in": "query", "description": "Comma-separated list of proposal IDs to be deleted. Example: proposalIds=101,102,103", "required": true }, { "name": "planIds", "in": "query", "required": true, "schema": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "Proposals deleted successfully", "content": { "application/json": { "examples": { "Single proposal deleted successfully": { "description": "Single proposal deleted successfully", "value": { "success": true, "data": { "message": "Sample deleted successfully" } } }, "Multiple proposals deleted successfully": { "description": "Multiple proposals deleted successfully", "value": { "success": true, "data": { "message": "3 Plans deleted successfully" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden !" } ] } } } }, "422": { "description": "Unprocessable Entity due to invalid proposal IDs", "content": { "application/json": { "examples": { "Invalid Proposal IDs provided": { "description": "Invalid Proposal IDs provided", "value": { "success": false, "errorObjects": [ { "error": "Some of the provided Proposal ID(s) are either already deleted, do not exist, or do not have a appropriate status" } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/cd/campaigns/{campaignId}/feedback/add": { "post": { "tags": [ "Campaign Debugger API", "Organization" ], "summary": "Add the feedback for a campaign", "description": "This API adds the feedback details of a campaign in the database.\n---\n\n#### Request Body Detail\n\n| **Field** | **Type** | **Description** |\n| --- | --- | --- |\n| feedbackCategoryId `[required]` | Number | ID of the category for which the feedback is given. |\n| feedbackText `[required]` | String | Text of feedback. |\n", "operationId": "addCampaignFeedback", "parameters": [ { "name": "campaignId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "feedbackCategoryId": { "type": "integer", "format": "int32" }, "feedbackText": { "type": "string" } } }, "example": { "feedbackCategoryId": 4, "feedbackText": "Add audience details." } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "success": true, "data": { "feedbackId": 73, "feedbackUser": "John Doe", "feedbackUserAvatarUrl": "https://iqm-web-assets-c92d6b6cbde1-stage.s3.amazonaws.com/avatar/JP.png", "feedbackCategory": "Budget", "feedbackText": "Max bid seems to be low. Try changing it to a higher bid amount.", "feedbackCreationTime": 1715770792000 } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden!" } ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/cd/campaigns/list": { "post": { "tags": [ "Campaign Debugger API", "Organization" ], "summary": "Get the list of campaigns for Campaign Listing", "description": "This API fetches the list of running campaigns with pagination, sorting and searching feature. It also filters out campaigns based on the given request body \n---\n\n#### Request Body Detail\n\n| **Field** | **Type** | **Description** |\n| --- | --- | --- |\n| pageNo `[optional]` | Number | Page number for the required data. The default value is 1. For no pagination give -1 as a value. |\n| noOfEntries `[optional]` | Number | The maximum number of returned results per page. The default value is 20 and the maximum value is 500. |\n| sortBy `[optional]` | Array of String | Sort the result set by specific field.String should be of format \"+sortField\" or \"-sortField\". \"+\" represents ASC and \"-\" represents DESC. Default value will be [\"-totalBudget\"]. Supported fields are campaign id, campaign name, daily budget, total budget, campaign start date, campaign end date, io name, io end date, timezone name, max bid, clicks, impressions, ctr, winrate, vcr, pacing percentage, daily pacing percentage, reach, frequency, time left in hours, total spent, budget completion percentage, shortfall amount, delivery percentage and organization name. |\n| searchField `[optional]` | String | Search the result by provided keyword in the searchField. It filters records by campaign id, campaign name, organization name, IO id and IO name |\n| verticalIds `[optional]` | Array of Number | IDs of verticals to filter out the data. |\n| creativeTypeIds `[optional]` | Array of Number | IDs of creative types to filter out the data. |\n| customerIds `[optional]` | Array of Number | IDs of the customers (ow_id) to filter out the data. |\n| ioIds `[optional]` | Array of Number | IDs of IO to filter out the data. |\n| timeLeftInHours `[optional]` | Number | Filter campaigns whose time left is less than this input |\n| campaignStatus `[optional]` | Array of String | Status of campaign. |\n| budgetTypeIds `[optional]` | Array of Number | Budget type of campaign (Dollar based or Impression based). |\n| yesterdayProposedDeliveryPercentageStart `[optional]` | Number | Lower bound of delivery percentage range filter. |\n| yesterdayProposedDeliveryPercentageEnd `[optional]` | Number | Upper bound of delivery percentage range filter. |\n| shortfallAmountStart `[optional]` | Number | Lower bound of shortfall range filter. |\n| shortfallAmountEnd `[optional]` | Number | Upper bound of shortfall range filter. |\n| timezoneIds `[optional]` | Array of Number | IDs of the timezones of the campaigns to be filtered out |\n", "operationId": "getCampaignList", "parameters": [ { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "verticalIds": { "type": "array", "items": { "type": "integer", "format": "int64" } }, "ioIds": { "type": "array", "items": { "type": "integer", "format": "int64" } }, "customerIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "creativeTypeIds": { "type": "array", "items": { "type": "integer", "format": "int64" } }, "timeLeftInHours": { "type": "integer", "format": "int64" }, "campaignStatus": { "type": "array", "items": { "type": "string" } }, "budgetTypeIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "yesterdayProposedDeliveryPercentageStart": { "type": "number", "format": "double" }, "yesterdayProposedDeliveryPercentageEnd": { "type": "number", "format": "double" }, "timezoneIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "shortfallAmountStart": { "type": "number", "format": "double" }, "shortfallAmountEnd": { "type": "number", "format": "double" }, "pageNo": { "type": "integer", "format": "int32" }, "noOfEntries": { "type": "integer", "format": "int32" }, "sortBy": { "type": "array", "items": { "type": "string" } }, "searchField": { "type": "string" } } }, "example": { "pageNo": 1, "noOfEntries": 20, "sortBy": [ "-totalBudget" ], "searchField": "GOGO", "verticalIds": [1], "creativeTypeIds": [11], "customerIds": [201427], "ioIds": [20233], "timeLeftInHours": 72, "campaignStatus": [ "running" ], "budgetTypeIds": [1], "yesterdayProposedDeliveryPercentageStart": 0, "yesterdayProposedDeliveryPercentageEnd": 80, "shortfallAmountStart": 0, "shortfallAmountEnd": 180, "timezoneIds": [29] } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "success": true, "data": { "totalRecords": 184, "filteredRecords": 1, "recordsTotal": { "id": 0, "campaignName": null, "creativeTypeId": 0, "organizationName": null, "dailyBudget": 32, "totalBudget": 12000, "totalSpent": 0.084, "budgetCompletionPercentage": 0.0019, "campaignStartDate": 0, "campaignEndDate": 0, "ioName": null, "ioEndDate": 0, "timezoneId": 0, "timezoneName": null, "maxBid": 0, "clicks": 3, "impressions": 7, "winRate": 77.7777777777778, "reach": 0, "frequency": 0, "pacingPercentage": 0, "actualSpent": 0, "expectedSpent": 0, "remainingDurationInDays": 0, "dailyPacingPercentage": 0, "expectedDailySpent": 0, "actualDailySpent": 0, "dailyCampaignDuration": 0, "dailyRemainingDuration": 0, "timeLeftInHours": null, "totalCount": 1, "budgetTypeId": 0, "shortfallAmount": 2430.88676082686, "deliveryPercentage": 0, "ctr": 42.8571428571429, "vcr": 0, "proposedDailyBudget": 0, "campaignFlightTimeInDays": 0, "campaignDurationInDays": 0, "remainingBudget": 0 }, "recordsList": [ { "id": 454683, "campaignName": "GOJO Conversion test", "creativeTypeId": 11, "organizationName": "Stage Shared Advertiser", "dailyBudget": 32, "totalBudget": 12000, "totalSpent": 0.084, "budgetCompletionPercentage": 0.0019, "campaignStartDate": 1704355469000, "campaignEndDate": 1744914600000, "ioName": "GOJO", "ioEndDate": 1711857600000, "timezoneId": 105, "timezoneName": "Asia/Kolkata", "maxBid": 12, "clicks": 3, "impressions": 7, "winRate": 77.7777777777778, "reach": 0, "frequency": 0, "pacingPercentage": 0.0019, "actualSpent": 0.228, "expectedSpent": 2431.11474582463, "remainingDurationInDays": 375, "dailyPacingPercentage": 0, "expectedDailySpent": 21.3333333333333, "actualDailySpent": 0, "dailyCampaignDuration": 24, "dailyRemainingDuration": 8, "timeLeftInHours": 8984, "totalCount": 0, "budgetTypeId": 1, "shortfallAmount": 2430.88674582451, "deliveryPercentage": 0.2625, "ctr": 42.8571428571429, "vcr": 0, "proposedDailyBudget": 53676.8260869565, "campaignFlightTimeInDays": 21, "campaignDurationInDays": 90, "remainingBudget": 1234567 } ] } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden!" } ] } } } }, "422": { "description": "Unprocessable Entity ", "content": { "application/json": { "examples": { "Invalid status ": { "description": "Invalid status ", "value": { "success": false, "errorObjects": [ { "error": "Please provide valid value of parameters." } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/cd/campaigns/download": { "post": { "tags": [ "Campaign Debugger API", "Organization" ], "summary": "Get the CSV, XLS or XLSX file for download", "description": "This API generates the CSV, XLS or XLSX file according to input and let the user download it. The file contains the Campaign List info with all the filters. \n---\n\n#### Request Body Detail\n\n| **Field** | **Type** | **Description** |\n| --- | --- | --- |\n| fileType `[optional]` | String | Type of file you want to download. csv, xls or xlsx. Default value is \"csv\"|\n| columnMap `[required]` | JSON of string and String | Name of response key as key and column name to display as value. Default value is an empty map. |\n| sortBy `[optional]` | Array of String | Sort the result set by specific field.String should be of format \"+sortField\" or \"-sortField\". \"+\" represents ASC and \"-\" represents DESC. Default value will be [\"-totalBudget\"]. Supported fields are campaign id, campaign name, daily budget, total budget, campaign start date, campaign end date, io name, io end date, timezone name, max bid, clicks, impressions, ctr, winrate, vcr, pacing percentage, daily pacing percentage, reach, frequency, time left in hours, total spent, budget completion percentage, shortfall amount and organization name. |\n| searchField `[optional]` | String | Search the result by provided keyword in the searchField. It filters records by campaign id, campaign name. |\n| verticalIds `[optional]` | Array of Number | IDs of verticals to filter out the data. |\n| creativeTypeIds `[optional]` | Array of Number | IDs of creative types to filter out the data. |\n| customerIds `[optional]` | Array of Number | IDs of the customers (ow_id) to filter out the data. |\n| ioIds `[optional]` | Array of Number | IDs of IO to filter out the data. |\n| timeLeftInHours `[optional]` | Number | Filter campaigns whose time left is less than this input |\n| campaignStatus `[optional]` | Array of String | Status of campaign. |\n| budgetTypeIds `[optional]` | Array of Number | Budget type of campaign (Dollar based or Impression based). |\n| yesterdayProposedDeliveryPercentageStart `[optional]` | Number | Lower bound of delivery percentage range filter. |\n| yesterdayProposedDeliveryPercentageEnd `[optional]` | Number | Upper bound of delivery percentage range filter. |\n| shortfallAmountStart `[optional]` | Number | Lower bound of shortfall range filter. |\n| shortfallAmountEnd `[optional]` | Number | Upper bound of shortfall range filter. |\n| timezoneIds `[optional]` | Array of Number | IDs of the timezones of the campaigns to be filtered out |\n", "operationId": "getCampaignListAsDownloadFile", "parameters": [ { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "verticalIds": { "type": "array", "items": { "type": "integer", "format": "int64" } }, "ioIds": { "type": "array", "items": { "type": "integer", "format": "int64" } }, "customerIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "creativeTypeIds": { "type": "array", "items": { "type": "integer", "format": "int64" } }, "timeLeftInHours": { "type": "integer", "format": "int64" }, "campaignStatus": { "type": "array", "items": { "type": "string" } }, "budgetTypeIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "yesterdayProposedDeliveryPercentageStart": { "type": "number", "format": "double" }, "yesterdayProposedDeliveryPercentageEnd": { "type": "number", "format": "double" }, "timezoneIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "shortfallAmountStart": { "type": "number", "format": "double" }, "shortfallAmountEnd": { "type": "number", "format": "double" }, "pageNo": { "type": "integer", "format": "int32" }, "noOfEntries": { "type": "integer", "format": "int32" }, "sortBy": { "type": "array", "items": { "type": "string" } }, "searchField": { "type": "string" }, "fileType": { "type": "string" }, "columnMap": { "type": "object", "additionalProperties": { "type": "string" } } } }, "example": { "fileType": "csv", "columnMap": { "id": "ID", "campaignName": "Campaign Name", "organizationName": "Organization Name", "ioName": "IO Name", "ioEndDate": "IO End Date", "dailyBudget": "Daily Budget", "totalBudget": "Total Budget", "pacingPercentage": "Campaign Pacing", "dailyPacingPercentage": "Daily Pacing", "maxBid": "Max Bid", "totalSpent": "Total Spent", "budgetCompletionPercentage": "Budget Completion Percentage", "timeLeftInHours": "Time Left (in hours)", "shortfallAmount": "Shortfall", "deliveryPercentage": "Delivery Percentage", "impressions": "Impressions", "clicks": "Clicks", "reach": "Reach", "ctr": "CTR %", "winRate": "Win Rate", "vcr": "VCR %", "frequency": "Frequency", "timezoneName": "Timezone", "campaignStartDate": "Start Date", "campaignEndDate": "End Date", "budgetTypeId": "Campaign Type" }, "sortBy": [ "-totalBudget" ], "searchField": null, "verticalIds": [1], "creativeTypeIds": [11], "customerIds": [201427], "ioIds": [20233], "timeLeftInHours": 72, "campaignStatus": [ "running" ], "budgetTypeIds": [1], "yesterdayProposedDeliveryPercentageStart": 0, "yesterdayProposedDeliveryPercentageEnd": 80, "shortfallAmountStart": 0, "shortfallAmountEnd": 180, "timezoneIds": [29] } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "success": true, "data": "https://example-bucket.s3.amazonaws.com/xlsx/report_example.xlsx?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20240407T070357Z&X-Amz-SignedHeaders=host&X-Amz-Expires=10798&X-Amz-Credential=EXAMPLE_ACCESS_KEY_ID%2F20240407%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=example_signature" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden!" } ] } } } }, "422": { "description": "Unprocessable Entity ", "content": { "application/json": { "examples": { "Invalid status ": { "description": "Invalid status ", "value": { "success": false, "errorObjects": [ { "error": "Please provide valid value of parameters." } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/cd/campaigns/charts/bubble": { "post": { "tags": [ "Campaign Debugger API", "Organization" ], "summary": "Get the list of campaigns and related info for Bubble Chart", "description": "This API fetches the list of campaigns with the following filters. \n---\n\n#### Request Body Detail\n\n| **Field** | **Type** | **Description** |\n| --- | --- | --- |\n| verticalIds `[optional]` | Array of Number | IDs of verticals to filter out the data. |\n| creativeTypeIds `[optional]` | Array of Number | IDs of creative types to filter out the data. |\n| customerIds `[optional]` | Array of Number | IDs of the customers (ow_id) to filter out the data. |\n| ioIds `[optional]` | Array of Number | IDs of IO to filter out the data. |\n| timeLeftInHours `[optional]` | Number | Filter campaigns whose time left is less than this input |\n| campaignStatus `[optional]` | Array of String | Status of campaign. |\n| budgetTypeIds `[optional]` | Array of Number | Budget type of campaign (Dollar based or Impression based). |\n| yesterdayProposedDeliveryPercentageStart `[optional]` | Number | Lower bound of delivery percentage range filter. |\n| yesterdayProposedDeliveryPercentageEnd `[optional]` | Number | Upper bound of delivery percentage range filter. |\n| shortfallAmountStart `[optional]` | Number | Lower bound of shortfall range filter. |\n| shortfallAmountEnd `[optional]` | Number | Upper bound of shortfall range filter. |\n| timezoneIds `[optional]` | Array of Number | IDs of the timezones of the campaigns to be filtered out |\n", "operationId": "getCampaignListForBubbleChart", "parameters": [ { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "verticalIds": { "type": "array", "items": { "type": "integer", "format": "int64" } }, "ioIds": { "type": "array", "items": { "type": "integer", "format": "int64" } }, "customerIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "creativeTypeIds": { "type": "array", "items": { "type": "integer", "format": "int64" } }, "timeLeftInHours": { "type": "integer", "format": "int64" }, "campaignStatus": { "type": "array", "items": { "type": "string" } }, "budgetTypeIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "yesterdayProposedDeliveryPercentageStart": { "type": "number", "format": "double" }, "yesterdayProposedDeliveryPercentageEnd": { "type": "number", "format": "double" }, "timezoneIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "shortfallAmountStart": { "type": "number", "format": "double" }, "shortfallAmountEnd": { "type": "number", "format": "double" } } }, "example": { "verticalIds": [1], "creativeTypeIds": [11], "customerIds": [201427], "ioIds": [20233], "timeLeftInHours": 72, "campaignStatus": [ "running" ], "budgetTypeIds": [1], "yesterdayProposedDeliveryPercentageStart": 0, "yesterdayProposedDeliveryPercentageEnd": 80, "shortfallAmountStart": 0, "shortfallAmountEnd": 180, "timezoneIds": [29] } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "success": true, "data": { "recordsList": [ { "campaignId": 450120, "timeLeftInHours": 24, "totalBudget": 200, "shortFallAmount": 153.589178608582, "shortfallPercentage": 78.1782755980621 }, { "campaignId": 454848, "timeLeftInHours": 24, "totalBudget": 1000, "shortFallAmount": 974.025974025974, "shortfallPercentage": 100 } ] } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden!" } ] } } } }, "422": { "description": "Unprocessable Entity ", "content": { "application/json": { "examples": { "Invalid status ": { "description": "Invalid status ", "value": { "success": false, "errorObjects": [ { "error": "Please provide valid value of parameters." } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/cd/static/campaigns/feedback/category-list": { "get": { "tags": [ "Campaign Debugger API", "Organization" ], "summary": "Get the responses for feedback categories", "description": "This API fetches the responses for feedback categories for categorizing the feedbacks.", "operationId": "getFeedbackCategoryList", "parameters": [ { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "success": true, "data": [ { "categoryId": 1, "categoryName": "Budget", "categoryFieldName": "budget" }, { "categoryId": 2, "categoryName": "Location", "categoryFieldName": "location" }, { "categoryId": 3, "categoryName": "Demographic", "categoryFieldName": "demographic" }, { "categoryId": 4, "categoryName": "Audience", "categoryFieldName": "audience" }, { "categoryId": 5, "categoryName": "Pre-Bid Audience", "categoryFieldName": "pre_bid_audience" }, { "categoryId": 6, "categoryName": "Inventory", "categoryFieldName": "inventory" }, { "categoryId": 7, "categoryName": "Device", "categoryFieldName": "device" }, { "categoryId": 8, "categoryName": "Other", "categoryFieldName": "other" } ] } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden!" } ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/cd/static/campaigns/debug-checks": { "get": { "tags": [ "Campaign Debugger API", "Organization" ], "summary": "Get the responses for debug checks of campaign", "description": "This API fetches the static responses for debug checks of campaign.The API supports filtering based on type (quick, advance, alert).", "operationId": "getCampaignDebugChecksStaticResponse", "parameters": [ { "name": "type", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "success": true, "data": [ { "successTitle": "Insertion Order (IO) Inactive", "failureTitle": "Insertion Order (IO) Active", "key": "isIoExpired", "type": "quick" }, { "successTitle": "Campaign Not Serving", "failureTitle": "Campaign Serving", "key": "isCampaignStartDateInFuture", "type": "quick" }, { "successTitle": "IO End Date Invalid", "failureTitle": "IO End Date Valid", "key": "isIoEndDateInvalid", "type": "quick" }, { "successTitle": "IO Budget Insufficient", "failureTitle": "IO Budget Sufficient", "key": "isIoBudgetExhausted", "type": "quick" }, { "successTitle": "Organization Balance Insufficient", "failureTitle": "Organization Balance Sufficient", "key": "isOrganizationBalanceNegative", "type": "quick" }, { "successTitle": "Workspace Balance Insufficient", "failureTitle": "Workplace Balance Sufficient", "key": "isWorkspaceBalanceNegative", "type": "quick" }, { "successTitle": "Audience Not Ready", "failureTitle": "Audience Ready", "key": "isAudienceStatusNotReady", "type": "quick" }, { "successTitle": "Creative Not Approved", "failureTitle": "Creative Approved", "key": "isCreativeNotApproved", "type": "quick" }, { "successTitle": "Creative not as per recommended specifications", "failureTitle": "Creative as per recommended specifications", "key": "isCreativeSizeNotAsPerStandard", "type": "advance" }, { "successTitle": "Campaign level data unavailable", "failureTitle": "Campaign level data available", "key": "isCampaignLevelDataUnavailable", "type": "advance" }, { "successTitle": "Campaign Ending Today", "failureTitle": "Campaign Not Ending Today", "key": "isCampaignEndingToday", "type": "alert" }, { "successTitle": "Campaign Ending Tomorrow", "failureTitle": "Campaign Not Ending Tomorrow", "key": "isCampaignEndingTomorrow", "type": "alert" }, { "successTitle": "IO Ending Today", "failureTitle": "IO Not Ending Today", "key": "isIoEndingToday", "type": "alert" }, { "successTitle": "IO Ending Tomorrow", "failureTitle": "IO Not Ending Tomorrow", "key": "isIoEndingTomorrow", "type": "alert" }, { "successTitle": "Low Advertiser Balance", "failureTitle": "Sufficient Advertiser Balance", "key": "isAdvertiserBalanceNotSufficient", "type": "alert" }, { "successTitle": "Daily budget less than proposed budget", "failureTitle": "Sufficient daily budget", "key": "isFixedDailyBudgetLessThanRequired", "type": "alert" } ] } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden!" } ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/cd/campaigns/{campaignId}/performance": { "get": { "tags": [ "Campaign Debugger API", "Organization" ], "summary": "Get the budget and performance details of campaign with given id", "description": "This API fetches the budget and performance details of campaign for given campaign id.", "operationId": "getCampaignPerformanceById", "parameters": [ { "name": "campaignId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "success": true, "data": { "budgetTypeId": 1, "totalBudget": 12000, "calculatedTotalBudget": 12000, "shortfallAmount": 12000, "remainingBudget": 12000, "proposedDailyBudget": 12000, "totalSpent": 0, "budgetCompletionPercentage": 0, "bidImpressions": 0, "totalImpressions": 0, "reach": 0, "frequency": 0, "requiredDailyImpressions": 0 } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden!" } ] } } } }, "422": { "description": "Unprocessable Entity ", "content": { "application/json": { "examples": { "Invalid status ": { "description": "Invalid status ", "value": { "success": false, "errorObjects": [ { "error": "Please provide valid value of parameters." } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/cd/campaigns/{campaignId}/feedback/list": { "get": { "tags": [ "Campaign Debugger API", "Organization" ], "summary": "Get the list of feedbacks of a campaign", "description": "This API fetches the list of feedbacks of a campaign.", "operationId": "getFeedbackListByCampaign", "parameters": [ { "name": "campaignId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "feedbackListRequestVO", "in": "query", "required": true, "schema": { "type": "object", "properties": { "pageNo": { "type": "integer", "format": "int32" }, "noOfEntries": { "type": "integer", "format": "int32" }, "campaignId": { "type": "integer", "format": "int64" } } } }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "success": true, "data": { "totalRecords": 1, "recordsList": [ { "feedbackId": 73, "feedbackUser": "John Doe", "feedbackUserAvatarUrl": "https://iqm-web-assets-c92d6b6cbde1-stage.s3.amazonaws.com/avatar/JP.png", "feedbackCategory": "Budget", "feedbackText": "Max bid seems to be low. Try changing it to a higher bid amount.", "feedbackCreationTime": 1715770792000 } ] } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden!" } ] } } } }, "422": { "description": "Unprocessable Entity ", "content": { "application/json": { "examples": { "Invalid status ": { "description": "Invalid status ", "value": { "success": false, "errorObjects": [ { "error": "Please provide valid value of parameters." } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/cd/campaigns/{campaignId}/delivery-metrics": { "get": { "tags": [ "Campaign Debugger API", "Organization" ], "summary": "Get the delivery metrics of a campaign", "description": "This API fetches the delivery metrics of campaign for the last 3 days (excluding today).", "operationId": "getCampaignDeliveryMetrics", "parameters": [ { "name": "campaignId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "success": true, "data": { "budgetTypeId": 2, "timezoneName": "US/Eastern", "metricValues": [ { "date": 1743998400000, "dailyBudget": 126, "daySpent": 0, "campaignPacingPercentage": 0.00799999978807237, "actualDeliveryPercentage": 0, "proposedDeliveryPercentage": 0, "impressions": 0, "winrate": 0, "maxBid": 90, "ecpm": 0 }, { "date": 1743912000000, "dailyBudget": 126, "daySpent": 0, "campaignPacingPercentage": 0.00799999978807237, "actualDeliveryPercentage": 0, "proposedDeliveryPercentage": 0, "impressions": 0, "winrate": 0, "maxBid": 90, "ecpm": 0 }, { "date": 1743825600000, "dailyBudget": 126, "daySpent": 0, "campaignPacingPercentage": 0.00799999978807237, "actualDeliveryPercentage": 0, "proposedDeliveryPercentage": 0, "impressions": 0, "winrate": 0, "maxBid": 90, "ecpm": 0 } ] } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden!" } ] } } } }, "422": { "description": "Unprocessable Entity ", "content": { "application/json": { "examples": { "Invalid status ": { "description": "Invalid status ", "value": { "success": false, "errorObjects": [ { "error": "Please provide valid value of parameters." } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/cd/campaigns/time-left-range": { "get": { "tags": [ "Campaign Debugger API", "Organization" ], "summary": "Get the Time left range in hours for all the campaigns", "description": "This API fetches the range for time left in hours (max and min value) for all the campaigns, the user has access to and which can be seen on the campaign listing", "operationId": "getCampaignsTimeLeftRange", "parameters": [ { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "success": true, "data": { "minimumTimeLeftInHours": 54, "maximumTimeLeftInHours": 2122 } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden!" } ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/cd/campaigns/shortfall-range": { "get": { "tags": [ "Campaign Debugger API", "Organization" ], "summary": "Get the Shortfall range for all the campaigns", "description": "This API fetches the range for shortfall in dollar (max and min value) for all the campaigns accessible to logged in user, which can be seen on the campaign listing", "operationId": "getCampaignsShortfallRange", "parameters": [ { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "success": true, "data": { "minimumShortfall": 125.5, "maximumShortfall": 1034.2 } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden!" } ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/cd/campaigns/performance-summary": { "get": { "tags": [ "Campaign Debugger API", "Organization" ], "summary": "Get the details of campaigns for performance summary", "description": "This API fetches the performance summary details of campaigns. This include data related to yesterday and today spent. The response will not be affected by any filters", "operationId": "getCampaignsPerformanceSummary", "parameters": [ { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "success": true, "data": { "yesterdayTotalProposedDailyBudget": 1234.5, "yesterdayTotalSpent": 1000.2, "yesterdayTotalUnspent": 234.3, "yesterdayTotalOverspent": 0, "yesterdayTotalUnspentPercentage": 14.55, "yesterdayTotalOverspentPercentage": 0, "todayTotalProposedDailyBudget": 1500.7, "todayTotalSpend": 500.5, "todayRemainingBudget": 1000.2 } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden!" } ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/cd/campaigns/performance-overview": { "get": { "tags": [ "Campaign Debugger API", "Organization" ], "summary": "Get the details of campaigns for performance overview", "description": "This API fetches the performance overview details of campaigns. The response will not be affected by any filters", "operationId": "getCampaignsPerformanceOverview", "parameters": [ { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "success": true, "data": { "totalRunningCampaigns": 100, "totalCampaignBudget": 1200, "totalShortfallAmount": 171.43, "totalShortfallPercentage": 18.66, "shortfallTrend": "increasing" } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden!" } ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/cd/campaigns/delivery-percentage-range": { "get": { "tags": [ "Campaign Debugger API", "Organization" ], "summary": "Get the yesterday's proposed delivery percentage range for all the campaigns", "description": "This API fetches the range for yesterday's proposed delivery percentage (max and min value) for all the campaigns, the user has access to", "operationId": "getCampaignsDeliveryPercentageRange", "parameters": [ { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "success": true, "data": { "minYesterdayProposedDeliveryPercentage": 25.5, "maxYesterdayProposedDeliveryPercentage": 104.2 } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden!" } ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/cd/campaigns/debug-checks": { "get": { "tags": [ "Campaign Debugger API", "Organization" ], "summary": "Get the debug checks of campaign with given id", "description": "This API fetches the debug checks for all the campaigns of the provided campaign ids.The API supports filtering based on type (quick, advance, alert).", "operationId": "getCampaignDebugChecks", "parameters": [ { "name": "campaignIds", "in": "query", "required": true, "schema": { "type": "array", "items": { "type": "integer", "format": "int64" } } }, { "name": "type", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "success": true, "data": { "recordList": [ { "campaignId": 553389, "quickCheckMap": { "isIoBudgetExhausted": false, "isAudienceStatusNotReady": false, "isIoEndDateInvalid": false, "isIoExpired": false, "isCampaignStartDateInFuture": false, "isWorkspaceBalanceNegative": false, "isOrganizationBalanceNegative": false, "isCreativeNotApproved": true }, "advanceCheckMap": { "isCreativeSizeNotAsPerStandard": true, "isCampaignLevelDataUnavailable": true }, "alertCheckMap": { "isAdvertiserBalanceNotSufficient": true, "isCampaignEndingTomorrow": false, "isCampaignEndingToday": false, "isIoEndingTomorrow": false, "isFixedDailyBudgetLessThanRequired": false, "isIoEndingToday": false } }, { "campaignId": 553491, "quickCheckMap": { "isIoBudgetExhausted": false, "isAudienceStatusNotReady": true, "isIoEndDateInvalid": false, "isIoExpired": false, "isCampaignStartDateInFuture": false, "isWorkspaceBalanceNegative": false, "isOrganizationBalanceNegative": false, "isCreativeNotApproved": true }, "advanceCheckMap": { "isCreativeSizeNotAsPerStandard": true, "isCampaignLevelDataUnavailable": true }, "alertCheckMap": { "isAdvertiserBalanceNotSufficient": true, "isCampaignEndingTomorrow": false, "isCampaignEndingToday": false, "isIoEndingTomorrow": false, "isFixedDailyBudgetLessThanRequired": false, "isIoEndingToday": false } } ] } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden!" } ] } } } }, "422": { "description": "Unprocessable Entity ", "content": { "application/json": { "examples": { "Invalid status ": { "description": "Invalid status ", "value": { "success": false, "errorObjects": [ { "error": "Please provide valid value of parameters." } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/cd/campaigns/charts/performance-chart/{campaignId}": { "get": { "tags": [ "Campaign Debugger API", "Organization" ], "summary": "Get the performance chart data for a campaign", "description": "This API fetches the data for performance chart of campaign for the campaign flight time or last 3 months (which ever is lesser). The data will be on daily basis", "operationId": "getCampaignPerformanceChartData", "parameters": [ { "name": "campaignId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "success": true, "data": { "budgetTypeId": 2, "timezoneName": "US/Eastern", "dailyValues": [ { "date": 1743998400000, "totalBudget": 1234, "proposedDailyBudget": 123, "dailyBudget": 126, "dailySpent": 0, "proposedDeliveryPercentage": 0, "shortfallAmount": 234, "shortfallPercentage": 11, "winRate": 0, "maxBid": 90, "eCPM": 0 } ], "activityInfo": [ { "tsEpoch": 1738142867000, "activityDescription": "States modified." }, { "tsEpoch": 1739173587000, "activityDescription": "Budget Pacing, Daily Budget, Total Budget and Political Advertiser modified." } ] } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden!" } ] } } } }, "422": { "description": "Unprocessable Entity ", "content": { "application/json": { "examples": { "Invalid status ": { "description": "Invalid status ", "value": { "success": false, "errorObjects": [ { "error": "Please provide valid value of parameters." } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/cd/campaigns/charts/burn-up/{campaignId}": { "get": { "tags": [ "Campaign Debugger API", "Organization" ], "summary": "Get the Burn Up Chart data of campaign with given id", "description": "This API fetches the data required for burn up chart of campaign of the given id. The API contains the budget info, hourly spent info and forecasted spent info of a campaign.", "operationId": "getBurnUpChartData", "parameters": [ { "name": "campaignId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": { "success": true, "data": { "basicInfo": { "campaignId": 486111, "totalBudget": 200, "startTime": 1717482600000, "endTime": 1718044200000 }, "forecastedSpentInfo": { "tsEpochHourly": 1718044200000, "forecastedSpent": 58.338943 }, "budgetInfo": [ { "tsEpochHourly": 1717480800000, "totalBudget": 111 }, { "tsEpochHourly": 1717574400000, "totalBudget": 200 } ], "expectedSpentInfo": [ { "tsEpochHourly": 1717482600000, "expectedSpent": 0 }, { "tsEpochHourly": 1717574400000, "expectedSpent": 111 }, { "tsEpochHourly": 1718044200000, "expectedSpent": 200 } ], "spentInfo": [ { "tsEpochHourly": 1717480800000, "totalSpent": 3.12 }, { "tsEpochHourly": 1717482600000, "totalSpent": 3.12 }, { "tsEpochHourly": 1717497000000, "totalSpent": 3.12 }, { "tsEpochHourly": 1717500600000, "totalSpent": 3.12 }, { "tsEpochHourly": 1717504200000, "totalSpent": 3.12 }, { "tsEpochHourly": 1717506000000, "totalSpent": 12.48 }, { "tsEpochHourly": 1717565400000, "totalSpent": 12.48 }, { "tsEpochHourly": 1717579800000, "totalSpent": 12.48 }, { "tsEpochHourly": 1717583400000, "totalSpent": 12.48 }, { "tsEpochHourly": 1717664400000, "totalSpent": 20.48 } ], "activityInfo": [ { "tsEpochHourly": 1717482600000, "activityDescription": "Changed end date for campaign #486111 - DND - Debugger - $ 1" }, { "tsEpochHourly": 1717497000000, "activityDescription": "Reduced daily budget to $10.0 for campaign #486111 - DND - Debugger - $ 1" }, { "tsEpochHourly": 1717497000000, "activityDescription": "Reduced daily budget to $10.0 for campaign #486111 - DND - Debugger - $ 1" } ] } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden!" } ] } } } }, "422": { "description": "Unprocessable Entity ", "content": { "application/json": { "examples": { "Invalid status ": { "description": "Invalid status ", "value": { "success": false, "errorObjects": [ { "error": "Please provide valid value of parameters." } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } }, "deprecated": true } }, "/api/v3/al/activity/logs": { "get": { "tags": [ "Activity Log API" ], "summary": "Retrieves a list of activity logs", "description": "Returns a paginated list of activity logs based on the provided filters and parameters", "operationId": "getActivityLogs", "parameters": [ { "name": "owIds", "in": "query", "description": "Comma-separated list of OW IDs to filter the logs", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "uowIds", "in": "query", "description": "Comma-separated list of UOW IDs to filter the logs", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "applicationIds", "in": "query", "description": "Comma-separated list of application IDs to filter the logs", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "activityTypes", "in": "query", "description": "Comma-separated list of activity types to filter the logs", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "searchField", "in": "query", "description": "Search the result by provided keyword in the searchField. ", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "isCustomerRequest", "in": "query", "description": "Flag indicating if the request is from Customers app", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "limit", "in": "query", "description": "The maximum number of returned results per page. ", "required": false, "schema": { "type": "integer", "format": "int32", "default": 10 } }, { "name": "pageNo", "in": "query", "description": "Page number for the required data. ", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "Successfully retrieved list of activity logs", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "errorObjects": { "type": "array", "items": { "type": "object", "properties": { "error": { "type": "string" }, "reason": { "type": "string" }, "field": { "type": "string" } } } }, "data": { "type": "object" } } }, "examples": { "Response including activity log details based on search criteria and pagination": { "description": "Response including activity log details based on search criteria and pagination", "value": { "success": true, "data": { "data": [ { "id": 1660549, "activityDescription": "Updated information in campaign #824576 - Summer Splash Sale 2024", "applicationId": 7, "applicationName": "Campaigns", "activityType": "Campaign Activity", "createdByUOWId": 912470, "createdByUser": "Emily Johnson", "createdByUserEmail": "emily.johnson@example.com", "owId": 824576, "organizationName": "AdVantage Solutions", "targetOWId": 824576, "targetOrganizationName": "AdVantage Solutions", "displayOWId": 824576, "displayOrganizationName": "AdVantage Solutions", "createdAt": 1723118906, "detailedLoggingPresent": true, "flagged": false }, { "id": 1660548, "activityDescription": "Reduced daily budget to $21046.35 for campaign #291470 - Holiday Gift Guide Extravaganza", "applicationId": 7, "applicationName": "Campaigns", "activityType": "Campaign Activity", "createdByUOWId": 657983, "createdByUser": "Michael Smith", "createdByUserEmail": "michael.smith@example.com", "owId": 738160, "organizationName": "BrightWave Advertising", "targetOWId": 738160, "targetOrganizationName": "BrightWave Advertising", "displayOWId": 738160, "displayOrganizationName": "BrightWave Advertising", "createdAt": 1723118904, "detailedLoggingPresent": false, "flagged": false } ], "totalRecords": 357344, "filteredRecords": 223 } } } } } } }, "403": { "description": "Permission denied for the specified customer or application", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "errorObjects": { "type": "array", "items": { "type": "object", "properties": { "error": { "type": "string" }, "reason": { "type": "string" }, "field": { "type": "string" } } } }, "data": { "type": "object" } } }, "examples": { "Unauthorized Customer Access": { "description": "Unauthorized Customer Access", "value": { "success": false, "errorObjects": [ { "error": "User is not allowed to access provided customer" } ] } }, "Application Access Restricted": { "description": "Application Access Restricted", "value": { "success": false, "errorObjects": [ { "error": "Customer don't have access to provided applications" } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } }, "/api/v3/al/activity-logs/{logId}/change-details": { "get": { "tags": [ "Activity Log API" ], "summary": "Retrieves details of an activity change log entry", "description": "Returns detailed information about a specific activity change log entry, including entity details and field changes", "operationId": "getChangeLogDetails", "parameters": [ { "name": "logId", "in": "path", "description": "ID of the activity log entry to retrieve details of its change log", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Authorization", "in": "header", "description": "Authorization Bearer Token", "example": "Bearer 0ed52da8-24ab-44b1-bc88-7ea03a090d24" }, { "name": "X-IAA-OW-ID", "in": "header", "description": "Organization Workspace Id Header", "example": 1 } ], "responses": { "200": { "description": "Successfully retrieved activity change log details", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "errorObjects": { "type": "array", "items": { "type": "object", "properties": { "error": { "type": "string" }, "reason": { "type": "string" }, "field": { "type": "string" } } } }, "data": { "type": "object" } } }, "examples": { "Response including activity change log details": { "description": "Response including activity change log details", "value": { "success": true, "data": { "activityLogId": 1660548, "entity": { "id": 1, "refEntityId": 533201, "fields": [ { "id": 60, "oldValue": { "blacklist": 1, "whitelist": 1 }, "newValue": { "blacklist": 1, "whitelist": 1 } }, { "id": 50, "oldValue": "11,12,13", "newValue": "11,12,13,14" }, { "id": 18, "oldValue": { "blacklist": "30000000,30000001", "whitelist": "30900029,30900030,30900031" }, "newValue": { "blacklist": "30000003,30000004,30000005", "whitelist": "30900032,30900033" } }, { "id": 20, "oldValue": { "blacklist": "30000000,30433208,30433210,30433211", "whitelist": "30408902,30408903" }, "newValue": { "blacklist": "30000001,30433211,30433212", "whitelist": "30408902,30408903,30433208" } }, { "id": 43, "oldValue": "10200001", "newValue": "10200001,10200002" }, { "id": 17, "oldValue": { "blacklist": "30100001", "whitelist": "30200010,30200031" }, "newValue": { "blacklist": "30200010,30200032", "whitelist": "30100002" } }, { "id": 51, "oldValue": "20400002,20400003", "newValue": "20400002,20400003,20400004" }, { "id": 16, "oldValue": 30100001, "newValue": 30100002 }, { "id": 31, "oldValue": { "blacklist": "1072085,1072086,1078373", "whitelist": "974058,974134,974485,984527,984528,987087,1054740,1062178,1062179,1067676,1068161,1078371,1083108" }, "newValue": { "blacklist": "1072086,1078373", "whitelist": "974058,974134,974485,984527,984528,987087,1054740,1062178,1062179,1067676,1068161,1078371,1083109" } }, { "id": 19, "oldValue": { "blacklist": "30500000,30319597", "whitelist": "30304863,30308948,30316902,30316903,30316904" }, "newValue": { "blacklist": "30500001,30316903,30316904,30319598", "whitelist": "30304863,30308948,30316902" } }, { "id": 5, "oldValue": 1723111200, "newValue": 1748664000 }, { "id": 33, "oldValue": "1,11,16,19,37,39,41,45,46,47,66,69,71,72,73,74,75,76,77,78,80,84,87,88", "newValue": "1,11,16,19,37,39,41,45,46,47,66,69,71,72,73,74,75,76,77,78,80,84,87,89" }, { "id": 46, "oldValue": "10800058,10800075,10800081,10800096,10800104,10800203,10801317,10801450,10801451,10801453,10801454", "newValue": "10800058,10800075,10800081,10800096,10800104,10800203,10801318,10801450,10801451,10801453,10801455" }, { "id": 47, "oldValue": "10500034,10500048,10500056,10500063,10500098,10500147,10500164,10500170", "newValue": "10500034,10500048,10500056,10500063,10500098,10500147,10500164,10500171" }, { "id": 40, "oldValue": "", "newValue": "123,456,789" }, { "id": 6, "oldValue": 399, "newValue": 29 }, { "id": 42, "oldValue": "10100008,10100009,10100003,10100004,10100005", "newValue": "10100008,10100009,10100003,10100004,10100005,10100006" }, { "id": 13, "oldValue": "636781", "newValue": "648327,640316" }, { "id": 59, "oldValue": { "blacklist": 4, "whitelist": 7 }, "newValue": { "blacklist": 12, "whitelist": 6 } }, { "id": 45, "oldValue": "10700002,10700003,10700004", "newValue": "10700002,10700003,10700005" }, { "id": 39, "oldValue": "180,159,178,121,127", "newValue": "180,159,178,121,128" }, { "id": 24, "oldValue": { "blacklist": "75001,75002,75003", "whitelist": "75201,75202" }, "newValue": { "blacklist": "75004,75005", "whitelist": "75203,75204,75205,75206" } }, { "id": 54, "oldValue": { "1": [ [ "07:00:00", "08:00:00" ], [ "09:00:00", "10:00:00" ], [ "11:00:00", "12:00:00" ] ], "2": [ [ "12:00:00", "13:00:00" ] ], "3": [ [ "14:00:00", "15:00:00" ], [ "08:00:00", "09:00:00" ], [ "06:00:00", "07:00:00" ], [ "03:00:00", "04:00:00" ] ], "4": [ [ "01:00:00", "02:00:00" ], [ "04:00:00", "05:00:00" ], [ "06:00:00", "07:00:00" ], [ "09:00:00", "10:00:00" ], [ "12:00:00", "13:00:00" ], [ "14:00:00", "15:00:00" ], [ "17:00:00", "18:00:00" ] ], "6": [ [ "01:00:00", "02:00:00" ], [ "02:00:00", "03:00:00" ], [ "04:00:00", "05:00:00" ], [ "06:00:00", "07:00:00" ] ] }, "newValue": { "1": [ [ "07:00:00", "08:00:00" ], [ "09:00:00", "10:00:00" ], [ "11:00:00", "12:00:00" ] ], "2": [ [ "12:00:00", "13:00:00" ], [ "13:00:00", "14:00:00" ] ], "3": [ [ "14:00:00", "15:00:00" ], [ "08:00:00", "09:00:00" ], [ "06:00:00", "07:00:00" ], [ "03:00:00", "04:00:00" ] ], "4": [ [ "01:00:00", "02:00:00" ], [ "04:00:00", "05:00:00" ], [ "06:00:00", "07:00:00" ], [ "09:00:00", "10:00:00" ], [ "12:00:00", "13:00:00" ], [ "14:00:00", "15:00:00" ], [ "17:00:00", "18:00:00" ] ], "6": [ [ "01:00:00", "02:00:00" ], [ "02:00:00", "03:00:00" ], [ "04:00:00", "05:00:00" ], [ "06:00:00", "07:00:00" ], [ "08:00:00", "09:00:00" ] ] } }, { "id": 57, "oldValue": 0, "newValue": 1 }, { "id": 4, "oldValue": 1723006242, "newValue": 1746041700 }, { "id": 11, "oldValue": 0, "newValue": 1 }, { "id": 41, "oldValue": { "type": 0, "values": "1000" }, "newValue": { "type": 1, "values": "4207" } }, { "id": 36, "oldValue": { "blacklist": 1, "whitelist": 1 }, "newValue": { "blacklist": 0, "whitelist": 1 } }, { "id": 9, "oldValue": 450, "newValue": 499.99 }, { "id": 48, "oldValue": "13,14,15", "newValue": "13,15,11,12" }, { "id": 44, "oldValue": "10300001,10300002", "newValue": "10300002,10300003,10300004,10300005" }, { "id": 49, "oldValue": "28,89,456,155,23,443", "newValue": "28,89,456,155,23,443,179,190,350,449" }, { "id": 37, "oldValue": { "blacklist": 1, "whitelist": 1 }, "newValue": { "blacklist": 0, "whitelist": 1 } }, { "id": 23, "oldValue": { "blacklist": "30800799,30800802", "whitelist": "" }, "newValue": { "blacklist": "", "whitelist": "30800799,30800802,30800803,30805416,30805417,30805458,30805459" } }, { "id": 8, "oldValue": 800, "newValue": 1000 }, { "id": 14, "oldValue": 1, "newValue": 0 }, { "id": 12, "oldValue": 1, "newValue": 0 }, { "id": 2, "oldValue": "Test Campaign", "newValue": "Do no touch - All fields Campaign to check logs copy" }, { "id": 10, "oldValue": 20, "newValue": 21 }, { "id": 52, "oldValue": "13,14", "newValue": "13,12" }, { "id": 22, "oldValue": { "blacklist": "30704754,30716195", "whitelist": "" }, "newValue": { "blacklist": "", "whitelist": "30704754,30716195,30716196" } }, { "id": 53, "oldValue": "11", "newValue": "11,12" }, { "id": 55, "oldValue": { "totalClicks": null, "maxDayClicks": null, "totalConversions": null, "totalImpressions": null, "maxDayConversions": null, "maxDayImpressions": null }, "newValue": { "totalClicks": 50000, "maxDayClicks": 100, "totalConversions": 2500, "totalImpressions": 100000, "maxDayConversions": 25, "maxDayImpressions": 5000 } }, { "id": 7, "oldValue": null, "newValue": 123.44 }, { "id": 38, "oldValue": { "blacklist": "175797,149470", "whitelist": "" }, "newValue": { "blacklist": "", "whitelist": "175797,149470,177399" } }, { "id": 32, "oldValue": "81,84,92", "newValue": "81,84,91,12,92,13,93,15,79" }, { "id": 1, "oldValue": null, "newValue": 9 }, { "id": 15, "oldValue": { "data": { "playerSize": "", "rollPosition": "", "skippability": "", "placementType": "", "playbackMethod": "" }, "active": 0 }, "newValue": { "data": { "playerSize": "20800001,20800002,20899999", "rollPosition": "20700001,20700002,20700003", "skippability": "20900001,20900002,20999999", "placementType": "20600001,20699999", "playbackMethod": "21000001,21099999" }, "active": 1 } }, { "id": 34, "oldValue": "12,13", "newValue": "12,13,14,15" }, { "id": 56, "oldValue": 0, "newValue": 1 }, { "id": 28, "oldValue": { "blacklist": 1, "whitelist": 3 }, "newValue": { "blacklist": 2, "whitelist": 4 } }, { "id": 27, "oldValue": { "blacklist": 1, "whitelist": 2 }, "newValue": { "blacklist": 0, "whitelist": 1 } }, { "id": 29, "oldValue": { "blacklist": 0, "whitelist": 2 }, "newValue": { "blacklist": 1, "whitelist": 3 } }, { "id": 58, "oldValue": 678, "newValue": 677 }, { "id": 3, "oldValue": "https://camtech1.com", "newValue": "https://camtech2.com" }, { "id": 35, "oldValue": { "blacklist": 1, "whitelist": 1 }, "newValue": { "blacklist": 0, "whitelist": 2 } }, { "id": 26, "oldValue": { "blacklist": 1, "whitelist": 3 }, "newValue": { "blacklist": 0, "whitelist": 5 } }, { "id": 25, "oldValue": { "blacklist": 1, "whitelist": 1 }, "newValue": { "blacklist": 0, "whitelist": 2 } }, { "id": 30, "oldValue": { "blacklist": 1, "whitelist": 1 }, "newValue": { "blacklist": 0, "whitelist": 2 } }, { "id": 21, "oldValue": { "blacklist": "30604589,30604590", "whitelist": "" }, "newValue": { "blacklist": "", "whitelist": "30604589,30604591,30604592" } } ] } } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "Forbidden!" } ] } } } }, "422": { "description": "Activity Change Log request error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "errorObjects": { "type": "array", "items": { "type": "object", "properties": { "error": { "type": "string" }, "reason": { "type": "string" }, "field": { "type": "string" } } } }, "data": { "type": "object" } } }, "examples": { "Invalid Activity Change Log ID": { "description": "Invalid Activity Change Log ID", "value": { "success": false, "errorObjects": [ { "error": "No activity change log found for logId: [12345]" } ] } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "success": false, "errorObjects": [ { "error": "server encountered an error !" } ] } } } } } } } } }