Akkio Audience API
The audience API from Akkio — 27 operation(s) for audience.
The audience API from Akkio — 27 operation(s) for audience.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/akkio-audience-api"
curl "https://apis.io/api/v1/apis?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
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:
# --- truncated at 32 KB (96 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/akkio/refs/heads/main/openapi/akkio-audience-api-openapi.yml