Akkio Ad Analytics API
The Ad Analytics API from Akkio — 32 operation(s) for ad analytics.
The Ad Analytics API from Akkio — 32 operation(s) for ad analytics.
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-ad-analytics-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 Ad Analytics API
version: 0.1.0
tags:
- name: Ad Analytics
paths:
/ad_analytics/cpg_suite/chat-explore:
post:
summary: ' Controller Chat Explore'
operationId: _controller_chat_explore_ad_analytics_cpg_suite_chat_explore_post
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
tags:
- Ad Analytics
/ad_analytics/cpg_suite/basket-analysis/get-existing:
post:
summary: ' Controller Get Existing Basket Analysis'
description: Get existing basket analysis results
operationId: _controller_get_existing_basket_analysis_ad_analytics_cpg_suite_basket_analysis_get_existing_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/BasketAnalysisRequest'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/BasketAnalysisResponse'
- type: 'null'
title: Response Controller Get Existing Basket Analysis Ad Analytics Cpg Suite Basket Analysis Get Existing Post
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
tags:
- Ad Analytics
/ad_analytics/cpg_suite/basket-analysis/:
post:
summary: ' Controller Basket Analysis'
description: Analyze products frequently purchased together with a given product
operationId: _controller_basket_analysis_ad_analytics_cpg_suite_basket_analysis__post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/BasketAnalysisRequest'
required: true
responses:
'201':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
tags:
- Ad Analytics
/ad_analytics/cpg_suite/cpg-analysis/get-existing:
post:
summary: ' Controller Get Existing Cpg Analysis'
description: Get existing CPG analysis results
operationId: _controller_get_existing_cpg_analysis_ad_analytics_cpg_suite_cpg_analysis_get_existing_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CPGAnalysisRequest'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/BrandAnalysisResponse'
- $ref: '#/components/schemas/CategoryAnalysisResponse'
- $ref: '#/components/schemas/SubcategoryAnalysisResponse'
- $ref: '#/components/schemas/ProductAnalysisResponse'
- $ref: '#/components/schemas/UPCAnalysisResponse'
- type: 'null'
title: Response Controller Get Existing Cpg Analysis Ad Analytics Cpg Suite Cpg Analysis Get Existing Post
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
tags:
- Ad Analytics
/ad_analytics/cpg_suite/cpg-analysis/:
post:
summary: ' Controller Cpg Analysis'
description: Analyze top brands, categories, products in purchase data
operationId: _controller_cpg_analysis_ad_analytics_cpg_suite_cpg_analysis__post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CPGAnalysisRequest'
required: true
responses:
'201':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
tags:
- Ad Analytics
/ad_analytics/cpg_suite/purchase-behaviour/get-existing:
post:
summary: ' Controller Get Existing Purchase Behaviour'
description: Get existing purchase behavior analysis results
operationId: _controller_get_existing_purchase_behaviour_ad_analytics_cpg_suite_purchase_behaviour_get_existing_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CPGBehaviourRequest'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/CPGBehaviourResponse'
- type: 'null'
title: Response Controller Get Existing Purchase Behaviour Ad Analytics Cpg Suite Purchase Behaviour Get Existing Post
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
tags:
- Ad Analytics
/ad_analytics/cpg_suite/purchase-behaviour/:
post:
summary: ' Controller Purchase Categories And Subcategories'
description: Analyze purchase behavior by category, subcategory, brand, or product
operationId: _controller_purchase_categories_and_subcategories_ad_analytics_cpg_suite_purchase_behaviour__post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CPGBehaviourRequest'
required: true
responses:
'201':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
tags:
- Ad Analytics
/ad_analytics/cpg_suite/trends-analysis/get-existing:
post:
summary: Get Existing Trends Analysis
description: Get existing trends analysis results if they exist.
operationId: get_existing_trends_analysis_ad_analytics_cpg_suite_trends_analysis_get_existing_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/TrendsAnalysisRequest'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/TrendsAnalysisResponse'
- type: 'null'
title: Response Get Existing Trends Analysis Ad Analytics Cpg Suite Trends Analysis Get Existing Post
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
tags:
- Ad Analytics
/ad_analytics/cpg_suite/trends-analysis/:
post:
summary: Start Trends Analysis
description: Start CPG trends analysis comparing two selections over time.
operationId: start_trends_analysis_ad_analytics_cpg_suite_trends_analysis__post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/TrendsAnalysisRequest'
required: true
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'
tags:
- Ad Analytics
/ad_analytics/cpg_suite/turf-analysis/get-existing:
post:
summary: ' Controller Get Existing Turf Analysis'
description: Get existing turf analysis results
operationId: _controller_get_existing_turf_analysis_ad_analytics_cpg_suite_turf_analysis_get_existing_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/TurfAnalysisRequest'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/TurfAnalysisResponse'
- type: 'null'
title: Response Controller Get Existing Turf Analysis Ad Analytics Cpg Suite Turf Analysis Get Existing Post
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
tags:
- Ad Analytics
/ad_analytics/cpg_suite/turf-analysis/:
post:
summary: ' Controller Turf Analysis'
description: Analyze optimal product combinations to maximize reach (TURF analysis)
operationId: _controller_turf_analysis_ad_analytics_cpg_suite_turf_analysis__post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/TurfAnalysisRequest'
required: true
responses:
'201':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
tags:
- Ad Analytics
/ad_analytics/cpg_suite/brands:
post:
summary: ' Controller Get Brands'
description: Get brands in the purchase data
operationId: _controller_get_brands_ad_analytics_cpg_suite_brands_post
parameters:
- name: sort_by_frequency
in: query
required: false
schema:
type: boolean
default: false
title: Sort By Frequency
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CPGSuiteFilter'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: array
items:
type: string
title: Response Controller Get Brands Ad Analytics Cpg Suite Brands Post
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
tags:
- Ad Analytics
/ad_analytics/cpg_suite/categories:
post:
summary: ' Controller Get Categories'
description: Get the categories in the purchase data
operationId: _controller_get_categories_ad_analytics_cpg_suite_categories_post
parameters:
- name: sort_by_frequency
in: query
required: false
schema:
type: boolean
default: false
title: Sort By Frequency
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CPGSuiteFilter'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: array
items:
type: string
title: Response Controller Get Categories Ad Analytics Cpg Suite Categories Post
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
tags:
- Ad Analytics
/ad_analytics/cpg_suite/subcategories:
post:
summary: ' Controller Get Subcategories'
description: Get the subcategories in the purchase data
operationId: _controller_get_subcategories_ad_analytics_cpg_suite_subcategories_post
parameters:
- name: sort_by_frequency
in: query
required: false
schema:
type: boolean
default: false
title: Sort By Frequency
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CPGSuiteFilter'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: array
items:
type: string
title: Response Controller Get Subcategories Ad Analytics Cpg Suite Subcategories Post
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
tags:
- Ad Analytics
/ad_analytics/cpg_suite/products:
post:
summary: ' Controller Get Products'
description: Get the products in the purchase data
operationId: _controller_get_products_ad_analytics_cpg_suite_products_post
parameters:
- name: sort_by_frequency
in: query
required: false
schema:
type: boolean
default: false
title: Sort By Frequency
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CPGSuiteFilter'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: array
items:
type: string
title: Response Controller Get Products Ad Analytics Cpg Suite Products Post
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
tags:
- Ad Analytics
/ad_analytics/cpg_suite/min-max-dates:
post:
summary: ' Controller Get Min Max Dates'
description: Get minimum and maximum dates available in the CPG data based on filters
operationId: _controller_get_min_max_dates_ad_analytics_cpg_suite_min_max_dates_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CPGSuiteFilter'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
anyOf:
- prefixItems:
- type: string
format: date
- type: string
format: date
type: array
maxItems: 2
minItems: 2
- type: 'null'
title: Response Controller Get Min Max Dates Ad Analytics Cpg Suite Min Max Dates Post
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
tags:
- Ad Analytics
/ad_analytics/cpg_suite/categories-with-brands:
post:
summary: ' Controller Get Categories With Brands'
description: Get the categories with brands in the purchase data
operationId: _controller_get_categories_with_brands_ad_analytics_cpg_suite_categories_with_brands_post
parameters:
- name: search_string
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Search String
- name: sort_by_frequency
in: query
required: false
schema:
type: boolean
default: false
title: Sort By Frequency
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/CategoryWithSubcategories'
title: Response Controller Get Categories With Brands Ad Analytics Cpg Suite Categories With Brands Post
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
tags:
- Ad Analytics
/ad_analytics/rfm/build_lookup:
post:
summary: ' Controller Build Rfm Lookup'
description: Builds the lookup table for an RFM model
operationId: _controller_build_rfm_lookup_ad_analytics_rfm_build_lookup_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RFMBuildPayload'
required: true
responses:
'201':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/src__async_job__service__build_concrete_async_job_record_class___locals___ConcreteAsyncJobRecord__4'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
tags:
- Ad Analytics
/ad_analytics/rfm/build_configuration:
post:
summary: ' Controller Build Rfm Configuration'
description: Builds the configuration for an RFM model
operationId: _controller_build_rfm_configuration_ad_analytics_rfm_build_configuration_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RFMBuildConfigurationPayload'
required: true
responses:
'201':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/src__async_job__service__build_concrete_async_job_record_class___locals___ConcreteAsyncJobRecord__5'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
tags:
- Ad Analytics
/ad_analytics/rfm/build_growth_framework:
post:
summary: ' Controller Build Growth Framework'
description: Builds the growth framework for an RFM model
operationId: _controller_build_growth_framework_ad_analytics_rfm_build_growth_framework_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RFMBuildGrowthFrameworkPayload'
required: true
responses:
'201':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/src__async_job__service__build_concrete_async_job_record_class___locals___ConcreteAsyncJobRecord__6'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
tags:
- Ad Analytics
/ad_analytics/rfm/build_audience_for_growth_framework:
post:
summary: ' Controller Build Audience For Growth Framework'
description: Builds the audience for a growth framework
operationId: _controller_build_audience_for_growth_framework_ad_analytics_rfm_build_audience_for_growth_framework_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RFMBuildAudienceForGrowthFrameworkPayload'
required: true
responses:
'201':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/src__async_job__service__build_concrete_async_job_record_class___locals___ConcreteAsyncJobRecord__7'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
tags:
- Ad Analytics
/ad_analytics/rfm/build_audience_for_rfm:
post:
summary: ' Controller Build Audience For Rfm'
description: Builds the audience for an RFM model
operationId: _controller_build_audience_for_rfm_ad_analytics_rfm_build_audience_for_rfm_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RFMBuildAudienceForRfmPayload'
required: true
responses:
'201':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/src__async_job__service__build_concrete_async_job_record_class___locals___ConcreteAsyncJobRecord__8'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
tags:
- Ad Analytics
/ad_analytics/entertainment/networks:
post:
summary: ' Controller Get Networks'
description: Get networks in the entertainment data
operationId: _controller_get_networks_ad_analytics_entertainment_networks_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/NetworkFilterPayload'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
items:
type: string
type: array
title: Response Controller Get Networks Ad Analytics Entertainment Networks Post
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
tags:
- Ad Analytics
/ad_analytics/entertainment/genres:
post:
summary: ' Controller Get Genres'
description: Get genres in the entertainment data
operationId: _controller_get_genres_ad_analytics_entertainment_genres_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/GenreFilterPayload'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
items:
type: string
type: array
title: Response Controller Get Genres Ad Analytics Entertainment Genres Post
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
tags:
- Ad Analytics
/ad_analytics/entertainment/dma-codes:
post:
summary: ' Controller Get Dma Codes'
description: Get DMA codes with their descriptions from the entertainment data
operationId: _controller_get_dma_codes_ad_analytics_entertainment_dma_codes_post
requestBody:
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/DmaCodesFilterPayload'
- type: 'null'
title: Payload
responses:
'200':
description: Successful Response
content:
application/json:
schema:
items:
$ref: '#/components/schemas/DMA'
type: array
title: Response Controller Get Dma Codes Ad Analytics Entertainment Dma Codes Post
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
tags:
- Ad Analytics
/ad_analytics/entertainment/titles:
post:
summary: ' Controller Get Titles'
description: Get titles in the entertainment data
operationId: _controller_get_titles_ad_analytics_entertainment_titles_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/TitleFilterPayload'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
items:
type: string
type: array
title: Response Controller Get Titles Ad Analytics Entertainment Titles Post
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
tags:
- Ad Analytics
/ad_analytics/entertainment/partition-dates:
post:
summary: ' Controller Get Partition Dates'
description: Get the minimum and maximum partition dates for the given filters
operationId: _controller_get_partition_dates_ad_analytics_entertainment_partition_dates_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/MinMaxPartitionDatePayload'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
anyOf:
- prefixItems:
- type: string
format: date
- type: string
format: date
type: array
maxItems: 2
minItems: 2
- type: 'null'
title: Response Controller Get Partition Dates Ad Analytics Entertainment Partition Dates Post
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
tags:
- Ad Analytics
/ad_analytics/entertainment/dates-with-data:
post:
summary: ' Controller Get Dates With Data'
description: Get a list of dates within the given range where data is available for the specified filters
operationId: _controller_get_dates_with_data_ad_analytics_entertainment_dates_with_data_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DateRangeDataAvailabilityPayload'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
items:
type: string
format: date
type: array
title: Response Controller Get Dates With Data Ad Analytics Entertainment Dates With Data Post
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
tags:
- Ad Analytics
/ad_analytics/poi/chains:
post:
summary: ' Controller Get Chains'
description: Get chains in the POI data
operationId: _controller_get_chains_ad_analytics_poi_chains_post
responses:
'200':
description: Successful Response
content:
application/json:
schema:
items: {}
type: array
title: Response Controller Get Chains Ad Analytics Poi Chains Post
tags:
- Ad Analytics
/ad_analytics/values:
post:
summary: Get Feature Values
description: Get unique values for a specific feature
operationId: get_feature_values_ad_analytics_values_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/GetFeatureValuesRequest'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
items:
type: string
type: array
title: Response Get Feature Values Ad Analytics Values Post
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
tags:
- Ad Analytics
/ad_analytics/hierarchy-search:
post:
summary: Hierarchy Search
description: Search across a hierarchy of columns
operationId: hierarchy_search_ad_analytics_hierarchy_search_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/HierarchySearchRequest'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
items:
$ref: '#/components/schemas/HierarchySearchResult'
type: array
title: Response Hierarchy Search Ad Analytics Hierarchy Search Post
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
tags:
- Ad Analytics
/ad_analytics/distinct-values:
post:
summary: Get Predicated Values
description: Get distinct values for a column with optional predicates
operationId: get_predicated_values_ad_analytics_distinct_values_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/GetDistinctValuesRequest'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
items:
type: string
type: array
title: Response Get Predicated Values Ad Analytics Distinct Values Post
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
tags:
- Ad Analytics
components:
schemas:
BrandAnalysisItem:
properties:
item:
type: string
title: Item
description: The item being analyzed (brand, category, product name, or UPC)
value:
type: number
title: Value
description: Value of the selected metric for this item
weighted_value:
type: number
title: Weighted Value
description: Weighted value of the selected metric for this item
additionalProperties: true
type: object
required:
- item
- value
- weighted_value
title: BrandAnalysisItem
description: Item for brand analysis results.
RFMBuildPayload:
properties:
product_selections:
$ref: '#/components/schemas/SelectionPayload'
description: The product selections for the RFM model
audience_id:
anyOf:
- type: string
- type: 'null'
title: Audienc
# --- truncated at 32 KB (87 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/akkio/refs/heads/main/openapi/akkio-ad-analytics-api-openapi.yml