openapi: 3.2.0 info: title: Fast Audience API version: 0.1.0 tags: - name: audience paths: /audience/lookalike/train: post: tags: - audience summary: ' Controller Handle Train Lookalike Audience' description: Train a lookalike model for an audience operationId: _controller_handle_train_lookalike_audience_audience_lookalike_train_post requestBody: content: application/json: schema: $ref: '#/components/schemas/TrainLALPayload' required: true responses: '201': description: Successful Response content: application/json: schema: anyOf: - $ref: '#/components/schemas/AudienceLAL' - type: 'null' title: Response Controller Handle Train Lookalike Audience Audience Lookalike Train Post '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /audience/lookalike/generate: post: tags: - audience summary: ' Controller Handle Generate Lookalike Audience' description: Generate a lookalike audience for an audience operationId: _controller_handle_generate_lookalike_audience_audience_lookalike_generate_post requestBody: content: application/json: schema: $ref: '#/components/schemas/BuildLALPayload' required: true responses: '201': description: Successful Response content: application/json: schema: type: object title: Response Controller Handle Generate Lookalike Audience Audience Lookalike Generate Post '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /audience/lookalike/stats: post: tags: - audience summary: ' Controller Handle Generate Lookalike Overview' description: Generate a lookalike audience stats for an audience operationId: _controller_handle_generate_lookalike_overview_audience_lookalike_stats_post requestBody: content: application/json: schema: $ref: '#/components/schemas/StatsLALPayload' required: true responses: '201': description: Successful Response content: application/json: schema: type: object title: Response Controller Handle Generate Lookalike Overview Audience Lookalike Stats Post '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /audience/lookalike/duration/{audience_id}: get: tags: - audience summary: ' Controller Handle Predict Execution Duration' description: Predict the execution duration of a lookalike model operationId: _controller_handle_predict_execution_duration_audience_lookalike_duration__audience_id__get parameters: - name: audience_id in: path required: true schema: type: string title: Audience Id responses: '201': description: Successful Response content: application/json: schema: type: number title: Response Controller Handle Predict Execution Duration Audience Lookalike Duration Audience Id Get '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /audience/lookalike/rerun: post: tags: - audience summary: ' Controller Handle Rerun Lookalike' description: Delete existing LAL data and retrain the lookalike model operationId: _controller_handle_rerun_lookalike_audience_lookalike_rerun_post requestBody: content: application/json: schema: $ref: '#/components/schemas/TrainLALPayload' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/AudienceLAL' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /audience/segmentation/build: post: tags: - audience summary: ' Controller Handle Train Segmentation Audience' description: Build a segmentation model for an audience operationId: _controller_handle_train_segmentation_audience_audience_segmentation_build_post requestBody: content: application/json: schema: $ref: '#/components/schemas/TrainSegPayload' required: true responses: '201': description: Successful Response content: application/json: schema: anyOf: - $ref: '#/components/schemas/AudienceSegmentationRecord' - type: 'null' title: Response Controller Handle Train Segmentation Audience Audience Segmentation Build Post '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /audience/segmentation/audience/generate: post: tags: - audience summary: ' Controller Handle Generate Segmentation Audience' description: Generate a segmentation audience for a segmentation model operationId: _controller_handle_generate_segmentation_audience_audience_segmentation_audience_generate_post requestBody: content: application/json: schema: $ref: '#/components/schemas/BuildSegAudiencePayload' required: true responses: '201': description: Successful Response content: application/json: schema: type: string title: Response Controller Handle Generate Segmentation Audience Audience Segmentation Audience Generate Post '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /audience/segmentation/rerun: post: tags: - audience summary: ' Controller Handle Rerun Segmentation' description: Delete existing segmentation data and retrain the model operationId: _controller_handle_rerun_segmentation_audience_segmentation_rerun_post requestBody: content: application/json: schema: $ref: '#/components/schemas/TrainSegPayload' required: true responses: '201': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/AudienceSegmentationRecord' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /audience/distribution/platform-one/target/create: post: tags: - audience summary: ' Create Target' description: Create a new PlatformOne Target/Syndication Group operationId: _create_target_audience_distribution_platform_one_target_create_post requestBody: content: application/json: schema: anyOf: - $ref: '#/components/schemas/MetaPlatformOneTargetPayload' - $ref: '#/components/schemas/DV360PlatformOneTargetPayload' - $ref: '#/components/schemas/TradeDeskPlatformOneTargetPayload' - $ref: '#/components/schemas/TikTokPlatformOneTargetPayload' - $ref: '#/components/schemas/AmazonPlatformOneTargetPayload' - $ref: '#/components/schemas/SnapchatPlatformOneTargetPayload' - $ref: '#/components/schemas/TeadsPlatformOneTargetPayload' - $ref: '#/components/schemas/PinterestPlatformOneTargetPayload' - $ref: '#/components/schemas/PandoraPlatformOneTargetPayload' - $ref: '#/components/schemas/DisneyPlusPlatformOneTargetPayload' - $ref: '#/components/schemas/RokuPlatformOneTargetPayload' - $ref: '#/components/schemas/ComcastPlatformOneTargetPayload' - $ref: '#/components/schemas/SpectrumTotalPlatformOneTargetPayload' - $ref: '#/components/schemas/PubmaticPlatformOneTargetPayload' - $ref: '#/components/schemas/LGAdsPlatformOneTargetPayload' - $ref: '#/components/schemas/AppNexusXandrInvestPlatformOneTargetPayload' - $ref: '#/components/schemas/SlingTvPlatformOneTargetPayload' - $ref: '#/components/schemas/SamsungAdsPlatformOneTargetPayload' - $ref: '#/components/schemas/LinkedInPlatformOneTargetPayload' - $ref: '#/components/schemas/MagnitePlatformOneTargetPayload' - $ref: '#/components/schemas/BeeswaxPlatformOneTargetPayload' - $ref: '#/components/schemas/DishPlatformOneTargetPayload' - $ref: '#/components/schemas/FourInfoPlatformOneTargetPayload' - $ref: '#/components/schemas/UndertonePlatformOneTargetPayload' - $ref: '#/components/schemas/IndexExchangePlatformOneTargetPayload' - $ref: '#/components/schemas/YahooVerizonDSPPlatformOneTargetPayload' - $ref: '#/components/schemas/OpenXPlatformOneTargetPayload' - $ref: '#/components/schemas/UnivisionPlatformOneTargetPayload' - $ref: '#/components/schemas/DirectTVSafeHavenPlatformOneTargetPayload' - $ref: '#/components/schemas/CriteoPlatformOneTargetPayload' - $ref: '#/components/schemas/SabioPlatformOneTargetPayload' - $ref: '#/components/schemas/GroundTruthPlatformOneTargetPayload' - $ref: '#/components/schemas/TaboolaPlatformOneTargetPayload' - $ref: '#/components/schemas/KargoPlatformOneTargetPayload' - $ref: '#/components/schemas/InMobiPlatformOneTargetPayload' - $ref: '#/components/schemas/LoopMePlatformOneTargetPayload' - $ref: '#/components/schemas/NativoPlatformOneTargetPayload' - $ref: '#/components/schemas/UnityPlatformOneTargetPayload' - $ref: '#/components/schemas/AdTheorentPlatformOneTargetPayload' - $ref: '#/components/schemas/LotamePlatformOneTargetPayload' - $ref: '#/components/schemas/CentroPlatformOneTargetPayload' - $ref: '#/components/schemas/TritonDigitalPlatformOneTargetPayload' title: Payload required: true responses: '201': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/PlatformOneAudienceDistributionTarget' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /audience/distribution/platform-one/target/delete/{target_id}: post: tags: - audience summary: ' Delete Target' description: Delete a new PlatformOne Target/Syndication Group operationId: _delete_target_audience_distribution_platform_one_target_delete__target_id__post parameters: - name: target_id in: path required: true schema: type: string title: Target Id responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /audience/distribution/distribute: post: tags: - audience summary: ' Distribute' description: Initiate Audience Distribution to Targets operationId: _distribute_audience_distribution_distribute_post requestBody: content: application/json: schema: $ref: '#/components/schemas/AudienceDistributionPayload' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /audience/location-intelligence/generate: post: tags: - audience summary: ' Controller Handle Generate Location Intelligence Audience' description: Generate an audience from location intelligence operationId: _controller_handle_generate_location_intelligence_audience_audience_location_intelligence_generate_post requestBody: content: application/json: schema: $ref: '#/components/schemas/LocationIntelligenceGenerateAudiencePayload' required: true responses: '201': description: Successful Response content: application/json: schema: type: object title: Response Controller Handle Generate Location Intelligence Audience Audience Location Intelligence Generate Post '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /audience/metadata/{audience_id}: get: tags: - audience summary: ' Audience Db Metadata' description: Get audience metadata operationId: _audience_db_metadata_audience_metadata__audience_id__get parameters: - name: audience_id in: path required: true schema: type: string title: Audience Id responses: '201': description: Successful Response content: application/json: schema: type: array items: {} title: Response Audience Db Metadata Audience Metadata Audience Id Get '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /audience: post: tags: - audience summary: ' Controller Handle Update Audience' description: Update an audience operationId: _controller_handle_update_audience_audience_post requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateAudiencePayload' required: true responses: '201': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /audience/parse_sql: post: tags: - audience summary: ' Controller Handle Parse Sql' description: Parses SQL and returns the result operationId: _controller_handle_parse_sql_audience_parse_sql_post requestBody: content: application/json: schema: $ref: '#/components/schemas/SqlParsePayload' required: true responses: '201': description: Successful Response content: application/json: schema: type: object title: Response Controller Handle Parse Sql Audience Parse Sql Post '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /audience/from_parsed_json: post: tags: - audience summary: ' Controller Handle From Parsed Json' description: Given parsed JSON and a datasource ID, returns an `Audience` object corresponding to that parsed JSON. Also initiates stats generation on the created audience. operationId: _controller_handle_from_parsed_json_audience_from_parsed_json_post requestBody: content: application/json: schema: $ref: '#/components/schemas/FromParsedJsonRequestPayload' required: true responses: '201': description: Successful Response content: application/json: schema: type: object title: Response Controller Handle From Parsed Json Audience From Parsed Json Post '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /audience/from_parsed_json/{task_id}/status: get: tags: - audience summary: ' Get Status' description: Retrieves the status of the provided Chat Explore task id. operationId: _get_status_audience_from_parsed_json__task_id__status_get parameters: - name: task_id in: path required: true schema: type: string title: Task Id responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/APIStatusResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /audience/from_parsed_json/{task_id}/result: get: tags: - audience summary: ' Get Result' description: Retrieves an audience creation result by ID. operationId: _get_result_audience_from_parsed_json__task_id__result_get parameters: - name: task_id in: path required: true schema: type: string title: Task Id responses: '200': description: Successful Response content: application/json: schema: type: object title: Response Get Result Audience From Parsed Json Task Id Result Get '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /audience/from_parsed_json/new: post: tags: - audience summary: ' Submit' description: Initiate audience creation call. Takes in a SQL payload as structured JSON. operationId: _submit_audience_from_parsed_json_new_post requestBody: content: application/json: schema: $ref: '#/components/schemas/FromParsedJsonRequestPayload' required: true responses: '201': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/APITaskStartedResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /audience/refresh/{audience_id}: post: tags: - audience summary: ' Refresh Audience' description: Refresh an audience and its stats from the stored SQL so that it matches the current data operationId: _refresh_audience_audience_refresh__audience_id__post parameters: - name: audience_id in: path required: true schema: type: string title: Audience Id requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AudienceRefreshPayload' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/AsyncJobRecord' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /audience/name/{audience_id}: put: tags: - audience summary: ' Set Audience Name' description: update audience name operationId: _set_audience_name_audience_name__audience_id__put parameters: - name: audience_id in: path required: true schema: type: string title: Audience Id requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AudienceNameUpdatePayload' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/AsyncJobRecord' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /audience/chart_update: post: tags: - audience summary: ' Audiece Chart Update' description: Update Chart Record with Render from a different audience. operationId: _audiece_chart_update_audience_chart_update_post requestBody: content: application/json: schema: $ref: '#/components/schemas/AudienceChartUpdatePayload' required: true responses: '201': description: Successful Response content: application/json: schema: type: object title: Response Audiece Chart Update Audience Chart Update Post '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /audience/audience_overlap: post: tags: - audience summary: ' Calculate Audiece Overlaps' description: Calculate Audience Overlaps. operationId: _calculate_audiece_overlaps_audience_audience_overlap_post requestBody: content: application/json: schema: $ref: '#/components/schemas/AudienceOverlapPayload' required: true responses: '201': description: Successful Response content: application/json: schema: type: object title: Response Calculate Audiece Overlaps Audience Audience Overlap Post '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /audience/key_differences/{audience_id}/{comparator_id}: post: tags: - audience summary: ' Controller Handle Key Differences' description: Given an audience_id and comparator_id, find the percent difference of demographic insights, using comparator_id's values as the base. operationId: _controller_handle_key_differences_audience_key_differences__audience_id___comparator_id__post parameters: - name: audience_id in: path required: true schema: type: string title: Audience Id - name: comparator_id in: path required: true schema: type: string title: Comparator Id - name: absolute_threshold in: query required: false schema: type: number default: 0.01 title: Absolute Threshold responses: '201': description: Successful Response content: application/json: schema: anyOf: - type: array items: {} - type: 'null' title: Response Controller Handle Key Differences Audience Key Differences Audience Id Comparator Id Post '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /audience/chat-explore-suggestions/{audience_id}: get: tags: - audience summary: Chat Explore Suggestions Route description: Generate suggestions for an audience operationId: chat_explore_suggestions_route_audience_chat_explore_suggestions__audience_id__get parameters: - name: audience_id in: path required: true schema: type: string title: Audience Id responses: '200': description: Successful Response content: application/json: schema: anyOf: - type: array items: type: string - type: 'null' title: Response Chat Explore Suggestions Route Audience Chat Explore Suggestions Audience Id Get '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /audience/import_audience: post: tags: - audience summary: ' Import Audience' description: Import an audience from a table operationId: _import_audience_audience_import_audience_post requestBody: content: application/json: schema: $ref: '#/components/schemas/ImportAudiencePayload' required: true responses: '201': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /audience/chat-explore: post: tags: - audience summary: ' Controller Chat Explore' operationId: _controller_chat_explore_audience_chat_explore_post responses: '200': description: Successful Response content: application/json: schema: {} components: schemas: AudienceRefreshPayload: properties: targets: items: $ref: '#/components/schemas/RefreshTargetEnum' type: array title: Targets description: 'List of entities to refresh: ''audience'', ''overview'', ''insights'', ''lookalike''. This list can not be empty' default: [] insight_context_list: anyOf: - items: $ref: '#/components/schemas/InsightContext' type: array - type: 'null' title: Insight Context List description: Limit insight refresh to specific insights. This parameter is ignored if insights are not being refresed in this call. additionalProperties: false type: object title: AudienceRefreshPayload UndertonePlatformOneTargetPayload: properties: type: $ref: '#/components/schemas/AudienceDistributionTargetType' platformOneConfigId: type: string title: Platformoneconfigid description: ID of PlatformOne Config teamId: type: string title: Teamid description: ID of Team undertoneAdvertiserName: type: string title: Undertoneadvertisername description: Undertone Advertiser Name. additionalProperties: true type: object required: - type - platformOneConfigId - teamId - undertoneAdvertiserName title: UndertonePlatformOneTargetPayload LoopMePlatformOneTargetPayload: properties: type: $ref: '#/components/schemas/AudienceDistributionTargetType' platformOneConfigId: type: string title: Platformoneconfigid description: ID of PlatformOne Config teamId: type: string title: Teamid description: ID of Team loopMeAdvertiserName: type: string title: Loopmeadvertisername description: Advertiser Name used in filenames for delivery of data to LoopMe. Consists of alpha-numeric characters and dash. additionalProperties: true type: object required: - type - platformOneConfigId - teamId - loopMeAdvertiserName title: LoopMePlatformOneTargetPayload SamsungAdsPlatformOneTargetPayload: properties: type: $ref: '#/components/schemas/AudienceDistributionTargetType' platformOneConfigId: type: string title: Platformoneconfigid description: ID of PlatformOne Config teamId: type: string title: Teamid description: ID of Team clientKey: type: string title: Clientkey description: Consists of alpha-numeric and underscore characters. additionalProperties: true type: object required: - type - platformOneConfigId - teamId - clientKey title: SamsungAdsPlatformOneTargetPayload RokuPlatformOneTargetPayload: properties: type: $ref: '#/components/schemas/AudienceDistributionTargetType' platformOneConfigId: type: string title: Platformoneconfigid description: ID of PlatformOne Config teamId: type: string title: Teamid description: ID of Team advertiserName: type: string title: Advertisername description: Advertiser Name additionalProperties: true type: object required: - type - platformOneConfigId - teamId - advertiserName title: RokuPlatformOneTargetPayload SabioPlatformOneTargetPayload: properties: type: $ref: '#/components/schemas/AudienceDistributionTargetType' platformOneConfigId: type: string title: Platformoneconfigid description: ID of PlatformOne Config teamId: type: string title: Teamid description: ID of Team distributionName: type: string title: Distributionname description: Identifier for the account configuration. additionalProperties: true type: object required: - type - platformOneConfigId - teamId - distributionName title: SabioPlatformOneTargetPayload PinterestPlatformOneTargetPayload: properties: type: $ref: '#/components/schemas/AudienceDistributionTargetType' platformOneConfigId: type: string title: Platformoneconfigid description: ID of PlatformOne Config teamId: type: string title: Teamid description: ID of Team advertiserId: type: string title: Advertiserid description: Pinterest Account ID which is 10 to 18 digits additionalProperties: true type: object required: - type - platformOneConfigId - teamId - advertiserId title: PinterestPlatformOneTargetPayload Audience: properties: id: type: string title: Id description: ID of this object. _markedForDeletion: type: boolean title: ' Markedfordeletion' description: marked if record has been soft-deleted. default: false created_at: anyOf: - type: string format: date-time - additionalProperties: type: integer type: object - type: 'null' title: Created At description: datetime object representing when this object was created. updated_at: anyOf: - type: string format: date-time - additionalProperties: type: integer type: object - type: 'null' title: Updated At description: datetime object representing when this object was updated. name: type: string title: Name description: The name of the audience. description: type: string title: Description description: description of the audience. default: '' owner: type: string title: Owner description: The owner of the audience. teamId: type: string title: Teamid description: The team ID associated with the audience. projectId: type: string title: Projectid description: The ID of the project associated with the audience. chatRecordId: anyOf: - type: string - type: 'null' title: Chatrecordid description: The ID of the chat record associated with the audience. state: $ref: '#/components/schemas/TaskStatusEnum' description: The state of the audience generation. default: PENDING audienceSql: type: string title: Audiencesql description: The SQL query defining the audience. audienceQueryJson: anyOf: - type: string - type: 'null' title: Audiencequeryjson description: The JSON defining the audience query. saved_to_db: type: boolean title: Saved To Db description: Whether the audience is saved to the database. llm_generated: anyOf: - type: boolean - type: 'null' title: Llm Generated description: Whether the audience was generated by LLM. default: true isGlobalAudience: type: boolean title: Isglobalaudience description: Whether the audience is global or pre-generated. default: false isSavedByUser: type: boolean title: Issavedbyuser description: Whether the audience was saved by the user. default: false audienceInsights: type: object title: Audienceinsights description: Insights related to the audience. default: {} bannerImagePath: type: string title: Bannerimagepath description: storage path for the audience banner. default: '' data: items: {} type: array title: Data description: The data for the audience. default: [] sources: anyOf: - type: object - type: 'null' title: Sources description: The source tables used for the audience. comment: anyOf: - type: string - type: object - type: 'null' title: Comment description: details on failure. imported: type: boolean title: Imported description: Whether the audience was imported. default: false num_rows: type: integer title: Num Rows description: The number of rows in the audience. default: 0 last_refreshed: anyOf: - type: string format: date-time - type: 'null' title: Last Refreshed description: datetime object representing when this audience was last refreshed. distribution_invalidity: anyOf: - additionalProperties: items: type: string type: array type: object - type: 'null' title: Distribution Invalidity description: Dict representing validity to distribute audience to various targets. startingAudienceId: anyOf: - type: string - type: 'null' title: Startingaudienceid description: Base audience id default: '' additionalProperties: true type: object required: - name - owner - teamId - projectId - audienceSql - saved_to_db title: Audience AudienceSegmentation: properties: segId: type: string title: Segid description: The ID of the lookalike audience. audience_id_fs: type: string title: Audience Id Fs description: The ID of the audience. status: $ref: '#/components/schemas/ModelStatus' description: The status of the lookalike audience. options: type: object title: Options description: The options for the lookalike audience. default: {} featureImportance: items: type: object type: array title: Featureimportance description: The feature importance of the segmentation. default: [] ignoreColumns: items: type: string type: array title: Ignorecolumns description: The passthrough columns of the lookalike model. numSegments: type: integer title: Numsegments description: The number of segments. default: 0 segments: items: $ref: '#/components/schemas/AudienceSegment' type: array title: Segments description: The segments of the audience. execution_duration: anyOf: - type: number - type: 'null' title: Execution Duration description: The execution duration of the segmentation. additionalProperties: true type: object required: - segId - audience_id_fs - status - ignoreColumns - segments title: AudienceSegmentation SpectrumTotalPlatformOneTargetPayload: properties: type: $ref: '#/components/schemas/AudienceDistributionTargetType' platformOneConfigId: type: string title: Platformoneconfigid description: ID of PlatformOne Config teamId: type: string title: Teamid description: ID of Team customerName: type: string title: Customername description: Customer Name segmentPrioritization: type: boolean title: Segmentprioritization description: Segment Prioritization subscriberSegmentId: $ref: '#/components/schemas/SpectrumTotalSubscriberSegment' description: Subscriber Segment ID additionalProperties: true type: object required: - type - platformOneConfigId - teamId - customerName - segmentPrioritization - subscriberSegmentId title: SpectrumTotalPlatformOneTargetPayload ModelStatus: type: string enum: - PRESTART - FINDING_FEATURES - COLLECTING_IDS - STAGING_DATA - COMPLETED - FAILED - FITTING_SUPERVISED_MODEL - BACKTESTING_SUPERVISED_MODEL - CLUSTERING_RESULTS - TRAINING_STACK - PREDICTING_SUPERVISED_MODEL - PREDICTING_STACK_MODEL - RESCALING_RESULTS - WRITING - LOGGING_PROBABILITIES - LOGGING_INFERENCE_SET_SIZE - FINDING_OPTIMAL_K - FINDING_CENTERS - FINDING_SEGMENT_DIFFS - FINDING_SEGMENT_DIFFERENCES - REMOVING_REDUNDANT_FEATURES_VIA_SQL title: ModelStatus AudienceSegmentationRecord: properties: id: anyOf: - type: integer - type: 'null' title: Id description: ID of this object. created_at: anyOf: - type: string format: date-time - type: 'null' title: Created At description: datetime object representing when this object was created. updated_at: anyOf: - type: string format: date-time - type: 'null' title: Updated At description: datetime object representing when this object was updated. deleted_at: anyOf: - type: string format: date-time - type: 'null' title: Deleted At description: datetime object representing when this object was deleted. seg_id: type: string title: Seg Id description: The ID of the lookalike audience. audience_id_fs: type: string title: Audience Id Fs description: The ID of the audience. status: $ref: '#/components/schemas/ModelStatus' description: The status of the lookalike audience. data: $ref: '#/components/schemas/AudienceSegmentation' description: Audience segmentation data type: object required: - seg_id - audience_id_fs - status - data title: AudienceSegmentationRecord MagnitePlatformOneTargetPayload: properties: type: $ref: '#/components/schemas/AudienceDistributionTargetType' platformOneConfigId: type: string title: Platformoneconfigid description: ID of PlatformOne Config teamId: type: string title: Teamid description: ID of Team magniteSeatId: type: string title: Magniteseatid description: Magnite Seat Id, Not the MetaData Seat Id. Consists of digits. magnitePartnerId: type: string title: Magnitepartnerid description: Magnite provided DMP Partner ID representing the owner of the segment. Consists of digits. additionalProperties: true type: object required: - type - platformOneConfigId - teamId - magniteSeatId - magnitePartnerId title: MagnitePlatformOneTargetPayload APIStatusMetadataFailed: properties: type: type: string enum: - FAILED const: FAILED title: Type default: FAILED error: type: string title: Error description: If provided, a text representation of what went wrong with the task, including if any action on your part may rectify the issue. default: Unable to complete request. Please verify your inputs, try again later, or get in touch at support@akkio.com. additionalProperties: true type: object title: APIStatusMetadataFailed SlingTvPlatformOneTargetPayload: properties: type: $ref: '#/components/schemas/AudienceDistributionTargetType' platformOneConfigId: type: string title: Platformoneconfigid description: ID of PlatformOne Config teamId: type: string title: Teamid description: ID of Team slingTVAdvertiserName: type: string title: Slingtvadvertisername description: slingTVAdvertiserName.This will be stored in seat.Input should consists of alphanumeric characters,underscores and hyphens. additionalProperties: true type: object required: - type - platformOneConfigId - teamId - slingTVAdvertiserName title: SlingTvPlatformOneTargetPayload AudienceChartUpdatePayload: properties: audience_id: type: string title: Audience Id description: Audience ID's to update chart with chat_id: type: string title: Chat Id description: Chat record to update additionalProperties: true type: object required: - audience_id - chat_id title: AudienceChartUpdatePayload PubmaticPlatformOneTargetPayload: properties: type: $ref: '#/components/schemas/AudienceDistributionTargetType' platformOneConfigId: type: string title: Platformoneconfigid description: ID of PlatformOne Config teamId: type: string title: Teamid description: ID of Team pubmaticDataProviderId: type: integer title: Pubmaticdataproviderid description: Pubmatic Data Provider ID, contains numeric characters only. additionalProperties: true type: object required: - type - platformOneConfigId - teamId - pubmaticDataProviderId title: PubmaticPlatformOneTargetPayload RefreshTargetEnum: type: string enum: - audience - overview - insights - lookalike title: RefreshTargetEnum AudienceNameUpdatePayload: properties: new_audience_name: type: string title: New Audience Name description: New audience name additionalProperties: true type: object required: - new_audience_name title: AudienceNameUpdatePayload HTTPValidationError: properties: detail: items: $ref: '#/components/schemas/ValidationError' type: array title: Detail type: object title: HTTPValidationError ValidationError: properties: loc: items: anyOf: - type: string - type: integer type: array title: Location msg: type: string title: Message type: type: string title: Error Type type: object required: - loc - msg - type title: ValidationError TrainLALPayload: properties: lal_id: type: string title: Lal Id description: The ID of the lookalike model to train audience_id: type: string title: Audience Id description: The ID of the audience to train the lookalike model on options: $ref: '#/components/schemas/TrainLALOptions' description: The options to use when training the lookalike model additionalProperties: true type: object required: - lal_id - audience_id - options title: TrainLALPayload AmazonPlatformOneTargetPayload: properties: type: $ref: '#/components/schemas/AudienceDistributionTargetType' platformOneConfigId: type: string title: Platformoneconfigid description: ID of PlatformOne Config teamId: type: string title: Teamid description: ID of Team cfid: type: string title: Cfid description: CFID for Amazon API. Amazon Advertiser ID. additionalProperties: true type: object required: - type - platformOneConfigId - teamId - cfid title: AmazonPlatformOneTargetPayload AudienceOverlapPayload: properties: audiences: items: type: string type: array title: Audiences description: Audience ID's to compare additionalProperties: true type: object required: - audiences title: AudienceOverlapPayload NativoPlatformOneTargetPayload: properties: type: $ref: '#/components/schemas/AudienceDistributionTargetType' platformOneConfigId: type: string title: Platformoneconfigid description: ID of PlatformOne Config teamId: type: string title: Teamid description: ID of Team nativoAdvertiserName: type: string title: Nativoadvertisername description: Advertiser Name used in filenames for delivery of data to Nativo. Enter 'thirdparty' for AdAdvisor and 3rd-party Data Providers. Consists of alpha-numeric characters and dash. additionalProperties: true type: object required: - type - platformOneConfigId - teamId - nativoAdvertiserName title: NativoPlatformOneTargetPayload MetaPlatformOneTargetPayload: properties: type: $ref: '#/components/schemas/AudienceDistributionTargetType' platformOneConfigId: type: string title: Platformoneconfigid description: ID of PlatformOne Config teamId: type: string title: Teamid description: ID of Team accountId: type: string title: Accountid description: Account ID for Meta Business API. metaDatasource: $ref: '#/components/schemas/MetaPlatformOneDataSourceEnum' description: Data Source for Meta Business API. additionalProperties: true type: object required: - type - platformOneConfigId - teamId - accountId - metaDatasource title: MetaPlatformOneTargetPayload src__ad_analytics__location_intelligence__model__Timeframe: properties: start_date: type: string format: date-time title: Start Date end_date: anyOf: - type: string format: date-time - type: 'null' title: End Date additionalProperties: true type: object required: - start_date - end_date title: Timeframe SnapchatPlatformOneTargetPayload: properties: type: $ref: '#/components/schemas/AudienceDistributionTargetType' platformOneConfigId: type: string title: Platformoneconfigid description: ID of PlatformOne Config teamId: type: string title: Teamid description: ID of Team organizationId: type: string title: Organizationid description: Snapchat Organization ID. Consists of alpha-numeric characters and - in the form xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx adAccountId: type: string title: Adaccountid description: The Ad Account Id is tied to a specific organisation, under which segments will be created. Consists of alpha-numeric characters and - in the form xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx. additionalProperties: true type: object required: - type - platformOneConfigId - teamId - organizationId - adAccountId title: SnapchatPlatformOneTargetPayload TritonDigitalPlatformOneTargetPayload: properties: type: $ref: '#/components/schemas/AudienceDistributionTargetType' platformOneConfigId: type: string title: Platformoneconfigid description: ID of PlatformOne Config teamId: type: string title: Teamid description: ID of Team publisherName: type: string title: Publishername description: Publisher Name of Triton's client, not the end Advertiser. Consists of alpha-numeric characters. additionalProperties: true type: object required: - type - platformOneConfigId - teamId - publisherName title: TritonDigitalPlatformOneTargetPayload LotamePlatformOneTargetPayload: properties: type: $ref: '#/components/schemas/AudienceDistributionTargetType' platformOneConfigId: type: string title: Platformoneconfigid description: ID of PlatformOne Config teamId: type: string title: Teamid description: ID of Team clientID: type: string title: Clientid description: Client ID which is 3 to 6 digits additionalProperties: true type: object required: - type - platformOneConfigId - teamId - clientID title: LotamePlatformOneTargetPayload DisneyPlusPlatformOneTargetPayload: properties: type: $ref: '#/components/schemas/AudienceDistributionTargetType' platformOneConfigId: type: string title: Platformoneconfigid description: ID of PlatformOne Config teamId: type: string title: Teamid description: ID of Team disneyClientName: type: string title: Disneyclientname description: Disney Plus client name. Consists of alpha-numeric characters. additionalProperties: true type: object required: - type - platformOneConfigId - teamId - disneyClientName title: DisneyPlusPlatformOneTargetPayload AppNexusXandrInvestPlatformOneTargetPayload: properties: type: $ref: '#/components/schemas/AudienceDistributionTargetType' platformOneConfigId: type: string title: Platformoneconfigid description: ID of PlatformOne Config teamId: type: string title: Teamid description: ID of Team memberIds: type: string title: Memberids description: Enter multiple member billing IDs separated by a comma. Consists of digits, ",", and " ". additionalProperties: true type: object required: - type - platformOneConfigId - teamId - memberIds title: AppNexusXandrInvestPlatformOneTargetPayload DV360PlatformOneTargetPayload: properties: type: $ref: '#/components/schemas/AudienceDistributionTargetType' platformOneConfigId: type: string title: Platformoneconfigid description: ID of PlatformOne Config teamId: type: string title: Teamid description: ID of Team customerId: type: string title: Customerid description: Customer ID for Google DV360 API. dv360Product: $ref: '#/components/schemas/DV360PlatformOneProductEnum' description: Product for DV360 API. additionalProperties: true type: object required: - type - platformOneConfigId - teamId - customerId - dv360Product title: DV360PlatformOneTargetPayload SqlParsePayload: properties: json_sql: type: object title: Json Sql description: The JSON containing the SQL to parse additionalProperties: true type: object required: - json_sql title: SqlParsePayload APITaskStartedResponse: properties: task_id: type: string title: Task Id description: The ID of the task that was started. This is generally queryable at a nearby `/status` endpoint to get the current status of the task. additionalProperties: true type: object required: - task_id title: APITaskStartedResponse TrainSegOptions: properties: k: anyOf: - type: integer enum: - 3 - 4 - 5 - type: string enum: - dynamic const: dynamic title: K description: 'The number of segments to create (allowed: 3, 4, 5, or ''dynamic'')' default: 3 household: type: boolean title: Household description: Whether to train at the household level default: false additionalProperties: true type: object title: TrainSegOptions AudienceSegment: properties: name: type: string title: Name description: The name of the segment. cluster_id: type: integer title: Cluster Id description: The cluster ID of the segment. overview: type: object title: Overview description: The overview statistics of the segment. default: {} description: type: string title: Description description: The description of the segment. default: '' topFactors: items: $ref: '#/components/schemas/TopFactor' type: array title: Topfactors description: The top factors of the segment. default: [] bannerImagePath: type: string title: Bannerimagepath description: The banner image path of the segment. default: '' aiSummary: items: $ref: '#/components/schemas/AISummary' type: array title: Aisummary description: The AI summary of the segment. default: [] additionalProperties: true type: object required: - name - cluster_id title: AudienceSegment TaskStatusEnum: type: string enum: - PENDING - IN_PROGRESS - SUCCEEDED - FAILED - UNKNOWN_TIMEOUT title: TaskStatusEnum description: Celery task status enum. Update apps/web-backend-api/src/types/TaskStatusEnum.ts if you update this enum. AudienceLAL: properties: id: type: string title: Id description: ID of this object. _markedForDeletion: type: boolean title: ' Markedfordeletion' description: marked if record has been soft-deleted. default: false created_at: anyOf: - type: string format: date-time - additionalProperties: type: integer type: object - type: 'null' title: Created At description: datetime object representing when this object was created. updated_at: anyOf: - type: string format: date-time - additionalProperties: type: integer type: object - type: 'null' title: Updated At description: datetime object representing when this object was updated. lalId: type: string title: Lalid description: The ID of the lookalike audience. audienceId: type: string title: Audienceid description: The ID of the audience. options: type: object title: Options description: The options for the lookalike audience. status: type: string title: Status description: The status of the lookalike audience. inference_set_size: type: integer title: Inference Set Size description: The size of the inference set. default: -1 ignore_columns: items: type: string type: array title: Ignore Columns description: The passthrough columns of the lookalike model. default: [] probabilities: anyOf: - items: type: number type: array - type: 'null' title: Probabilities description: The sorted probabilities of the lookalike audience. defaultStatsConfidence: anyOf: - type: number - type: 'null' title: Defaultstatsconfidence description: The default stats confidence of the lookalike audience. defaultStats: anyOf: - type: object - type: 'null' title: Defaultstats description: The default stats of the lookalike audience. featureImportance: anyOf: - items: type: object type: array - type: 'null' title: Featureimportance description: The feature importance of the lookalike audience. top_factors: items: $ref: '#/components/schemas/TopFactor' type: array title: Top Factors description: The top factors of the lookalike audience. default: [] executionDuration: anyOf: - type: number - type: 'null' title: Executionduration description: The execution duration of the lookalike audience. additionalProperties: true type: object required: - lalId - audienceId - options - status title: AudienceLAL PlatformOneAudienceDistributionTarget: properties: id: type: string title: Id description: ID of this object. _markedForDeletion: type: boolean title: ' Markedfordeletion' description: marked if record has been soft-deleted. default: false created_at: anyOf: - type: string format: date-time - additionalProperties: type: integer type: object - type: 'null' title: Created At description: datetime object representing when this object was created. updated_at: anyOf: - type: string format: date-time - additionalProperties: type: integer type: object - type: 'null' title: Updated At description: datetime object representing when this object was updated. teamId: type: string title: Teamid description: The team ID associated with the target. name: type: string title: Name type: $ref: '#/components/schemas/AudienceDistributionTargetType' config: $ref: '#/components/schemas/PlatformOneAudienceDistributionTargetConfig' additionalProperties: true type: object required: - teamId - name - type - config title: PlatformOneAudienceDistributionTarget AsyncJobRecord: properties: id: anyOf: - type: integer - type: 'null' title: Id description: ID of this object. created_at: anyOf: - type: string format: date-time - type: 'null' title: Created At description: datetime object representing when this object was created. updated_at: anyOf: - type: string format: date-time - type: 'null' title: Updated At description: datetime object representing when this object was updated. deleted_at: anyOf: - type: string format: date-time - type: 'null' title: Deleted At description: datetime object representing when this object was deleted. status: $ref: '#/components/schemas/TaskStatus' description: The status of the task. default: RUNNING endpoint: type: string title: Endpoint description: Endpoint spawning async job default: '' request: anyOf: - type: object - items: {} type: array - type: 'null' title: Request description: request sent to endpoint sync_response: anyOf: - type: object - items: {} type: array - type: 'null' title: Sync Response description: sync response error: anyOf: - type: string - type: 'null' title: Error description: error message response: title: Response description: async response type: object title: AsyncJobRecord description: Do NOT access this table directly. APIStatusResponse: properties: status: $ref: '#/components/schemas/TaskStatusEnum' description: The current status of the task being queried. metadata: oneOf: - $ref: '#/components/schemas/APIStatusMetadataPending' - $ref: '#/components/schemas/APIStatusMetadataInProgress' - $ref: '#/components/schemas/APIStatusMetadataSucceeded' - $ref: '#/components/schemas/APIStatusMetadataFailed' title: Metadata description: Metadata, contextually dependent on the status of the task being queried. discriminator: propertyName: type mapping: FAILED: '#/components/schemas/APIStatusMetadataFailed' IN_PROGRESS: '#/components/schemas/APIStatusMetadataInProgress' PENDING: '#/components/schemas/APIStatusMetadataPending' SUCCEEDED: '#/components/schemas/APIStatusMetadataSucceeded' additionalProperties: true type: object required: - status - metadata title: APIStatusResponse PandoraPlatformOneTargetPayload: properties: type: $ref: '#/components/schemas/AudienceDistributionTargetType' platformOneConfigId: type: string title: Platformoneconfigid description: ID of PlatformOne Config teamId: type: string title: Teamid description: ID of Team dmpTaxonomyId: type: integer title: Dmptaxonomyid description: DMP Taxonomy Id additionalProperties: true type: object required: - type - platformOneConfigId - teamId - dmpTaxonomyId title: PandoraPlatformOneTargetPayload BuildSegAudiencePayload: properties: seg_id: type: string title: Seg Id description: The ID of the segmentation model cluster_ids: items: type: integer type: array title: Cluster Ids description: The cluster IDs to generate the audience for new_audience_name: anyOf: - type: string - type: 'null' title: New Audience Name description: The name of the new audience team_id: anyOf: - type: string - type: 'null' title: Team Id description: The ID of the team to create the audience in owner: anyOf: - type: string - type: 'null' title: Owner description: The owner of the audience additionalProperties: true type: object required: - seg_id - cluster_ids title: BuildSegAudiencePayload YahooVerizonDSPPlatformOneTargetPayload: properties: type: $ref: '#/components/schemas/AudienceDistributionTargetType' platformOneConfigId: type: string title: Platformoneconfigid description: ID of PlatformOne Config teamId: type: string title: Teamid description: ID of Team distributionName: type: string title: Distributionname description: Identifier for the account configuration. dataType: type: string enum: - 3rd Party Data - AdAdvisor Data - Custom Data - Private Data - AdAdvisor by TransUnion Custom Data title: Datatype description: For 1st Party Data, Select "Private Data". For 3rd Party Data to a specific seat, Select "Custom Data". For 3rd Party Data to Yahoo’s MarketPlace, Select "3rd Party Data". additionalProperties: true type: object required: - type - platformOneConfigId - teamId - distributionName - dataType title: YahooVerizonDSPPlatformOneTargetPayload CriteoPlatformOneTargetPayload: properties: type: $ref: '#/components/schemas/AudienceDistributionTargetType' platformOneConfigId: type: string title: Platformoneconfigid description: ID of PlatformOne Config teamId: type: string title: Teamid description: ID of Team advertiserId: type: string title: Advertiserid description: Criteo Advertiser Id clientId: type: string title: Clientid description: Listed as client id in the document created when making a new key on criteos website clientSecret: type: string title: Clientsecret description: Listed as client secret in the document created when making a new key on criteos website additionalProperties: true type: object required: - type - platformOneConfigId - teamId - advertiserId - clientId - clientSecret title: CriteoPlatformOneTargetPayload FourInfoPlatformOneTargetPayload: properties: type: $ref: '#/components/schemas/AudienceDistributionTargetType' platformOneConfigId: type: string title: Platformoneconfigid description: ID of PlatformOne Config teamId: type: string title: Teamid description: ID of Team fourInfoAdvertiserName: type: string title: Fourinfoadvertisername description: FourInfo Advertiser Name. additionalProperties: true type: object required: - type - platformOneConfigId - teamId - fourInfoAdvertiserName title: FourInfoPlatformOneTargetPayload InsightContext: type: string enum: - AGE - GENDER - ETHNICITY_PREDICTION - EDUCATION - MARITAL_STATUS - LOCATION - STATE - OCCUPATION - HOUSEHOLD_MEDIAN_HOMEVALUE_BY_STATE - PRESENCE_OF_CHILDREN_IN_HOUSEHOLD - NUM_PEOPLE_IN_HOUSEHOLD - HOUSEHOLD_OWNS_HOME - AGE_OF_CHILDREN_IN_HOUSEHOLD - NUMBER_OF_CHILDREN_IN_HOUSEHOLD - INCOME - GENERAL_INTERESTS - SPORTS_INTERESTS - READING_INTERESTS - TRAVEL_INTERESTS - CAR_BRANDS - CAR_TYPES - CAR_MAKE_MODEL - CAR_FUEL_TYPES - CAR_SIZE - FINANCIAL_HEALTH - NET_WORTH - CREDIT_CARDS - INVESTMENTS - MEDIA_APPS - MEDIA_NETWORKS - MEDIA_TOP_TITLES - MEDIA_TOP_GENRES - MEDIA_INPUT_DEVICES - PURCHASE_CATEGORY - PURCHASE_AVERAGE_SPEND - ONLINE_CONTENT_CONSUMPTION - POI_CATEGORIES - POI_CHAINS - COUNTS title: InsightContext MetaPlatformOneDataSourceEnum: type: string enum: - BOTH_USER_AND_PARTNER_PROVIDED - USER_PROVIDED_ONLY - PARTNER_PROVIDED_ONLY title: MetaPlatformOneDataSourceEnum TeadsPlatformOneTargetPayload: properties: type: $ref: '#/components/schemas/AudienceDistributionTargetType' platformOneConfigId: type: string title: Platformoneconfigid description: ID of PlatformOne Config teamId: type: string title: Teamid description: ID of Team teadsDpId: type: string title: Teadsdpid description: Teads DPID is a value that must be provided by Teads or the Advertiser. Consists of 5 or 6 alpha-numeric characters. additionalProperties: true type: object required: - type - platformOneConfigId - teamId - teadsDpId title: TeadsPlatformOneTargetPayload StatsLALPayload: properties: lal_id: type: string title: Lal Id description: The ID of the lal model confidence: anyOf: - type: number - type: 'null' title: Confidence description: The confidence threshold for the lookalike model size: anyOf: - type: integer - type: 'null' title: Size description: The number of audience members to return additionalProperties: true type: object required: - lal_id title: StatsLALPayload TrainLALOptions: properties: household: type: boolean title: Household description: Whether to train at the household level locality_type: anyOf: - $ref: '#/components/schemas/LocalityType' - type: 'null' description: If set will target people within the specified geographical delineation. additionalProperties: true type: object required: - household title: TrainLALOptions APIStatusMetadataPending: properties: type: type: string enum: - PENDING const: PENDING title: Type default: PENDING additionalProperties: true type: object title: APIStatusMetadataPending OpenXPlatformOneTargetPayload: properties: type: $ref: '#/components/schemas/AudienceDistributionTargetType' platformOneConfigId: type: string title: Platformoneconfigid description: ID of PlatformOne Config teamId: type: string title: Teamid description: ID of Team uuid: type: string title: Uuid description: OpenX Advertiser Account ID additionalProperties: true type: object required: - type - platformOneConfigId - teamId - uuid title: OpenXPlatformOneTargetPayload UnivisionPlatformOneTargetPayload: properties: type: $ref: '#/components/schemas/AudienceDistributionTargetType' platformOneConfigId: type: string title: Platformoneconfigid description: ID of PlatformOne Config teamId: type: string title: Teamid description: ID of Team univisionAdvertiserName: type: string title: Univisionadvertisername description: Advertiser Name specific to Univision, not related to the chosen advertiser above. Used in filenames for delivery of data to Univision. Consists of alpha-numeric and underscore characters. additionalProperties: true type: object required: - type - platformOneConfigId - teamId - univisionAdvertiserName title: UnivisionPlatformOneTargetPayload CentroPlatformOneTargetPayload: properties: type: $ref: '#/components/schemas/AudienceDistributionTargetType' platformOneConfigId: type: string title: Platformoneconfigid description: ID of PlatformOne Config teamId: type: string title: Teamid description: ID of Team centroAdvertiserID: type: string title: Centroadvertiserid description: Basis DSP (Centro) Advertiser ID. Consists of lower-case alpha-numeric characters and dash. additionalProperties: true type: object required: - type - platformOneConfigId - teamId - centroAdvertiserID title: CentroPlatformOneTargetPayload ComcastPlatformOneTargetPayload: properties: type: $ref: '#/components/schemas/AudienceDistributionTargetType' platformOneConfigId: type: string title: Platformoneconfigid description: ID of PlatformOne Config teamId: type: string title: Teamid description: ID of Team subscriberType: $ref: '#/components/schemas/ComcastSubscriberType' description: Subscriber Type segmentPrioritization: type: boolean title: Segmentprioritization description: Segment Prioritization additionalProperties: true type: object required: - type - platformOneConfigId - teamId - subscriberType - segmentPrioritization title: ComcastPlatformOneTargetPayload TopFactor: properties: name: type: string title: Name importance: type: number title: Importance keyDifferences: items: type: object type: array title: Keydifferences additionalProperties: true type: object required: - name - importance - keyDifferences title: TopFactor IndexExchangePlatformOneTargetPayload: properties: type: $ref: '#/components/schemas/AudienceDistributionTargetType' platformOneConfigId: type: string title: Platformoneconfigid description: ID of PlatformOne Config teamId: type: string title: Teamid description: ID of Team distributionName: type: string title: Distributionname description: Identifier for the account configuration. additionalProperties: true type: object required: - type - platformOneConfigId - teamId - distributionName title: IndexExchangePlatformOneTargetPayload AudienceDistributionPayload: properties: audience_distribution_group_id: type: string title: Audience Distribution Group Id description: ID of the Audience Distribution Group additionalProperties: true type: object required: - audience_distribution_group_id title: AudienceDistributionPayload PlatformOneAudienceDistributionTargetConfig: properties: platform_one_config_id: type: string title: Platform One Config Id description: FK to PlatformOneAudienceDistributionTargetConfig record. syndication_group_id: type: integer title: Syndication Group Id description: Syndication Group ID, selects Destination for deploying audience additionalProperties: true type: object required: - platform_one_config_id - syndication_group_id title: PlatformOneAudienceDistributionTargetConfig description: Useful base model for any distribution target that goes through Platform One. BeeswaxPlatformOneTargetPayload: properties: type: $ref: '#/components/schemas/AudienceDistributionTargetType' platformOneConfigId: type: string title: Platformoneconfigid description: ID of PlatformOne Config teamId: type: string title: Teamid description: ID of Team accountID: type: string title: Accountid description: Enter your Beeswax Account ID. If you do not know your Account ID, reach out to your Beeswax Account Representative. buzzkey: type: string title: Buzzkey description: Enter your Beeswax Buzz Key. If you do not know your Buzz Key, reach out to your Beeswax Account Representative. additionalProperties: true type: object required: - type - platformOneConfigId - teamId - accountID - buzzkey title: BeeswaxPlatformOneTargetPayload APIStatusMetadataSucceeded: properties: type: type: string enum: - SUCCEEDED const: SUCCEEDED title: Type default: SUCCEEDED location: type: string title: Location description: The path at which you can submit a GET request to retrieve the result of the successful job. May require proper authentication or authorization to access. additionalProperties: true type: object required: - location title: APIStatusMetadataSucceeded ImportAudiencePayload: properties: audience_name: type: string title: Audience Name description: Name of the audience to import table_name: type: string title: Table Name description: Name of the table to import from additionalProperties: true type: object required: - audience_name - table_name title: ImportAudiencePayload GroundTruthPlatformOneTargetPayload: properties: type: $ref: '#/components/schemas/AudienceDistributionTargetType' platformOneConfigId: type: string title: Platformoneconfigid description: ID of PlatformOne Config teamId: type: string title: Teamid description: ID of Team distributionName: type: string title: Distributionname description: Identifier for the account configuration. additionalProperties: true type: object required: - type - platformOneConfigId - teamId - distributionName title: GroundTruthPlatformOneTargetPayload InMobiPlatformOneTargetPayload: properties: type: $ref: '#/components/schemas/AudienceDistributionTargetType' platformOneConfigId: type: string title: Platformoneconfigid description: ID of PlatformOne Config teamId: type: string title: Teamid description: ID of Team distributionName: type: string title: Distributionname description: Identifier for the account configuration. additionalProperties: true type: object required: - type - platformOneConfigId - teamId - distributionName title: InMobiPlatformOneTargetPayload FromParsedJsonRequestPayload: properties: audience_name: anyOf: - type: string - type: 'null' title: Audience Name description: If provided, used as the name of the audience. If missing, we infer an accurate name via LLM call. audience_description: anyOf: - type: string - type: 'null' title: Audience Description description: If provided, used as the description of the audience. If missing, we infer an accurate description via LLM call. parsed_json: type: object title: Parsed Json description: The parsed JSON object (corresponding to something created through the query builder) to create an `Audience` from. additionalProperties: true type: object required: - parsed_json title: FromParsedJsonRequestPayload DishPlatformOneTargetPayload: properties: type: $ref: '#/components/schemas/AudienceDistributionTargetType' platformOneConfigId: type: string title: Platformoneconfigid description: ID of PlatformOne Config teamId: type: string title: Teamid description: ID of Team dishAdvertiserName: type: string title: Dishadvertisername description: Dish Network Advertiser Name. additionalProperties: true type: object required: - type - platformOneConfigId - teamId - dishAdvertiserName title: DishPlatformOneTargetPayload UnityPlatformOneTargetPayload: properties: type: $ref: '#/components/schemas/AudienceDistributionTargetType' platformOneConfigId: type: string title: Platformoneconfigid description: ID of PlatformOne Config teamId: type: string title: Teamid description: ID of Team distributionName: type: string title: Distributionname description: Identifier for the account configuration. additionalProperties: true type: object required: - type - platformOneConfigId - teamId - distributionName title: UnityPlatformOneTargetPayload DirectTVSafeHavenPlatformOneTargetPayload: properties: type: $ref: '#/components/schemas/AudienceDistributionTargetType' platformOneConfigId: type: string title: Platformoneconfigid description: ID of PlatformOne Config teamId: type: string title: Teamid description: ID of Team distributionName: type: string title: Distributionname description: Identifier for the account configuration. additionalProperties: true type: object required: - type - platformOneConfigId - teamId - distributionName title: DirectTVSafeHavenPlatformOneTargetPayload UpdateAudiencePayload: properties: parsed_json: type: object title: Parsed Json description: The JSON SQL to update the audience with audience: $ref: '#/components/schemas/Audience' description: The audience to update additionalProperties: true type: object required: - parsed_json - audience title: UpdateAudiencePayload ComcastSubscriberType: type: string enum: - VOD - X1 - UA - LSA title: ComcastSubscriberType DV360PlatformOneProductEnum: type: string enum: - GOOGLE_ADS - DISPLAY_VIDEO_PARTNER - DISPLAY_VIDEO_ADVERTISER - GOOGLE_AD_MANAGER title: DV360PlatformOneProductEnum LocationIntelligenceGenerateAudiencePayload: properties: teamId: type: string title: Teamid description: team id new_audience_name: anyOf: - type: string - type: 'null' title: New Audience Name description: Audience Name zip_codes: items: type: string type: array title: Zip Codes description: Zip codes of places visited places: items: type: string type: array title: Places description: places visited timeframe: $ref: '#/components/schemas/src__ad_analytics__location_intelligence__model__Timeframe' description: timeframe audience_id: anyOf: - type: string - type: 'null' title: Audience Id description: source audience id additionalProperties: true type: object required: - teamId - new_audience_name - zip_codes - places - timeframe title: LocationIntelligenceGenerateAudiencePayload AudienceDistributionTargetType: type: string enum: - dv360-p1 - trade-desk-p1 - meta-p1 - tiktok-p1 - amazon-p1 - snapchat-p1 - teads-p1 - pinterest-p1 - pandora-p1 - disney-plus-p1 - roku-p1 - comcast-p1 - spectrum-total-p1 - pubmatic-p1 - lg-ads-p1 - appnexus-xandr-invest-p1 - sling-tv-p1 - samsung-ads-p1 - linkedin-p1 - magnite-p1 - beeswax-p1 - dish-p1 - 4info-p1 - undertone-p1 - index-exchange-p1 - yahoo-verizon-media-dsp-p1 - openx-p1 - univision-p1 - directv-safehaven-p1 - criteo-p1 - sabio-p1 - groundtruth-p1 - taboola-p1 - kargo-p1 - inmobi-p1 - loopme-p1 - nativo-p1 - unity-p1 - adtheorent-p1 - lotame-usa-p1 - centro-p1 - triton-digital-p1 - dmp-p1 - dv360-direct - trade-desk-direct - meta-direct title: AudienceDistributionTargetType AdTheorentPlatformOneTargetPayload: properties: type: $ref: '#/components/schemas/AudienceDistributionTargetType' platformOneConfigId: type: string title: Platformoneconfigid description: ID of PlatformOne Config teamId: type: string title: Teamid description: ID of Team clientID: type: string title: Clientid description: Client ID additionalProperties: true type: object required: - type - platformOneConfigId - teamId - clientID title: AdTheorentPlatformOneTargetPayload TaboolaPlatformOneTargetPayload: properties: type: $ref: '#/components/schemas/AudienceDistributionTargetType' platformOneConfigId: type: string title: Platformoneconfigid description: ID of PlatformOne Config teamId: type: string title: Teamid description: ID of Team distributionName: type: string title: Distributionname description: Identifier for the account configuration. additionalProperties: true type: object required: - type - platformOneConfigId - teamId - distributionName title: TaboolaPlatformOneTargetPayload TradeDeskPlatformOneTargetPayload: properties: type: $ref: '#/components/schemas/AudienceDistributionTargetType' platformOneConfigId: type: string title: Platformoneconfigid description: ID of PlatformOne Config teamId: type: string title: Teamid description: ID of Team firstPartyDataProviderId: type: string title: Firstpartydataproviderid description: First Party Data Provider TradeDesk API. secretKey: type: string title: Secretkey description: Secret Key for TradeDesk API. additionalProperties: true type: object required: - type - platformOneConfigId - teamId - firstPartyDataProviderId - secretKey title: TradeDeskPlatformOneTargetPayload LocalityType: type: string enum: - zip - dma title: LocalityType KargoPlatformOneTargetPayload: properties: type: $ref: '#/components/schemas/AudienceDistributionTargetType' platformOneConfigId: type: string title: Platformoneconfigid description: ID of PlatformOne Config teamId: type: string title: Teamid description: ID of Team kargoAdvertiserName: type: string title: Kargoadvertisername description: Advertiser Name specific to Kargo, not related to the chosen advertiser above. Consists of alpha-numeric and underscore characters. additionalProperties: true type: object required: - type - platformOneConfigId - teamId - kargoAdvertiserName title: KargoPlatformOneTargetPayload TikTokPlatformOneTargetPayload: properties: type: $ref: '#/components/schemas/AudienceDistributionTargetType' platformOneConfigId: type: string title: Platformoneconfigid description: ID of PlatformOne Config teamId: type: string title: Teamid description: ID of Team businessAccount: type: string title: Businessaccount description: Business Account for TikTok API. Business Account is used to select Access Token used with Advertiser ID. If a new Business Account is needed, an engineer MUST get a new accessToken. advertiserId: type: string title: Advertiserid description: Advertiser ID for TikTok API. additionalProperties: true type: object required: - type - platformOneConfigId - teamId - businessAccount - advertiserId title: TikTokPlatformOneTargetPayload APIStatusMetadataInProgress: properties: type: type: string enum: - IN_PROGRESS const: IN_PROGRESS title: Type default: IN_PROGRESS estimate_seconds: anyOf: - type: number - type: 'null' title: Estimate Seconds description: If provided, an estimate of how many seconds we expect this task to take. This value should be treated as a rough estimate on a best-effort basis, not a guarantee. additionalProperties: true type: object title: APIStatusMetadataInProgress AISummary: properties: summary: type: string title: Summary keyDifference: type: object title: Keydifference additionalProperties: true type: object required: - summary - keyDifference title: AISummary SpectrumTotalSubscriberSegment: type: string enum: - '29825341' - '46105647' - '46501132' title: SpectrumTotalSubscriberSegment TaskStatus: type: string enum: - RUNNING - COMPLETED - FAILED title: TaskStatus LGAdsPlatformOneTargetPayload: properties: type: $ref: '#/components/schemas/AudienceDistributionTargetType' platformOneConfigId: type: string title: Platformoneconfigid description: ID of PlatformOne Config teamId: type: string title: Teamid description: ID of Team lgAdsAdvertiserName: type: string title: Lgadsadvertisername description: LG Ads Advertiser Name. additionalProperties: true type: object required: - type - platformOneConfigId - teamId - lgAdsAdvertiserName title: LGAdsPlatformOneTargetPayload BuildLALPayload: properties: lal_id: type: string title: Lal Id description: The ID of the lal model new_audience_name: anyOf: - type: string - type: 'null' title: New Audience Name description: The name of the new audience confidence: anyOf: - type: number - type: 'null' title: Confidence description: The confidence threshold for the lookalike model size: anyOf: - type: integer - type: 'null' title: Size description: The number of audience members to return include_seed: type: boolean title: Include Seed description: Whether to include the seed audience in the lookalike audience default: false additionalProperties: true type: object required: - lal_id title: BuildLALPayload LinkedInPlatformOneTargetPayload: properties: type: $ref: '#/components/schemas/AudienceDistributionTargetType' platformOneConfigId: type: string title: Platformoneconfigid description: ID of PlatformOne Config teamId: type: string title: Teamid description: ID of Team accountId: type: string title: Accountid description: 'LinkedIn Account Id. Do NOT include urn:li:sponsoredAccount: at the beginning. Consists of 9 to 19 digits.' schema: type: string enum: - SHA256_EMAIL const: SHA256_EMAIL title: Schema description: Syndication Schema. default: SHA256_EMAIL additionalProperties: true type: object required: - type - platformOneConfigId - teamId - accountId title: LinkedInPlatformOneTargetPayload TrainSegPayload: properties: seg_id: type: string title: Seg Id description: The ID of the segmentation model to train audience_id: type: string title: Audience Id description: The ID of the audience to train the segmentation model on options: $ref: '#/components/schemas/TrainSegOptions' description: The options to use when training the segmentation model additionalProperties: true type: object required: - seg_id - audience_id - options title: TrainSegPayload