openapi: 3.1.0 info: title: Kickstart API description: API documentation for Kickstart services contact: name: Your Team email: support@example.com license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0 version: '1.0' servers: - url: https://platform.digitalremedy.com description: Generated server url tags: - name: Flip Dashboard description: This contains API endpoints related to Flip Dashboard - name: 'App Console: Solution Management' description: This contains API endpoints related to solution management - name: 'App Console: Brand' description: This contains API endpoints related to Performance Brand solution in App Console - name: 'App Console: Search' description: This contains API endpoints related to Google Search solution in App Console - name: Flip Dashboard description: APIs related to Flip Dashboard - name: App Console description: This contains API endpoints related to App Console - name: App Console description: App Console - name: 'App Console: Social' description: This contains API endpoints related to Meta solution in App Console paths: /api/whitelabel_domains/{orgId}: get: tags: - whitelabel-domain-controller operationId: get parameters: - name: orgId in: path required: true schema: type: integer format: int32 responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponseWhitelabelDomain' put: tags: - whitelabel-domain-controller operationId: update parameters: - name: orgId in: path required: true schema: type: integer format: int32 - name: acctId in: query required: false schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/WhitelabelDomain' required: true responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponseWhitelabelDomain' delete: tags: - whitelabel-domain-controller operationId: delete parameters: - name: orgId in: path required: true schema: type: integer format: int32 - name: acctId in: query required: true schema: type: integer format: int32 responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponseWhitelabelDomain' /api/users/{userId}/mapAdvertisers: put: tags: - user-controller operationId: mapAdvertisers parameters: - name: userId in: path required: true schema: type: integer format: int64 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/UserAdvertiser' required: true responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK /api/users/{userId}/mapAccounts: put: tags: - user-controller operationId: mapAccounts parameters: - name: userId in: path required: true schema: type: integer format: int64 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/UserAccount' required: true responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponse' /api/users/{id}: get: tags: - user-controller operationId: get_1 parameters: - name: id in: path required: true schema: type: integer format: int64 responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponseUserDTO' put: tags: - user-controller operationId: update_1 parameters: - name: id in: path required: true schema: type: integer format: int64 requestBody: content: application/json: schema: $ref: '#/components/schemas/User' required: true responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponseUserDTO' delete: tags: - user-controller operationId: delete_1 parameters: - name: id in: path required: true schema: type: integer format: int64 responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponse' /api/segments/{id}: get: tags: - segment-controller operationId: getSegmentById parameters: - name: id in: path required: true schema: type: integer format: int64 responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: type: object put: tags: - segment-controller operationId: updateSegment parameters: - name: id in: path required: true schema: type: integer format: int64 requestBody: content: application/json: schema: $ref: '#/components/schemas/Segment' required: true responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/Segment' delete: tags: - segment-controller operationId: deleteSegment parameters: - name: id in: path required: true schema: type: integer format: int64 responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK /api/rateCards/{productTypeId}: put: tags: - rate-cards-controller operationId: updateRateCard requestBody: content: application/json: schema: $ref: '#/components/schemas/RateCardItem' required: true responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponseRateCardItemDTO' /api/publisherDeal/{id}: get: tags: - publisher-deal-mapping-controller operationId: get_2 parameters: - name: id in: path required: true schema: type: integer format: int32 responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/PublisherDealMapping' put: tags: - publisher-deal-mapping-controller operationId: update_2 parameters: - name: id in: path required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/PublisherDealMapping' required: true responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/PublisherDealMapping' delete: tags: - publisher-deal-mapping-controller operationId: delete_2 parameters: - name: id in: path required: true schema: type: integer format: int32 responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK /api/plans/{planId}: get: tags: - plans-controller operationId: get_3 parameters: - name: planId in: path required: true schema: type: integer format: int32 - name: includePacing in: query required: false schema: type: boolean default: false - name: advertiser in: query required: false schema: type: string - name: client in: query required: false schema: type: string - name: xandrId in: query required: false schema: type: string - name: pixel in: query required: false schema: type: string responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponsePlan' put: tags: - plans-controller operationId: updatePlan parameters: - name: planId in: path required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/Plan' required: true responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponsePlan' delete: tags: - plans-controller operationId: delete_3 parameters: - name: planId in: path required: true schema: type: integer format: int32 responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponse' /api/plans/{planId}/updateFlag: put: tags: - plans-controller operationId: updateFlag parameters: - name: planId in: path required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/Plan' required: true responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponseBoolean' /api/plans/{planId}/changeTargetingLevel: put: tags: - plans-controller operationId: changeTargetingLevel parameters: - name: planId in: path required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/CalcReq' required: true responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponsePlan' /api/plans/{planId}/changeProductTypeAllocation: put: tags: - plans-controller operationId: changeProductTypeAllocation parameters: - name: planId in: path required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/CalcReq' required: true responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponsePlan' /api/plans/{planId}/changeProductCategoryAllocation: put: tags: - plans-controller operationId: changeProductCategoryAllocation parameters: - name: planId in: path required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/CalcReq' required: true responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponsePlan' /api/plans/{planId}/changeDisplayDeviceAllocation: put: tags: - plans-controller operationId: changeDisplayDeviceAllocation parameters: - name: planId in: path required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/CalcReq' required: true responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponsePlan' /api/organizations/{organizationId}: get: tags: - organization-controller operationId: getOrganization parameters: - name: organizationId in: path required: true schema: type: integer format: int32 responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponseOrganization' put: tags: - organization-controller operationId: update_3 parameters: - name: organizationId in: path required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/Organization' required: true responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponseOrganization' /api/mediaTypes/{id}: get: tags: - publisher-media-type-mapping-controller operationId: get_4 parameters: - name: id in: path required: true schema: type: integer format: int32 responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/PublisherMediaTypeMapping' put: tags: - publisher-media-type-mapping-controller operationId: update_4 parameters: - name: id in: path required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/PublisherMediaTypeMapping' required: true responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/PublisherMediaTypeMapping' delete: tags: - publisher-media-type-mapping-controller operationId: delete_4 parameters: - name: id in: path required: true schema: type: integer format: int32 responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK /api/mediaPublisher/{id}: get: tags: - media-publisher-master-controller operationId: get_5 parameters: - name: id in: path required: true schema: type: integer format: int32 responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/MediaPublisherMaster' put: tags: - media-publisher-master-controller operationId: update_5 parameters: - name: id in: path required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/MediaPublisherMaster' required: true responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/MediaPublisherMaster' delete: tags: - media-publisher-master-controller operationId: delete_5 parameters: - name: id in: path required: true schema: type: integer format: int32 responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK /api/ios/{insertionOrderId}/lineItems/{lineItemId}: put: tags: - line-items-controller operationId: update_6 parameters: - name: insertionOrderId in: path required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/LineItem' required: true responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponseLineItem' delete: tags: - line-items-controller operationId: delete_6 parameters: - name: insertionOrderId in: path required: true schema: type: integer format: int32 - name: lineItemId in: path required: true schema: type: integer format: int32 responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponseLineItem' /api/ios/{insertionOrderId}/lineItems/{lineItemId}/updateFlag: put: tags: - line-items-controller operationId: updateFlag_1 parameters: - name: insertionOrderId in: path required: true schema: type: integer format: int32 - name: lineItemId in: path required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/LineItem' required: true responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponseBoolean' /api/ios/{insertionOrderId}/lineItems/{lineItemId}/pushToXandr: put: tags: - line-items-controller operationId: pushToXandr parameters: - name: insertionOrderId in: path required: true schema: type: integer format: int32 - name: lineItemId in: path required: true schema: type: integer format: int32 responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponseLineItem' /api/comments/{id}: get: tags: - comment-controller operationId: get_6 parameters: - name: id in: path required: true schema: type: integer format: int32 responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/Comment' put: tags: - comment-controller operationId: update_7 parameters: - name: id in: path required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/Comment' required: true responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/Comment' delete: tags: - comment-controller operationId: delete_7 parameters: - name: id in: path required: true schema: type: integer format: int32 responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK /api/budgetGroup/{id}: put: tags: - budget-group-controller operationId: update_8 parameters: - name: id in: path required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/BudgetGroup' required: true responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponseBudgetGroup' /api/agencies/{agencyId}/mapAdvertiser: put: tags: - agency-controller operationId: mapAdvertiser parameters: - name: agencyId in: path required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/Advertiser' required: true responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/Agency' /api/advertisers/{advertiserId}: get: tags: - advertiser-controller operationId: getAdvertiser parameters: - name: advertiserId in: path required: true schema: type: integer format: int32 responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponseAdvertiser' put: tags: - advertiser-controller operationId: update_9 parameters: - name: advertiserId in: path required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/Advertiser' required: true responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponseAdvertiser' /api/advertisers/{advertiserId}/mapUsers: put: tags: - advertiser-controller operationId: mapUsers parameters: - name: advertiserId in: path required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/UserAdvertiser' required: true responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK /api/advertisers/{advertiserId}/flipPixels/{pixelId}: get: tags: - Flip Dashboard summary: Get details of a FLIP pixel for an advertiser description: Returns metadata for a given FLIP pixel and advertiser operationId: fetchFlipPixelDetails parameters: - name: advertiserId in: path description: The advertiser ID required: true schema: type: integer - name: pixelId in: path description: The FLIP pixel ID required: true schema: type: string responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: Pixel details successfully retrieved content: '*/*': schema: $ref: '#/components/schemas/ApiResponseFlipPixel' put: tags: - Flip Dashboard summary: Update an existing FLIP pixel for an advertiser description: Updates a FLIP pixel's properties using the provided data operationId: updateFlipPixel parameters: - name: advertiserId in: path description: The advertiser ID required: true schema: type: integer - name: pixelId in: path description: The pixel ID required: true schema: type: string requestBody: description: The updated FlipPixel object content: application/json: schema: $ref: '#/components/schemas/FlipPixel' required: true responses: '400': description: Invalid input '200': description: Pixel updated successfully content: '*/*': schema: $ref: '#/components/schemas/ApiResponseFlipPixel' '404': description: Pixel not found content: '*/*': schema: $ref: '#/components/schemas/ApiResponseFlipPixel' /api/advertisers/{advertiserId}/brand_lift/campaigns/{blCampaignId}: put: tags: - Flip Dashboard summary: Update campaign operationId: updateCampaign parameters: - name: advertiserId in: path description: the advertiser id required: true - name: blCampaignId in: path description: Campaign Id required: true requestBody: description: Campaign to be created content: application/json: schema: $ref: '#/components/schemas/ExistingLucidCampaign' required: true responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: application/json: {} delete: tags: - Flip Dashboard summary: Delete campaign operationId: deleteCampaign parameters: - name: advertiserId in: path description: the advertiser id required: true - name: blCampaignId in: path description: Campaign Id required: true responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: application/json: {} /api/advertisers/{advertiserId}/brand_lift/campaigns/{blCampaignId}/launch: put: tags: - Flip Dashboard summary: Launch Campaign operationId: launchCampaign parameters: - name: advertiserId in: path description: the advertiser id required: true - name: blCampaignId in: path description: Campaign Id required: true responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: application/json: {} /api/advertisers/{advertiserId}/brand_lift/campaign/{blCampaignId}/spc_groupings_and_mappings: put: tags: - Flip Dashboard summary: Update SPC Groupings and Mappings operationId: updateSPCGroupings parameters: - name: advertiserId in: path description: the advertiser id required: true schema: type: integer - name: blCampaignId in: path description: Brandlift campaign id required: true schema: type: string - name: client in: query description: the account/client name required: true schema: type: string - name: advertiser in: query description: the advertiser name required: true schema: type: string - name: type in: query description: 'SPC Grouping types: placement or publisher' required: true schema: type: string enum: - placement - publisher requestBody: content: application/json: schema: type: array items: type: object additionalProperties: {} required: true responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponseLucidSPCGroupingsWrapper' /api/accounts/{id}: put: tags: - account-controller operationId: update_10 parameters: - name: id in: path required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/Account' required: true responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponseAccount' /api/accounts/{accountId}/provisionDefaultAccountData: put: tags: - account-controller operationId: provisionDefaultAccountData parameters: - name: accountId in: path required: true schema: type: integer format: int32 responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK /api/accounts/{accountId}/mapUsers: put: tags: - account-controller operationId: mapUsers_1 parameters: - name: accountId in: path required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/UserAccount' required: true responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK /api/accounts/{accountId}/mapUsersAndDropdowns: put: tags: - account-controller operationId: mapUsersAndDropdowns parameters: - name: accountId in: path required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/DropdownUserMaster' required: true responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK /api/accounts/refresh_wl_files/{id}: put: tags: - account-controller operationId: refreshWhitelabelFiles parameters: - name: id in: path required: true schema: type: integer format: int32 responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponseAccount' /api/ac/solutions/{solutionId}: get: tags: - 'App Console: Solution Management' operationId: getSolution parameters: - name: solutionId in: path required: true schema: type: integer format: int32 responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponseSolution' put: tags: - 'App Console: Solution Management' operationId: update_11 parameters: - name: solutionId in: path required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/Solution' required: true responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponseSolution' delete: tags: - 'App Console: Solution Management' operationId: delete_8 parameters: - name: solutionId in: path required: true schema: type: integer format: int32 responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponse' /api/ac/advertisers/{advertiserId}/reportTemplate/{reportTemplateId}: get: tags: - 'App Console: Report Template Management' operationId: get_7 parameters: - name: reportTemplateId in: path required: true schema: type: integer format: int32 - name: advertiserId in: path required: true schema: type: integer format: int32 responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponseReportTemplate' put: tags: - 'App Console: Report Template Management' operationId: update_12 parameters: - name: reportTemplateId in: path required: true schema: type: integer format: int32 - name: advertiserId in: path required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ReportTemplate' required: true responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponseReportTemplate' delete: tags: - 'App Console: Report Template Management' operationId: delete_9 parameters: - name: reportTemplateId in: path required: true schema: type: integer format: int32 - name: advertiserId in: path required: true schema: type: integer format: int32 responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponseReportTemplate' /api/ac/advertiserSolution/id/{id}: get: tags: - 'App Console: Solution Management' operationId: getById parameters: - name: id in: path required: true schema: type: integer format: int32 responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponseAdvertiserSolution' put: tags: - 'App Console: Solution Management' operationId: update_13 parameters: - name: id in: path required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/AdvertiserSolution' required: true responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponseAdvertiserSolution' delete: tags: - 'App Console: Solution Management' operationId: delete_10 parameters: - name: id in: path required: true schema: type: integer format: int32 responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponse' /api/whitelabel_domains: get: tags: - whitelabel-domain-controller operationId: getWhitelabelDomains responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponseListWhitelabelDomain' post: tags: - whitelabel-domain-controller operationId: create parameters: - name: acctId in: query required: false schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/WhitelabelDomain' required: true responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponseWhitelabelDomain' /api/users: get: tags: - user-controller operationId: getAll parameters: - name: accountId in: query required: false schema: type: integer format: int32 responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponseListUserDTO' post: tags: - user-controller operationId: create_1 requestBody: content: application/json: schema: $ref: '#/components/schemas/User' required: true responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponseUserDTO' /api/users/{userId}/password_reset/url: post: tags: - user-controller operationId: createPasswordResetUrl parameters: - name: userId in: path required: true schema: type: integer format: int64 responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponseString' /api/users/{userId}/invite: post: tags: - user-controller operationId: inviteUser parameters: - name: userId in: path required: true schema: type: integer format: int64 responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: type: object /api/users/{userId}/invite/url: post: tags: - user-controller operationId: inviteUserUrl parameters: - name: userId in: path required: true schema: type: integer format: int64 responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponseString' /api/users/{userId}/globalRoles/{roleId}: post: tags: - user-controller operationId: updateUserRoles parameters: - name: userId in: path required: true schema: type: integer format: int64 - name: roleId in: path required: true schema: type: integer format: int32 - name: userRole in: query required: true schema: $ref: '#/components/schemas/UserRole' responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/UserRole' delete: tags: - user-controller operationId: deleteUserRoles parameters: - name: userId in: path required: true schema: type: integer format: int64 - name: roleId in: path required: true schema: type: integer format: int32 - name: userRole in: query required: true schema: $ref: '#/components/schemas/UserRole' responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK /api/users/{userId}/activateSolution: post: tags: - user-controller operationId: activateSolution parameters: - name: userId in: path required: true schema: type: integer format: int64 - name: accountName in: query required: true schema: type: string - name: advertiserName in: query required: true schema: type: string - name: solutionName in: query required: true schema: type: string responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: type: object /api/sendVerificationEmail: post: tags: - sign-up-controller operationId: sendVerificationEmail parameters: - name: userId in: query required: true schema: type: integer format: int64 - name: app in: query required: true schema: type: integer format: int32 responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: type: object /api/segments: get: tags: - segment-controller operationId: getAllSegments responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: type: array items: $ref: '#/components/schemas/Segment' post: tags: - segment-controller operationId: createSegment requestBody: content: application/json: schema: $ref: '#/components/schemas/Segment' required: true responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/Segment' /api/run/updateLineItemStatus: post: tags: - api-controller operationId: updateLineItemStatus requestBody: content: application/json: schema: $ref: '#/components/schemas/LoginRequest' required: true responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponseString' /api/run/updateLineItemStatusLive: post: tags: - api-controller operationId: updateLineItemStatusLive requestBody: content: application/json: schema: $ref: '#/components/schemas/LoginRequest' required: true responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponseString' /api/run/sendDailySummaryReport: post: tags: - api-controller operationId: runReport requestBody: content: application/json: schema: $ref: '#/components/schemas/LoginRequest' required: true responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponseString' /api/run/generateReports: post: tags: - api-controller operationId: generateReports requestBody: content: application/json: schema: $ref: '#/components/schemas/LoginRequest' required: true responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponseString' /api/run/flip_pixel_activity_scheduler: post: tags: - api-controller operationId: runFlipPixelActivityController requestBody: content: application/json: schema: $ref: '#/components/schemas/LoginRequest' required: true responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponse' /api/run/exportScheduleJob: post: tags: - api-controller operationId: runExportScheduleJob requestBody: content: application/json: schema: $ref: '#/components/schemas/LoginRequest' required: true responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponseString' /api/reportGenerationLog/updateStatus: post: tags: - api-controller operationId: updateReportGenerationLogStatus requestBody: content: application/json: schema: $ref: '#/components/schemas/ReportLogStatusUpdateRequest' required: true responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponseString' /api/rateCards: post: tags: - rate-cards-controller operationId: createRateCardItem requestBody: content: application/json: schema: $ref: '#/components/schemas/RateCardItem' required: true responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponseRateCardItemDTO' /api/publisherDeal: get: tags: - publisher-deal-mapping-controller operationId: list responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: type: array items: $ref: '#/components/schemas/PublisherDealMapping' post: tags: - publisher-deal-mapping-controller operationId: create_2 requestBody: content: application/json: schema: $ref: '#/components/schemas/PublisherDealMapping' required: true responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/PublisherDealMapping' /api/plans: get: tags: - plans-controller operationId: getAll_1 parameters: - name: q in: query required: true schema: type: string - name: pageNumber in: query required: false schema: type: integer format: int32 - name: perPage in: query required: false schema: type: integer format: int32 - name: sortKey in: query required: false schema: type: string - name: sortOrder in: query required: false schema: type: string - name: crFilter in: query required: false schema: type: boolean - name: flip in: query required: false schema: type: boolean - name: includePacing in: query required: false schema: type: boolean - name: advertiser in: query required: false schema: type: string - name: client in: query required: false schema: type: string - name: xandrId in: query required: false schema: type: string - name: pixel in: query required: false schema: type: string responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponsePageResponsePlan' post: tags: - plans-controller operationId: create_3 requestBody: content: application/json: schema: $ref: '#/components/schemas/Plan' required: true responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponsePlan' /api/plans/{planId}/workflowEmailNotification: post: tags: - plans-controller operationId: workflowEmailNotification parameters: - name: planId in: path required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/EmailNotification' required: true responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponsePlan' /api/plans/{planId}/updateStatusEmailNotification: post: tags: - plans-controller operationId: updateStatusEmailNotification parameters: - name: planId in: path required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/EmailNotification' required: true responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponsePlan' /api/plans/{planId}/sendSubmitOrderNotification: post: tags: - plans-controller operationId: sendSubmitOrderNotification parameters: - name: planId in: path required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/SubmitOrder' required: true responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponsePlan' /api/plans/{planId}/sendEmailNotification: post: tags: - plans-controller operationId: emailNotification parameters: - name: planId in: path required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/EmailNotification' required: true responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponsePlan' /api/plans/{planId}/export: post: tags: - plans-controller operationId: exportOrder parameters: - name: planId in: path required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ExportSchedule' required: true responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponse' /api/plans/{planId}/createOrder: post: tags: - plans-controller operationId: createOrder parameters: - name: planId in: path required: true schema: type: integer format: int32 responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponsePlan' deprecated: true /api/plans/{planId}/changeAppliedEmailNotification: post: tags: - plans-controller operationId: changeAppliedEmailNotification parameters: - name: planId in: path required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/EmailNotification' required: true responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponsePlan' /api/pixels: get: tags: - pixel-controller operationId: getAll_2 responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponseListPixel' post: tags: - pixel-controller operationId: create_4 requestBody: content: application/json: schema: $ref: '#/components/schemas/PixelDTO' required: true responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponsePixel' /api/organizations: get: tags: - organization-controller operationId: getOrganizations responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponseListOrganization' post: tags: - organization-controller operationId: create_5 requestBody: content: application/json: schema: $ref: '#/components/schemas/Organization' required: true responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponseOrganization' /api/mediaTypes: get: tags: - publisher-media-type-mapping-controller operationId: list_1 responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: type: array items: $ref: '#/components/schemas/PublisherMediaTypeMapping' post: tags: - publisher-media-type-mapping-controller operationId: create_6 requestBody: content: application/json: schema: $ref: '#/components/schemas/PublisherMediaTypeMapping' required: true responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/PublisherMediaTypeMapping' /api/mediaPublisher: get: tags: - media-publisher-master-controller operationId: list_2 responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: type: array items: $ref: '#/components/schemas/MediaPublisherMaster' post: tags: - media-publisher-master-controller operationId: create_7 requestBody: content: application/json: schema: $ref: '#/components/schemas/MediaPublisherMaster' required: true responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/MediaPublisherMaster' /api/ios/{lineItemId}/sendEmailNotification: post: tags: - line-items-controller operationId: emailNotification_1 parameters: - name: lineItemId in: path required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/EmailNotification' required: true responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponseLineItem' /api/ios/{lineItemId}/customEmailNotification: post: tags: - line-items-controller operationId: customEmailNotification parameters: - name: lineItemId in: path required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/EmailNotification' required: true responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponseLineItem' /api/ios/{insertionOrderId}/{lineItemId}/sendResubmitEmailNotification: post: tags: - line-items-controller operationId: sendResubmitEmailNotification parameters: - name: insertionOrderId in: path required: true schema: type: integer format: int32 - name: lineItemId in: path required: true schema: type: integer format: int32 responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponseLineItem' /api/ios/{insertionOrderId}/lineItems: get: tags: - line-items-controller operationId: index parameters: - name: insertionOrderId in: path required: true schema: type: integer format: int32 - name: pageNumber in: query required: false schema: type: integer format: int32 - name: perPage in: query required: false schema: type: integer format: int32 - name: sortKey in: query required: false schema: type: string - name: sortOrder in: query required: false schema: type: string responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponsePageResponseLineItem' post: tags: - line-items-controller operationId: create_8 parameters: - name: insertionOrderId in: path required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/LineItem' required: true responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponseLineItem' /api/ios/{insertionOrderId}/lineItems/{lineItemId}/calculatePriceSpend: post: tags: - line-items-controller operationId: calculatePriceSpend parameters: - name: insertionOrderId in: path required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/LineItem' required: true responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponseLineItem' /api/ios/{insertionOrderId}/lineItems/{lineItemId}/calculateCpm: post: tags: - line-items-controller operationId: calculateCpm parameters: - name: insertionOrderId in: path required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/LineItem' required: true responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponseLineItem' /api/flipPixelsFile/dumpToBucket: post: tags: - Flip PixelFile operationId: dumpToBucket parameters: - name: pretty in: query required: false schema: type: boolean - name: filePath in: query required: false schema: type: string responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponse' /api/flipPixelsFile/dumpToBucketCronAuth: post: tags: - Flip PixelFile operationId: dumpToBucket_1 parameters: - name: pretty in: query required: false schema: type: boolean - name: filePath in: query required: false schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/LoginRequest' required: true responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponse' /api/files/{orderId}/lineItems/{lineItemId}: post: tags: - file-controller operationId: uploadFile parameters: - name: type in: query required: true schema: type: string - name: orderId in: path required: true schema: type: integer format: int32 - name: lineItemId in: path required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: object properties: file: type: string format: binary required: - file responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponseFileData' /api/files/publisher/{publisherId}: post: tags: - file-controller operationId: savePublisherLogo parameters: - name: publisherId in: path required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: object properties: file: type: string format: binary required: - file responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponseFileData' /api/files/organizations/{organizationId}: post: tags: - file-controller operationId: saveLogo parameters: - name: type in: query required: true schema: type: string - name: organizationId in: path required: true schema: type: integer format: int32 requestBody: content: application/json: schema: type: object properties: file: type: string format: binary required: - file responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponseFileData' /api/comments: get: tags: - comment-controller operationId: list_3 parameters: - name: itemId in: query required: true schema: type: string - name: itemType in: query required: true schema: type: string responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: type: array items: $ref: '#/components/schemas/Comment' post: tags: - comment-controller operationId: create_9 requestBody: content: application/json: schema: $ref: '#/components/schemas/Comment' required: true responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/Comment' /api/comments/notification: post: tags: - comment-controller operationId: notification requestBody: content: application/json: schema: $ref: '#/components/schemas/CommentNotification' required: true responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponse' /api/budgetGroup/create: post: tags: - budget-group-controller operationId: create_10 requestBody: content: application/json: schema: $ref: '#/components/schemas/BudgetGroup' required: true responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponseBudgetGroup' /api/auth/validate_token: post: tags: - auth-controller operationId: validateResetPasswordToken requestBody: content: application/json: schema: $ref: '#/components/schemas/ValidateResetPasswordTokenRequest' required: true responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: type: object /api/auth/reset_password: post: tags: - auth-controller operationId: ResetPassword parameters: - name: app in: query required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/CreatePasswordRequest' required: true responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: type: object /api/auth/plus_login: post: tags: - auth-controller operationId: authenticatePlusUser responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: type: object /api/auth/login: post: tags: - auth-controller operationId: authenticateUser parameters: - name: app in: query required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/LoginRequest' required: true responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: type: object /api/auth/loginC360User: post: tags: - auth-controller operationId: loginAhUser responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: type: object /api/auth/forgot_password: post: tags: - auth-controller operationId: createPassword parameters: - name: app in: query required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ForgotPasswordRequest' required: true responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: type: object /api/auth/create_password: post: tags: - auth-controller operationId: createPassword_1 requestBody: content: application/json: schema: $ref: '#/components/schemas/CreatePasswordRequest' required: true responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: type: object /api/agencies: get: tags: - agency-controller operationId: getAll_3 parameters: - name: accountId in: query required: true schema: type: integer format: int32 responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponseListAgency' post: tags: - agency-controller operationId: create_11 requestBody: content: application/json: schema: $ref: '#/components/schemas/Agency' required: true responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponseAgency' /api/advertisers: get: tags: - advertiser-controller operationId: getByAccount parameters: - name: accountId in: query required: false schema: type: integer format: int32 - name: type in: query required: false schema: type: string - name: userId in: query required: false schema: type: integer format: int64 responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponseListAdvertiser' post: tags: - advertiser-controller operationId: create_12 requestBody: content: application/json: schema: $ref: '#/components/schemas/Advertiser' required: true responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponseAdvertiser' /api/advertisers/{advertiserId}/reports/rollup: post: tags: - Flip Dashboard summary: Get rollup report with only last touches for each conversion operationId: getLastTouches parameters: - name: advertiserId in: path description: the advertiser id required: true schema: type: integer - name: kind in: query description: the kind of data to be returned, either all_touch or last_touch required: true schema: type: string enum: - all_touch - last_touch - name: includeChannel in: query description: 'true : Include channel false : Dont include channel' required: true schema: type: boolean - name: client in: query description: the account/client name required: true schema: type: string - name: advertiser in: query description: the advertiser name required: true schema: type: string - name: xandrId in: query description: the advertiser's XandrId required: true schema: type: string - name: pixel in: query description: the FLIP universal pixel id required: true schema: type: string - name: conversionWindow in: query description: the conversion window in hours schema: type: integer default: 0 - name: mediaType in: query description: the media types to filter (e.g. Display Retargeting, OTT, etc.) style: form explode: false schema: type: array items: type: string - name: creative in: query description: the comma-separated creative ids to filter style: form explode: false schema: type: array items: type: string - name: publisher in: query description: the comma-separated publisher names to filter style: form explode: false schema: type: array items: type: string - name: audience in: query description: the comma-separated audience names to filter style: form explode: false schema: type: array items: type: string - name: ioIds in: query description: the comma-separated IO ids to filter style: form explode: false schema: type: array items: type: string - name: adGroups in: query description: the comma-separated Adready Id & start date (separated by |) combination to filter style: form explode: false schema: type: array items: type: string - name: event in: query description: the event required: true schema: type: string - name: category in: query description: the pixel category required: true schema: type: string - name: subCategory in: query description: the comma-separated pixel sub-categories style: form explode: false schema: type: array items: type: string - name: startDate in: query description: the start date required: true schema: type: string example: '2022-01-08' - name: endDate in: query description: the end date required: true schema: type: string example: '2022-01-14' - name: offset in: query description: the number of records to skip schema: type: integer default: 0 - name: limit in: query description: the max number of records to return schema: type: integer default: 100 - name: onceNow in: query description: Run this report once? schema: type: boolean default: true - name: emailIt in: query description: Email this report? schema: type: boolean default: false - name: emailAddr in: query description: Email address? schema: type: string - name: Accept in: header description: '''application/json'' - provides json response. ''text/csv'' or ''application/csv'' provides csv file.' schema: type: string default: application/json responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponseListObject' /api/advertisers/{advertiserId}/reports/rollup/touches: post: tags: - Flip Dashboard summary: Get all touches (except last touch) for a conversion operationId: getAllTouchesForConversion parameters: - name: advertiserId in: path description: the advertiser id required: true schema: type: integer - name: client in: query description: the account/client name required: true schema: type: string - name: advertiser in: query description: the advertiser name required: true schema: type: string - name: xandrId in: query description: the advertiser's XandrId required: true schema: type: string - name: pixel in: query description: the FLIP universal pixel id required: true schema: type: string - name: conversionWindow in: query description: the conversion window in hours schema: type: integer default: 0 - name: mediaType in: query description: the media types to filter (e.g. Display Retargeting, OTT, etc.) style: form explode: false schema: type: array items: type: string - name: creative in: query description: the comma-separated creative ids to filter style: form explode: false schema: type: array items: type: string - name: publisher in: query description: the comma-separated publisher names to filter style: form explode: false schema: type: array items: type: string - name: audience in: query description: the comma-separated audience names to filter style: form explode: false schema: type: array items: type: string - name: ioIds in: query description: the comma-separated IO ids to filter style: form explode: false schema: type: array items: type: string - name: adGroups in: query description: the comma-separated Adready Id & start date (separated by |) combination to filter style: form explode: false schema: type: array items: type: string - name: event in: query description: the event required: true schema: type: string - name: category in: query description: the pixel category required: true schema: type: string - name: subCategory in: query description: the comma-separated pixel sub-categories style: form explode: false schema: type: array items: type: string - name: startDate in: query description: the start date required: true schema: type: string example: '2022-01-08' - name: endDate in: query description: the end date required: true schema: type: string example: '2022-01-14' - name: ip in: query description: the IP address required: true schema: type: string - name: ts in: query description: the pixel timestamp in micro seconds required: true schema: type: integer responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponseListConversionTouch' /api/advertisers/{advertiserId}/reports/performance: post: tags: - Flip Dashboard summary: Get performance report by creative/publisher/channel/daypart/audience/device/mediatype/state/dma/zip/overall description: Get performance report by creative/publisher/channel/daypart/audience/device/mediatype/state/dma/zip/overall operationId: getPerformanceReport parameters: - name: advertiserId in: path description: the advertiser id required: true schema: type: integer - name: kind in: query description: the field by which data to be grouped, either creative/adgroup/publisher/channel/daypart/audience/device/mediatype/state/dma/zip/overall schema: type: string enum: - creative - adgroup - publisher - channel - daypart - audience - device - mediatype - state - dma - zip - overall - name: client in: query description: the account/client name required: true schema: type: string - name: advertiser in: query description: the advertiser name required: true schema: type: string - name: xandrId in: query description: the advertiser's XandrId required: true schema: type: string - name: pixel in: query description: the FLIP universal pixel id required: true schema: type: string - name: showUniques in: query description: flag to decide whether to show only uniques or not schema: type: boolean default: false - name: conversionWindow in: query description: the conversion window in hours schema: type: integer default: 0 - name: mediaType in: query description: the media types to filter (e.g. Display Retargeting, OTT, etc.) style: form explode: false schema: type: array items: type: string - name: creative in: query description: the comma-separated creative ids to filter style: form explode: false schema: type: array items: type: string - name: publisher in: query description: the comma-separated publisher names to filter style: form explode: false schema: type: array items: type: string - name: audience in: query description: the comma-separated audience names to filter style: form explode: false schema: type: array items: type: string - name: ioIds in: query description: the comma-separated IO ids to filter style: form explode: false schema: type: array items: type: string - name: adGroups in: query description: the comma-separated Adready Id & start date (separated by |) combination to filter style: form explode: false schema: type: array items: type: string - name: attribution in: query description: the conversion attribution to be used, either full or partial schema: type: string default: full enum: - full - partial - name: methodology in: query description: the methodology to be used, either first_touch/last_touch/linear/time_decay schema: type: string default: last_touch enum: - first_touch - last_touch - linear - time_decay - name: event in: query description: the event schema: type: string - name: category in: query description: the pixel category required: true schema: type: string - name: subCategory in: query description: the comma-separated pixel sub-categories style: form explode: false schema: type: array items: type: string - name: startDate in: query description: the start date required: true schema: type: string example: '2022-01-08' - name: endDate in: query description: the end date required: true schema: type: string example: '2022-01-14' - name: fields in: query description: the comma-separated fields to return style: form explode: false schema: type: array items: type: string - name: offset in: query description: the number of records to skip schema: type: integer default: 0 - name: limit in: query description: the max number of records to return schema: type: integer default: 100 - name: onceNow in: query description: Run this report once? schema: type: boolean default: true - name: emailIt in: query description: Email this report? schema: type: boolean default: false - name: emailAddr in: query description: Email address? schema: type: string - name: Accept in: header description: '''application/json'' - provides json response. ''text/csv'' or ''application/csv'' provides csv file.' schema: type: string default: application/json responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponseListMetricsByField' /api/advertisers/{advertiserId}/reports/eventPerformance: post: tags: - Flip Dashboard summary: Get event-wise performance report by creative/publisher/channel/daypart/audience/device/mediatype/state/dma/zip/overall description: Get event-wise performance report by creative/publisher/channel/daypart/audience/device/mediatype/state/dma/zip/overall operationId: getEventPerformanceReport parameters: - name: advertiserId in: path description: the advertiser id required: true schema: type: integer - name: kind in: query description: the field by which data to be grouped, either creative/adgroup/publisher/channel/daypart/audience/device/mediatype/state/dma/zip/overall required: true schema: type: string enum: - creative - adgroup - publisher - channel - daypart - audience - device - mediatype - state - dma - zip - overall - name: client in: query description: the account/client name required: true schema: type: string - name: advertiser in: query description: the advertiser name required: true schema: type: string - name: xandrId in: query description: the advertiser's XandrId required: true schema: type: string - name: pixel in: query description: the FLIP universal pixel id required: true schema: type: string - name: showUniques in: query description: flag to decide whether to show only uniques or not schema: type: boolean default: false - name: conversionWindow in: query description: the conversion window in hours schema: type: integer default: 0 - name: mediaType in: query description: the media types to filter (e.g. Display Retargeting, OTT, etc.) style: form explode: false schema: type: array items: type: string - name: creative in: query description: the comma-separated creative ids to filter style: form explode: false schema: type: array items: type: string - name: publisher in: query description: the comma-separated publisher names to filter style: form explode: false schema: type: array items: type: string - name: audience in: query description: the comma-separated audience names to filter style: form explode: false schema: type: array items: type: string - name: ioIds in: query description: the comma-separated IO ids to filter style: form explode: false schema: type: array items: type: string - name: adGroups in: query description: the comma-separated Adready Id & start date (separated by |) combination to filter style: form explode: false schema: type: array items: type: string - name: attribution in: query description: the conversion attribution to be used, either full or partial schema: type: string default: full enum: - full - partial - name: methodology in: query description: the methodology to be used, either first_touch/last_touch/linear/time_decay schema: type: string default: last_touch enum: - first_touch - last_touch - linear - time_decay - name: event in: query description: the event schema: type: string - name: category in: query description: the pixel category required: true schema: type: string - name: subCategory in: query description: the comma-separated pixel sub-categories style: form explode: false schema: type: array items: type: string - name: startDate in: query description: the start date required: true schema: type: string example: '2022-01-08' - name: endDate in: query description: the end date required: true schema: type: string example: '2022-01-14' - name: fields in: query description: the comma-separated fields to return style: form explode: false schema: type: array items: type: string - name: offset in: query description: the number of records to skip schema: type: integer default: 0 - name: limit in: query description: the max number of records to return schema: type: integer default: 100 - name: onceNow in: query description: Run this report once? schema: type: boolean default: true - name: emailIt in: query description: Email this report? schema: type: boolean default: false - name: emailAddr in: query description: Email address? schema: type: string - name: Accept in: header description: '''application/json'' - provides json response. ''text/csv'' or ''application/csv'' provides csv file.' schema: type: string default: application/json responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponsePagedResultEventMetricsByField' /api/advertisers/{advertiserId}/pixelReadyEmailNotification: post: tags: - advertiser-controller operationId: sendPixelReadyEmailNotification parameters: - name: advertiserId in: path required: true schema: type: integer format: int32 responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponseObject' /api/advertisers/{advertiserId}/performance: post: tags: - Flip Dashboard summary: Get performance by creative/adgroup/publisher/channel/audience/mediatype description: Returns grouped performance metrics operationId: getPerformance parameters: - name: advertiserId in: path description: The advertiser ID required: true - name: groupBy in: query description: The field to group by required: true schema: type: string enum: - creative - adgroup - publisher - channel - audience - mediatype - name: client in: query description: The client name required: true - name: advertiser in: query description: The advertiser name required: true - name: xandrId in: query description: The advertiser's Xandr ID required: true - name: pixel in: query description: The FLIP universal pixel ID required: true - name: showUniques in: query description: Whether to show only uniques schema: type: boolean default: false - name: conversionWindow in: query description: Conversion window in hours schema: type: integer default: 0 - name: mediaType in: query description: Media types to filter schema: type: array items: type: string - name: startDate in: query description: The start date required: true schema: type: string example: '2022-01-08' - name: endDate in: query description: The end date required: true schema: type: string example: '2022-01-14' responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: Successful response content: '*/*': schema: type: array items: $ref: '#/components/schemas/MetricsComparisonByField' /api/advertisers/{advertiserId}/performance/metrics/reach: post: tags: - Flip Dashboard summary: Get reach and frequency performance metric description: Returns reach and frequency metrics for a given advertiser and filters operationId: getReachFrequencyMetric parameters: - name: advertiserId in: path description: The advertiser ID required: true schema: type: integer - name: client in: query description: The account/client name required: true - name: advertiser in: query description: The advertiser name required: true - name: xandrId in: query description: The advertiser's XandrId required: true - name: mediaType in: query description: Media types to filter (e.g., Display Retargeting, OTT, etc.) schema: type: array items: type: string - name: creative in: query description: Comma-separated creative IDs to filter schema: type: array items: type: string - name: publisher in: query description: Comma-separated publisher names to filter schema: type: array items: type: string - name: audience in: query description: Comma-separated audience names to filter schema: type: array items: type: string - name: ioIds in: query description: Comma-separated IO IDs to filter schema: type: array items: type: string - name: adGroups in: query description: Comma-separated AdReady ID & start date (separated by |) combination to filter schema: type: array items: type: string - name: startDate in: query description: Start date required: true schema: type: string example: '2021-05-24' - name: endDate in: query description: End date required: true schema: type: string example: '2021-05-31' - name: compareStartDate in: query description: Compare start date schema: type: string example: '2021-05-17' - name: compareEndDate in: query description: Compare end date schema: type: string example: '2021-05-23' responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: Successful operation content: '*/*': schema: $ref: '#/components/schemas/ReachMetric' /api/advertisers/{advertiserId}/performance/daily: post: tags: - Flip Dashboard - Performance summary: Get daily CPM/CPA/ROAS/VCR/CTR performance description: Retrieve daily metrics such as CPM, CPA, ROAS, VCR, and CTR. operationId: getDailyPerformance parameters: - name: advertiserId in: path description: the advertiser id required: true schema: type: integer - name: kind in: query description: the kind of data to be returned, either CPM or CPA or ROAS or VCR or CTR required: true schema: type: string enum: - cpm - cpa - roas - vcr - ctr responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponseDailyPerformanceSummary' /api/advertisers/{advertiserId}/media_types: post: tags: - advertiser - Flip Dashboard summary: Get media types for an advertiser description: Get media types for an advertiser operationId: getMediaTypes parameters: - name: advertiserId in: query description: the advertiser id required: true - name: client in: query description: the account/client name required: true - name: advertiser in: query description: the advertiser name required: true - name: ioIds in: query description: the comma-separated IO ids to filter schema: type: string - name: startDate in: query description: the start date required: true example: '2022-01-08' - name: endDate in: query description: the end date required: true example: '2022-01-14' - name: adGroups in: query description: the comma-separated Adready Id & start date (separated by |) combination to filter schema: type: string - name: includeNonFlip in: query description: flag to decide whether to include non-flip IOs in the response or not schema: type: string enum: - 'true' - 'false' responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: type: string /api/advertisers/{advertiserId}/mdsp/performance/daily: post: tags: - Flip Dashboard summary: Get daily CPM/CPA/ROAS/VCR/CTR performance description: Retrieve daily performance metrics like CPM, CPA, ROAS, VCR, CTR operationId: getDailyPerformance_1 parameters: - name: advertiserId in: path description: the advertiser id required: true schema: type: integer - name: kind in: query description: the kind of data to be returned, either CPM or CPA or ROAS or VCR or CTR required: true schema: type: string enum: - cpm - cpa - roas - vcr - ctr - name: client in: query description: the account/client name required: true schema: type: string - name: advertiser in: query description: the advertiser name required: true schema: type: string - name: xandrId in: query description: the advertiser's XandrId required: true schema: type: string - name: pixel in: query description: the FLIP universal pixel id required: true schema: type: string - name: showUniques in: query description: flag to decide whether to show only uniques or not schema: type: boolean default: false enum: - 'true' - 'false' - name: conversionWindow in: query description: the conversion window in hours schema: type: integer default: 0 - name: mediaType in: query description: the media types to filter (e.g. Display Retargeting, OTT, etc.) schema: type: string - name: creative in: query description: the comma-separated creative ids to filter schema: type: string - name: publisher in: query description: the comma-separated publisher names to filter schema: type: string - name: audience in: query description: the comma-separated audience names to filter schema: type: string - name: ioIds in: query description: the comma-separated IO ids to filter schema: type: string - name: adGroups in: query description: the comma-separated Adready Id & start date (separated by |) combination to filter schema: type: string - name: attribution in: query description: the conversion attribution to be used, either full or partial schema: type: string default: full enum: - full - partial - name: methodology in: query description: the methodology to be used, either first_touch/last_touch/linear/time_decay schema: type: string default: last_touch enum: - first_touch - last_touch - linear - time_decay - name: event in: query description: the event schema: type: string - name: category in: query description: the pixel category required: true schema: type: string - name: subCategory in: query description: the comma-separated pixel sub-categories schema: type: string - name: startDate in: query description: the start date required: true schema: type: string format: date example: '2022-01-08' - name: endDate in: query description: the end date required: true schema: type: string format: date example: '2022-01-14' - name: compareStartDate in: query description: the compare start date schema: type: string format: date example: '2022-01-01' - name: compareEndDate in: query description: the compare end date schema: type: string format: date example: '2022-01-07' - name: cumulative in: query description: flag to specify cumulative or not. schema: type: boolean default: true enum: - 'true' - 'false' responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: Successful response content: '*/*': schema: $ref: '#/components/schemas/ApiResponseDailyPerformanceSummary' /api/advertisers/{advertiserId}/mdsp/impressions/summary: post: tags: - Flip Dashboard summary: Get impressions summary (MDSP) description: Retrieve impressions summary data filtered by various parameters operationId: getImpressionsSummary parameters: - name: advertiserId in: path description: The advertiser id required: true schema: type: integer - name: kind in: query description: 'Return what data? Choices: Impressions / Ad Spend / Video Completions / Clicks' schema: type: string default: views enum: - views - spend - videoCompletions - clicks - name: client in: query description: The account/client name required: true schema: type: string - name: advertiser in: query description: The advertiser name required: true schema: type: string - name: xandrId in: query description: The advertiser's XandrId required: true schema: type: string - name: mediaType in: query description: The media types to filter (e.g. Display Retargeting, OTT, etc.) schema: type: string - name: creative in: query description: The comma-separated creative ids to filter schema: type: string - name: publisher in: query description: The comma-separated publisher names to filter schema: type: string - name: audience in: query description: The comma-separated audience names to filter schema: type: string - name: ioIds in: query description: The comma-separated IO ids to filter schema: type: string - name: adGroups in: query description: The comma-separated Adready Id & start date (separated by |) combination to filter schema: type: string - name: startDate in: query description: The start date required: true schema: type: string format: date example: '2022-01-08' - name: endDate in: query description: The end date required: true schema: type: string format: date example: '2022-01-14' - name: compareStartDate in: query description: The compare start date schema: type: string format: date example: '2022-01-01' - name: compareEndDate in: query description: The compare end date schema: type: string format: date example: '2022-01-07' responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: Successful response content: '*/*': schema: $ref: '#/components/schemas/ApiResponseImpressionsSummary' /api/advertisers/{advertiserId}/mdsp/impressions/distribution: post: tags: - Flip Dashboard summary: Get impressions distribution operationId: getImpressionsDistribution parameters: - name: advertiserId in: path description: the advertiser id required: true - name: kind in: query description: 'Return what data? Choices: Impressions/Ad Spend/Video Completions/Clicks' required: true schema: type: string enum: - views - spend - videoCompletions - clicks - name: groupBy in: query description: 'Group by?, Choices: creative/adgroup/device/daypart/publisher/channel/audience/state/dma/mediatype' required: true schema: type: string enum: - creative - adgroup - device - daypart - publisher - channel - audience - state - dma - mediatype - name: client in: query description: the account/client name required: true - name: advertiser in: query description: the advertiser name required: true - name: xandrId in: query description: the advertiser's XandrId required: true - name: mediaType in: query description: the media types to filter (e.g. Display Retargeting, OTT, etc.) schema: type: string - name: creative in: query description: the comma-separated creative ids to filter schema: type: string - name: publisher in: query description: the comma-separated publisher names to filter schema: type: string - name: audience in: query description: the comma-separated audience names to filter schema: type: string - name: ioIds in: query description: the comma-separated IO ids to filter schema: type: string - name: adGroups in: query description: the comma-separated Adready Id & start date (separated by |) combination to filter schema: type: string - name: startDate in: query description: the start date required: true example: '2022-01-08' - name: endDate in: query description: the end date required: true example: '2022-01-14' responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: successful operation content: application/json: {} /api/advertisers/{advertiserId}/mdsp/impressions/daily: post: tags: - Flip Dashboard summary: Get daily impressions details description: Return daily impressions details for given filters operationId: getDailyImpressions parameters: - name: advertiserId in: path description: The advertiser id required: true schema: type: integer - name: kind in: query description: 'Return what data? Choices: Impressions / Ad Spend / Video Completions / Clicks' required: true schema: type: string default: views enum: - views - spend - videoCompletions - clicks - name: client in: query description: The account/client name required: true schema: type: string - name: advertiser in: query description: The advertiser name required: true schema: type: string - name: xandrId in: query description: The advertiser's XandrId required: true schema: type: string - name: mediaType in: query description: The media types to filter (e.g. Display Retargeting, OTT, etc.) schema: type: string - name: creative in: query description: The comma-separated creative ids to filter schema: type: string - name: publisher in: query description: The comma-separated publisher names to filter schema: type: string - name: audience in: query description: The comma-separated audience names to filter schema: type: string - name: ioIds in: query description: The comma-separated IO ids to filter schema: type: string - name: adGroups in: query description: The comma-separated Adready Id & start date (separated by |) combination to filter schema: type: string - name: startDate in: query description: The start date required: true schema: type: string format: date example: '2022-01-08' - name: endDate in: query description: The end date required: true schema: type: string format: date example: '2022-01-14' - name: compareStartDate in: query description: The compare start date schema: type: string format: date example: '2022-01-01' - name: compareEndDate in: query description: The compare end date schema: type: string format: date example: '2022-01-07' - name: cumulative in: query description: Flag to specify cumulative or not. schema: type: boolean default: true enum: - 'true' - 'false' responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: application/json: {} /api/advertisers/{advertiserId}/lift/summary: post: tags: - Flip Dashboard summary: Get incrementality & brand lift summary operationId: getLiftSummary parameters: - name: advertiserId in: path description: the advertiser id required: true schema: type: integer - name: client in: query description: the account/client name required: true schema: type: string - name: advertiser in: query description: the advertiser name required: true schema: type: string - name: xandrId in: query description: the advertiser's XandrId required: true schema: type: string - name: pixel in: query description: the FLIP universal pixel id required: true schema: type: string - name: showUniques in: query description: flag to decide whether to show only uniques or not schema: type: boolean default: false enum: - 'true' - 'false' - name: conversionWindow in: query description: the conversion window in hours schema: type: integer default: 0 - name: mediaType in: query description: the media types to filter (e.g. Display Retargeting, OTT, etc.) schema: type: string - name: creative in: query description: the comma-separated creative ids to filter schema: type: string - name: publisher in: query description: the comma-separated publisher names to filter schema: type: string - name: audience in: query description: the comma-separated audience names to filter schema: type: string - name: io in: query description: the IO name/grouping name required: true schema: type: string - name: ioIds in: query description: the comma-separated IO ids to filter schema: type: string - name: adGroups in: query description: the comma-separated Adready Id & start date (separated by |) combination to filter schema: type: string - name: attribution in: query description: the conversion attribution to be used, either full or partial schema: type: string default: full enum: - full - partial - name: methodology in: query description: the methodology to be used, either first_touch/last_touch/linear/time_decay schema: type: string default: last_touch enum: - first_touch - last_touch - linear - time_decay - name: event in: query description: the event schema: type: string - name: category in: query description: the pixel category required: true schema: type: string - name: subCategory in: query description: the comma-separated pixel sub-categories schema: type: string - name: liftType in: query description: the lift type required: true schema: type: string - name: startDate in: query description: the start date required: true schema: type: string format: date example: '2022-01-08' - name: endDate in: query description: the end date required: true schema: type: string format: date example: '2022-01-14' responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: List of solutions returned content: application/json: {} /api/advertisers/{advertiserId}/io_pacing: post: tags: - Flip Dashboard summary: Get overall pacing for selected insertion orders description: Fetches the overall pacing details for the provided insertion orders operationId: getInsertionOrderPacing parameters: - name: advertiserId in: path description: the advertiser id required: true schema: type: integer requestBody: content: application/json: schema: $ref: '#/components/schemas/InsertionOrderPacingRequest' required: true responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponseInsertionOrderPacing' /api/advertisers/{advertiserId}/incrementality/distribution: post: tags: - Incrementality summary: Get incrementality distribution description: Provides incrementality distribution data operationId: getIncrementalityDistribution parameters: - name: advertiserId in: path description: the advertiser id required: true schema: type: integer - name: groupBy in: query description: the field by which data to be grouped, either creative/publisher/audience/mediatype/adgroup/overall required: true schema: type: string enum: - creative - publisher - audience - mediatype - adgroup - overall - name: client in: query description: the account/client name required: true schema: type: string - name: advertiser in: query description: the advertiser name required: true schema: type: string - name: xandrId in: query description: the advertiser's XandrId required: true schema: type: string - name: pixel in: query description: the FLIP universal pixel id required: true schema: type: string - name: showUniques in: query description: flag to decide whether to show only uniques or not schema: type: boolean default: false enum: - 'true' - 'false' - name: conversionWindow in: query description: the conversion window in hours schema: type: integer default: 0 - name: mediaType in: query description: the media types to filter (e.g. Display Retargeting, OTT, etc.) style: form schema: type: string - name: creative in: query description: the comma-separated creative ids to filter style: form schema: type: string - name: publisher in: query description: the comma-separated publisher names to filter style: form schema: type: string - name: audience in: query description: the comma-separated audience names to filter style: form schema: type: string - name: ioIds in: query description: the comma-separated IO ids to filter style: form schema: type: string - name: adGroups in: query description: the comma-separated Adready Id & start date (separated by |) combination to filter style: form schema: type: string - name: attribution in: query description: the conversion attribution to be used, either full or partial schema: type: string default: full enum: - full - partial - name: methodology in: query description: the methodology to be used, either first_touch/last_touch/linear/time_decay schema: type: string default: last_touch enum: - first_touch - last_touch - linear - time_decay - name: event in: query description: the event schema: type: string - name: category in: query description: the pixel category required: true schema: type: string - name: subCategory in: query description: the comma-separated pixel sub-categories style: form schema: type: string - name: startDate in: query description: the start date required: true schema: type: string example: '2022-01-08' - name: endDate in: query description: the end date required: true schema: type: string example: '2022-01-14' responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: Successful operation content: '*/*': schema: $ref: '#/components/schemas/ApiResponseListIncrementalLiftData' /api/advertisers/{advertiserId}/impressions/summary: post: tags: - Flip Dashboard summary: Get impressions summary operationId: getImpressionsSummary_1 parameters: - name: advertiserId in: path description: the advertiser id required: true schema: type: integer - name: kind in: query description: the kind of data to be returned, either Impressions / Ad Spend / Video Completions / Clicks schema: type: string default: views enum: - views - spend - videoCompletions - clicks - name: client in: query description: the account/client name required: true schema: type: string - name: advertiser in: query description: the advertiser name required: true schema: type: string - name: xandrId in: query description: the advertiser's XandrId required: true schema: type: string - name: mediaType in: query description: the media types to filter (e.g. Display Retargeting, OTT, etc.) schema: type: string - name: creative in: query description: the comma-separated creative ids to filter schema: type: string - name: publisher in: query description: the comma-separated publisher names to filter schema: type: string - name: audience in: query description: the comma-separated audience names to filter schema: type: string - name: ioIds in: query description: the comma-separated IO ids to filter schema: type: string - name: adGroups in: query description: the comma-separated Adready Id & start date (separated by |) combination to filter schema: type: string - name: startDate in: query description: the start date required: true schema: type: string format: date example: '2022-01-08' - name: endDate in: query description: the end date required: true schema: type: string format: date example: '2022-01-14' - name: compareStartDate in: query description: the compare start date schema: type: string format: date example: '2022-01-01' - name: compareEndDate in: query description: the compare end date schema: type: string format: date example: '2022-01-07' responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: Impressions summary content: application/json: {} /api/advertisers/{advertiserId}/impressions/distribution: post: tags: - Flip Dashboard summary: Get impressions distribution operationId: getImpressionsDistribution_1 parameters: - name: advertiserId in: path description: the advertiser id required: true - name: kind in: query description: the kind of data to be returned, either Impressions / Ad Spend / Video Completions / Clicks required: true schema: type: string enum: - views - spend - videoCompletions - clicks - name: groupBy in: query description: the field by which data to be grouped, either creative/adgroup/device/daypart/publisher/channel/audience/state/dma/mediatype required: true schema: type: string enum: - creative - adgroup - device - daypart - publisher - channel - audience - state - dma - mediatype - name: client in: query description: the account/client name required: true - name: advertiser in: query description: the advertiser name required: true - name: xandrId in: query description: the advertiser's XandrId required: true - name: mediaType in: query description: the media types to filter (e.g. Display Retargeting, OTT, etc.) schema: type: string - name: creative in: query description: the comma-separated creative ids to filter schema: type: string - name: publisher in: query description: the comma-separated publisher names to filter schema: type: string - name: audience in: query description: the comma-separated audience names to filter schema: type: string - name: ioIds in: query description: the comma-separated IO ids to filter schema: type: string - name: adGroups in: query description: the comma-separated Adready Id & start date (separated by |) combination to filter schema: type: string - name: startDate in: query description: the start date required: true example: '2022-01-08' - name: endDate in: query description: the end date required: true example: '2022-01-14' responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: application/json: {} /api/advertisers/{advertiserId}/impressions/daily: post: tags: - Flip Dashboard summary: Get daily impressions details description: Returns daily impression data for a given advertiser operationId: getDailyImpressions_1 parameters: - name: advertiserId in: path required: true schema: type: integer format: int32 - name: kind in: query description: The kind of data to be returned, either Impressions / Ad Spend / Video Completions / Clicks required: true schema: type: string enum: - views - spend - videoCompletions - clicks responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponseDailySummary' /api/advertisers/{advertiserId}/flipPixels: get: tags: - Flip Dashboard summary: Get FLIP pixels by advertiser id description: Returns FLIP pixels for the specified advertiser operationId: getFlipPixels parameters: - name: advertiserId in: path description: The advertiser id required: true schema: type: integer - name: showAll in: query description: Flag to decide whether to show all pixels or only active pixels required: false schema: type: boolean default: false responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: Successful retrieval content: '*/*': schema: $ref: '#/components/schemas/ApiResponseListFlipPixel' post: tags: - Flip Dashboard summary: Add new FLIP pixel for an advertiser description: Adds a new FLIP pixel for the given advertiser ID operationId: addFlipPixel parameters: - name: advertiserId in: path description: The advertiser id required: true schema: type: integer requestBody: description: FlipPixel object to add content: application/json: schema: $ref: '#/components/schemas/FlipPixel' required: true responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: Successfully added FlipPixel content: '*/*': schema: $ref: '#/components/schemas/FlipPixel' /api/advertisers/{advertiserId}/creatives: post: tags: - Flip Dashboard summary: Get creatives for an advertiser description: Fetches creatives for a given advertiser operationId: getCreatives parameters: - name: advertiserId in: path description: the advertiser id required: true - name: client in: query description: the account/client name required: true - name: advertiser in: query description: the advertiser name required: true - name: ioIds in: query description: the comma-separated IO ids to filter schema: type: string - name: startDate in: query description: the start date required: true example: '2022-01-08' - name: endDate in: query description: the end date required: true example: '2022-01-14' - name: adGroups in: query description: the comma-separated Adready Id & start date (separated by |) combination to filter schema: type: string responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: type: string /api/advertisers/{advertiserId}/conversions/summary: post: tags: - Flip Dashboard summary: Get conversions summary for a FLIP pixel operationId: getPixelSummary parameters: - name: advertiserId in: path description: the advertiser id required: true schema: type: integer - name: client in: query description: the account/client name required: true schema: type: string - name: advertiser in: query description: the advertiser name required: true schema: type: string - name: xandrId in: query description: the advertiser's XandrId required: true schema: type: string - name: pixel in: query description: the FLIP universal pixel id required: true schema: type: string - name: showUniques in: query description: flag to decide whether to show only uniques or not schema: type: boolean default: false enum: - 'true' - 'false' - name: conversionWindow in: query description: the conversion window in hours schema: type: integer default: 0 - name: mediaType in: query description: the media types to filter (e.g. Display Retargeting, OTT, etc.) schema: type: string - name: creative in: query description: the comma-separated creative ids to filter schema: type: string - name: publisher in: query description: the comma-separated publisher names to filter schema: type: string - name: audience in: query description: the comma-separated audience names to filter schema: type: string - name: ioIds in: query description: the comma-separated ioIds ids to filter schema: type: string - name: adGroups in: query description: the comma-separated Adready Id & start date (separated by |) combination to filter schema: type: string - name: attribution in: query description: the conversion attribution to be used, either full or partial schema: type: string default: full enum: - full - partial - name: methodology in: query description: the methodology to be used, either first_touch/last_touch/linear/time_decay schema: type: string default: last_touch enum: - first_touch - last_touch - linear - time_decay - name: event in: query description: the event schema: type: string - name: category in: query description: the pixel category required: true schema: type: string - name: subCategory in: query description: the comma-separated pixel sub-categories schema: type: string - name: startDate in: query description: the start date required: true schema: type: string format: date example: '2022-01-08' - name: endDate in: query description: the end date required: true schema: type: string format: date example: '2022-01-14' - name: compareStartDate in: query description: the compare start date schema: type: string format: date example: '2022-01-01' - name: compareEndDate in: query description: the compare end date schema: type: string format: date example: '2022-01-07' responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: List of solutions returned content: application/json: {} /api/advertisers/{advertiserId}/conversions/distribution: post: tags: - Flip Dashboard summary: Get conversions distribution for a FLIP pixel operationId: getPixelDistribution parameters: - name: advertiserId in: path description: the advertiser id required: true - name: kind in: query description: the kind of data to be returned, either pixel visits or pixel revenue required: true schema: type: string enum: - visits - revenue - name: groupBy in: query description: the field by which data to be grouped, either creative/adgroup/device/daypart/publisher/channel/audience/timesexposed/state/dma/mediatype/subcategories required: true schema: type: string enum: - creative - adgroup - device - daypart - publisher - channel - audience - timesexposed - state - dma - mediatype - subcategories - name: client in: query description: the account/client name required: true - name: advertiser in: query description: the advertiser name required: true - name: xandrId in: query description: the advertiser's XandrId required: true - name: pixel in: query description: the FLIP universal pixel id required: true - name: showUniques in: query description: flag to decide whether to show only uniques or not schema: type: string enum: - 'true' - 'false' - name: conversionWindow in: query description: the conversion window in hours schema: type: integer default: 0 - name: mediaType in: query description: the media types to filter (e.g. Display Retargeting, OTT, etc.) schema: type: string - name: creative in: query description: the comma-separated creative ids to filter schema: type: string - name: publisher in: query description: the comma-separated publisher names to filter schema: type: string - name: audience in: query description: the comma-separated audience names to filter schema: type: string - name: ioIds in: query description: the comma-separated IO ids to filter schema: type: string - name: adGroups in: query description: the comma-separated Adready Id & start date (separated by |) combination to filter schema: type: string - name: attribution in: query description: the conversion attribution to be used, either full or partial schema: type: string enum: - full - partial - name: methodology in: query description: the methodology to be used, either first_touch/last_touch/linear/time_decay schema: type: string enum: - first_touch - last_touch - linear - time_decay - name: event in: query description: the event - name: category in: query description: the pixel category required: true - name: subCategory in: query description: the comma-separated pixel sub-categories schema: type: string - name: startDate in: query description: the start date required: true example: '2022-01-08' - name: endDate in: query description: the end date required: true example: '2022-01-14' responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: application/json: {} /api/advertisers/{advertiserId}/conversions/daily: post: tags: - Flip Dashboard summary: Get daily pixel visits details description: Returns pixel visit or revenue data for a specific advertiser over a time range. operationId: getDailyConversions parameters: - name: advertiserId in: path description: The advertiser ID required: true schema: type: integer format: int32 - name: kind in: query description: The kind of data to be returned required: true schema: type: string responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponseDailySummary' /api/advertisers/{advertiserId}/brand_lift/campaigns: get: tags: - Flip Dashboard summary: Get campaigns for an Advertiser and selected IO operationId: getLiftCampaigns parameters: - name: advertiserId in: path description: the advertiser id required: true schema: type: integer - name: client in: query description: the account/client name schema: type: string - name: advertiser in: query description: the advertiser name schema: type: string - name: intCampaignId in: query description: the IO/Campaign Id schema: type: integer - name: io in: query description: the IO name/grouping name schema: type: string - name: pioCampaignId in: query description: the PIO Campaign Id schema: type: integer responses: '400': description: Bad Request content: '*/*': schema: type: object default: description: default response content: application/json: {} post: tags: - Flip Dashboard summary: Create campaign for an Advertiser and selected IO operationId: createCampaign parameters: - name: advertiserId in: path description: the advertiser id required: true schema: type: integer format: int32 - name: client in: query description: the account/client name required: true schema: type: string - name: advertiser in: query description: the advertiser name required: true schema: type: string - name: intCampaignId in: query description: the Campaign/IO Id required: true schema: type: integer format: int32 - name: io in: query description: the IO name/grouping name required: true schema: type: string - name: pioCampaignId in: query required: false schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/NewLucidCampaign' required: true responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: application/json: {} /api/advertisers/{advertiserId}/audiences: post: tags: - advertiser - Flip Dashboard summary: Get audiences for an advertiser description: Get audiences for an advertiser operationId: getAudiences parameters: - name: advertiserId in: query description: the advertiser id required: true - name: client in: query description: the account/client name required: true - name: advertiser in: query description: the advertiser name required: true - name: ioIds in: query description: the comma-separated IO ids to filter schema: type: string - name: startDate in: query description: the start date required: true example: '2022-01-08' - name: endDate in: query description: the end date required: true example: '2022-01-14' - name: adGroups in: query description: the comma-separated Adready Id & start date (separated by |) combination to filter schema: type: string responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: application/json: schema: type: array items: $ref: '#/components/schemas/KeyValue' /api/advertisers/{advertiserId}/advertiserUpdateEmailNotification: post: tags: - advertiser-controller operationId: sendAdvertiserUpdateEmailNotification parameters: - name: advertiserId in: path required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/EmailNotification' required: true responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponseObject' /api/advertisers/ah/create_all: post: tags: - advertiser-controller operationId: createAll requestBody: content: application/json: schema: $ref: '#/components/schemas/AHSyncRequest' required: true responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: type: boolean /api/accounts: get: tags: - account-controller operationId: getAll_4 responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponseListAccount' post: tags: - account-controller operationId: create_13 requestBody: content: application/json: schema: $ref: '#/components/schemas/Account' required: true responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponseAccount' /api/ac/solutions: get: tags: - 'App Console: Solution Management' operationId: getAll_5 responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponseListSolution' post: tags: - 'App Console: Solution Management' operationId: create_14 requestBody: content: application/json: schema: $ref: '#/components/schemas/Solution' required: true responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponseSolution' /api/ac/advertisers/{advertiserId}/solutions/{solutionId}/brand/reports: post: tags: - 'App Console: Brand' summary: Get dimension-wise measurements & metrics report for Performance Brand solution description: 'Groups data by one of: overall, day, campaign, adgroup, mediatype, creative, audience, country, state, dma, device' operationId: getBrandPerformanceReport parameters: - name: advertiserId in: path description: The advertiser id required: true schema: type: integer - name: solutionId in: path description: The solution id required: true schema: type: integer - name: dimension in: query description: The dimension by which data is grouped required: false schema: type: string default: overall enum: - overall - day - campaign - adgroup - mediatype - creative - audience - country - state - dma - device - name: client in: query description: The account/client name required: true - name: advertiser in: query description: The advertiser name required: true - name: mediaTypes in: query description: The media types to filter (e.g. Display Retargeting, OTT, etc.) schema: type: array items: type: string - name: creatives in: query description: The comma-separated creative ids to filter schema: type: array items: type: string - name: audiences in: query description: The comma-separated audience names to filter schema: type: array items: type: string - name: campaignIds in: query description: The comma-separated Campaign ids to filter schema: type: array items: type: string - name: adGroups in: query description: The comma-separated AdReady Id & start date (separated by |) schema: type: array items: type: string - name: startDate in: query description: The start date required: true example: '2023-06-08' - name: endDate in: query description: The end date required: true example: '2023-06-14' - name: standardRequest in: query required: true schema: $ref: '#/components/schemas/StandardApiRequest' - name: conversionApiRequest in: query required: true schema: $ref: '#/components/schemas/ConversionApiRequest' - name: Accept in: header required: true schema: type: string - name: schedulingRequest in: query required: true schema: $ref: '#/components/schemas/SchedulingRequest' - name: creative in: query required: false schema: type: string - name: audience in: query required: false schema: type: string - name: mediaType in: query required: false schema: type: string - name: ioIds in: query required: false schema: type: string responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponseListBrandMetricsByDimension' /api/ac/advertisers/{advertiserId}/reportTemplate: post: tags: - 'App Console: Report Template Management' operationId: create_15 parameters: - name: advertiserId in: path required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ReportTemplate' required: true responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponseReportTemplate' /api/ac/advertisers/{advertiserId}/reportTemplate/run: post: tags: - 'App Console: Report Template Management' operationId: run parameters: - name: advertiserId in: path required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ReportRequest' required: true responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponseReportResponse' /api/ac/advertisers/{advertiserId}/reportTemplate/preset/run: post: tags: - 'App Console: Report Template Management' operationId: queryTemplate parameters: - name: advertiserId in: path required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/ReportRequest' required: true responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponsePresetTemplateResult' /api/ac/advertisers/{advertiserId}/ad_groups: post: tags: - App Console summary: Get ad groups for an advertiser as per the solution id operationId: fetchAdGroups parameters: - name: advertiserId in: path description: the advertiser id required: true - name: solutionId in: query description: the solution id schema: type: integer default: 0 - name: campaignIds in: query description: the comma-separated Campaign ids to filter allowEmptyValue: true schema: type: string - name: startDate in: query description: the start date example: '2023-06-08' - name: endDate in: query description: the end date example: '2023-06-14' responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: application/json: {} /api/ac/advertiserSolution: get: tags: - 'App Console: Solution Management' operationId: getAll_6 responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponseListAdvertiserSolution' post: tags: - 'App Console: Solution Management' operationId: create_16 requestBody: content: application/json: schema: $ref: '#/components/schemas/AdvertiserSolution' required: true responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponseAdvertiserSolution' /version: get: tags: - version-controller operationId: getVersion responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/AppVersion' /api/version: get: tags: - version-controller operationId: getVersion_1 responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/AppVersion' /throw_exception: get: tags: - version-controller operationId: throwException responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/AppVersion' /health-check: get: tags: - health-check operationId: getHealthCheckPage responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: type: string /api/workflowOptions: get: tags: - api-controller operationId: getWorkflowOptions responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponseListWorkflowOption' /api/whitelabel_domains/get_by_domain_name: get: tags: - whitelabel-domain-controller operationId: getByDomainName parameters: - name: domainName in: query required: true schema: type: string responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/WhitelabelDomain' /api/verificationPartners: get: tags: - api-controller operationId: getAllVerificationPartners responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponseListVerificationPartner' /api/vendors: get: tags: - vendor-master-controller operationId: getAllVendor parameters: - name: productCategoryId in: query required: false schema: type: integer format: int32 responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponseListVendorMaster' /api/users/{userId}/globalRoles: get: tags: - user-controller operationId: findUserGlobalRoles parameters: - name: userId in: path required: true schema: type: integer format: int64 responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: type: array items: $ref: '#/components/schemas/UserRole' /api/users/organization: get: tags: - user-controller operationId: getUserByOrgId parameters: - name: orgId in: query required: true schema: type: integer format: int32 responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: type: array items: $ref: '#/components/schemas/User' /api/users/advertiser: get: tags: - user-controller operationId: getUsersByAdvertiserId parameters: - name: advertiserId in: query required: true schema: type: integer format: int32 responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponseListUserDTO' /api/trackingTypes: get: tags: - api-controller operationId: getTrackingTypes responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponseListTrackingPixel' /api/token/thoughtSpot: get: tags: - token-controller operationId: generateThoughtSpotToken responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponseThoughtSpotToken' /api/token/tableau: get: tags: - token-controller operationId: tableauJwtToken responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponseString' /api/token/tableau/{advertiserId}: get: tags: - token-controller operationId: tableauJwtToken_1 parameters: - name: advertiserId in: path required: true schema: type: integer format: int32 responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponseString' /api/token/tableau/sign/{advertiserId}: get: tags: - token-controller operationId: tableauSignInTokenByAdvertiser parameters: - name: advertiserId in: path required: true schema: type: integer format: int32 responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponseString' /api/token/tableau/account/{accountId}: get: tags: - token-controller operationId: tableauJwtTokenByAccount parameters: - name: accountId in: path required: true schema: type: integer format: int32 responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponseString' /api/token/refresh: get: tags: - token-controller operationId: refreshToken responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponseTokenWrapper' /api/token/parse: get: tags: - token-controller operationId: parseJwtToken responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponseTokenWrapper' /api/theme: get: tags: - config-controller operationId: getTheme parameters: - name: domain in: query required: false schema: type: string - name: appId in: query required: false schema: type: integer format: int32 - name: mode in: query required: false schema: type: string responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: type: object /api/test/error: get: tags: - errors-controller operationId: throwErr responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: type: string /api/taskTypeOptions: get: tags: - api-controller operationId: getTaskTypeOptions responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponseListTaskTypeOption' /api/targetingElements: get: tags: - api-controller operationId: getTargetableElements responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponseListTargetableElement' /api/targetableElement/{targetableElementId}/options: get: tags: - api-controller operationId: getTargetableElementOptions parameters: - name: targetableElementId in: path required: true schema: type: integer format: int32 - name: term in: query required: false schema: type: string - name: source in: query required: false schema: type: string responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponseListOptionDTO' /api/tableau/{advertiserId}/download/views/{viewId}/{type}: get: tags: - tableau-controller summary: Download Tableau report description: Downloads a Tableau report for the given advertiser, view, and type operationId: tableauReportDownload parameters: - name: advertiserId in: path description: Advertiser ID required: true schema: type: integer format: int32 example: 123 - name: viewId in: path description: View ID required: true schema: type: string example: my-dashboard-id - name: type in: path description: Report type (e.g., pdf, png) required: true schema: type: string example: pdf responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: Report downloaded successfully '500': description: Error while generating the report /api/tableau/views/{advertiserId}: get: tags: - tableau-controller operationId: tableauViews parameters: - name: advertiserId in: path required: true schema: type: integer format: int32 responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponseListTableauView' /api/tableau/views/account/{accountId}: get: tags: - Tableau Views summary: Get Tableau views for an account description: Retrieve a list of Tableau views belonging to a specific account ID operationId: tableauViewsForAccount parameters: - name: accountId in: path description: The account ID required: true schema: type: integer format: int32 responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: List of Tableau views content: '*/*': schema: $ref: '#/components/schemas/ApiResponse' /api/statusOptions/{type}: get: tags: - api-controller operationId: getAllStatusOptions parameters: - name: type in: path required: true schema: type: string responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponseListStatusOption' /api/segments/download: get: tags: - segment-controller operationId: downloadRecordsAsJson responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: type: string /api/secured_config: get: tags: - config-controller operationId: getSecuredConfig responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: type: object /api/roles: get: tags: - api-controller operationId: getRoles responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponseListRole' /api/rateCards/{accountId}: get: tags: - rate-cards-controller operationId: listRateCards parameters: - name: accountId in: path required: true schema: type: integer format: int32 - name: accountType in: query required: true schema: type: string responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponseRateCardDTO' /api/productTypes/{productTypeId}: get: tags: - api-controller operationId: getProductTypeById parameters: - name: productTypeId in: path required: true schema: type: integer format: int32 responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponseProductType' /api/productTypes/{productTypeId}/targetingTypes/{targetingType}: get: tags: - api-controller operationId: getTargetableElements_1 parameters: - name: productTypeId in: path required: true schema: type: integer format: int32 - name: targetingType in: path required: true schema: type: string - name: accountId in: query required: true schema: type: integer format: int32 responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponseListTargetableElement' /api/productTypes/{productTypeId}/targetingTypes/{targetingType}/level/{level}: get: tags: - api-controller operationId: getTargetableElementsByLevel parameters: - name: productTypeId in: path required: true schema: type: integer format: int32 - name: targetingType in: path required: true schema: type: string - name: level in: path required: true schema: type: integer format: int32 responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponseListTargetableElement' /api/productTypes/{productTypeId}/kpiOptions: get: tags: - api-controller operationId: getKpiOptions parameters: - name: productTypeId in: path required: true schema: type: integer format: int32 responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponseListKpiOption' /api/productTypes/{productTypeId}/goalOptions: get: tags: - api-controller operationId: goalOptions parameters: - name: productTypeId in: path required: true schema: type: integer format: int32 responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: type: array items: $ref: '#/components/schemas/Option' /api/productCategories: get: tags: - api-controller operationId: getProductCategories responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponseListProductCategoryDTO' /api/productCategories/{productCategoryId}: get: tags: - api-controller operationId: getProductCategoryById parameters: - name: productCategoryId in: path required: true schema: type: integer format: int32 responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponseProductCategoryDTO' /api/priceTypeOptions: get: tags: - api-controller operationId: getPriceTypeOptions responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponseListKeyValue' /api/pixels/{pixelId}: get: tags: - pixel-controller operationId: get_8 parameters: - name: pixelId in: path required: true schema: type: integer format: int32 responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponsePixel' /api/pixels/advertiser/{advertiserId}: get: tags: - pixel-controller operationId: getAllByAdvertiser parameters: - name: advertiserId in: path required: true schema: type: integer format: int32 responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponseListPixel' /api/options/marketingObjectives: get: tags: - api-controller operationId: getMarketingObjectives responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponseListMarketingObjective' /api/options/locations: get: tags: - api-controller operationId: getLocations responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponseListLocation' /api/options/industries: get: tags: - api-controller operationId: getIndustries responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponseListIndustry' /api/options/budgetRanges: get: tags: - api-controller summary: Get budget ranges operationId: getBudgetRanges responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponseListBudgetRange' /api/lineItemHistory/lineitem/{lineItemId}: get: tags: - line-item-history-controller operationId: findByLineItemId parameters: - name: lineItemId in: path required: true schema: type: integer format: int32 responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponse' /api/kpiOptions: get: tags: - api-controller operationId: getKpiOptions_1 responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponseListKpiOption' /api/ios/{advertiserId}/msdp/lineItemNamesData: get: tags: - line-items-controller operationId: lineItemNamesDataFromBQ parameters: - name: advertiserId in: path required: true schema: type: integer format: int32 - name: planIds in: query required: false schema: type: string responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: type: array items: $ref: '#/components/schemas/LineItemNameResponse' /api/ios/{advertiserId}/lineItemNamesData: get: tags: - line-items-controller operationId: lineItemNamesData parameters: - name: advertiserId in: path required: true schema: type: integer format: int32 - name: planIds in: query required: false schema: type: string - name: ioNames in: query required: false schema: type: string - name: includeNonFlip in: query required: false schema: type: boolean default: false responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: type: array items: $ref: '#/components/schemas/LineItemNameResponse' /api/ios/workflowStatusCount: get: tags: - line-items-controller operationId: workflowStatusCount parameters: - name: accountId in: query required: false schema: type: integer format: int32 responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: type: array items: $ref: '#/components/schemas/WorkflowStats' /api/ios/plan/workflowStatsCount: get: tags: - line-items-controller operationId: workflowStatsCount parameters: - name: accountId in: query required: false schema: type: integer format: int32 responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: type: array items: $ref: '#/components/schemas/WorkflowStats' /api/ios/plan/lineItemStatusCount: get: tags: - line-items-controller operationId: lineItemStatusCount parameters: - name: accountId in: query required: false schema: type: integer format: int32 - name: advertiserId in: query required: false schema: type: integer format: int32 - name: isFlip in: query required: false schema: type: boolean responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: type: array items: $ref: '#/components/schemas/WorkflowStats' /api/ios/plan/lineItemStatusCountForPlans: get: tags: - line-items-controller operationId: lineItemStatusCountForPlans parameters: - name: accountId in: query required: false schema: type: integer format: int32 - name: advertiserId in: query required: false schema: type: integer format: int32 - name: isFlip in: query required: false schema: type: boolean responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: type: array items: $ref: '#/components/schemas/WorkflowStats' /api/ios/lineItems: get: tags: - line-items-controller operationId: getAll_7 parameters: - name: q in: query required: false schema: type: string - name: pageNumber in: query required: false schema: type: integer format: int32 - name: perPage in: query required: false schema: type: integer format: int32 - name: sortKey in: query required: false schema: type: string - name: sortOrder in: query required: false schema: type: string - name: crFilter in: query required: false schema: type: boolean responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponsePageResponseLineItem' /api/ios/lineItem/{lineItemId}: get: tags: - line-items-controller operationId: getLineItem parameters: - name: lineItemId in: path required: true schema: type: integer format: int32 responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponseLineItem' /api/hierarchies: get: tags: - api-controller operationId: getAllProductHierarchies parameters: - name: accountId in: query required: false schema: type: integer format: int32 - name: accountType in: query required: true schema: type: string responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: type: array items: $ref: '#/components/schemas/ProductHierarchy' /api/flagOptions: get: tags: - api-controller operationId: getFlagOptions responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponseListFlagOption' /api/files/{fileId}: get: tags: - file-controller operationId: getFile parameters: - name: fileId in: path required: true schema: type: integer format: int32 responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/FileData' /api/files/download/plan/{planId}: get: tags: - file-controller operationId: downloadPlanFile parameters: - name: planId in: path required: true schema: type: integer format: int32 responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: type: string format: binary /api/files/download/orders/{orderId}/{lineItemId}/{fileName}: get: tags: - file-controller operationId: downloadFile parameters: - name: fileName in: path required: true schema: type: string - name: orderId in: path required: true schema: type: integer format: int32 - name: lineItemId in: path required: true schema: type: integer format: int32 - name: download in: query required: false schema: type: boolean responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: type: string format: binary /api/files/download/orders/{orderId}/{fileName}: get: tags: - file-controller operationId: downloadFile_1 parameters: - name: fileName in: path required: true schema: type: string - name: orderId in: path required: true schema: type: integer format: int32 - name: download in: query required: false schema: type: boolean responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: type: string format: binary /api/files/download/tmp/{fileName}: get: tags: - file-controller operationId: downloadFile_2 parameters: - name: fileName in: path required: true schema: type: string - name: download in: query required: false schema: type: boolean responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: type: string format: binary /api/files/download/{fileName}: get: tags: - file-controller operationId: downloadFile_3 parameters: - name: fileName in: path required: true schema: type: string - name: download in: query required: false schema: type: boolean responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: type: string format: binary /api/files/download/line-item/{lineItemId}: get: tags: - file-controller operationId: downloadLineItemFile parameters: - name: lineItemId in: path required: true schema: type: integer format: int32 responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: type: string format: binary /api/features: get: tags: - available-features-controller operationId: getAvailableFeatures responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: type: array items: type: string /api/dmm/campaign/{campaignId}/package/{packageId}/ioMarketFeedRaw: get: tags: - dmm-controller summary: getIoMarketFeedRawByCampaignIdAndPackageId operationId: findAllIoMarketFeedRawByCampaignIdPackageId parameters: - name: campaignId in: path required: true schema: type: integer format: int32 - name: packageId in: path required: true schema: type: integer format: int32 responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: type: array items: $ref: '#/components/schemas/DmmIoMarketsFeedRaw' /api/dmm/campaign/{campaignId}/package/{packageId}/ioMarketFeedRawHistory: get: tags: - dmm-controller summary: getIoMarketFeedRawHistoryByCampaignIdAndPackageId operationId: findAllIoMarketFeedRawHistoryByCampaignIdPackageId parameters: - name: campaignId in: path required: true schema: type: integer format: int32 - name: packageId in: path required: true schema: type: integer format: int32 responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: type: array items: $ref: '#/components/schemas/DmmIoMarketsFeedRawHistory' /api/dmm/campaign/{campaignId}/marketGroupsFeedRaw: get: tags: - dmm-controller summary: getMarketGroupsFeedRawByCampaignId operationId: findAllMarketGroupsFeedRawByCampaignId parameters: - name: campaignId in: path required: true schema: type: integer format: int32 responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: type: array items: $ref: '#/components/schemas/DmmIoMarketGroupsFeedRaw' /api/dmm/campaign/{campaignId}/marketGroupsFeedRawHistory: get: tags: - dmm-controller summary: getMarketGroupsFeedRawHistoryByCampaignId operationId: findAllMarketGroupsFeedRawHistoryByCampaignId parameters: - name: campaignId in: path required: true schema: type: integer format: int32 responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: type: array items: $ref: '#/components/schemas/DmmIoMarketGroupsFeedRawHistory' /api/dmm/campaign/{campaignId}/ioSiteListFeedRaw: get: tags: - dmm-controller summary: getIoSiteListFeedRawByCampaignId operationId: findAllIoSiteListFeedRawByCampaignId parameters: - name: campaignId in: path required: true schema: type: integer format: int32 responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: type: array items: $ref: '#/components/schemas/DmmIoSiteListFeedRaw' /api/dmm/campaign/{campaignId}/ioSiteListFeedRawHistory: get: tags: - dmm-controller summary: getIoSiteListFeedRawHistoryByCampaignId operationId: findAllIoSiteListFeedRawHistoryByCampaignId parameters: - name: campaignId in: path required: true schema: type: integer format: int32 responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: type: array items: $ref: '#/components/schemas/DmmIoSiteListFeedRawHistory' /api/dmm/campaign/{campaignId}/ioKeywordListFeedRaw: get: tags: - dmm-controller summary: getIoKeywordListFeedRawByCampaignId operationId: findAllIoKeywordListFeedRawByCampaignId parameters: - name: campaignId in: path required: true schema: type: integer format: int32 responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: type: array items: $ref: '#/components/schemas/DmmIoKeywordListFeedRaw' /api/dmm/campaign/{campaignId}/ioKeywordListFeedRawHistory: get: tags: - dmm-controller summary: getIoKeywordListFeedRawHistoryByCampaignId operationId: findAllIoKeywordListFeedRawHistoryByCampaignId parameters: - name: campaignId in: path required: true schema: type: integer format: int32 responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: type: array items: $ref: '#/components/schemas/DmmIoKeywordListFeedRawHistory' /api/dmm/campaign/{campaignId}/ioAudienceDefinitionFeedRaw: get: tags: - dmm-controller summary: getIoAudienceDefinitionFeedRawByCampaignId operationId: findAllIoAudienceDefinitionFeedRawByCampaignId parameters: - name: campaignId in: path required: true schema: type: integer format: int32 responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: type: array items: $ref: '#/components/schemas/DmmIoAudienceDefinitionFeedRaw' /api/dmm/campaign/{campaignId}/ioAudienceDefinitionFeedRawHistory: get: tags: - dmm-controller summary: getIoAudienceDefinitionFeedRawHistoryByCampaignId operationId: findAllIoAudienceDefinitionFeedRawHistoryByCampaignId parameters: - name: campaignId in: path required: true schema: type: integer format: int32 responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: type: array items: $ref: '#/components/schemas/DmmIoAudienceDefinitionFeedRawHistory' /api/deviceTypes: get: tags: - device-type-controller operationId: getDeviceTypeMaster parameters: - name: productCategoryId in: query required: false schema: type: integer format: int32 responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponseListDeviceTypeMaster' /api/demoAdvtMapping: get: tags: - demo-advertiser-mapping-controller operationId: getDemoAdvertiserMappings responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: type: array items: $ref: '#/components/schemas/DemoConfig' /api/deals: get: tags: - deal-performance-controller operationId: list_4 responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: type: array items: $ref: '#/components/schemas/DealPerformance' /api/deals/{id}: get: tags: - deal-performance-controller operationId: get_9 parameters: - name: id in: path required: true schema: type: integer format: int32 responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/DealPerformance' /api/config: get: tags: - config-controller operationId: getConfig parameters: - name: domain in: query required: false schema: type: string - name: appId in: query required: false schema: type: integer format: int32 - name: mode in: query required: false schema: type: string responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: type: object /api/budgetGroup/budgetGroupByPlanId/{ioId}: get: tags: - budget-group-controller operationId: getByPlanId parameters: - name: ioId in: path required: true schema: type: integer format: int32 responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponseListBudgetGroup' /api/brandSafetyLevels: get: tags: - api-controller operationId: getAllBrandSafetyLevels responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponseListBrandSafetyLevel' /api/billingTypeOptions: get: tags: - api-controller operationId: getBillingTypeOptions responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponseListKeyValue' /api/applications: get: tags: - api-controller operationId: getApplications responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponseListApplication' /api/agencies/{agencyId}: get: tags: - agency-controller operationId: getAgency parameters: - name: agencyId in: path required: true schema: type: integer format: int32 responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponseAgency' /api/advertisers/{id}/audienceNames: get: tags: - advertiser-controller summary: get operationId: getAudienceNames parameters: - name: id in: path required: true schema: type: integer format: int32 responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: type: array items: type: string /api/advertisers/{advertiserId}/publishers: get: tags: - Flip Dashboard summary: Get publishers for an advertiser description: Fetches the list of publishers for the specified advertiser operationId: getPublishers parameters: - name: advertiserId in: path description: the advertiser id required: true - name: client in: query description: the account/client name required: true - name: advertiser in: query description: the advertiser name required: true - name: ioIds in: query description: the comma-separated IO ids to filter schema: type: string - name: startDate in: query description: the start date required: true example: '2022-01-08' - name: endDate in: query description: the end date required: true example: '2022-01-14' - name: adGroups in: query description: the comma-separated Adready Id & start date (separated by |) combination to filter schema: type: string responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: type: string /api/advertisers/{advertiserId}/performance/metrics/incrementalreach: get: tags: - Flip Dashboard summary: Get incremental reach metric description: Returns incremental reach metrics by advertiser and client over specified date range operationId: getIncrementalReach parameters: - name: startDate in: query description: The start date required: true schema: type: string example: '2021-05-24' - name: endDate in: query description: The end date required: true schema: type: string example: '2021-05-31' - name: advertiserId in: path description: The advertiser ID required: true schema: type: integer - name: adGroups in: query description: Comma-separated AdReady ID & start date (separated by |) combinations schema: type: array items: type: string - name: compareStartDate in: query description: Compare start date schema: type: string example: '2021-05-17' - name: compareEndDate in: query description: Compare end date schema: type: string example: '2021-05-23' - name: client in: query description: The account/client name required: true - name: advertiser in: query description: The advertiser name required: true responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: Successful operation content: '*/*': schema: $ref: '#/components/schemas/IncrementalReachMetric' /api/advertisers/{advertiserId}/io_names: get: tags: - Flip Dashboard summary: Get unique insertion order names for an advertiser description: Get unique insertion order names for an advertiser operationId: getInsertionOrderNames parameters: - name: advertiserId in: path description: the advertiser id required: true schema: type: integer format: int32 - name: client in: query description: the account/client name required: true schema: type: string - name: advertiser in: query description: the advertiser name required: true schema: type: string - name: showAll in: query description: flag to decide whether to include Adready IOs in the response or not required: false schema: type: boolean default: false enum: - 'true' - 'false' - name: includeNonFlip in: query description: flag to decide whether to include non-flip IOs in the response or not required: false schema: type: boolean default: false enum: - 'true' - 'false' - name: currentPage in: query description: for pagination required: false schema: type: string responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: type: string /api/advertisers/{advertiserId}/incrementality/haloEffect: get: tags: - Incrementality summary: Get Halo Effect data description: Provides halo effect data operationId: getIncrementalityHaloEffect parameters: - name: advertiserId in: path description: the advertiser id required: true schema: type: integer - name: client in: query description: the account/client name required: true schema: type: string - name: advertiser in: query description: the advertiser name required: true schema: type: string - name: xandrId in: query description: the advertiser's XandrId required: true schema: type: string - name: pixel in: query description: the FLIP universal pixel id required: true schema: type: string - name: showUniques in: query description: flag to decide whether to show only uniques or not schema: type: boolean default: false enum: - 'true' - 'false' - name: conversionWindow in: query description: the conversion window in hours schema: type: integer default: 0 - name: mediaType in: query description: the media types to filter (e.g. Display Retargeting, OTT, etc.) style: form schema: type: string - name: creative in: query description: the comma-separated creative ids to filter style: form schema: type: string - name: publisher in: query description: the comma-separated publisher names to filter style: form schema: type: string - name: audience in: query description: the comma-separated audience names to filter style: form schema: type: string - name: ioIds in: query description: the comma-separated IO ids to filter style: form schema: type: string - name: adGroups in: query description: the comma-separated Adready Id & start date (separated by |) combination to filter style: form schema: type: string - name: attribution in: query description: the conversion attribution to be used, either full or partial schema: type: string default: full enum: - full - partial - name: methodology in: query description: the methodology to be used, either first_touch/last_touch/linear/time_decay schema: type: string default: last_touch enum: - first_touch - last_touch - linear - time_decay - name: event in: query description: the event schema: type: string - name: category in: query description: the pixel category required: true schema: type: string - name: subCategory in: query description: the comma-separated pixel sub-categories style: form schema: type: string - name: startDate in: query description: the start date required: true schema: type: string example: '2022-01-08' - name: endDate in: query description: the end date required: true schema: type: string example: '2022-01-14' responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: Successful operation content: '*/*': schema: $ref: '#/components/schemas/ApiResponseListHaloEffectData' /api/advertisers/{advertiserId}/flipPixels/{pixelId}/fires: get: tags: - Flip Dashboard summary: Fetch FLIP pixel fires description: Returns pixel fires for the specified pixel and advertiser, with support for filters and pagination. operationId: fetchPixelFires parameters: - name: advertiserId in: path description: The advertiser ID required: true schema: type: integer - name: pixelId in: path description: The FLIP pixel ID required: true schema: type: string - name: category in: query description: Comma-separated pixel categories required: false schema: type: string default: all - name: subCategory in: query description: Comma-separated pixel sub-categories required: false schema: type: string default: all - name: startDate in: query description: The start date required: true schema: type: string example: '2022-01-08' - name: endDate in: query description: The end date required: true schema: type: string example: '2022-01-14' - name: offset in: query description: Number of records to skip schema: type: integer default: 0 - name: limit in: query description: Max number of records to return schema: type: integer default: 20 - name: Accept in: header description: '''application/json'' (default), ''text/csv'', or ''application/csv''' required: false schema: type: string default: application/json responses: '400': description: Invalid request parameters '200': description: Pixel fires fetched successfully content: '*/*': schema: $ref: '#/components/schemas/ApiResponseListUniversalPixelFires' /api/advertisers/{advertiserId}/flipPixels/{pixelId}/fires/summary: get: tags: - Flip Dashboard summary: Get FLIP pixel fires summary description: Returns summary of pixel fires for a given pixel ID and date range operationId: fetchFlipPixelFiresSummary parameters: - name: advertiserId in: path description: The advertiser id required: true schema: type: integer - name: pixelId in: path description: The pixel id required: true schema: type: string - name: category in: query description: The comma-separated pixel categories required: false schema: type: string example: category1,category2 - name: subCategory in: query description: The comma-separated pixel sub-categories required: false schema: type: string example: sub1,sub2 - name: startDate in: query description: The start date required: true schema: type: string format: date example: '2022-01-08' - name: endDate in: query description: The end date required: true schema: type: string format: date example: '2022-01-14' responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: Successfully retrieved pixel fires summary content: '*/*': schema: $ref: '#/components/schemas/ApiResponseUniversalPixelFiresSummary' /api/advertisers/{advertiserId}/flipPixels/{pixelId}/fires/daily: get: tags: - Flip Dashboard summary: Get daily FLIP pixel fires description: Returns daily pixel fires for a given advertiser and pixel ID. operationId: fetchDailyPixelFires parameters: - name: advertiserId in: path description: The advertiser ID required: true schema: type: integer - name: pixelId in: path description: The FLIP pixel ID required: true schema: type: string - name: category in: query description: Comma-separated pixel categories required: false schema: type: string default: all - name: subCategory in: query description: Comma-separated pixel sub-categories required: false schema: type: string default: all - name: startDate in: query description: The start date required: true schema: type: string format: date example: '2022-01-08' - name: endDate in: query description: The end date required: true schema: type: string format: date example: '2022-01-14' - name: Accept in: header description: '''application/json'' (default), or ''text/csv'' / ''application/csv'' for CSV format' schema: type: string default: application/json responses: '400': description: Invalid parameters '200': description: Daily pixel fires fetched successfully content: '*/*': schema: $ref: '#/components/schemas/ApiResponseListKeyValueLong' '500': description: Server error content: '*/*': schema: $ref: '#/components/schemas/ApiResponseListKeyValueLong' /api/advertisers/{advertiserId}/flipPixels/{pixelId}/categories: get: tags: - Flip Dashboard summary: Fetch FLIP pixel categories description: Returns a list of pixel events (categories) for the given pixel ID and advertiser ID within the specified date range operationId: fetchPixelCategories parameters: - name: advertiserId in: path description: The advertiser ID required: true schema: type: integer - name: pixelId in: path description: The FLIP pixel ID required: true schema: type: string - name: startDate in: query description: 'The start date (format: yyyy-MM-dd)' required: true schema: type: string example: '2022-01-08' - name: endDate in: query description: 'The end date (format: yyyy-MM-dd)' required: true schema: type: string example: '2022-01-14' responses: '400': description: Invalid input '200': description: Successfully fetched pixel categories content: '*/*': schema: $ref: '#/components/schemas/ApiResponseListPixelEvent' '404': description: Pixel not found content: '*/*': schema: $ref: '#/components/schemas/ApiResponseListPixelEvent' /api/advertisers/{advertiserId}/events: get: tags: - Flip Dashboard summary: Get conversion events for an advertiser description: Fetches conversion events for a given advertiser operationId: getConversionEvents parameters: - name: advertiserId in: path description: the advertiser id required: true - name: xandrId in: query description: the advertiser's XandrId - name: pixelId in: query description: the advertiser's pixelId responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: type: string /api/advertisers/{advertiserId}/crossview/dsp: get: tags: - advertiser-controller operationId: getCrossViewDspIdsByAdvertiserId parameters: - name: advertiserId in: path required: true schema: type: integer format: int32 responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponseListString' /api/advertisers/{advertiserId}/brand_lift/types: get: tags: - Flip Dashboard summary: Get lift types for brand lift operationId: getLiftTypes parameters: - name: advertiserId in: path description: the advertiser id required: true schema: type: integer - name: client in: query description: the account/client name required: false schema: type: string - name: advertiser in: query description: the advertiser name required: false schema: type: string - name: intCampaignId in: query description: the IO/Campaign Id required: false schema: type: string - name: io in: query description: the IO name/grouping name required: false schema: type: string - name: pioCampaignId in: query description: the PIO Campaign Id required: false schema: type: integer responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: successful operation content: application/json: {} /api/advertisers/{advertiserId}/brand_lift/template_questions: get: tags: - Flip Dashboard summary: List Template Questions operationId: listTemplateQuestions parameters: - name: advertiserId in: path required: true schema: type: integer format: int32 - name: usage in: query required: true schema: type: string - name: countryLanguageId in: query required: true schema: type: string - name: industryId in: query required: true schema: type: string responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: successful operation content: application/json: {} /api/advertisers/{advertiserId}/brand_lift/industries: get: tags: - Flip Dashboard summary: List Industries operationId: listIndustries responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: successful operation content: application/json: {} /api/advertisers/{advertiserId}/brand_lift/groupBy: get: tags: - Flip Dashboard summary: Get group by for brand lift operationId: getBrandLiftGroupByOption parameters: - name: advertiserId in: path description: the advertiser id required: true schema: type: integer - name: client in: query description: the account/client name schema: type: string - name: advertiser in: query description: the advertiser name schema: type: string - name: intCampaignId in: query description: the IO/Campaign Id schema: type: string - name: io in: query description: the IO name/grouping name schema: type: string - name: pioCampaignId in: query description: the PIO Campaign Id schema: type: integer responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: successful operation content: application/json: {} /api/advertisers/{advertiserId}/brand_lift/distribution: get: tags: - Flip Dashboard summary: Get brand lift distribution operationId: getLiftDistribution parameters: - name: advertiserId in: path description: the advertiser id required: true schema: type: integer - name: client in: query description: the account/client name schema: type: string - name: advertiser in: query description: the advertiser name schema: type: string - name: intCampaignId in: query description: the IO/Campaign Id schema: type: integer - name: io in: query description: the IO name/grouping name schema: type: string - name: groupBy in: query description: the field by which data to be grouped, either creative/publisher/audience/overall required: true schema: type: string enum: - creative - publisher - audience - overall - name: liftType in: query description: the lift type required: true schema: type: string - name: pioCampaignId in: query description: the PIO Campaign Id schema: type: integer responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: successful operation content: application/json: {} /api/advertisers/{advertiserId}/brand_lift/country_languages: get: tags: - Flip Dashboard summary: List Country Languages operationId: listCountryLanguages responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: successful operation content: application/json: {} /api/advertisers/{advertiserId}/brand_lift/campaignsStats: get: tags: - Flip Dashboard summary: Get campaigns stats for an Advertiser and selected IO operationId: getLiftCampaignsStats parameters: - name: advertiserId in: path description: the advertiser id required: true - name: client in: query description: the account/client name - name: advertiser in: query description: the advertiser name - name: intCampaignId in: query description: the IO/Campaign Id - name: io in: query description: the IO name/grouping name - name: pioCampaignId in: query description: the PIO Campaign Id responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: application/json: {} /api/advertisers/{advertiserId}/brand_lift/campaign/{bl_campaign_id}: get: tags: - Flip Dashboard summary: Retrieve single campaign detail for a given campaign id operationId: getBrandLiftCampaign parameters: - name: advertiserId in: path description: the advertiser id required: true schema: type: integer - name: client in: query description: the account/client name required: true schema: type: string - name: advertiser in: query description: the advertiser name required: true schema: type: string - name: bl_campaign_id in: path description: the BL campaign id required: true schema: type: string responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: successful operation content: application/json: {} /api/advertisers/dsp/{pixelId}: get: tags: - advertiser-controller operationId: getDspIdByUniversalPixelId parameters: - name: pixelId in: path required: true schema: type: string responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponseListString' /api/advertisers/advertiserMapping: get: tags: - advertiser-controller operationId: getAdvertiserMapping parameters: - name: advertiserIdType in: query required: false schema: type: string - name: advertiserId in: query required: true schema: type: integer format: int32 responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponseAdvertiserMappingResponse' /api/accounts/{accountId}: get: tags: - account-controller operationId: getAccount parameters: - name: accountId in: path required: true schema: type: integer format: int32 - name: adreadyPlus in: query required: true schema: type: boolean responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponseAccount' /api/accounts/{accountId}/dropdowns/{type}: get: tags: - account-controller operationId: getUserbyAccountAndType parameters: - name: accountId in: path required: true schema: type: integer format: int32 - name: type in: path required: true schema: type: string responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponseListLong' /api/accounts/{accountId}/dropdownUsers: get: tags: - account-controller operationId: getDropdownUserbyAccount parameters: - name: accountId in: path required: true schema: type: integer format: int32 responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: type: array items: $ref: '#/components/schemas/DropdownUserMaster' /api/accounts/user/{userId}: get: tags: - account-controller operationId: getAllAccountsByUserId parameters: - name: userId in: path required: true schema: type: integer format: int64 responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponseListAccount' /api/accounts/prefixExist: get: tags: - account-controller operationId: isPrefixExist parameters: - name: prefix in: query required: true schema: type: string responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: type: boolean /api/accounts/nameExist: get: tags: - account-controller operationId: isNameExist parameters: - name: name in: query required: true schema: type: string responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: type: boolean /api/accounts/managed/{userId}: get: tags: - account-controller operationId: getAllManagedAccountsByUserId parameters: - name: userId in: path required: true schema: type: integer format: int64 responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponseListAccount' /api/accounts/abbreviationExist: get: tags: - account-controller operationId: isAbbreviationExist parameters: - name: abbreviation in: query required: true schema: type: string responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: type: boolean /api/ac/advertisers/{advertiserId}/solutions: get: tags: - App Console summary: Get list of solutions for an advertiser operationId: fetchAdvertiserSolutions parameters: - name: advertiserId in: path required: true schema: type: integer format: int32 responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: application/json: {} /api/ac/advertisers/{advertiserId}/solutions/{solutionId}/social/top_performers: get: tags: - Social Solution - 'App Console: Social' summary: Get dimension-wise top performing metrics for Social solution description: Get dimension-wise top performing metrics for Social solution operationId: getSocialTopPerformers parameters: - name: advertiserId in: path description: the advertiser id required: true - name: solutionId in: path description: the solution id required: true - name: dimension in: query description: the dimension by which data to be grouped, either campaign, adSet, ad, placement schema: type: string default: adSet, ad enum: - campaign, adSet, ad, placement - name: client in: query description: the account/client name required: true - name: advertiser in: query description: the advertiser name required: true - name: creatives in: query description: the comma-separated creative ids to filter schema: type: string - name: campaignIds in: query description: the comma-separated Campaign ids to filter schema: type: string - name: adGroups in: query description: the comma-separated AdReady Id & start date (separated by |) combination to filter schema: type: string - name: startDate in: query description: the start date required: true example: '2023-06-08' - name: endDate in: query description: the end date required: true example: '2023-06-14' responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponseListSocialTopPerformer' /api/ac/advertisers/{advertiserId}/solutions/{solutionId}/social/summary: get: tags: - 'App Console: Social' summary: Get summary for Social solution operationId: getSocialSummary parameters: - name: advertiserId in: path description: the advertiser id required: true schema: type: integer - name: solutionId in: path description: the solution id required: true schema: type: integer - name: client in: query description: the account/client name required: true schema: type: string - name: advertiser in: query description: the advertiser name required: true schema: type: string - name: creatives in: query description: the comma-separated creative ids to filter style: form schema: type: string - name: pixelIds in: query description: the comma-separated pixel ids to filter style: form schema: type: string - name: campaignIds in: query description: the comma-separated Campaign ids to filter style: form schema: type: string - name: adGroups in: query description: the comma-separated AdReady Id & start date (separated by |) combination to filter style: form schema: type: string - name: startDate in: query description: the start date required: true schema: type: string example: '2023-06-08' - name: endDate in: query description: the end date required: true schema: type: string example: '2023-06-14' - name: compareStartDate in: query description: the compare start date schema: type: string example: '2023-06-01' - name: compareEndDate in: query description: the compare end date schema: type: string example: '2023-06-07' responses: '400': description: Bad Request content: '*/*': schema: type: object default: description: default response content: application/json: {} /api/ac/advertisers/{advertiserId}/solutions/{solutionId}/social/reports: get: tags: - 'App Console: Social' summary: Get dimension-wise measurements & metrics report for Social solution operationId: getSocialPerformanceReport parameters: - name: advertiserId in: path description: the advertiser id required: true schema: type: integer - name: solutionId in: path description: the solution id required: true schema: type: integer - name: dimension in: query description: the dimension by which data to be grouped, either overall, day, campaign, adSet, ad, placement schema: type: string enum: - overall - day - campaign - adSet - ad - placement - name: client in: query description: the account/client name required: true schema: type: string - name: advertiser in: query description: the advertiser name required: true schema: type: string - name: creatives in: query description: the comma-separated creative ids to filter style: form schema: type: string - name: campaignIds in: query description: the comma-separated Campaign ids to filter style: form schema: type: string - name: adGroups in: query description: the comma-separated AdReady Id & start date (separated by |) combination to filter style: form schema: type: string - name: startDate in: query description: the start date required: true schema: type: string example: '2023-06-08' - name: endDate in: query description: the end date required: true schema: type: string example: '2023-06-14' responses: '400': description: Bad Request content: '*/*': schema: type: object default: description: default response content: application/json: {} /api/ac/advertisers/{advertiserId}/solutions/{solutionId}/social/performance: get: tags: - 'App Console: Social' summary: Get dimension-wise measurements & metrics for Social solution operationId: getSocialPerformance parameters: - name: advertiserId in: path description: the advertiser id required: true schema: type: integer - name: solutionId in: path description: the solution id required: true schema: type: integer - name: dimension in: query description: the dimension by which data to be grouped, either campaign, adSet, ad, placement schema: type: string default: ad enum: - campaign - adSet - ad - placement - name: client in: query description: the account/client name required: true schema: type: string - name: advertiser in: query description: the advertiser name required: true schema: type: string - name: creatives in: query description: the comma-separated creative ids to filter style: form schema: type: string - name: campaignIds in: query description: the comma-separated Campaign ids to filter style: form schema: type: string - name: adGroups in: query description: the comma-separated AdReady Id & start date (separated by |) combination to filter style: form schema: type: string - name: startDate in: query description: the start date required: true schema: type: string example: '2023-06-08' - name: endDate in: query description: the end date required: true schema: type: string example: '2023-06-14' responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/SocialMetricsByDimension' /api/ac/advertisers/{advertiserId}/solutions/{solutionId}/social/metrics/distribution: get: tags: - Social Solution - 'App Console: Social' summary: Get dimension-wise metrics for Social solution description: Get dimension-wise metrics for Social solution operationId: getSocialMetricsDistribution parameters: - name: advertiserId in: path description: the advertiser id required: true - name: solutionId in: path description: the solution id required: true - name: metric in: query description: the metric to be returned, either ctr, cpc, vcr, cpcv, cpa, roas schema: type: string enum: - ctr, cpc, vcr, cpcv, cpa, roas - name: dimension in: query description: the dimension by which data to be grouped, either campaign, adSet, ad, placement schema: type: string enum: - campaign, adSet, ad, placement - name: client in: query description: the account/client name required: true - name: advertiser in: query description: the advertiser name required: true - name: creatives in: query description: the comma-separated creative ids to filter schema: type: string - name: pixelIds in: query description: the comma-separated pixel ids to filter schema: type: string - name: campaignIds in: query description: the comma-separated Campaign ids to filter schema: type: string - name: adGroups in: query description: the comma-separated AdReady Id & start date (separated by |) combination to filter schema: type: string - name: startDate in: query description: the start date required: true example: '2023-06-08' - name: endDate in: query description: the end date required: true example: '2023-06-14' responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponseListKeyValueDouble' /api/ac/advertisers/{advertiserId}/solutions/{solutionId}/social/metrics/daily: get: tags: - Social Solution - 'App Console: Social' summary: Get daily metrics for Social solution description: Get daily metrics for Social solution operationId: getDailyMetric parameters: - name: advertiserId in: path description: the advertiser id required: true - name: solutionId in: path description: the solution id required: true - name: metric in: query description: the metric like ctr / vcr / cpa / roas schema: type: string enum: - ctr, vcr, cpa, roas - name: client in: query description: the account/client name required: true - name: advertiser in: query description: the advertiser name required: true - name: creatives in: query description: the comma-separated creative ids to filter schema: type: string - name: pixelIds in: query description: the comma-separated pixel ids to filter schema: type: string - name: campaignIds in: query description: the comma-separated Campaign ids to filter schema: type: string - name: adGroups in: query description: the comma-separated AdReady Id & start date (separated by |) combination to filter schema: type: string - name: startDate in: query description: the start date required: true example: '2023-06-08' - name: endDate in: query description: the end date required: true example: '2023-06-14' - name: compareStartDate in: query description: the compare start date example: '2023-06-01' - name: compareEndDate in: query description: the compare end date example: '2023-06-07' responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponseDailySocialSummary' /api/ac/advertisers/{advertiserId}/solutions/{solutionId}/social/measurements/distribution: get: tags: - Social Solution - 'App Console: Social' summary: Get dimension-wise measurements for Social solution description: Get dimension-wise measurements for Social solution operationId: getSocialMeasurementsDistribution parameters: - name: advertiserId in: path description: the advertiser id required: true - name: solutionId in: path description: the solution id required: true - name: measurement in: query schema: type: string description: the measurement to be returned, either Impressions / Spend / Clicks / Video Completions / Conversions / Revenue enum: - impressions, spend, clicks, completions, conversions, revenue - name: dimension in: query description: the dimension by which data to be grouped, either campaign, adSet, ad, placement schema: type: string enum: - campaign, adSet, ad, placement - name: client in: query description: the account/client name required: true - name: advertiser in: query description: the advertiser name required: true - name: creatives in: query description: the comma-separated creative ids to filter schema: type: string - name: pixelIds in: query description: the comma-separated pixel ids to filter schema: type: string - name: campaignIds in: query description: the comma-separated Campaign ids to filter schema: type: string - name: adGroups in: query description: the comma-separated AdReady Id & start date (separated by |) combination to filter schema: type: string - name: startDate in: query description: the start date required: true example: '2023-06-08' - name: endDate in: query description: the end date required: true example: '2023-06-14' responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponseListKeyValueDouble' /api/ac/advertisers/{advertiserId}/solutions/{solutionId}/social/measurements/daily: get: tags: - Social Solution - 'App Console: Social' summary: Get daily measurements for Social solution description: Get daily measurements for Social solution operationId: getDailyMeasurement parameters: - name: advertiserId in: path description: the advertiser id required: true - name: solutionId in: path description: the solution id required: true - name: measurement in: query description: the measurement to be returned, either Impressions / Spend / Clicks / Video Completions / Conversions / Revenue schema: type: string enum: - impressions, spend, clicks, completions, conversions, revenue - name: client in: query description: the account/client name required: true - name: advertiser in: query description: the advertiser name required: true - name: creatives in: query description: the comma-separated creative ids to filter schema: type: string - name: pixelIds in: query description: the comma-separated pixel ids to filter schema: type: string - name: campaignIds in: query description: the comma-separated Campaign ids to filter schema: type: string - name: adGroups in: query description: the comma-separated AdReady Id & start date (separated by |) combination to filter schema: type: string - name: startDate in: query description: the start date required: true example: '2023-06-08' - name: endDate in: query description: the end date required: true example: '2023-06-14' - name: compareStartDate in: query description: the compare start date example: '2023-06-01' - name: compareEndDate in: query description: the compare end date example: '2023-06-07' responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponseDailySummary' /api/ac/advertisers/{advertiserId}/solutions/{solutionId}/search/top_performers: get: tags: - 'App Console: Search' summary: Get dimension-wise top performing metrics for Search solution operationId: getSearchTopPerformers parameters: - name: advertiserId in: path description: The advertiser id required: true schema: type: integer - name: solutionId in: path description: The solution id required: true schema: type: integer - name: dimension in: query description: 'The dimensions (comma-separated) by which data is grouped: campaign, adgroup, country, state, dma, zipcode, county, city, ad, adType, keyword, matchType' schema: type: string default: ad,adType enum: - campaign - adgroup - country - state - dma - zipcode - county - city - ad - adType - keyword - matchType - name: client in: query description: The account/client name required: true schema: type: string - name: advertiser in: query description: The advertiser name required: true schema: type: string - name: keywords in: query description: Comma-separated keywords to filter schema: type: string - name: creatives in: query description: Comma-separated creative ids to filter schema: type: string - name: campaignIds in: query description: Comma-separated Campaign ids to filter schema: type: string - name: adGroups in: query description: Comma-separated AdReady Id & start date (separated by |) combinations schema: type: string - name: startDate in: query description: The start date required: true schema: type: string format: date example: '2023-06-08' - name: endDate in: query description: The end date required: true schema: type: string format: date example: '2023-06-14' responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponseListSearchTopPerformer' /api/ac/advertisers/{advertiserId}/solutions/{solutionId}/search/summary: get: tags: - 'App Console: Search' summary: Get summary for Search solution operationId: getSearchSummary parameters: - name: advertiserId in: path description: The advertiser id required: true schema: type: integer - name: solutionId in: path description: The solution id required: true schema: type: integer - name: client in: query description: The account/client name required: true schema: type: string - name: advertiser in: query description: The advertiser name required: true schema: type: string - name: keywords in: query description: The keywords to filter (comma-separated) schema: type: string - name: creatives in: query description: Comma-separated creative ids to filter schema: type: string - name: campaignIds in: query description: Comma-separated Campaign ids to filter schema: type: string - name: adGroups in: query description: Comma-separated AdReady Id & start date (separated by |) combinations to filter schema: type: string - name: startDate in: query description: The start date required: true schema: type: string format: date example: '2023-06-08' - name: endDate in: query description: The end date required: true schema: type: string format: date example: '2023-06-14' - name: compareStartDate in: query description: The compare start date schema: type: string format: date example: '2023-06-01' - name: compareEndDate in: query description: The compare end date schema: type: string format: date example: '2023-06-07' responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponseSearchSummary' /api/ac/advertisers/{advertiserId}/solutions/{solutionId}/search/reports: get: tags: - 'App Console: Search' summary: Get dimension-wise measurements & metrics report for Search solution operationId: getSearchPerformanceReport parameters: - name: advertiserId in: path description: The advertiser id required: true schema: type: integer - name: solutionId in: path description: The solution id required: true schema: type: integer - name: dimension in: query description: 'The dimension by which data to be grouped: overall, day, campaign, adgroup, country, state, dma, zipcode, county, city, ad, adType, keyword, matchType' schema: type: string default: overall enum: - overall - day - campaign - adgroup - country - state - dma - zipcode - county - city - ad - adType - keyword - matchType - name: client in: query description: The account/client name required: true schema: type: string - name: advertiser in: query description: The advertiser name required: true schema: type: string - name: keywords in: query description: The keywords to filter (comma-separated) schema: type: string - name: creatives in: query description: Comma-separated creative ids to filter schema: type: string - name: campaignIds in: query description: Comma-separated Campaign ids to filter schema: type: string - name: adGroups in: query description: Comma-separated AdReady Id & start date (separated by |) combination to filter schema: type: string - name: startDate in: query description: The start date required: true schema: type: string format: date example: '2023-06-08' - name: endDate in: query description: The end date required: true schema: type: string format: date example: '2023-06-14' responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponseListSearchMetricsByDimension' /api/ac/advertisers/{advertiserId}/solutions/{solutionId}/search/performance: get: tags: - 'App Console: Search' summary: Get dimension-wise measurements & metrics for Search solution operationId: getSearchPerformance parameters: - name: advertiserId in: path description: The advertiser id required: true schema: type: integer - name: solutionId in: path description: The solution id required: true schema: type: integer - name: dimension in: query description: 'The dimension by which data to be grouped: campaign, adgroup, country, state, dma, zipcode, county, city, ad, adType, keyword, matchType' schema: type: string default: ad enum: - campaign - adgroup - country - state - dma - zipcode - county - city - ad - adType - keyword - matchType - name: client in: query description: The account/client name required: true schema: type: string - name: advertiser in: query description: The advertiser name required: true schema: type: string - name: keywords in: query description: The keywords to filter (comma-separated) schema: type: string - name: creatives in: query description: Comma-separated creative ids to filter schema: type: string - name: campaignIds in: query description: Comma-separated Campaign ids to filter schema: type: string - name: adGroups in: query description: Comma-separated AdReady Id & start date (separated by |) combination to filter schema: type: string - name: startDate in: query description: The start date required: true schema: type: string format: date example: '2023-06-08' - name: endDate in: query description: The end date required: true schema: type: string format: date example: '2023-06-14' responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponseListSearchMetricsByDimension' /api/ac/advertisers/{advertiserId}/solutions/{solutionId}/search/metrics/distribution: get: tags: - 'App Console: Search' summary: Get dimension-wise metrics for Search solution operationId: getSearchMetricsDistribution parameters: - name: advertiserId in: path description: The advertiser id required: true schema: type: integer - name: solutionId in: path description: The solution id required: true schema: type: integer - name: metric in: query description: 'The metric to be returned: ctr, cpc, cpa, roas' schema: type: string default: ctr enum: - ctr - cpc - cpa - roas - name: dimension in: query description: 'The dimension by which data is grouped: campaign, adgroup, country, state, dma, zipcode, county, city, ad, adType, keyword, matchType' schema: type: string default: ad enum: - campaign - adgroup - country - state - dma - zipcode - county - city - ad - adType - keyword - matchType - name: client in: query description: The account/client name required: true schema: type: string - name: advertiser in: query description: The advertiser name required: true schema: type: string - name: keywords in: query description: Comma-separated keywords to filter schema: type: string - name: creatives in: query description: Comma-separated creative ids to filter schema: type: string - name: pixelIds in: query description: Comma-separated pixel ids to filter schema: type: string - name: campaignIds in: query description: Comma-separated Campaign ids to filter schema: type: string - name: adGroups in: query description: Comma-separated AdReady Id & start date (separated by |) combinations schema: type: string - name: startDate in: query description: The start date required: true schema: type: string format: date example: '2023-06-08' - name: endDate in: query description: The end date required: true schema: type: string format: date example: '2023-06-14' responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponseListKeyValueDouble' /api/ac/advertisers/{advertiserId}/solutions/{solutionId}/search/metrics/daily: get: tags: - 'App Console: Search' summary: Get daily metrics for Search solution operationId: getDailyMetric_1 parameters: - name: advertiserId in: path description: The advertiser id required: true schema: type: integer - name: solutionId in: path description: The solution id required: true schema: type: integer - name: metric in: query description: The metric like ctr / cpc / cpa / roas schema: type: string default: ctr enum: - ctr - cpc - cpa - roas - name: client in: query description: The account/client name required: true schema: type: string - name: advertiser in: query description: The advertiser name required: true schema: type: string - name: keywords in: query description: Comma-separated keywords to filter schema: type: string - name: creatives in: query description: Comma-separated creative ids to filter schema: type: string - name: pixelIds in: query description: Comma-separated pixel ids to filter schema: type: string - name: campaignIds in: query description: Comma-separated campaign ids to filter schema: type: string - name: adGroups in: query description: Comma-separated AdReady Id & start date (separated by |) combinations schema: type: string - name: startDate in: query description: The start date required: true schema: type: string format: date example: '2023-06-08' - name: endDate in: query description: The end date required: true schema: type: string format: date example: '2023-06-14' - name: compareStartDate in: query description: The compare start date schema: type: string format: date example: '2023-06-01' - name: compareEndDate in: query description: The compare end date schema: type: string format: date example: '2023-06-07' responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponseDailySearchSummary' /api/ac/advertisers/{advertiserId}/solutions/{solutionId}/search/measurements/distribution: get: tags: - 'App Console: Search' summary: Get dimension-wise measurements for Search solution operationId: getSearchMeasurementsDistribution parameters: - name: advertiserId in: path description: The advertiser id required: true schema: type: integer - name: solutionId in: path description: The solution id required: true schema: type: integer - name: measurement in: query description: 'The measurement to be returned: impressions / spend / clicks / conversions / revenue' schema: type: string default: impressions enum: - impressions - spend - clicks - conversions - revenue - name: dimension in: query description: 'The dimension by which data is grouped: campaign, adgroup, country, state, dma, zipcode, county, city, ad, adType, keyword, matchType' schema: type: string default: ad enum: - campaign - adgroup - country - state - dma - zipcode - county - city - ad - adType - keyword - matchType - name: client in: query description: The account/client name required: true schema: type: string - name: advertiser in: query description: The advertiser name required: true schema: type: string - name: keywords in: query description: The keywords to filter (comma-separated) schema: type: string - name: creatives in: query description: Comma-separated creative ids to filter schema: type: string - name: pixelIds in: query description: Comma-separated pixel ids to filter schema: type: string - name: campaignIds in: query description: Comma-separated Campaign ids to filter schema: type: string - name: adGroups in: query description: Comma-separated AdReady Id & start date (separated by |) combination to filter schema: type: string - name: startDate in: query description: The start date required: true schema: type: string format: date example: '2023-06-08' - name: endDate in: query description: The end date required: true schema: type: string format: date example: '2023-06-14' responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponseListKeyValueDouble' /api/ac/advertisers/{advertiserId}/solutions/{solutionId}/search/measurements/daily: get: tags: - 'App Console: Search' summary: Get daily measurements for Search solution operationId: getDailyMeasurement_1 parameters: - name: advertiserId in: path description: The advertiser id required: true schema: type: integer - name: solutionId in: path description: The solution id required: true schema: type: integer - name: measurement in: query description: 'The measurement to be returned: impressions / spend / clicks / conversions / revenue' schema: type: string default: impressions enum: - impressions - spend - clicks - conversions - revenue - name: client in: query description: The account/client name required: true schema: type: string - name: advertiser in: query description: The advertiser name required: true schema: type: string - name: keywords in: query description: Comma-separated keywords to filter schema: type: string - name: creatives in: query description: Comma-separated creative ids to filter schema: type: string - name: pixelIds in: query description: Comma-separated pixel ids to filter schema: type: string - name: campaignIds in: query description: Comma-separated Campaign ids to filter schema: type: string - name: adGroups in: query description: Comma-separated AdReady Id & start date (separated by |) combination to filter schema: type: string - name: startDate in: query description: The start date required: true schema: type: string format: date example: '2023-06-08' - name: endDate in: query description: The end date required: true schema: type: string format: date example: '2023-06-14' - name: compareStartDate in: query description: The compare start date schema: type: string format: date example: '2023-06-01' - name: compareEndDate in: query description: The compare end date schema: type: string format: date example: '2023-06-07' responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponseDailySummary' /api/ac/advertisers/{advertiserId}/solutions/{solutionId}/convergedtv/summary: get: tags: - 'App Console: Converged TV' summary: Get something for Social solution description: Get something for Social solution operationId: getCvgdTVSummary parameters: - name: solutionId in: path description: the solution id required: true schema: type: integer example: 7 - name: advertiserId in: path description: the advertiser id required: true schema: type: integer example: 674 - name: advertiser in: query description: the advertiser name required: true example: Jersey Mike's Subs - name: client in: query description: the account/client name required: true example: Jersey Mike's Subs - name: campaignIds in: query description: the CSV Campaign ids to filter on style: form - name: adGroups in: query description: the CSV AdReady Ids to filter on style: form - name: startDate in: query description: the start date required: true example: '2024-01-01' - name: endDate in: query description: the end date required: true example: '2024-04-15' - name: conversionWindow in: query description: the conversion window in hours schema: type: integer default: 0 responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: Successful response content: '*/*': schema: $ref: '#/components/schemas/ApiResponseCTVReachAndOverlap' /api/ac/advertisers/{advertiserId}/solutions/{solutionId}/brand/top_performers: get: tags: - 'App Console: Brand' summary: Get dimension-wise top performing metrics for Performance Brand solution description: Returns top-performing metrics grouped by specified dimensions operationId: getBrandTopPerformers parameters: - name: advertiserId in: path description: The advertiser ID required: true schema: type: integer - name: solutionId in: path description: The solution ID required: true schema: type: integer - name: dimension in: query description: Comma-separated dimensions to group by (e.g. creative,audience) required: false style: form explode: false schema: type: array items: type: string enum: - campaign - adgroup - mediatype - creative - audience - country - state - dma - device - name: client in: query description: The account/client name required: true schema: type: string - name: advertiser in: query description: The advertiser name required: true schema: type: string - name: mediaTypes in: query description: Comma-separated media types (e.g. Display Retargeting, OTT, etc.) style: form explode: false schema: type: array items: type: string - name: creatives in: query description: Comma-separated creative IDs style: form explode: false schema: type: array items: type: string - name: audiences in: query description: Comma-separated audience names style: form explode: false schema: type: array items: type: string - name: campaignIds in: query description: Comma-separated campaign IDs style: form explode: false schema: type: array items: type: string - name: adGroups in: query description: Comma-separated AdReady ID and start date (| separated) style: form explode: false schema: type: array items: type: string - name: startDate in: query description: Start date required: true schema: type: string format: date example: '2023-06-08' - name: endDate in: query description: End date required: true schema: type: string format: date example: '2023-06-14' responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponseListBrandTopPerformer' /api/ac/advertisers/{advertiserId}/solutions/{solutionId}/brand/summary: get: tags: - 'App Console: Brand' summary: Get summary for Performance Brand solution description: Get summary for Performance Brand solution operationId: getBrandSummary parameters: - name: advertiserId in: path description: the advertiser id required: true schema: type: integer - name: solutionId in: path description: the solution id required: true schema: type: integer - name: client in: query description: the account/client name required: true schema: type: string - name: advertiser in: query description: the advertiser name required: true schema: type: string - name: mediaTypes in: query description: the media types to filter (e.g. Display Retargeting, OTT, etc.) style: form explode: false schema: type: array items: type: string - name: creatives in: query description: the comma-separated creative ids to filter style: form explode: false schema: type: array items: type: string - name: audiences in: query description: the comma-separated audience names to filter style: form explode: false schema: type: array items: type: string - name: pixelIds in: query description: the comma-separated pixel ids to filter style: form explode: false schema: type: array items: type: string - name: campaignIds in: query description: the comma-separated Campaign ids to filter style: form explode: false schema: type: array items: type: string - name: adGroups in: query description: the comma-separated AdReady Id & start date (separated by |) combination to filter style: form explode: false schema: type: array items: type: string - name: startDate in: query description: the start date required: true schema: type: string format: date example: '2023-06-08' - name: endDate in: query description: the end date required: true schema: type: string format: date example: '2023-06-14' - name: compareStartDate in: query description: the compare start date schema: type: string format: date example: '2023-06-01' - name: compareEndDate in: query description: the compare end date schema: type: string format: date example: '2023-06-07' responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: Success content: '*/*': schema: $ref: '#/components/schemas/ApiResponseBrandSummary' /api/ac/advertisers/{advertiserId}/solutions/{solutionId}/brand/performance: get: tags: - 'App Console: Brand' summary: Get dimension-wise measurements & metrics for Performance Brand solution description: 'Returns grouped data by dimension: campaign, adgroup, mediatype, creative, audience, country, state, dma, or device.' operationId: getBrandPerformance parameters: - name: advertiserId in: path description: The advertiser id required: true schema: type: integer - name: solutionId in: path description: The solution id required: true schema: type: integer - name: dimension in: query description: The dimension to group by required: false schema: type: string default: mediatype enum: - campaign - adgroup - mediatype - creative - audience - country - state - dma - device - name: client in: query description: The account/client name required: true - name: advertiser in: query description: The advertiser name required: true - name: mediaTypes in: query description: Comma-separated media types (e.g. Display Retargeting, OTT) schema: type: array items: type: string - name: creatives in: query description: Comma-separated creative ids schema: type: array items: type: string - name: audiences in: query description: Comma-separated audience names schema: type: array items: type: string - name: campaignIds in: query description: Comma-separated campaign ids schema: type: array items: type: string - name: adGroups in: query description: Comma-separated AdReady Id & start date (separated by |) schema: type: array items: type: string - name: startDate in: query description: Start date (e.g. 2023-06-08) required: true schema: type: string - name: endDate in: query description: End date (e.g. 2023-06-14) required: true schema: type: string - name: standardRequest in: query required: true schema: $ref: '#/components/schemas/StandardApiRequest' responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponseListBrandMetricsByDimension' /api/ac/advertisers/{advertiserId}/solutions/{solutionId}/brand/metrics/distribution: get: tags: - 'App Console: Brand' summary: Get dimension-wise metrics for Performance Brand solution description: Returns grouped metrics (e.g., CTR, CPC) by dimension (e.g., campaign, adgroup) operationId: getBrandMetricsDistribution parameters: - name: advertiserId in: path description: The advertiser ID required: true schema: type: integer - name: solutionId in: path description: The solution ID required: true schema: type: integer - name: metric in: query description: Metric to return required: false schema: type: string default: ctr enum: - ctr - cpc - vcr - cpcv - cpa - name: dimension in: query description: Group by dimension required: false schema: type: string default: mediatype enum: - campaign - adgroup - mediatype - creative - audience - country - state - dma - device - name: client in: query description: The account/client name required: true schema: type: string - name: advertiser in: query description: The advertiser name required: true schema: type: string - name: mediaTypes in: query description: Comma-separated media types (e.g. Display Retargeting, OTT, etc.) schema: type: array items: type: string - name: creatives in: query description: Comma-separated creative IDs schema: type: array items: type: string - name: audiences in: query description: Comma-separated audience names schema: type: array items: type: string - name: pixelIds in: query description: Comma-separated pixel IDs schema: type: array items: type: string - name: campaignIds in: query description: Comma-separated campaign IDs schema: type: array items: type: string - name: adGroups in: query description: Comma-separated AdReady ID & start date (separated by |) schema: type: array items: type: string - name: startDate in: query description: The start date required: true schema: type: string format: date example: '2023-06-08' - name: endDate in: query description: The end date required: true schema: type: string format: date example: '2023-06-14' responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponseListKeyValueDouble' /api/ac/advertisers/{advertiserId}/solutions/{solutionId}/brand/metrics/daily: get: tags: - 'App Console: Brand' summary: Get daily metrics for Performance Brand solution description: Retrieve daily metrics filtered by various criteria operationId: getDailyMetric_2 parameters: - name: advertiserId in: path description: The advertiser id required: true schema: type: integer - name: solutionId in: path description: The solution id required: true schema: type: integer - name: metric in: query description: The metric like ctr or vcr required: false schema: type: string default: ctr enum: - ctr - vcr - name: client in: query description: The account/client name required: true schema: type: string - name: advertiser in: query description: The advertiser name required: true schema: type: string - name: mediaTypes in: query description: The media types to filter (e.g. Display Retargeting, OTT, etc.) style: form explode: false schema: type: array items: type: string - name: creatives in: query description: Comma-separated creative ids to filter style: form explode: false schema: type: array items: type: string - name: audiences in: query description: Comma-separated audience names to filter style: form explode: false schema: type: array items: type: string - name: pixelIds in: query description: Comma-separated pixel ids to filter style: form explode: false schema: type: array items: type: string - name: campaignIds in: query description: Comma-separated Campaign ids to filter style: form explode: false schema: type: array items: type: string - name: adGroups in: query description: Comma-separated AdReady Id & start date (separated by |) combination to filter style: form explode: false schema: type: array items: type: string - name: startDate in: query description: The start date required: true schema: type: string format: date example: '2023-06-08' - name: endDate in: query description: The end date required: true schema: type: string format: date example: '2023-06-14' - name: compareStartDate in: query description: The compare start date schema: type: string format: date example: '2023-06-01' - name: compareEndDate in: query description: The compare end date schema: type: string format: date example: '2023-06-07' responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponseDailyBrandSummary' /api/ac/advertisers/{advertiserId}/solutions/{solutionId}/brand/measurements/distribution: get: tags: - 'App Console: Brand' summary: Get dimension-wise measurements for Performance Brand solution description: Returns grouped measurement data (e.g. impressions, spend) by a specified dimension. operationId: getBrandMeasurementsDistribution parameters: - name: advertiserId in: path description: The advertiser id required: true schema: type: integer - name: solutionId in: path description: The solution id required: true schema: type: integer - name: measurement in: query description: Measurement to return required: false schema: type: string default: impressions enum: - impressions - spend - clicks - completions - conversions - name: dimension in: query description: Group by dimension required: false schema: type: string default: mediatype enum: - campaign - adgroup - mediatype - creative - audience - country - state - dma - device - name: client in: query description: The account/client name required: true - name: advertiser in: query description: The advertiser name required: true - name: mediaTypes in: query description: Comma-separated media types (e.g. Display Retargeting, OTT) schema: type: array items: type: string - name: creatives in: query description: Comma-separated creative ids schema: type: array items: type: string - name: audiences in: query description: Comma-separated audience names schema: type: array items: type: string - name: pixelIds in: query description: Comma-separated pixel ids schema: type: array items: type: string - name: campaignIds in: query description: Comma-separated campaign ids schema: type: array items: type: string - name: adGroups in: query description: Comma-separated AdReady Id & start date (separated by |) schema: type: array items: type: string - name: startDate in: query description: Start date required: true schema: type: string example: '2023-06-08' - name: endDate in: query description: End date required: true schema: type: string example: '2023-06-14' - name: standardRequest in: query required: true schema: $ref: '#/components/schemas/StandardApiRequest' responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponseListKeyValueDouble' /api/ac/advertisers/{advertiserId}/solutions/{solutionId}/brand/measurements/daily: get: tags: - 'App Console: Brand' summary: Get daily measurements for Performance Brand solution description: Returns daily measurement data filtered by various criteria operationId: getDailyMeasurement_2 parameters: - name: advertiserId in: path description: The advertiser id required: true schema: type: integer - name: solutionId in: path description: The solution id required: true schema: type: integer - name: measurement in: query description: The measurement to be returned, either Impressions / Spend / Clicks / Video Completions / Conversions required: false schema: type: string default: impressions enum: - impressions - spend - clicks - completions - conversions - name: client in: query description: The account/client name required: true schema: type: string - name: advertiser in: query description: The advertiser name required: true schema: type: string - name: mediaTypes in: query description: The media types to filter (e.g. Display Retargeting, OTT, etc.) style: form explode: false schema: type: array items: type: string - name: creatives in: query description: Comma-separated creative ids to filter style: form explode: false schema: type: array items: type: string - name: audiences in: query description: Comma-separated audience names to filter style: form explode: false schema: type: array items: type: string - name: pixelIds in: query description: Comma-separated pixel ids to filter style: form explode: false schema: type: array items: type: string - name: campaignIds in: query description: Comma-separated Campaign ids to filter style: form explode: false schema: type: array items: type: string - name: adGroups in: query description: Comma-separated AdReady Id & start date (separated by |) combination to filter style: form explode: false schema: type: array items: type: string - name: startDate in: query description: The start date required: true schema: type: string format: date example: '2023-06-08' - name: endDate in: query description: The end date required: true schema: type: string format: date example: '2023-06-14' - name: compareStartDate in: query description: The compare start date schema: type: string format: date example: '2023-06-01' - name: compareEndDate in: query description: The compare end date schema: type: string format: date example: '2023-06-07' responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponseDailySummary' /api/ac/advertisers/{advertiserId}/reportTemplate/{reportTemplateId}/reportGenerationLogs: get: tags: - 'App Console: Report Template Management' operationId: getReportGenerationLogs parameters: - name: reportTemplateId in: path required: true schema: type: integer format: int32 - name: advertiserId in: path required: true schema: type: integer format: int32 - name: page in: query required: false schema: type: integer format: int32 default: 0 - name: size in: query required: false schema: type: integer format: int32 default: 5 responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponsePageResponseReportGenerationLog' /api/ac/advertisers/{advertiserId}/reportTemplate/getUserSavedReports: get: tags: - 'App Console: Report Template Management' operationId: getReportTemplateByUserId parameters: - name: advertiserId in: path required: true schema: type: integer format: int32 responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponseListReportTemplateResponseDto' /api/ac/advertisers/{advertiserId}/pixels: get: tags: - App Console summary: Get conversion pixels for an advertiser as per the solution id operationId: fetchConversionPixels parameters: - name: advertiserId in: path description: the advertiser id required: true schema: type: integer - name: solutionId in: query description: the solution id schema: type: integer default: 0 - name: client in: query description: the account/client name required: true schema: type: string - name: advertiser in: query description: the advertiser name required: true schema: type: string - name: campaignIds in: query description: the comma-separated Campaign ids to filter schema: type: string - name: adGroups in: query description: the comma-separated AdReady Id & start date (separated by |) combination to filter schema: type: string - name: startDate in: query description: the start date schema: type: string example: '2023-06-08' - name: endDate in: query description: the end date schema: type: string example: '2023-06-14' responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: successful operation content: application/json: {} /api/ac/advertisers/{advertiserId}/mediatypes: get: tags: - App Console summary: Get mediatypes for an advertiser as per the solution id operationId: fetchMediaTypes parameters: - name: advertiserId in: path description: the advertiser id required: true schema: type: integer format: int32 - name: solutionId in: query description: the solution id schema: type: integer format: int32 default: 0 - name: client in: query description: the account/client name required: true schema: type: string - name: advertiser in: query description: the advertiser name required: true schema: type: string - name: campaignIds in: query description: the comma-separated Campaign ids to filter allowEmptyValue: true schema: type: string - name: adGroups in: query description: the comma-separated AdReady Id & start date (separated by |) combination to filter allowEmptyValue: true schema: type: string - name: startDate in: query description: the start date schema: type: string example: '2023-06-08' - name: endDate in: query description: the end date schema: type: string example: '2023-06-14' responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: List of solutions returned content: application/json: {} /api/ac/advertisers/{advertiserId}/matchtypes: get: tags: - App Console - App Console Helper summary: Get match types for an advertiser as per the solution id description: Fetch match types for an advertiser as per the solution id operationId: fetchMatchTypes parameters: - name: advertiserId in: path description: the advertiser id required: true schema: type: integer format: int32 - name: solutionId in: query description: the solution id schema: type: integer format: int32 default: 0 - name: client in: query description: the account/client name required: true schema: type: string - name: advertiser in: query description: the advertiser name required: true schema: type: string - name: campaignIds in: query description: the comma-separated Campaign ids to filter allowEmptyValue: true schema: type: string - name: adGroups in: query description: the comma-separated AdReady Id & start date (separated by |) combination to filter allowEmptyValue: true schema: type: string - name: startDate in: query description: the start date schema: type: string example: '2023-06-08' - name: endDate in: query description: the end date schema: type: string example: '2023-06-14' responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponseListString' /api/ac/advertisers/{advertiserId}/keywords: get: tags: - App Console - App Console Helper summary: Get keywords for an advertiser as per the solution id description: Fetch keywords for an advertiser as per the solution id operationId: fetchKeywords parameters: - name: advertiserId in: path description: the advertiser id required: true schema: type: integer format: int32 - name: solutionId in: query description: the solution id schema: type: integer format: int32 default: 0 - name: client in: query description: the account/client name required: true schema: type: string - name: advertiser in: query description: the advertiser name required: true schema: type: string - name: campaignIds in: query description: the comma-separated Campaign ids to filter allowEmptyValue: true schema: type: string - name: adGroups in: query description: the comma-separated AdReady Id & start date (separated by |) combination to filter allowEmptyValue: true schema: type: string - name: startDate in: query description: the start date schema: type: string example: '2023-06-08' - name: endDate in: query description: the end date schema: type: string example: '2023-06-14' responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponseListString' /api/ac/advertisers/{advertiserId}/creatives: get: tags: - App Console - AppConsole summary: Get creatives for an advertiser as per the solution id description: Get creatives for an advertiser as per the solution id operationId: fetchCreatives parameters: - name: advertiserId in: path description: the advertiser id required: true schema: type: integer format: int32 - name: solutionId in: query description: the solution id schema: type: integer format: int32 default: 0 - name: client in: query description: the account/client name required: true schema: type: string - name: advertiser in: query description: the advertiser name required: true schema: type: string - name: campaignIds in: query description: the comma-separated Campaign ids to filter allowEmptyValue: true schema: type: string - name: adGroups in: query description: the comma-separated AdReady Id & start date (separated by |) combination to filter allowEmptyValue: true schema: type: string - name: startDate in: query description: the start date schema: type: string example: '2023-06-08' - name: endDate in: query description: the end date schema: type: string example: '2023-06-14' responses: '400': description: Bad request '200': description: Successful operation content: '*/*': schema: $ref: '#/components/schemas/ApiResponseListKeyValueString' '401': description: Unauthorized content: '*/*': schema: $ref: '#/components/schemas/ApiResponseListKeyValueString' '403': description: Forbidden content: '*/*': schema: $ref: '#/components/schemas/ApiResponseListKeyValueString' '404': description: Resource not found content: '*/*': schema: $ref: '#/components/schemas/ApiResponseListKeyValueString' '500': description: Internal Server Error content: '*/*': schema: $ref: '#/components/schemas/ApiResponseListKeyValueString' /api/ac/advertisers/{advertiserId}/campaigns: get: tags: - App Console summary: Get campaigns for an advertiser as per the solution id operationId: fetchCampaigns parameters: - name: advertiserId in: path description: the advertiser id required: true schema: type: integer format: int32 - name: solutionId in: query description: the solution id schema: type: integer default: 0 - name: startDate in: query description: the start date example: '2023-06-08' - name: endDate in: query description: the end date example: '2023-06-14' responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: application/json: {} /api/ac/advertisers/{advertiserId}/audiences: get: tags: - App Console - App Console Helper summary: Get audiences for an advertiser as per the solution id description: Fetch audiences for an advertiser as per the solution id operationId: fetchAudiences parameters: - name: advertiserId in: path description: the advertiser id required: true schema: type: integer format: int32 - name: solutionId in: query description: the solution id schema: type: integer format: int32 default: 0 - name: client in: query description: the account/client name required: true schema: type: string - name: advertiser in: query description: the advertiser name required: true schema: type: string - name: campaignIds in: query description: the comma-separated Campaign ids to filter allowEmptyValue: true schema: type: string - name: adGroups in: query description: the comma-separated AdReady Id & start date (separated by |) combination to filter allowEmptyValue: true schema: type: string - name: startDate in: query description: the start date schema: type: string example: '2023-06-08' - name: endDate in: query description: the end date schema: type: string example: '2023-06-14' responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponseListString' /api/users/{userId}/removeAdvertiser: delete: tags: - user-controller operationId: removeAdvertiser parameters: - name: userId in: path required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/UserAdvertiser' required: true responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK /api/users/{userId}/removeAccount: delete: tags: - user-controller operationId: removeAccount parameters: - name: userId in: path required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/UserAccount' required: true responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK /api/token/remove: delete: tags: - token-controller operationId: removeJwtToken responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: type: object /api/accounts/{accountId}/removeUser: delete: tags: - account-controller operationId: removeUser parameters: - name: accountId in: path required: true schema: type: integer format: int32 requestBody: content: application/json: schema: $ref: '#/components/schemas/UserAccount' required: true responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK /api/accounts/{accountId}/dropdown/{id}: delete: tags: - account-controller operationId: removeUserFromDropdown parameters: - name: accountId in: path required: true schema: type: integer format: int32 - name: id in: path required: true schema: type: integer format: int64 responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK /api/dmm/placement: get: tags: - dmm-controller operationId: getPlacements parameters: - name: q in: query required: false schema: type: string - name: pageNumber in: query required: false schema: type: integer format: int32 - name: perPage in: query required: false schema: type: integer format: int32 - name: sortKey in: query required: false schema: type: string - name: sortOrder in: query required: false schema: type: string responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponsePageDmmIoPlacementFeedRaw' put: tags: - dmm-controller operationId: getPlacements_2 parameters: - name: q in: query required: false schema: type: string - name: pageNumber in: query required: false schema: type: integer format: int32 - name: perPage in: query required: false schema: type: integer format: int32 - name: sortKey in: query required: false schema: type: string - name: sortOrder in: query required: false schema: type: string responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponsePageDmmIoPlacementFeedRaw' post: tags: - dmm-controller operationId: getPlacements_1 parameters: - name: q in: query required: false schema: type: string - name: pageNumber in: query required: false schema: type: integer format: int32 - name: perPage in: query required: false schema: type: integer format: int32 - name: sortKey in: query required: false schema: type: string - name: sortOrder in: query required: false schema: type: string responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponsePageDmmIoPlacementFeedRaw' delete: tags: - dmm-controller operationId: getPlacements_3 parameters: - name: q in: query required: false schema: type: string - name: pageNumber in: query required: false schema: type: integer format: int32 - name: perPage in: query required: false schema: type: integer format: int32 - name: sortKey in: query required: false schema: type: string - name: sortOrder in: query required: false schema: type: string responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponsePageDmmIoPlacementFeedRaw' options: tags: - dmm-controller operationId: getPlacements_6 parameters: - name: q in: query required: false schema: type: string - name: pageNumber in: query required: false schema: type: integer format: int32 - name: perPage in: query required: false schema: type: integer format: int32 - name: sortKey in: query required: false schema: type: string - name: sortOrder in: query required: false schema: type: string responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponsePageDmmIoPlacementFeedRaw' head: tags: - dmm-controller operationId: getPlacements_5 parameters: - name: q in: query required: false schema: type: string - name: pageNumber in: query required: false schema: type: integer format: int32 - name: perPage in: query required: false schema: type: integer format: int32 - name: sortKey in: query required: false schema: type: string - name: sortOrder in: query required: false schema: type: string responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponsePageDmmIoPlacementFeedRaw' patch: tags: - dmm-controller operationId: getPlacements_4 parameters: - name: q in: query required: false schema: type: string - name: pageNumber in: query required: false schema: type: integer format: int32 - name: perPage in: query required: false schema: type: integer format: int32 - name: sortKey in: query required: false schema: type: string - name: sortOrder in: query required: false schema: type: string responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponsePageDmmIoPlacementFeedRaw' /api/dmm/placementHistory: get: tags: - dmm-controller operationId: getPlacementsHistory parameters: - name: q in: query required: false schema: type: string - name: pageNumber in: query required: false schema: type: integer format: int32 - name: perPage in: query required: false schema: type: integer format: int32 - name: sortKey in: query required: false schema: type: string - name: sortOrder in: query required: false schema: type: string responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponsePageDmmIoPlacementFeedRawHistory' put: tags: - dmm-controller operationId: getPlacementsHistory_2 parameters: - name: q in: query required: false schema: type: string - name: pageNumber in: query required: false schema: type: integer format: int32 - name: perPage in: query required: false schema: type: integer format: int32 - name: sortKey in: query required: false schema: type: string - name: sortOrder in: query required: false schema: type: string responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponsePageDmmIoPlacementFeedRawHistory' post: tags: - dmm-controller operationId: getPlacementsHistory_1 parameters: - name: q in: query required: false schema: type: string - name: pageNumber in: query required: false schema: type: integer format: int32 - name: perPage in: query required: false schema: type: integer format: int32 - name: sortKey in: query required: false schema: type: string - name: sortOrder in: query required: false schema: type: string responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponsePageDmmIoPlacementFeedRawHistory' delete: tags: - dmm-controller operationId: getPlacementsHistory_3 parameters: - name: q in: query required: false schema: type: string - name: pageNumber in: query required: false schema: type: integer format: int32 - name: perPage in: query required: false schema: type: integer format: int32 - name: sortKey in: query required: false schema: type: string - name: sortOrder in: query required: false schema: type: string responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponsePageDmmIoPlacementFeedRawHistory' options: tags: - dmm-controller operationId: getPlacementsHistory_6 parameters: - name: q in: query required: false schema: type: string - name: pageNumber in: query required: false schema: type: integer format: int32 - name: perPage in: query required: false schema: type: integer format: int32 - name: sortKey in: query required: false schema: type: string - name: sortOrder in: query required: false schema: type: string responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponsePageDmmIoPlacementFeedRawHistory' head: tags: - dmm-controller operationId: getPlacementsHistory_5 parameters: - name: q in: query required: false schema: type: string - name: pageNumber in: query required: false schema: type: integer format: int32 - name: perPage in: query required: false schema: type: integer format: int32 - name: sortKey in: query required: false schema: type: string - name: sortOrder in: query required: false schema: type: string responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponsePageDmmIoPlacementFeedRawHistory' patch: tags: - dmm-controller operationId: getPlacementsHistory_4 parameters: - name: q in: query required: false schema: type: string - name: pageNumber in: query required: false schema: type: integer format: int32 - name: perPage in: query required: false schema: type: integer format: int32 - name: sortKey in: query required: false schema: type: string - name: sortOrder in: query required: false schema: type: string responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponsePageDmmIoPlacementFeedRawHistory' /api/dmm/package: get: tags: - dmm-controller operationId: getPackages parameters: - name: q in: query required: false schema: type: string - name: pageNumber in: query required: false schema: type: integer format: int32 - name: perPage in: query required: false schema: type: integer format: int32 - name: sortKey in: query required: false schema: type: string - name: sortOrder in: query required: false schema: type: string responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponsePageDmmIoPackageFeedRaw' put: tags: - dmm-controller operationId: getPackages_2 parameters: - name: q in: query required: false schema: type: string - name: pageNumber in: query required: false schema: type: integer format: int32 - name: perPage in: query required: false schema: type: integer format: int32 - name: sortKey in: query required: false schema: type: string - name: sortOrder in: query required: false schema: type: string responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponsePageDmmIoPackageFeedRaw' post: tags: - dmm-controller operationId: getPackages_1 parameters: - name: q in: query required: false schema: type: string - name: pageNumber in: query required: false schema: type: integer format: int32 - name: perPage in: query required: false schema: type: integer format: int32 - name: sortKey in: query required: false schema: type: string - name: sortOrder in: query required: false schema: type: string responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponsePageDmmIoPackageFeedRaw' delete: tags: - dmm-controller operationId: getPackages_3 parameters: - name: q in: query required: false schema: type: string - name: pageNumber in: query required: false schema: type: integer format: int32 - name: perPage in: query required: false schema: type: integer format: int32 - name: sortKey in: query required: false schema: type: string - name: sortOrder in: query required: false schema: type: string responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponsePageDmmIoPackageFeedRaw' options: tags: - dmm-controller operationId: getPackages_6 parameters: - name: q in: query required: false schema: type: string - name: pageNumber in: query required: false schema: type: integer format: int32 - name: perPage in: query required: false schema: type: integer format: int32 - name: sortKey in: query required: false schema: type: string - name: sortOrder in: query required: false schema: type: string responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponsePageDmmIoPackageFeedRaw' head: tags: - dmm-controller operationId: getPackages_5 parameters: - name: q in: query required: false schema: type: string - name: pageNumber in: query required: false schema: type: integer format: int32 - name: perPage in: query required: false schema: type: integer format: int32 - name: sortKey in: query required: false schema: type: string - name: sortOrder in: query required: false schema: type: string responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponsePageDmmIoPackageFeedRaw' patch: tags: - dmm-controller operationId: getPackages_4 parameters: - name: q in: query required: false schema: type: string - name: pageNumber in: query required: false schema: type: integer format: int32 - name: perPage in: query required: false schema: type: integer format: int32 - name: sortKey in: query required: false schema: type: string - name: sortOrder in: query required: false schema: type: string responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponsePageDmmIoPackageFeedRaw' /api/dmm/packageHistory: get: tags: - dmm-controller operationId: getPackagesHistory parameters: - name: q in: query required: false schema: type: string - name: pageNumber in: query required: false schema: type: integer format: int32 - name: perPage in: query required: false schema: type: integer format: int32 - name: sortKey in: query required: false schema: type: string - name: sortOrder in: query required: false schema: type: string responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponsePageDmmIoPackageFeedRawHistory' put: tags: - dmm-controller operationId: getPackagesHistory_2 parameters: - name: q in: query required: false schema: type: string - name: pageNumber in: query required: false schema: type: integer format: int32 - name: perPage in: query required: false schema: type: integer format: int32 - name: sortKey in: query required: false schema: type: string - name: sortOrder in: query required: false schema: type: string responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponsePageDmmIoPackageFeedRawHistory' post: tags: - dmm-controller operationId: getPackagesHistory_1 parameters: - name: q in: query required: false schema: type: string - name: pageNumber in: query required: false schema: type: integer format: int32 - name: perPage in: query required: false schema: type: integer format: int32 - name: sortKey in: query required: false schema: type: string - name: sortOrder in: query required: false schema: type: string responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponsePageDmmIoPackageFeedRawHistory' delete: tags: - dmm-controller operationId: getPackagesHistory_3 parameters: - name: q in: query required: false schema: type: string - name: pageNumber in: query required: false schema: type: integer format: int32 - name: perPage in: query required: false schema: type: integer format: int32 - name: sortKey in: query required: false schema: type: string - name: sortOrder in: query required: false schema: type: string responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponsePageDmmIoPackageFeedRawHistory' options: tags: - dmm-controller operationId: getPackagesHistory_6 parameters: - name: q in: query required: false schema: type: string - name: pageNumber in: query required: false schema: type: integer format: int32 - name: perPage in: query required: false schema: type: integer format: int32 - name: sortKey in: query required: false schema: type: string - name: sortOrder in: query required: false schema: type: string responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponsePageDmmIoPackageFeedRawHistory' head: tags: - dmm-controller operationId: getPackagesHistory_5 parameters: - name: q in: query required: false schema: type: string - name: pageNumber in: query required: false schema: type: integer format: int32 - name: perPage in: query required: false schema: type: integer format: int32 - name: sortKey in: query required: false schema: type: string - name: sortOrder in: query required: false schema: type: string responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponsePageDmmIoPackageFeedRawHistory' patch: tags: - dmm-controller operationId: getPackagesHistory_4 parameters: - name: q in: query required: false schema: type: string - name: pageNumber in: query required: false schema: type: integer format: int32 - name: perPage in: query required: false schema: type: integer format: int32 - name: sortKey in: query required: false schema: type: string - name: sortOrder in: query required: false schema: type: string responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponsePageDmmIoPackageFeedRawHistory' /api/dmm/campaign: get: tags: - dmm-controller operationId: getCampaigns parameters: - name: q in: query required: false schema: type: string - name: pageNumber in: query required: false schema: type: integer format: int32 - name: perPage in: query required: false schema: type: integer format: int32 - name: sortKey in: query required: false schema: type: string - name: sortOrder in: query required: false schema: type: string responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponsePageDmmIoCampaignFeedRaw' put: tags: - dmm-controller operationId: getCampaigns_2 parameters: - name: q in: query required: false schema: type: string - name: pageNumber in: query required: false schema: type: integer format: int32 - name: perPage in: query required: false schema: type: integer format: int32 - name: sortKey in: query required: false schema: type: string - name: sortOrder in: query required: false schema: type: string responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponsePageDmmIoCampaignFeedRaw' post: tags: - dmm-controller operationId: getCampaigns_1 parameters: - name: q in: query required: false schema: type: string - name: pageNumber in: query required: false schema: type: integer format: int32 - name: perPage in: query required: false schema: type: integer format: int32 - name: sortKey in: query required: false schema: type: string - name: sortOrder in: query required: false schema: type: string responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponsePageDmmIoCampaignFeedRaw' delete: tags: - dmm-controller operationId: getCampaigns_3 parameters: - name: q in: query required: false schema: type: string - name: pageNumber in: query required: false schema: type: integer format: int32 - name: perPage in: query required: false schema: type: integer format: int32 - name: sortKey in: query required: false schema: type: string - name: sortOrder in: query required: false schema: type: string responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponsePageDmmIoCampaignFeedRaw' options: tags: - dmm-controller operationId: getCampaigns_6 parameters: - name: q in: query required: false schema: type: string - name: pageNumber in: query required: false schema: type: integer format: int32 - name: perPage in: query required: false schema: type: integer format: int32 - name: sortKey in: query required: false schema: type: string - name: sortOrder in: query required: false schema: type: string responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponsePageDmmIoCampaignFeedRaw' head: tags: - dmm-controller operationId: getCampaigns_5 parameters: - name: q in: query required: false schema: type: string - name: pageNumber in: query required: false schema: type: integer format: int32 - name: perPage in: query required: false schema: type: integer format: int32 - name: sortKey in: query required: false schema: type: string - name: sortOrder in: query required: false schema: type: string responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponsePageDmmIoCampaignFeedRaw' patch: tags: - dmm-controller operationId: getCampaigns_4 parameters: - name: q in: query required: false schema: type: string - name: pageNumber in: query required: false schema: type: integer format: int32 - name: perPage in: query required: false schema: type: integer format: int32 - name: sortKey in: query required: false schema: type: string - name: sortOrder in: query required: false schema: type: string responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponsePageDmmIoCampaignFeedRaw' /api/dmm/campaignHistory: get: tags: - dmm-controller operationId: getCampaignsHistory parameters: - name: q in: query required: false schema: type: string - name: pageNumber in: query required: false schema: type: integer format: int32 - name: perPage in: query required: false schema: type: integer format: int32 - name: sortKey in: query required: false schema: type: string - name: sortOrder in: query required: false schema: type: string responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponsePageDmmIoCampaignFeedRawHistory' put: tags: - dmm-controller operationId: getCampaignsHistory_2 parameters: - name: q in: query required: false schema: type: string - name: pageNumber in: query required: false schema: type: integer format: int32 - name: perPage in: query required: false schema: type: integer format: int32 - name: sortKey in: query required: false schema: type: string - name: sortOrder in: query required: false schema: type: string responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponsePageDmmIoCampaignFeedRawHistory' post: tags: - dmm-controller operationId: getCampaignsHistory_1 parameters: - name: q in: query required: false schema: type: string - name: pageNumber in: query required: false schema: type: integer format: int32 - name: perPage in: query required: false schema: type: integer format: int32 - name: sortKey in: query required: false schema: type: string - name: sortOrder in: query required: false schema: type: string responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponsePageDmmIoCampaignFeedRawHistory' delete: tags: - dmm-controller operationId: getCampaignsHistory_3 parameters: - name: q in: query required: false schema: type: string - name: pageNumber in: query required: false schema: type: integer format: int32 - name: perPage in: query required: false schema: type: integer format: int32 - name: sortKey in: query required: false schema: type: string - name: sortOrder in: query required: false schema: type: string responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponsePageDmmIoCampaignFeedRawHistory' options: tags: - dmm-controller operationId: getCampaignsHistory_6 parameters: - name: q in: query required: false schema: type: string - name: pageNumber in: query required: false schema: type: integer format: int32 - name: perPage in: query required: false schema: type: integer format: int32 - name: sortKey in: query required: false schema: type: string - name: sortOrder in: query required: false schema: type: string responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponsePageDmmIoCampaignFeedRawHistory' head: tags: - dmm-controller operationId: getCampaignsHistory_5 parameters: - name: q in: query required: false schema: type: string - name: pageNumber in: query required: false schema: type: integer format: int32 - name: perPage in: query required: false schema: type: integer format: int32 - name: sortKey in: query required: false schema: type: string - name: sortOrder in: query required: false schema: type: string responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponsePageDmmIoCampaignFeedRawHistory' patch: tags: - dmm-controller operationId: getCampaignsHistory_4 parameters: - name: q in: query required: false schema: type: string - name: pageNumber in: query required: false schema: type: integer format: int32 - name: perPage in: query required: false schema: type: integer format: int32 - name: sortKey in: query required: false schema: type: string - name: sortOrder in: query required: false schema: type: string responses: '400': description: Bad Request content: '*/*': schema: type: object '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ApiResponsePageDmmIoCampaignFeedRawHistory' components: schemas: WhitelabelDomain: type: object properties: apiDomain: type: string appType: type: string enum: - flip - app demoDomainName: type: string domainName: type: string domainType: type: string enum: - std_subdomain - fqdn flipEmbeddedDomain: type: string orgId: type: integer format: int32 ApiResponseWhitelabelDomain: type: object properties: status: type: integer format: int32 message: type: string result: $ref: '#/components/schemas/WhitelabelDomain' UserAdvertiser: type: object properties: advertiserId: type: integer format: int32 userId: type: integer format: int64 UserAccount: type: object properties: accountId: type: integer format: int32 userId: type: integer format: int64 ApiResponse: type: object properties: status: type: integer format: int32 message: type: string result: {} Permission: type: object properties: entity: type: string enum: - User - Account - Advertiser - RateCard - Organization id: type: integer format: int32 privilege: type: string enum: - All - Read - Create - Delete Role: type: object properties: canCreateRole: type: array items: type: string id: type: integer format: int32 name: type: string permissions: type: array items: $ref: '#/components/schemas/Permission' uniqueItems: true User: type: object properties: acceptedTos: type: boolean accountIds: type: array items: type: integer format: int32 allowedDomains: type: string createdAt: type: string format: date-time createdBy: type: string deletedAt: type: string format: date-time email: type: string emailVerificationDate: type: string format: date-time emailVerified: type: boolean enabled: type: boolean flags: type: array items: type: string id: type: integer format: int64 lastLogin: type: string format: date-time loginCount: type: integer format: int32 organizationId: type: integer format: int32 password: type: string phone: type: string promptLibrary: type: string provider: type: string enum: - GOOGLE - DR_SSO - LOCAL - NONE role: $ref: '#/components/schemas/Role' team: type: boolean teamUserIds: type: array items: type: integer format: int64 teams: type: array items: $ref: '#/components/schemas/User' uniqueItems: true updatedAt: type: string format: date-time updatedBy: type: string userApplications: type: array items: $ref: '#/components/schemas/UserApplication' uniqueItems: true userName: type: string verificationMailSent: type: boolean UserApplication: type: object properties: applicationId: type: integer format: int32 id: type: integer format: int32 ApiResponseUserDTO: type: object properties: status: type: integer format: int32 message: type: string result: $ref: '#/components/schemas/UserDTO' UserDTO: type: object properties: acceptedTos: type: boolean accountIds: type: array items: type: integer format: int32 allowedDomains: type: string createdAt: type: string format: date-time createdBy: type: string deletedAt: type: string format: date-time email: type: string emailVerificationDate: type: string format: date-time emailVerified: type: boolean enabled: type: boolean flags: type: array items: type: string id: type: integer format: int64 lastLogin: type: string format: date-time loginCount: type: integer format: int32 organizationId: type: integer format: int32 phone: type: string promptLibrary: type: string provider: type: string enum: - GOOGLE - DR_SSO - LOCAL - NONE role: $ref: '#/components/schemas/Role' team: type: boolean teamUserIds: type: array items: type: integer format: int64 teams: type: array items: $ref: '#/components/schemas/User' uniqueItems: true updatedAt: type: string format: date-time updatedBy: type: string userApplications: type: array items: $ref: '#/components/schemas/UserApplication' uniqueItems: true userName: type: string verificationMailSent: type: boolean selfServe: type: boolean inviteAccepted: type: boolean Segment: type: object properties: code: type: string contextual: type: boolean id: type: integer format: int64 isContextual: type: boolean lastActivity: type: string format: date-time memberId: type: integer format: int32 name: type: string price: type: string providerId: type: integer format: int32 providerName: type: string reach: type: string segmentObjectTypeId: type: integer format: int32 type: type: string RateCardItem: type: object properties: accountId: type: integer format: int32 accountType: type: string adjustmentId: type: integer format: int32 adjustmentModel: type: string enum: - TARGETING - KPI adjustmentType: type: string enum: - INCREMENT - OVERRIDE costPlus: type: number createdAt: type: string format: date-time createdBy: type: string defaultValue: type: number deletedAt: type: string format: date-time enabled: type: boolean id: type: integer format: int64 max: type: number min: type: number productTypeId: type: integer format: int32 rateType: type: string enum: - STANDARD - COSTPLUS - CPM - FIXED_MARGIN - ADDED_VALUE - CPA updatedAt: type: string format: date-time updatedBy: type: string ApiResponseRateCardItemDTO: type: object properties: status: type: integer format: int32 message: type: string result: $ref: '#/components/schemas/RateCardItemDTO' RateCardItemDTO: type: object properties: accountId: type: integer format: int32 accountType: type: string adjustmentId: type: integer format: int32 adjustmentModel: type: string enum: - TARGETING - KPI adjustmentType: type: string enum: - INCREMENT - OVERRIDE costPlus: type: number createdAt: type: string format: date-time createdBy: type: string defaultValue: type: number deletedAt: type: string format: date-time enabled: type: boolean id: type: integer format: int64 max: type: number min: type: number productTypeId: type: integer format: int32 rateType: type: string enum: - STANDARD - COSTPLUS - CPM - FIXED_MARGIN - ADDED_VALUE - CPA updatedAt: type: string format: date-time updatedBy: type: string productCategoryId: type: integer format: int32 productTypeName: type: string productCategoryName: type: string DealPerformance: type: object properties: cpm: type: number createdAt: type: string format: date-time dealId: type: integer format: int32 dealName: type: string pctBadIp: type: number seller: type: string totalImpressionsLast30Days: type: integer format: int32 PublisherDealMapping: type: object properties: deal: $ref: '#/components/schemas/DealPerformance' dealId: type: integer format: int32 id: type: integer format: int32 mediaPublisherId: type: integer format: int32 BudgetGroup: type: object properties: budget: type: number budgetGroupId: type: integer format: int32 id: type: integer format: int32 markup: type: number planId: type: integer format: int32 CompanionAsset: type: object properties: adTagCode: type: string assetType: type: string enum: - image - ad_tag - facebook - twitter - pinterest createdAt: type: string format: date-time createdBy: type: string deletedAt: type: string format: date-time id: type: integer format: int32 images: type: array items: $ref: '#/components/schemas/FileData' uniqueItems: true landingPageURL: type: string location: type: string enum: - top - bottom - top_mobile - bottom_mobile - right_rail updatedAt: type: string format: date-time updatedBy: type: string Creative: type: object properties: addCloseCaptioning: type: boolean bodyText: type: string brandName: type: string businessName: type: string callToAction: type: string clickThroughURL: type: string companionAsset: type: boolean companionAssets: type: array items: $ref: '#/components/schemas/CompanionAsset' uniqueItems: true createdAt: type: string format: date-time createdBy: type: string creativeEndDate: type: string format: date-time creativeStartDate: type: string format: date-time creativeType: type: string enum: - normal - search - social - pay_per_call - url_only - native_display - native_video - native_article - youtube_bumper_video - youtube_nonskippable_video - social_tiktok - social_snapchat cta: type: string deletedAt: type: string format: date-time description1: type: string description2: type: string displayPath1: type: string displayPath2: type: string files: type: array items: $ref: '#/components/schemas/FileData' uniqueItems: true headline1: type: string headline2: type: string headline3: type: string headlines: type: array items: $ref: '#/components/schemas/Headline' id: type: integer format: int32 name: type: string percentOfRetargetingBudget: type: number format: double phoneNumber: type: string previewText: type: string socialUrl: type: string trueView: type: boolean updatedAt: type: string format: date-time updatedBy: type: string FileData: type: object properties: createdAt: type: string format: date-time createdBy: type: string deletedAt: type: string format: date-time id: type: integer format: int32 name: type: string path: type: string size: type: integer format: int32 type: type: string enum: - UPLOAD - LINK - ARTICLE_UPLOAD - ARTICLE_LINK - COMPANION_ASSET_UPLOAD - COMPANION_ASSET_LINK - CLOSED_CAPTIONING_UPLOAD - ADVERTISER_LOGO - IO_ATTACHMENT - NOTES - CREATIVE - ARTICLE_CREATIVE - COMPANION_ASSET - CLOSED_CAPTIONING - TRACKING_PIXEL - ORGANIZATION_LOGO updatedAt: type: string format: date-time updatedBy: type: string Headline: type: object properties: id: type: integer format: int32 value: type: string Kpi: type: object properties: benchmark: type: number deletedAt: type: string format: date-time id: type: integer format: int32 kpiId: type: integer format: int32 notes: type: string value: type: string LineItem: type: object properties: adreadyId: type: string assignedTo: type: integer format: int32 audienceName: type: string billingType: type: string enum: - FIRST_PARTY - THIRD_PARTY - THIRD_PARTY_FLASHTALKING - THIRD_PARTY_SIZMEK - THIRD_PARTY_INNOVID - THIRD_PARTY_OTHERS budgetGroup: $ref: '#/components/schemas/BudgetGroup' budgetGroupId: type: integer format: int32 contactUserId: type: integer format: int32 crLineItems: type: array items: $ref: '#/components/schemas/LineItem' uniqueItems: true createdAt: type: string format: date-time createdBy: type: string creatives: type: array items: $ref: '#/components/schemas/Creative' uniqueItems: true customUserId: type: integer format: int32 dayParting: {} deletedAt: type: string format: date-time deviceTypes: type: array items: $ref: '#/components/schemas/LineItemDeviceTypes' uniqueItems: true externalName: type: string externalSourceId: type: integer format: int32 fixCpm: type: number flag: type: boolean flagId: type: integer format: int32 flightEndDate: type: string format: date-time flightStartDate: type: string format: date-time flip: type: boolean frequencyRecency: {} goalMetric: type: number format: double id: type: integer format: int32 impressions: type: integer format: int32 incrementality: type: boolean kpis: type: array items: $ref: '#/components/schemas/Kpi' uniqueItems: true lineItemBudget: type: number lucid: type: boolean managementFeeOnly: type: boolean markup: type: number mediaSpend: type: number name: type: string note: $ref: '#/components/schemas/Note' pace: type: number format: double parentId: type: integer format: int32 planId: type: integer format: int32 price: type: number pricingType: type: string enum: - CPM - COST_PLUS - FIXED_MARGIN - ADDED_VALUE - CPA productCategoryId: type: integer format: int32 productTypes: type: array items: $ref: '#/components/schemas/LineItemProductType' uniqueItems: true qa: {} retargetingNotes: type: string siteRetargeting: type: boolean spend: type: number format: double statusId: type: integer format: int32 tagsTrackers: type: boolean targetings: type: array items: $ref: '#/components/schemas/LineItemTargeting' uniqueItems: true taskTypeId: type: integer format: int32 trackingPixels: type: array items: $ref: '#/components/schemas/TrackingPixelData' uniqueItems: true type: type: string enum: - LINE - FLIGHT - CHANGE updatedAt: type: string format: date-time updatedBy: type: string vendors: type: array items: $ref: '#/components/schemas/LineItemVendors' uniqueItems: true workflowId: type: integer format: int32 xandrLineItemId: type: integer format: int32 LineItemDeviceTypes: type: object properties: deletedAt: type: string format: date-time deviceTypeId: type: integer format: int32 id: type: integer format: int32 LineItemProductType: type: object properties: categoryPath: type: string goalId: type: integer format: int32 googleAdAccount: type: string id: type: integer format: int32 placementType: type: string productTypeId: type: integer format: int32 productTypes: type: array items: type: string LineItemTargeting: type: object properties: id: type: integer format: int32 targetableElementId: type: integer format: int32 value: {} LineItemVendors: type: object properties: id: type: integer format: int32 vendorId: type: integer format: int32 LocationData: type: object properties: addresses: type: array items: type: string locationId: type: integer format: int32 Note: type: object properties: files: type: array items: $ref: '#/components/schemas/FileData' uniqueItems: true id: type: integer format: int32 value: type: string Plan: type: object properties: accountId: type: integer format: int32 advertiserId: type: integer format: int32 advertiserIsNew: type: boolean agencyId: type: integer format: int32 brandSafetyLevelId: type: integer format: int32 budget: type: number campaignName: type: string contactUserId: type: integer format: int32 crPlans: type: array items: $ref: '#/components/schemas/Plan' uniqueItems: true createdAt: type: string format: date-time createdBy: type: string customOrderId: type: string customUserId: type: integer format: int32 deletedAt: type: string format: date-time emailSubject: type: string endedFlightDate: type: string format: date-time externalSourceId: type: integer format: int32 files: type: array items: $ref: '#/components/schemas/FileData' uniqueItems: true flag: type: boolean flagId: type: integer format: int32 flightEndDate: type: string format: date-time flightStartDate: type: string format: date-time flip: type: boolean flipCampaignInfo: {} goalMetric: type: number format: double id: type: integer format: int32 impressions: type: integer format: int32 industryId: type: integer format: int32 internalNote: $ref: '#/components/schemas/Note' ioId: type: integer format: int32 lineItems: type: array items: $ref: '#/components/schemas/LineItem' uniqueItems: true location: $ref: '#/components/schemas/LocationData' lucid: type: boolean lucidCampaignInfo: {} marketingObjectiveId: type: integer format: int32 nonEndedFlightDate: type: integer format: int32 note: $ref: '#/components/schemas/Note' ownerId: type: integer format: int32 pace: type: number format: double parentId: type: integer format: int32 planFlip: type: boolean political: type: boolean productCategoryAllocations: type: array items: $ref: '#/components/schemas/ProductCategoryAllocation' uniqueItems: true source: type: string enum: - ADREADY - FLIPPLUS - DMM - PIO - VIA spend: type: number format: double state: type: string enum: - PLAN - IO - CHANGE - EXTEND statusId: type: integer format: int32 updatedAt: type: string format: date-time updatedBy: type: string verificationPartners: {} xandrIoId: type: integer format: int32 PlanningMatrixEntry: type: object properties: budgetRangeId: type: integer format: int32 id: type: integer format: int32 industryId: type: integer format: int32 locationId: type: integer format: int32 marketingObjectiveId: type: integer format: int32 ProductCategeoryDeviceAllocation: type: object properties: budget: type: number budgetPercentage: type: number deviceTypeId: type: integer format: int32 id: type: integer format: int32 impressions: type: integer format: int32 ProductCategoryAllocation: type: object properties: avgCPM: type: number budget: type: number budgetPercentage: type: number id: type: integer format: int32 impressions: type: integer format: int32 planningMatrixEntries: type: array items: $ref: '#/components/schemas/PlanningMatrixEntry' productCategeoryDeviceAllocations: type: array items: $ref: '#/components/schemas/ProductCategeoryDeviceAllocation' uniqueItems: true productCategoryId: type: integer format: int32 productTypeAllocations: type: array items: $ref: '#/components/schemas/ProductTypeAllocation' uniqueItems: true ProductTypeAllocation: type: object properties: budget: type: number budgetPercentage: type: number cpm: type: number fixCpm: type: number id: type: integer format: int32 impressions: type: integer format: int32 maxCpm: type: number productTypeId: type: integer format: int32 targetingTypeAllocations: type: array items: $ref: '#/components/schemas/TargetingTypeAllocation' uniqueItems: true TargetingTypeAllocation: type: object properties: id: type: integer format: int32 level: type: integer format: int32 targetingType: type: string enum: - NONE - PUBLISHER - GEO - AUDIENCE - CONTEXTUAL TrackingPixelData: type: object properties: files: type: array items: $ref: '#/components/schemas/FileData' uniqueItems: true id: type: integer format: int32 idKey: type: integer format: int32 name: type: string value: type: string ApiResponsePlan: type: object properties: status: type: integer format: int32 message: type: string result: $ref: '#/components/schemas/Plan' ApiResponseBoolean: type: object properties: status: type: integer format: int32 message: type: string result: type: boolean CalcReq: type: object properties: productCategoryId: type: integer format: int32 writeOnly: true productTypeId: type: integer format: int32 writeOnly: true deviceTypeId: type: integer format: int32 writeOnly: true targetingType: type: string writeOnly: true level: type: integer format: int32 writeOnly: true fixCpm: type: number format: double writeOnly: true percentage: type: number format: float writeOnly: true Organization: type: object properties: appConsoleLogoFile: $ref: '#/components/schemas/FileData' appConsoleSquareLogoFile: $ref: '#/components/schemas/FileData' emailBranding: type: boolean favIconLogoFile: $ref: '#/components/schemas/FileData' id: type: integer format: int32 loginEnabled: type: boolean logoFile: $ref: '#/components/schemas/FileData' name: type: string orgType: type: string subdomainConfig: {} subdomainEnabled: type: boolean theme: {} whitelabelEnabled: type: boolean ApiResponseOrganization: type: object properties: status: type: integer format: int32 message: type: string result: $ref: '#/components/schemas/Organization' ProductCategory: type: object properties: id: type: integer format: int32 name: type: string required: - name ProductType: type: object properties: canonicalProductId: type: integer format: int32 id: type: integer format: int32 name: type: string required: - name PublisherMediaTypeMapping: type: object properties: id: type: integer format: int32 mediaPublisherId: type: integer format: int32 productCategory: $ref: '#/components/schemas/ProductCategory' productType: $ref: '#/components/schemas/ProductType' siteDomain: type: string MediaPublisherMaster: type: object properties: category: type: string enum: - APP - NETWORK - OS createdAt: type: string format: date-time createdBy: type: string deals: type: array items: $ref: '#/components/schemas/PublisherDealMapping' uniqueItems: true deletedAt: type: string format: date-time displayName: type: string highCpmDealId: type: integer format: int32 highDealPerformance: $ref: '#/components/schemas/DealPerformance' id: type: integer format: int32 infoURL: type: string logoURL: type: string lowCpmDealId: type: integer format: int32 lowDealPerformance: $ref: '#/components/schemas/DealPerformance' mediaTypes: type: array items: $ref: '#/components/schemas/PublisherMediaTypeMapping' uniqueItems: true name: type: string scalability: type: integer format: int32 streamingCategory: type: string updatedAt: type: string format: date-time updatedBy: type: string ApiResponseLineItem: type: object properties: status: type: integer format: int32 message: type: string result: $ref: '#/components/schemas/LineItem' Comment: type: object properties: createdAt: type: string format: date-time createdBy: type: string deletedAt: type: string format: date-time id: type: integer format: int32 itemId: type: string itemType: type: string updatedAt: type: string format: date-time updatedBy: type: string value: type: string ApiResponseBudgetGroup: type: object properties: status: type: integer format: int32 message: type: string result: $ref: '#/components/schemas/BudgetGroup' Advertiser: type: object properties: about: type: string accountId: type: integer format: int32 accountSetup: {} advisrAdvertiserId: type: integer format: int32 ahAdvertiserId: type: integer format: int32 annualBudget: type: string companySize: type: string createdAt: type: string format: date-time createdBy: type: string customReportsEnabled: type: boolean dashboardAccess: type: boolean dashboardUserEmail: type: string dashboardUserName: type: string deletedAt: type: string format: date-time domainName: type: string dsp: type: string dspMappings: type: object additionalProperties: type: string features: type: array items: type: string flip: type: boolean hideCostMetrics: type: boolean id: type: integer format: int32 industry: type: string isSelfServe: type: boolean logoFile: $ref: '#/components/schemas/FileData' name: type: string organizationId: type: integer format: int32 pioId: type: integer format: int32 pixelSetup: {} templateId: type: integer format: int32 updatedAt: type: string format: date-time updatedBy: type: string vertical: type: string website: type: string xandrAdvertiserId: type: integer format: int32 Agency: type: object properties: accountId: type: integer format: int32 advertisers: type: array items: $ref: '#/components/schemas/Advertiser' uniqueItems: true deletedAt: type: string format: date-time flags: type: array items: type: string id: type: integer format: int32 name: type: string ApiResponseAdvertiser: type: object properties: status: type: integer format: int32 message: type: string result: $ref: '#/components/schemas/Advertiser' FlipPixel: type: object properties: apn_name: type: string apn_adv_id: type: string active: type: boolean name: type: string start_date: type: string end_date: type: string conversion_type: type: string values_returned: type: string requires_order_number: type: boolean piggyback_pixels: type: array items: type: string authorized_urls: type: array items: type: string order_number_regex: type: string total_regex: type: string external_file: type: string is_mni: type: boolean flip_id: type: string pixel_fires: $ref: '#/components/schemas/FlipPixelFires' FlipPixelFires: type: object properties: yesterday: type: integer format: int64 last15Minutes: type: integer format: int64 last7Days: type: integer format: int64 last30Days: type: integer format: int64 lifetime: type: integer format: int64 dailyAverage: type: number format: double last7DayAverage: type: number format: double yesterdayDelta: type: number format: double ApiResponseFlipPixel: type: object properties: status: type: integer format: int32 message: type: string result: $ref: '#/components/schemas/FlipPixel' Column: type: object properties: text: type: string title: type: string order: type: integer format: int32 none_of_the_above: type: boolean DraftSettings: type: object properties: questions: type: array items: $ref: '#/components/schemas/Question' baseline_questions: type: array items: $ref: '#/components/schemas/Question' allow_ip: type: boolean expected_impressions_count: type: integer format: int32 target_audiences: type: array items: $ref: '#/components/schemas/TargetAudience' ExistingLucidCampaign: type: object properties: campaign_name: type: string start_date: type: string end_date: type: string client_name: type: string country_language_id: type: integer format: int32 industry_id: type: integer format: int32 channels: type: array items: type: string draft_settings: $ref: '#/components/schemas/DraftSettings' campaign_id: type: string bl_campaign_id: type: string int_campaign_id: type: integer format: int32 pio_campaign_id: type: integer format: int32 status: type: string control_survey_id: type: string exposed_survey_id: type: string errors: type: string default_question_id: type: integer format: int32 default_question_name: type: string account_id: type: string project_manager_user_id: type: integer format: int32 created_at: type: string updated_at: type: string permission_id: type: integer format: int32 campaign_data_updated_at: type: string salesforce_id: type: string region: {} Field: type: object properties: name: type: string label: type: string value: type: string Option: type: object properties: text: type: string none_of_the_above: type: boolean Qualification: type: object properties: marketplace_question_id: type: number format: float qual_name: type: string answer_type: type: string precodes: type: array items: type: string Question: type: object properties: customQuestion: type: boolean question_text: type: string question_name: type: string kpi_type: type: string max_sel: type: integer format: int32 answers: type: array items: type: string none_of_the_above_answer: type: string anchored_answer: type: string custom_question_text: type: string is_custom_question_text: type: boolean randomize: type: boolean order: type: integer format: int32 default: type: boolean question_type: type: string columns: type: array items: $ref: '#/components/schemas/Column' rows: type: array items: $ref: '#/components/schemas/Row' target_option_index: type: integer format: int32 options: type: array items: $ref: '#/components/schemas/Option' multi_target_option_index: type: array items: type: integer format: int32 multi_level_target_option_index: {} fields: type: array items: $ref: '#/components/schemas/Field' required: type: boolean questionParams: type: array items: type: string input_fields_values: type: object additionalProperties: type: string Row: type: object properties: text: type: string title: type: string order: type: integer format: int32 none_of_the_above: type: boolean TargetAudience: type: object properties: target_name: type: string is_default: type: boolean qualifications: type: array items: $ref: '#/components/schemas/Qualification' ApiResponseLucidSPCGroupingsWrapper: type: object properties: status: type: integer format: int32 message: type: string result: $ref: '#/components/schemas/LucidSPCGroupingsWrapper' LucidSPCGroupingsWrapper: type: object properties: campaign_id: type: string data: type: array items: {} Account: type: object properties: abbreviation: type: string aboutAgency: type: string active: type: boolean advertisers: type: array items: $ref: '#/components/schemas/Advertiser' uniqueItems: true advisrGroupId: type: integer format: int32 ahAgencyUuid: type: string aiName: type: string countryCode: type: string createdAt: type: string format: date-time createdBy: type: string currency: type: string dashboardUrls: type: array items: $ref: '#/components/schemas/DashboardUrl' uniqueItems: true deletedAt: type: string format: date-time flags: type: array items: type: string id: type: integer format: int32 name: type: string organization: $ref: '#/components/schemas/Organization' organizationId: type: integer format: int32 parentId: type: integer format: int32 pioId: type: integer format: int32 plusAccountId: type: integer format: int32 prefix: type: string updatedAt: type: string format: date-time updatedBy: type: string DashboardUrl: type: object properties: accountId: type: integer format: int32 id: type: integer format: int32 link: type: string title: type: string ApiResponseAccount: type: object properties: status: type: integer format: int32 message: type: string result: $ref: '#/components/schemas/Account' DropdownUserMaster: type: object properties: accountId: type: integer format: int32 createdAt: type: string format: date-time createdBy: type: string deletedAt: type: string format: date-time id: type: integer format: int32 type: type: string enum: - ASSIGNEE - OWNER - CONTACT_USER - CUSTOM_USER updatedAt: type: string format: date-time updatedBy: type: string userId: type: integer format: int64 Solution: type: object properties: config: {} createdAt: type: string format: date-time createdBy: type: string deletedAt: type: string format: date-time description: type: string icon: type: string id: type: integer format: int32 order: type: integer format: int32 scope: type: string enum: - GLOBAL - ADVERTISER state: type: string enum: - ACTIVE - DISCOVER - HIDDEN - DISABLED title: type: string type: type: string enum: - FLIP - TS - DATORAMA updatedAt: type: string format: date-time updatedBy: type: string ApiResponseSolution: type: object properties: status: type: integer format: int32 message: type: string result: $ref: '#/components/schemas/Solution' ReportFilter: type: object properties: adGroups: type: array items: type: string audiences: type: array items: type: string campaignIds: type: array items: type: string conversionWindow: type: integer format: int32 conversionWindowUnit: type: string enum: - DAYS - HOURS creatives: type: array items: type: string dateRangeType: type: string enum: - CUSTOM - LAST_7_DAYS - LAST_2_WEEKS - LAST_30_DAYS - CAMPAIGN_TO_DATE dimensions: type: array items: type: string endDate: type: string interval: type: string enum: - CUMULATIVE - DAY - HOURLY keywords: type: array items: type: string mediaTypes: type: array items: type: string methodology: type: string enum: - LAST_TOUCH - FIRST_TOUCH - LINEAR - TIME_DECAY pixelIds: type: array items: type: string presetTemplateName: type: string publisher: type: array items: type: string reportMetrics: type: array items: $ref: '#/components/schemas/ReportMetrics' showUniques: type: boolean startDate: type: string ReportMetrics: type: object properties: event: type: boolean metrics: type: string subCategory: type: array items: type: string ReportTemplate: type: object properties: accountId: type: integer format: int32 advertiserId: type: integer format: int32 createdAt: type: string format: date-time createdBy: type: string deletedAt: type: string format: date-time emailTo: type: string filters: $ref: '#/components/schemas/ReportFilter' id: type: integer format: int32 lastRunDate: type: string format: date lastRunStatus: type: string enum: - SUCCESS - FAILED - PROCESSING name: type: string nextRunDate: type: string format: date schedule: type: string enum: - WEEKLY - BI_WEEKLY - MONTHLY - MONTH_END scheduleEndDate: type: string format: date scheduleStartDate: type: string format: date scheduleStatus: type: string enum: - ACTIVE - INACTIVE updatedAt: type: string format: date-time updatedBy: type: string ApiResponseReportTemplate: type: object properties: status: type: integer format: int32 message: type: string result: $ref: '#/components/schemas/ReportTemplate' AdvertiserSolution: type: object properties: advertiserId: type: integer format: int32 id: type: integer format: int32 solution: $ref: '#/components/schemas/Solution' solutionId: type: integer format: int32 state: type: string enum: - ACTIVE - DISCOVER - HIDDEN ApiResponseAdvertiserSolution: type: object properties: status: type: integer format: int32 message: type: string result: $ref: '#/components/schemas/AdvertiserSolution' ApiResponseString: type: object properties: status: type: integer format: int32 message: type: string result: type: string UserRole: type: object properties: role: $ref: '#/components/schemas/Role' roleId: type: integer format: int32 userId: type: integer format: int64 LoginRequest: type: object properties: email: type: string format: email minLength: 1 password: type: string minLength: 1 required: - email - password ReportLogStatusUpdateRequest: type: object properties: email: type: string format: email minLength: 1 password: type: string minLength: 1 reportGenerationLogId: type: integer format: int32 status: type: string enum: - SUCCESS - FAILED - PROCESSING required: - email - password - reportGenerationLogId - status EmailNotification: type: object properties: emails: type: array items: type: string changeTypes: type: array items: type: string notes: type: string lineItems: type: array items: $ref: '#/components/schemas/LineItem' emailSubject: type: string category: type: string enum: - SUBMIT - CR_SUBMIT - CR_SUBMIT_PENDING - RESUBMIT - LI_DISAPPROVED - LI_READY_FOR_ACTIVATION - LI_ACTIVATED - LI_CAMPAIGN_LIVE - LI_PAUSED - LI_CANCELED - LI_CHANGE_READY - LI_CHANGE_APPLIED emailSource: type: string SubmitOrder: type: object properties: crPlanId: type: integer format: int32 emails: type: array items: type: string notes: type: string ExportSchedule: type: object properties: createdAt: type: string format: date-time createdBy: type: string deletedAt: type: string format: date-time emailIds: type: string emailSource: type: string id: type: integer format: int32 lineItemId: type: integer format: int32 notes: type: string planId: type: integer format: int32 scheduledTime: type: string format: date-time status: type: string enum: - SCHEDULED - STARTED - FINISHED - FAILED - DELETED updatedAt: type: string format: date-time updatedBy: type: string PixelDTO: type: object properties: active: type: boolean advertiserId: type: integer format: int32 createdAt: type: string format: date-time createdBy: type: string deletedAt: type: string format: date-time id: type: integer format: int32 name: type: string triggerType: type: string type: type: string enum: - CONVERSION - SEGMENT updatedAt: type: string format: date-time updatedBy: type: string xandrPixelId: type: integer format: int32 advisrAdvertiserId: type: integer format: int32 advisrAdvertiserName: type: string adreadyAccountId: type: integer format: int32 ApiResponsePixel: type: object properties: status: type: integer format: int32 message: type: string result: $ref: '#/components/schemas/Pixel' Pixel: type: object properties: active: type: boolean advertiserId: type: integer format: int32 createdAt: type: string format: date-time createdBy: type: string deletedAt: type: string format: date-time id: type: integer format: int32 name: type: string triggerType: type: string type: type: string enum: - CONVERSION - SEGMENT updatedAt: type: string format: date-time updatedBy: type: string xandrPixelId: type: integer format: int32 ApiResponseFileData: type: object properties: status: type: integer format: int32 message: type: string result: $ref: '#/components/schemas/FileData' CommentNotification: type: object properties: emails: type: array items: type: string mentionedUsers: type: array items: type: string comment: $ref: '#/components/schemas/Comment' lineItemName: type: string planId: type: integer format: int32 accountName: type: string accountId: type: integer format: int32 ValidateResetPasswordTokenRequest: type: object properties: userId: type: integer format: int64 token: type: string minLength: 1 required: - token - userId CreatePasswordRequest: type: object properties: password: type: string minLength: 1 userId: type: integer format: int64 token: type: string minLength: 1 name: type: string minLength: 1 phone: type: string required: - name - password - token - userId ForgotPasswordRequest: type: object properties: hostname: type: string minLength: 1 email: type: string format: email minLength: 1 required: - email - hostname ApiResponseAgency: type: object properties: status: type: integer format: int32 message: type: string result: $ref: '#/components/schemas/Agency' ApiResponseListObject: type: object properties: status: type: integer format: int32 message: type: string result: type: array items: {} ApiResponseListConversionTouch: type: object properties: status: type: integer format: int32 message: type: string result: type: array items: $ref: '#/components/schemas/ConversionTouch' ConversionTouch: type: object properties: uniqueId: type: string ip: type: string revenue: type: number format: double subCategory: type: string pixelTimestamp: type: string pixelTimestampMillis: type: integer format: int64 creative: type: string publisher: type: string channel: type: string audience: type: string mediaType: type: string state: type: string dma: type: string deviceType: type: string impressionTimestamp: type: string timeToConvert: type: integer format: int32 timesExposed: type: integer format: int32 ApiResponseListMetricsByField: type: object properties: status: type: integer format: int32 message: type: string result: type: array items: $ref: '#/components/schemas/MetricsByField' MetricsByField: type: object properties: category: type: string event: type: string name: type: string impressions: type: integer format: int64 spend: type: number format: double cpm: {} cpmInfinity: type: boolean totalCount: type: number format: double conversionRate: {} conversionRateInfinity: type: boolean revenue: type: number format: double videoCompletionRate: {} videoCompletionRateInfinity: type: boolean videoCompletions: type: integer format: int64 clickThroughRate: {} clickThroughRateInfinity: type: boolean clicks: type: integer format: int64 cpa: {} cpaInfinity: type: boolean roas: {} roasInfinity: type: boolean pm: {} pmInfinity: type: boolean reach: type: integer format: int64 frequency: {} frequencyInfinity: type: boolean timeToConvert: type: number format: double totalExposures: type: number format: double incrementalReach: type: integer format: int64 overallCTVReach: type: integer format: int64 incrementalReachPercentage: type: number format: double ApiResponsePagedResultEventMetricsByField: type: object properties: status: type: integer format: int32 message: type: string result: $ref: '#/components/schemas/PagedResultEventMetricsByField' EventMetricsByField: type: object properties: name: type: string spend: type: number format: double allEvents: type: object additionalProperties: {} PagedResultEventMetricsByField: type: object properties: records: type: array items: $ref: '#/components/schemas/EventMetricsByField' recordCount: type: integer format: int64 headers: type: array items: type: string ApiResponseObject: type: object properties: status: type: integer format: int32 message: type: string result: {} ComparisonDataDouble: type: object properties: currentValue: type: number format: double compareValue: type: number format: double change: type: number format: double isCurrentInfinity: type: boolean isCompareInfinity: type: boolean isChangeInfinity: type: boolean ComparisonDataLong: type: object properties: currentValue: type: integer format: int64 compareValue: type: integer format: int64 change: type: number format: double isCurrentInfinity: type: boolean isCompareInfinity: type: boolean isChangeInfinity: type: boolean MetricsComparisonByField: type: object properties: category: type: string event: type: string id: type: string name: type: string displayName: type: string streamingCategory: type: string imageUrl: type: string impressions: $ref: '#/components/schemas/ComparisonDataLong' spend: $ref: '#/components/schemas/ComparisonDataDouble' totalCount: $ref: '#/components/schemas/ComparisonDataDouble' cpa: $ref: '#/components/schemas/ComparisonDataDouble' roas: $ref: '#/components/schemas/ComparisonDataDouble' revenue: $ref: '#/components/schemas/ComparisonDataDouble' cpm: $ref: '#/components/schemas/ComparisonDataDouble' pm: $ref: '#/components/schemas/ComparisonDataDouble' videoCompletions: $ref: '#/components/schemas/ComparisonDataLong' videoImpressions: $ref: '#/components/schemas/ComparisonDataLong' clicks: $ref: '#/components/schemas/ComparisonDataLong' vcr: $ref: '#/components/schemas/ComparisonDataDouble' ctr: $ref: '#/components/schemas/ComparisonDataDouble' ireach: $ref: '#/components/schemas/ComparisonDataLong' ireachPercentage: $ref: '#/components/schemas/ComparisonDataDouble' ReachMetric: type: object properties: reach: $ref: '#/components/schemas/ComparisonDataLong' frequency: $ref: '#/components/schemas/ComparisonDataDouble' ApiResponseDailyPerformanceSummary: type: object properties: status: type: integer format: int32 message: type: string result: $ref: '#/components/schemas/DailyPerformanceSummary' DailyPerformanceSummary: type: object properties: breakup: type: array items: $ref: '#/components/schemas/KeyValuePerformanceSummary' KeyValuePerformanceSummary: type: object properties: key: type: string value: $ref: '#/components/schemas/PerformanceSummary' extra: type: string PerformanceSummary: type: object properties: impressions: $ref: '#/components/schemas/ComparisonDataLong' spend: $ref: '#/components/schemas/ComparisonDataDouble' visits: $ref: '#/components/schemas/ComparisonDataDouble' cpa: $ref: '#/components/schemas/ComparisonDataDouble' revenue: $ref: '#/components/schemas/ComparisonDataDouble' roas: $ref: '#/components/schemas/ComparisonDataDouble' cpm: $ref: '#/components/schemas/ComparisonDataDouble' videoImpressions: $ref: '#/components/schemas/ComparisonDataLong' videoCompletions: $ref: '#/components/schemas/ComparisonDataLong' vcr: $ref: '#/components/schemas/ComparisonDataDouble' clicks: $ref: '#/components/schemas/ComparisonDataLong' ctr: $ref: '#/components/schemas/ComparisonDataDouble' ApiResponseImpressionsSummary: type: object properties: status: type: integer format: int32 message: type: string result: $ref: '#/components/schemas/ImpressionsSummary' ImpressionsSummary: type: object properties: spend: $ref: '#/components/schemas/ComparisonDataDouble' impressions: $ref: '#/components/schemas/ComparisonDataLong' videoCompletions: $ref: '#/components/schemas/ComparisonDataLong' videoCompletionRate: $ref: '#/components/schemas/ComparisonDataDouble' clicks: $ref: '#/components/schemas/ComparisonDataLong' clickThroughRate: $ref: '#/components/schemas/ComparisonDataDouble' InsertionOrderPacingRequest: type: object properties: client: type: string advertiser: type: string ioIds: type: string adGroups: type: string ApiResponseInsertionOrderPacing: type: object properties: status: type: integer format: int32 message: type: string result: $ref: '#/components/schemas/InsertionOrderPacing' InsertionOrderPacing: type: object properties: startDate: type: string endDate: type: string budget: type: number format: double spend: type: number format: double pacing: $ref: '#/components/schemas/ComparisonDataDouble' ApiResponseListIncrementalLiftData: type: object properties: status: type: integer format: int32 message: type: string result: type: array items: $ref: '#/components/schemas/IncrementalLiftData' IncrementalLiftData: type: object properties: name: type: string exposedCount: type: number format: double exposedConversions: type: number format: double exposedRate: type: number format: double controlCount: type: number format: double controlConversions: type: number format: double controlRate: type: number format: double liftPercentage: type: number format: double liftPercentageInfinity: type: boolean incrementality: type: number format: double incrementalityInfinity: type: boolean ApiResponseDailySummary: type: object properties: status: type: integer format: int32 message: type: string result: $ref: '#/components/schemas/DailySummary' ComparisonDataNumber: type: object properties: currentValue: type: number compareValue: type: number change: type: number format: double isCurrentInfinity: type: boolean isCompareInfinity: type: boolean isChangeInfinity: type: boolean DailySummary: type: object properties: breakup: type: array items: $ref: '#/components/schemas/KeyValueComparisonDataNumber' KeyValueComparisonDataNumber: type: object properties: key: type: string value: $ref: '#/components/schemas/ComparisonDataNumber' extra: type: string NewLucidCampaign: type: object properties: campaign_name: type: string start_date: type: string end_date: type: string client_name: type: string country_language_id: type: integer format: int32 industry_id: type: integer format: int32 channels: type: array items: type: string draft_settings: $ref: '#/components/schemas/DraftSettings' KeyValue: type: object properties: key: type: string value: {} extra: type: string AHSyncRequest: type: object properties: email: type: string format: email minLength: 1 password: type: string minLength: 1 ids: type: array items: type: integer format: int32 batchCount: type: integer format: int32 sleepTimeInMs: type: integer format: int32 maxLimit: type: integer format: int32 required: - email - password StandardApiRequest: type: object properties: solutionId: type: integer format: int32 client: type: string advertiser: type: string advertiserId: type: integer format: int32 xandrId: type: string campaignIds: type: string adGroups: type: string mediaTypes: type: string creatives: type: string audiences: type: string keywords: type: string pixelIds: type: string startDate: type: string endDate: type: string compareStartDate: type: string compareEndDate: type: string publisher: type: string offset: type: integer format: int32 limit: type: integer format: int32 conversionWindow: type: integer format: int32 keywordFilterApplied: type: boolean comparedDateRangeProvided: type: boolean ConversionApiRequest: type: object properties: pixel: type: string description: The FLIP universal pixel id example: pixel_123 showUniques: type: boolean default: false description: Flag to decide whether to show only uniques or not conversionWindow: type: integer format: int32 default: 0 description: The conversion window in hours attribution: type: string default: full description: The conversion attribution to be used, either full or partial enum: - full - partial methodology: type: string default: last_touch description: The methodology to be used enum: - first_touch - last_touch - linear - time_decay event: type: string description: The event category: type: string description: The pixel category subCategory: type: string description: The comma-separated pixel sub-categories ip: type: string description: IP address of the request example: 192.168.1.1 ts: type: integer format: int64 description: Timestamp of the request example: 1651234567890 fields: type: string writeOnly: true fieldsToReturn: type: array items: type: string required: - category - pixel SchedulingRequest: type: object properties: onceNow: type: boolean emailIt: type: boolean emailAddr: type: string ApiResponseListBrandMetricsByDimension: type: object properties: status: type: integer format: int32 message: type: string result: type: array items: $ref: '#/components/schemas/BrandMetricsByDimension' BrandMetricsByDimension: type: object properties: name: type: string spend: type: number format: double impressions: type: number format: double clicks: type: number format: double cpm: {} cpmInfinity: type: boolean cpc: {} cpcInfinity: type: boolean cpcv: {} cpcvInfinity: type: boolean reach: type: integer format: int64 frequency: {} frequencyInfinity: type: boolean incrementalReach: type: integer format: int64 incrementalReachPercentage: type: number format: double totalCount: type: number format: double conversionRate: {} conversionRateInfinity: type: boolean revenue: type: number format: double cpa: {} pm: {} pmInfinity: type: boolean cpaInfinity: type: boolean roas: {} roasInfinity: type: boolean timeToConvert: type: number format: double totalExposures: type: number format: double key: type: string category: type: string event: type: string ctr: {} ctrInfinity: type: boolean completions: type: number format: double vcr: {} vcrInfinity: type: boolean ReportRequest: type: object properties: accountId: type: integer format: int32 advertiserId: type: integer format: int32 createdAt: type: string format: date-time createdBy: type: string deletedAt: type: string format: date-time emailTo: type: string filters: $ref: '#/components/schemas/ReportFilter' id: type: integer format: int32 lastRunDate: type: string format: date lastRunStatus: type: string enum: - SUCCESS - FAILED - PROCESSING name: type: string nextRunDate: type: string format: date schedule: type: string enum: - WEEKLY - BI_WEEKLY - MONTHLY - MONTH_END scheduleEndDate: type: string format: date scheduleStartDate: type: string format: date scheduleStatus: type: string enum: - ACTIVE - INACTIVE updatedAt: type: string format: date-time updatedBy: type: string runNow: type: boolean export: type: boolean email: type: boolean offset: type: integer format: int32 limit: type: integer format: int32 orderBy: type: string orderByDirection: type: string totalRecordLimit: type: integer format: int32 ApiResponseReportResponse: type: object properties: status: type: integer format: int32 message: type: string result: $ref: '#/components/schemas/ReportResponse' ReportData: type: object properties: overAll: type: string mediaType: type: string creative: type: string publisher: type: string channel: type: string placement: type: string audience: type: string adGroup: type: string deviceType: type: string state: type: string dma: type: string zipCode: type: string day: type: string dayPart: type: string spend: type: number format: double impressions: type: number format: double clicks: type: number format: double cpm: type: number format: double cpc: type: number format: double ctr: type: number format: double completions: type: number format: double vcr: type: number format: double reach: type: integer format: int64 frequency: type: number format: double lead: type: number format: double leadConversionRate: type: number format: double leadCpa: type: number format: double leadPm: type: number format: double leadTimeToConvert: type: number format: double leadTotalExposures: type: number format: double activity: type: number format: double activityConversionRate: type: number format: double activityCpa: type: number format: double activityPm: type: number format: double activityTimeToConvert: type: number format: double activityTotalExposures: type: number format: double checkout: type: number format: double checkoutConversionRate: type: number format: double checkoutCpa: type: number format: double checkoutPm: type: number format: double checkoutTimeToConvert: type: number format: double checkoutTotalExposures: type: number format: double pageVisit: type: number format: double pageVisitConversionRate: type: number format: double pageVisitCpa: type: number format: double pageVisitPm: type: number format: double pageVisitTimeToConvert: type: number format: double pageVisitTotalExposures: type: number format: double locationVisit: type: number format: double locationVisitConversionRate: type: number format: double locationVisitCpa: type: number format: double locationVisitPm: type: number format: double locationVisitTimeToConvert: type: number format: double locationVisitTotalExposures: type: number format: double revenue: type: number format: double roas: type: number format: double ReportResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/ReportData' total: type: integer format: int32 ApiResponsePresetTemplateResult: type: object properties: status: type: integer format: int32 message: type: string result: $ref: '#/components/schemas/PresetTemplateResult' PresetTemplateResult: type: object properties: data: type: array items: type: object additionalProperties: {} total: type: integer format: int32 headers: type: array items: type: string firstAttemptFailed: type: boolean AppVersion: type: object properties: gitBranch: type: string gitRevision: type: string builtBy: type: string buildJdk: type: string buildTime: type: string version: type: string api: type: object additionalProperties: {} ApiResponseListWorkflowOption: type: object properties: status: type: integer format: int32 message: type: string result: type: array items: $ref: '#/components/schemas/WorkflowOption' WorkflowOption: type: object properties: displayOrder: type: integer format: int32 flagColorCode: type: string id: type: integer format: int32 name: type: string type: type: string enum: - LI - IO - IO_CHANGE - LI_CHANGE ApiResponseListWhitelabelDomain: type: object properties: status: type: integer format: int32 message: type: string result: type: array items: $ref: '#/components/schemas/WhitelabelDomain' ApiResponseListVerificationPartner: type: object properties: status: type: integer format: int32 message: type: string result: type: array items: $ref: '#/components/schemas/VerificationPartner' VerificationPartner: type: object properties: id: type: integer format: int32 name: type: string ApiResponseListVendorMaster: type: object properties: status: type: integer format: int32 message: type: string result: type: array items: $ref: '#/components/schemas/VendorMaster' VendorMaster: type: object properties: createdAt: type: string format: date-time createdBy: type: string deletedAt: type: string format: date-time id: type: integer format: int32 name: type: string updatedAt: type: string format: date-time updatedBy: type: string ApiResponseListUserDTO: type: object properties: status: type: integer format: int32 message: type: string result: type: array items: $ref: '#/components/schemas/UserDTO' ApiResponseListTrackingPixel: type: object properties: status: type: integer format: int32 message: type: string result: type: array items: $ref: '#/components/schemas/TrackingPixel' TrackingPixel: type: object properties: id: type: integer format: int32 name: type: string value: type: string required: - name ApiResponseThoughtSpotToken: type: object properties: status: type: integer format: int32 message: type: string result: $ref: '#/components/schemas/ThoughtSpotToken' ThoughtSpotToken: type: object properties: userName: type: string authToken: type: string ApiResponseTokenWrapper: type: object properties: status: type: integer format: int32 message: type: string result: $ref: '#/components/schemas/TokenWrapper' TokenWrapper: type: object properties: apps: type: array items: type: integer format: int32 expires: type: integer format: int64 orgId: type: integer format: int32 userId: type: integer format: int64 email: type: string ApiResponseListTaskTypeOption: type: object properties: status: type: integer format: int32 message: type: string result: type: array items: $ref: '#/components/schemas/TaskTypeOption' TaskTypeOption: type: object properties: id: type: integer format: int32 name: type: string ApiResponseListTargetableElement: type: object properties: status: type: integer format: int32 message: type: string result: type: array items: $ref: '#/components/schemas/TargetableElement' TargetableElement: type: object properties: id: type: integer format: int32 level: type: integer format: int32 name: type: string targetingType: type: string required: - name ApiResponseListOptionDTO: type: object properties: status: type: integer format: int32 message: type: string result: type: array items: $ref: '#/components/schemas/OptionDTO' OptionDTO: type: object properties: id: type: integer format: int32 value: type: string options: type: array items: type: string ApiResponseListTableauView: type: object properties: status: type: integer format: int32 message: type: string result: type: array items: $ref: '#/components/schemas/TableauView' TableauView: type: object properties: name: type: string url: type: string createdAt: type: string id: type: string ApiResponseListStatusOption: type: object properties: status: type: integer format: int32 message: type: string result: type: array items: $ref: '#/components/schemas/StatusOption' StatusOption: type: object properties: displayOrder: type: integer format: int32 id: type: integer format: int32 status: type: string type: type: string enum: - LI - IO - IO_CHANGE - LI_CHANGE ApiResponseListRole: type: object properties: status: type: integer format: int32 message: type: string result: type: array items: $ref: '#/components/schemas/Role' ApiResponseRateCardDTO: type: object properties: status: type: integer format: int32 message: type: string result: $ref: '#/components/schemas/RateCardDTO' RateCardDTO: type: object properties: markup: type: number rateCardItems: type: array items: $ref: '#/components/schemas/RateCardItemDTO' ApiResponseProductType: type: object properties: status: type: integer format: int32 message: type: string result: $ref: '#/components/schemas/ProductType' ApiResponseListKpiOption: type: object properties: status: type: integer format: int32 message: type: string result: type: array items: $ref: '#/components/schemas/KpiOption' KpiOption: type: object properties: id: type: integer format: int32 name: type: string ApiResponseListProductCategoryDTO: type: object properties: status: type: integer format: int32 message: type: string result: type: array items: $ref: '#/components/schemas/ProductCategoryDTO' ProductCategoryDTO: type: object properties: id: type: integer format: int32 name: type: string productTypes: type: array items: $ref: '#/components/schemas/ProductType' ApiResponseProductCategoryDTO: type: object properties: status: type: integer format: int32 message: type: string result: $ref: '#/components/schemas/ProductCategoryDTO' ApiResponseListKeyValue: type: object properties: status: type: integer format: int32 message: type: string result: type: array items: $ref: '#/components/schemas/KeyValue' ApiResponsePageResponsePlan: type: object properties: status: type: integer format: int32 message: type: string result: $ref: '#/components/schemas/PageResponsePlan' PageResponsePlan: type: object properties: content: type: array items: $ref: '#/components/schemas/Plan' first: type: boolean last: type: boolean pageNumber: type: integer format: int32 pageSize: type: integer format: int32 totalElements: type: integer format: int64 totalPages: type: integer format: int32 ApiResponseListPixel: type: object properties: status: type: integer format: int32 message: type: string result: type: array items: $ref: '#/components/schemas/Pixel' ApiResponseListOrganization: type: object properties: status: type: integer format: int32 message: type: string result: type: array items: $ref: '#/components/schemas/Organization' ApiResponseListMarketingObjective: type: object properties: status: type: integer format: int32 message: type: string result: type: array items: $ref: '#/components/schemas/MarketingObjective' MarketingObjective: type: object properties: id: type: integer format: int32 name: type: string required: - name ApiResponseListLocation: type: object properties: status: type: integer format: int32 message: type: string result: type: array items: $ref: '#/components/schemas/Location' Location: type: object properties: id: type: integer format: int32 name: type: string ApiResponseListIndustry: type: object properties: status: type: integer format: int32 message: type: string result: type: array items: $ref: '#/components/schemas/Industry' Industry: type: object properties: id: type: integer format: int32 name: type: string ApiResponseListBudgetRange: type: object properties: status: type: integer format: int32 message: type: string result: type: array items: $ref: '#/components/schemas/BudgetRange' BudgetRange: type: object properties: id: type: integer format: int32 name: type: string ApiResponsePageResponseLineItem: type: object properties: status: type: integer format: int32 message: type: string result: $ref: '#/components/schemas/PageResponseLineItem' PageResponseLineItem: type: object properties: content: type: array items: $ref: '#/components/schemas/LineItem' first: type: boolean last: type: boolean pageNumber: type: integer format: int32 pageSize: type: integer format: int32 totalElements: type: integer format: int64 totalPages: type: integer format: int32 LineItemData: type: object properties: adreadyId: type: string flightStartDate: type: string LineItemNameResponse: type: object properties: lineItemName: type: string liData: type: array items: $ref: '#/components/schemas/LineItemData' WorkflowStats: type: object properties: count: type: integer format: int32 id: type: integer format: int32 name: type: string parentId: type: integer format: int32 planId: type: integer format: int32 type: type: string ProductHierarchy: type: object properties: accountId: type: integer format: int32 accountType: type: string createdAt: type: string format: date-time createdBy: type: string deletedAt: type: string format: date-time displayName: type: string id: type: integer format: int32 multiselect: type: integer format: int32 parentId: type: integer format: int32 refId: type: integer format: int32 type: type: string updatedAt: type: string format: date-time updatedBy: type: string ApiResponseListFlagOption: type: object properties: status: type: integer format: int32 message: type: string result: type: array items: $ref: '#/components/schemas/FlagOption' FlagOption: type: object properties: icon: type: string id: type: integer format: int32 name: type: string value: type: string DmmIoMarketsFeedRaw: type: object properties: campaignId: type: integer format: int32 id: type: integer format: int32 ioCampaign: type: string markets: type: string packageId: type: integer format: int32 packageName: type: string updatedOn: type: string format: date-time DmmIoMarketsFeedRawHistory: type: object properties: campaignId: type: integer format: int32 id: type: integer format: int32 ioCampaign: type: string markets: type: string packageId: type: integer format: int32 packageName: type: string updatedOn: type: string format: date-time DmmIoMarketGroupsFeedRaw: type: object properties: campaignId: type: integer format: int32 id: type: integer format: int32 ioCampaign: type: string marketGroup: type: string marketGroupItems: type: string marketType: type: string updatedOn: type: string format: date-time DmmIoMarketGroupsFeedRawHistory: type: object properties: campaignId: type: integer format: int32 id: type: integer format: int32 ioCampaign: type: string marketGroup: type: string marketGroupItems: type: string marketType: type: string updatedOn: type: string format: date-time DmmIoSiteListFeedRaw: type: object properties: campaignId: type: integer format: int32 id: type: integer format: int32 ioCampaign: type: string siteList: type: string siteListName: type: string updatedOn: type: string format: date-time DmmIoSiteListFeedRawHistory: type: object properties: campaignId: type: integer format: int32 id: type: integer format: int32 ioCampaign: type: string siteList: type: string siteListName: type: string updatedOn: type: string format: date-time DmmIoKeywordListFeedRaw: type: object properties: campaignId: type: integer format: int32 id: type: integer format: int32 ioCampaign: type: string keywordList: type: string keywordListName: type: string updatedOn: type: string format: date-time DmmIoKeywordListFeedRawHistory: type: object properties: campaignId: type: integer format: int32 id: type: integer format: int32 ioCampaign: type: string keywordList: type: string keywordListName: type: string updatedOn: type: string format: date-time DmmIoAudienceDefinitionFeedRaw: type: object properties: audienceDefinitionName: type: string campaignId: type: integer format: int32 header1: type: string header2: type: string header3: type: string header4: type: string header5: type: string id: type: integer format: int32 ioCampaign: type: string rowNum: type: integer format: int32 updatedOn: type: string format: date-time value1: type: string value2: type: string value3: type: string value4: type: string value5: type: string DmmIoAudienceDefinitionFeedRawHistory: type: object properties: audienceDefinitionName: type: string campaignId: type: integer format: int32 header1: type: string header2: type: string header3: type: string header4: type: string header5: type: string id: type: integer format: int32 ioCampaign: type: string rowNum: type: integer format: int32 updatedOn: type: string format: date-time value1: type: string value2: type: string value3: type: string value4: type: string value5: type: string ApiResponseListDeviceTypeMaster: type: object properties: status: type: integer format: int32 message: type: string result: type: array items: $ref: '#/components/schemas/DeviceTypeMaster' DeviceTypeMaster: type: object properties: deviceType: type: string id: type: integer format: int32 DemoConfig: type: object properties: advertiserId: type: integer format: int32 accountId: type: integer format: int32 targetAdvertiserId: type: integer format: int32 targetAccountId: type: integer format: int32 solutionId: type: integer format: int32 startDate: type: string endDate: type: string compareStartDate: type: string compareEndDate: type: string selectedCampaigns: type: array items: type: string config: type: object additionalProperties: type: string ApiResponseListBudgetGroup: type: object properties: status: type: integer format: int32 message: type: string result: type: array items: $ref: '#/components/schemas/BudgetGroup' ApiResponseListBrandSafetyLevel: type: object properties: status: type: integer format: int32 message: type: string result: type: array items: $ref: '#/components/schemas/BrandSafetyLevel' BrandSafetyLevel: type: object properties: id: type: integer format: int32 levelText: type: string ApiResponseListApplication: type: object properties: status: type: integer format: int32 message: type: string result: type: array items: $ref: '#/components/schemas/Application' Application: type: object properties: id: type: integer format: int32 name: type: string ApiResponseListAgency: type: object properties: status: type: integer format: int32 message: type: string result: type: array items: $ref: '#/components/schemas/Agency' ApiResponseListAdvertiser: type: object properties: status: type: integer format: int32 message: type: string result: type: array items: $ref: '#/components/schemas/Advertiser' IncrementalReachMetric: type: object properties: incrementalReach: $ref: '#/components/schemas/ComparisonDataLong' incrementalReachPercentage: $ref: '#/components/schemas/ComparisonDataDouble' ApiResponseListHaloEffectData: type: object properties: status: type: integer format: int32 message: type: string result: type: array items: $ref: '#/components/schemas/HaloEffectData' HaloEffectData: type: object properties: name: type: string exposedCount: type: number format: double exposedConversions: type: number format: double controlCount: type: number format: double controlConversions: type: number format: double scale: type: number format: double incrementalConversions: type: number format: double liftPercentage: {} isLiftPercentageInfinity: type: boolean ApiResponseListFlipPixel: type: object properties: status: type: integer format: int32 message: type: string result: type: array items: $ref: '#/components/schemas/FlipPixel' ApiResponseListUniversalPixelFires: type: object properties: status: type: integer format: int32 message: type: string result: type: array items: $ref: '#/components/schemas/UniversalPixelFires' UniversalPixelFires: type: object properties: pixelTimeStamp: type: string orderNumber: type: string checkoutValue: type: number format: double category: type: string subCategory: type: string gaEventName: type: string gaEventAction: type: string gaReferrerUrl: type: string utmSource: type: string utmMedium: type: string ApiResponseUniversalPixelFiresSummary: type: object properties: status: type: integer format: int32 message: type: string result: $ref: '#/components/schemas/UniversalPixelFiresSummary' UniversalPixelFiresSummary: type: object properties: pixelId: type: string todaysCount: type: integer format: int64 yesterdaysCount: type: integer format: int64 last7DaysCount: type: integer format: int64 last30DaysCount: type: integer format: int64 last7DaysAverage: type: number format: double average: type: number format: double ApiResponseListKeyValueLong: type: object properties: status: type: integer format: int32 message: type: string result: type: array items: $ref: '#/components/schemas/KeyValueLong' KeyValueLong: type: object properties: key: type: string value: type: integer format: int64 extra: type: string ApiResponseListPixelEvent: type: object properties: status: type: integer format: int32 message: type: string result: type: array items: $ref: '#/components/schemas/PixelEvent' PixelEvent: type: object properties: event: type: string category: type: string selected: type: boolean numSubCategories: type: integer format: int32 children: type: array items: $ref: '#/components/schemas/PixelEvent' ApiResponseListString: type: object properties: status: type: integer format: int32 message: type: string result: type: array items: type: string AdvertiserMappingResponse: type: object properties: ahAccountId: type: string ahAdvertiserId: type: integer format: int32 drAccountId: type: integer format: int32 drAccountName: type: string drAdvertiserId: type: integer format: int32 drAdvertiserName: type: string universalPixel: type: string ApiResponseAdvertiserMappingResponse: type: object properties: status: type: integer format: int32 message: type: string result: $ref: '#/components/schemas/AdvertiserMappingResponse' ApiResponseListAccount: type: object properties: status: type: integer format: int32 message: type: string result: type: array items: $ref: '#/components/schemas/Account' ApiResponseListLong: type: object properties: status: type: integer format: int32 message: type: string result: type: array items: type: integer format: int64 ApiResponseListSolution: type: object properties: status: type: integer format: int32 message: type: string result: type: array items: $ref: '#/components/schemas/Solution' ApiResponseListSocialTopPerformer: type: object properties: status: type: integer format: int32 message: type: string result: type: array items: $ref: '#/components/schemas/SocialTopPerformer' SocialTopPerformer: type: object properties: name: type: string dimension: type: string ctr: {} ctrInfinity: type: boolean vcr: {} vcrInfinity: type: boolean SocialMetricsByDimension: type: object properties: name: type: string spend: type: number format: double impressions: type: number format: double clicks: type: number format: double cpm: {} cpmInfinity: type: boolean cpc: {} cpcInfinity: type: boolean cpcv: {} cpcvInfinity: type: boolean ctr: {} ctrInfinity: type: boolean completions: type: number format: double vcr: {} vcrInfinity: type: boolean ApiResponseListKeyValueDouble: type: object properties: status: type: integer format: int32 message: type: string result: type: array items: $ref: '#/components/schemas/KeyValueDouble' KeyValueDouble: type: object properties: key: type: string value: type: number format: double extra: type: string ApiResponseDailySocialSummary: type: object properties: status: type: integer format: int32 message: type: string result: $ref: '#/components/schemas/DailySocialSummary' ComparisonData: type: object properties: currentValue: type: number format: double compareValue: type: number format: double difference: type: number format: double change: type: number format: double isCurrentInfinity: type: boolean isCompareInfinity: type: boolean isChangeInfinity: type: boolean DailySocialSummary: type: object properties: breakup: type: array items: $ref: '#/components/schemas/KeyValueSocialSummary' KeyValueSocialSummary: type: object properties: key: type: string value: $ref: '#/components/schemas/SocialSummary' extra: type: string SocialSummary: type: object properties: spend: $ref: '#/components/schemas/ComparisonData' impressions: $ref: '#/components/schemas/ComparisonData' videoCompletions: $ref: '#/components/schemas/ComparisonData' videoImpressions: $ref: '#/components/schemas/ComparisonData' clicks: $ref: '#/components/schemas/ComparisonData' cpa: $ref: '#/components/schemas/ComparisonData' roas: $ref: '#/components/schemas/ComparisonData' vcr: $ref: '#/components/schemas/ComparisonData' ctr: $ref: '#/components/schemas/ComparisonData' ApiResponseListSearchTopPerformer: type: object properties: status: type: integer format: int32 message: type: string result: type: array items: $ref: '#/components/schemas/SearchTopPerformer' SearchTopPerformer: type: object properties: name: type: string dimension: type: string cpc: {} cpcInfinity: type: boolean cpa: {} cpaInfinity: type: boolean roas: {} roasInfinity: type: boolean ctr: {} ctrInfinity: type: boolean ApiResponseSearchSummary: type: object properties: status: type: integer format: int32 message: type: string result: $ref: '#/components/schemas/SearchSummary' SearchSummary: type: object properties: spend: $ref: '#/components/schemas/ComparisonData' impressions: $ref: '#/components/schemas/ComparisonData' clicks: $ref: '#/components/schemas/ComparisonData' cpc: $ref: '#/components/schemas/ComparisonData' ctr: $ref: '#/components/schemas/ComparisonData' ApiResponseListSearchMetricsByDimension: type: object properties: status: type: integer format: int32 message: type: string result: type: array items: $ref: '#/components/schemas/SearchMetricsByDimension' SearchMetricsByDimension: type: object properties: name: type: string spend: type: number format: double impressions: type: number format: double clicks: type: number format: double cpc: {} cpcInfinity: type: boolean ctr: {} ctrInfinity: type: boolean ApiResponseDailySearchSummary: type: object properties: status: type: integer format: int32 message: type: string result: $ref: '#/components/schemas/DailySearchSummary' DailySearchSummary: type: object properties: breakup: type: array items: $ref: '#/components/schemas/KeyValueSearchSummary' KeyValueSearchSummary: type: object properties: key: type: string value: $ref: '#/components/schemas/SearchSummary' extra: type: string ApiResponseCTVReachAndOverlap: type: object properties: status: type: integer format: int32 message: type: string result: $ref: '#/components/schemas/CTVReachAndOverlap' CTVReachAndOverlap: type: object properties: overallReach: type: number format: double overallCtvReach: type: number format: double incrementalCtvReach: type: number format: double incrementalReachPercent: type: number format: double uniqueCtvReach: type: number format: double overallLinearNrpReach: type: number format: double linearOnlyNrpReach: type: number format: double linearAndCtvNrpReach: type: number format: double linearCvr: type: number format: double linearAndCtvOverlapCvr: type: number format: double ctvCvr: type: number format: double ApiResponseListBrandTopPerformer: type: object properties: status: type: integer format: int32 message: type: string result: type: array items: $ref: '#/components/schemas/BrandTopPerformer' BrandTopPerformer: type: object properties: name: type: string dimension: type: string cpc: {} ctr: {} ctrInfinity: type: boolean vcr: {} vcrInfinity: type: boolean roas: {} roasInfinity: type: boolean impressions: type: number format: double ApiResponseBrandSummary: type: object properties: status: type: integer format: int32 message: type: string result: $ref: '#/components/schemas/BrandSummary' BrandSummary: type: object properties: spend: $ref: '#/components/schemas/ComparisonData' impressions: $ref: '#/components/schemas/ComparisonData' videoCompletions: $ref: '#/components/schemas/ComparisonData' videoImpressions: $ref: '#/components/schemas/ComparisonData' clicks: $ref: '#/components/schemas/ComparisonData' vcr: $ref: '#/components/schemas/ComparisonData' ctr: $ref: '#/components/schemas/ComparisonData' ApiResponseDailyBrandSummary: type: object properties: status: type: integer format: int32 message: type: string result: $ref: '#/components/schemas/DailyBrandSummary' DailyBrandSummary: type: object properties: breakup: type: array items: $ref: '#/components/schemas/KeyValueBrandSummary' KeyValueBrandSummary: type: object properties: key: type: string value: $ref: '#/components/schemas/BrandSummary' extra: type: string ApiResponsePageResponseReportGenerationLog: type: object properties: status: type: integer format: int32 message: type: string result: $ref: '#/components/schemas/PageResponseReportGenerationLog' PageResponseReportGenerationLog: type: object properties: content: type: array items: $ref: '#/components/schemas/ReportGenerationLog' first: type: boolean last: type: boolean pageNumber: type: integer format: int32 pageSize: type: integer format: int32 totalElements: type: integer format: int64 totalPages: type: integer format: int32 ReportGenerationLog: type: object properties: createdAt: type: string format: date-time createdBy: type: string deletedAt: type: string format: date-time id: type: integer format: int32 reportTemplateId: type: integer format: int32 status: type: string enum: - SUCCESS - FAILED - PROCESSING updatedAt: type: string format: date-time updatedBy: type: string url: type: string ApiResponseListReportTemplateResponseDto: type: object properties: status: type: integer format: int32 message: type: string result: type: array items: $ref: '#/components/schemas/ReportTemplateResponseDto' ReportTemplateResponseDto: type: object properties: accountId: type: integer format: int32 advertiserId: type: integer format: int32 createdBy: type: string createdByUserEmail: type: string createdByUserName: type: string emailTo: type: string filters: $ref: '#/components/schemas/ReportFilter' id: type: integer format: int32 lastRunDate: type: string format: date lastRunStatus: type: string enum: - SUCCESS - FAILED - PROCESSING name: type: string nextRunDate: type: string format: date schedule: type: string scheduleEndDate: type: string format: date scheduleStartDate: type: string format: date scheduleStatus: type: string ApiResponseListKeyValueString: type: object properties: status: type: integer format: int32 message: type: string result: type: array items: $ref: '#/components/schemas/KeyValueString' KeyValueString: type: object properties: key: type: string value: type: string extra: type: string ApiResponseListAdvertiserSolution: type: object properties: status: type: integer format: int32 message: type: string result: type: array items: $ref: '#/components/schemas/AdvertiserSolution' ApiResponsePageDmmIoPlacementFeedRaw: type: object properties: status: type: integer format: int32 message: type: string result: $ref: '#/components/schemas/PageDmmIoPlacementFeedRaw' DmmIoPlacementFeedRaw: type: object properties: campaignId: type: integer format: int32 creativeExecution: type: string creativeId: type: integer format: int32 creativeName: type: string device: type: string id: type: integer format: int32 ioPlacementName: type: string ioPlacementSize: type: string packageId: type: integer format: int32 placementId: type: integer format: int32 updatedOn: type: string format: date-time PageDmmIoPlacementFeedRaw: type: object properties: content: type: array items: $ref: '#/components/schemas/DmmIoPlacementFeedRaw' empty: type: boolean first: type: boolean last: type: boolean number: type: integer format: int32 numberOfElements: type: integer format: int32 pageable: $ref: '#/components/schemas/PageableObject' size: type: integer format: int32 sort: $ref: '#/components/schemas/SortObject' totalElements: type: integer format: int64 totalPages: type: integer format: int32 PageableObject: type: object properties: offset: type: integer format: int64 pageNumber: type: integer format: int32 pageSize: type: integer format: int32 paged: type: boolean sort: $ref: '#/components/schemas/SortObject' unpaged: type: boolean SortObject: type: object properties: empty: type: boolean sorted: type: boolean unsorted: type: boolean ApiResponsePageDmmIoPlacementFeedRawHistory: type: object properties: status: type: integer format: int32 message: type: string result: $ref: '#/components/schemas/PageDmmIoPlacementFeedRawHistory' DmmIoPlacementFeedRawHistory: type: object properties: campaignId: type: integer format: int32 creativeExecution: type: string creativeId: type: integer format: int32 creativeName: type: string device: type: string id: type: integer format: int32 ioPlacementName: type: string ioPlacementSize: type: string packageId: type: integer format: int32 placementId: type: integer format: int32 updatedOn: type: string format: date-time PageDmmIoPlacementFeedRawHistory: type: object properties: content: type: array items: $ref: '#/components/schemas/DmmIoPlacementFeedRawHistory' empty: type: boolean first: type: boolean last: type: boolean number: type: integer format: int32 numberOfElements: type: integer format: int32 pageable: $ref: '#/components/schemas/PageableObject' size: type: integer format: int32 sort: $ref: '#/components/schemas/SortObject' totalElements: type: integer format: int64 totalPages: type: integer format: int32 ApiResponsePageDmmIoPackageFeedRaw: type: object properties: status: type: integer format: int32 message: type: string result: $ref: '#/components/schemas/PageDmmIoPackageFeedRaw' DmmIoPackageFeedRaw: type: object properties: adServer: type: string campaignId: type: integer format: int32 cntMarketFeed: type: integer format: int32 id: type: integer format: int32 ioPackageCost: type: number ioPackageCostStructure: type: string ioPackageEndDate: type: string format: date-time ioPackageMottoClientCost: type: number ioPackageMottoClientRate: type: number ioPackageNotes: type: string ioPackageRate: type: number ioPackageRevisionNotes: type: string ioPackageStartDate: type: string format: date-time ioPackageUnits: type: integer format: int32 packageId: type: integer format: int32 packageName: type: string placementDetails: type: string targettingTactics: type: string updatedOn: type: string format: date-time PageDmmIoPackageFeedRaw: type: object properties: content: type: array items: $ref: '#/components/schemas/DmmIoPackageFeedRaw' empty: type: boolean first: type: boolean last: type: boolean number: type: integer format: int32 numberOfElements: type: integer format: int32 pageable: $ref: '#/components/schemas/PageableObject' size: type: integer format: int32 sort: $ref: '#/components/schemas/SortObject' totalElements: type: integer format: int64 totalPages: type: integer format: int32 ApiResponsePageDmmIoPackageFeedRawHistory: type: object properties: status: type: integer format: int32 message: type: string result: $ref: '#/components/schemas/PageDmmIoPackageFeedRawHistory' DmmIoPackageFeedRawHistory: type: object properties: adServer: type: string campaignId: type: integer format: int32 cntMarketFeed: type: integer format: int32 id: type: integer format: int32 ioPackageCost: type: number ioPackageCostStructure: type: string ioPackageEndDate: type: string format: date-time ioPackageMottoClientCost: type: number ioPackageMottoClientRate: type: number ioPackageNotes: type: string ioPackageRate: type: number ioPackageRevisionNotes: type: string ioPackageStartDate: type: string format: date-time ioPackageUnits: type: integer format: int32 packageId: type: integer format: int32 packageName: type: string placementDetails: type: string targettingTactics: type: string updatedOn: type: string format: date-time PageDmmIoPackageFeedRawHistory: type: object properties: content: type: array items: $ref: '#/components/schemas/DmmIoPackageFeedRawHistory' empty: type: boolean first: type: boolean last: type: boolean number: type: integer format: int32 numberOfElements: type: integer format: int32 pageable: $ref: '#/components/schemas/PageableObject' size: type: integer format: int32 sort: $ref: '#/components/schemas/SortObject' totalElements: type: integer format: int64 totalPages: type: integer format: int32 ApiResponsePageDmmIoCampaignFeedRaw: type: object properties: status: type: integer format: int32 message: type: string result: $ref: '#/components/schemas/PageDmmIoCampaignFeedRaw' DmmIoCampaignFeedRaw: type: object properties: advertiser: type: string campaignId: type: integer format: int32 cntAudienceDefination: type: integer format: int32 cntKeywordList: type: integer format: int32 cntMarketGroup: type: integer format: int32 cntSiteList: type: integer format: int32 contact: type: string id: type: integer format: int32 ioCampaign: type: string ioDate: type: string format: date-time ioEndDate: type: string format: date-time ioStartDate: type: string format: date-time ioStatus: type: string ioTotalCost: type: number ioTotalPackages: type: integer format: int32 ioTotalUnits: type: integer format: int32 mailingAddress: type: string updatedOn: type: string format: date-time PageDmmIoCampaignFeedRaw: type: object properties: content: type: array items: $ref: '#/components/schemas/DmmIoCampaignFeedRaw' empty: type: boolean first: type: boolean last: type: boolean number: type: integer format: int32 numberOfElements: type: integer format: int32 pageable: $ref: '#/components/schemas/PageableObject' size: type: integer format: int32 sort: $ref: '#/components/schemas/SortObject' totalElements: type: integer format: int64 totalPages: type: integer format: int32 ApiResponsePageDmmIoCampaignFeedRawHistory: type: object properties: status: type: integer format: int32 message: type: string result: $ref: '#/components/schemas/PageDmmIoCampaignFeedRawHistory' DmmIoCampaignFeedRawHistory: type: object properties: advertiser: type: string campaignId: type: integer format: int32 cntAudienceDefination: type: integer format: int32 cntKeywordList: type: integer format: int32 cntMarketGroup: type: integer format: int32 cntSiteList: type: integer format: int32 contact: type: string id: type: integer format: int32 ioCampaign: type: string ioDate: type: string format: date-time ioEndDate: type: string format: date-time ioStartDate: type: string format: date-time ioStatus: type: string ioTotalCost: type: number ioTotalPackages: type: integer format: int32 ioTotalUnits: type: integer format: int32 mailingAddress: type: string updatedOn: type: string format: date-time PageDmmIoCampaignFeedRawHistory: type: object properties: content: type: array items: $ref: '#/components/schemas/DmmIoCampaignFeedRawHistory' empty: type: boolean first: type: boolean last: type: boolean number: type: integer format: int32 numberOfElements: type: integer format: int32 pageable: $ref: '#/components/schemas/PageableObject' size: type: integer format: int32 sort: $ref: '#/components/schemas/SortObject' totalElements: type: integer format: int64 totalPages: type: integer format: int32