Adzviser: Talk to Your Marketing & Sales Data
Adzviser: Talk to Your Marketing & Sales Data · Acciones GPT
Adzviser Actions for GPT
Equip GPTs with the ability to retrieve real-time reporting data from Google Ads, Facebook Ads, Instagram Insights, Google Analytics, and more.
GET /mailchimp/get_metrics_and_breakdowns_listsgetMailchimpMetricsAndBreakdownsListGet the list of selectable Mailchimp metrics, such as Emails sent, Open rate (%), Total clicks, and breakdowns like Campaign name, List name, and Member email etc.
GET /klaviyo/get_metrics_and_breakdowns_listsgetKlaviyoMetricsAndBreakdownsListGet the list of selectable Klaviyo metrics, such as Emails recipients, Received SMS, and breakdowns like Campaign name, Flow name, and Person first name etc.
GET /google_my_business/get_metrics_and_breakdowns_listsgetBusinessProfileMetricsAndBreakdownsListGet the list of selectable Google My Business metrics, such as Total views, Phone calls, Bookings, and breakdowns like Location name, Website URL, and Address lines etc.
GET /merchant_center/get_metrics_and_breakdowns_listsgetMerchantCenterMetricsAndBreakdownsListGet the list of selectable Merchant Center metrics, such as Impressions, Clicks, Conversions, and breakdowns like Title, Brand, and Availability etc.
GET /woo_commerce/get_metrics_and_breakdowns_listsgetWooCommerceMetricsAndBreakdownsListGet the list of selectable WooCommerce metrics, such as Gross sales, Returns, Items sold, and breakdowns like Order number, Billing first name, and Shipping phone etc.
GET /linkedin_company_page/get_metrics_and_breakdowns_listsgetLinkedInPageMetricsAndBreakdownsListGet the list of selectable LinkedIn Page metrics, such as Content comments, Lifetime followers, Page views, and breakdowns like Content text, and Content URL etc.
GET /shopify/get_metrics_and_breakdowns_listsgetShopifyMetricsAndBreakdownsListGet the list of selectable Shopify metrics, such as Gross sales, Returns, Shipping, and breakdowns like Customer first name, Product SKU, and Order ID etc.
GET /tiktok_ads/get_metrics_and_breakdowns_listsgetTikTokAdsMetricsAndBreakdownsListGet the list of selectable TikTok Ads metrics, such as Clicks, CPM, Cost, and breakdowns like Campaign name, Gender, and Age etc.
GET /pinterest_ads/get_metrics_and_breakdowns_listsgetPinterestAdsMetricsAndBreakdownsListGet the list of selectable Pinterest Ads metrics, such as Impressions paid, Cost, Video views, and breakdowns like Ad group name, and Targeting location etc.
GET /snapchat_ads/get_metrics_and_breakdowns_listsgetSnapchatAdsMetricsAndBreakdownsListGet the list of selectable Snapchat Ads metrics such as Impressions, Cost, Leads, and breakdowns like DMA, Ad type, and Campaign name etc.
GET /linkedin_ads/get_metrics_and_breakdowns_listsgetLinkedInAdsMetricsAndBreakdownsListGet the list of selectable LinkedIn Ads metrics, such as Impressions, Reach, Total spent, and breakdowns like Device, Placement, and Campaign name etc.
GET /google_ads/get_metrics_and_breakdowns_listsgetGoogleAdsMetricsAndBreakdownsListGet the list of selectable Google Ads metrics, such as Cost, Roas, Impressions, and breakdowns like Device, Keyword Text, and Campaign Name etc.
GET /fb_ads/get_metrics_and_breakdowns_listsgetFacebookAdsMetricsAndBreakdownsListGet the list of selectable Facebook Ads metrics, such as Spend, CPC, Clicks, and breakdowns such as Gender, Country, and Device etc.
GET /ga4/get_metrics_and_breakdowns_listsgetGa4MetricsAndBreakdownsListGet the list of selectable Google Analytics metrics such as Active users, New users, Sessions, and breakdowns like Account name, Session medium, and Country etc.
GET /ig_profile/get_metrics_and_breakdowns_listsgetIgProfileMetricsAndBreakdownsListGet the list of selectable Instagram Profile metrics like Profile Follower, Profile Impressions, etc., and breakdowns like Profile ID, Profile Name, and Profile Website etc.
GET /ig_post/get_metrics_and_breakdowns_listsgetIgPostsMetricsAndBreakdownsListGet the list of selectable Instagram Post metrics such as Post Comments, Post Follows, Post Likes, and breakdowns like Media URL, Media Caption, and Media Product Type etc.
GET /fb_page/get_metrics_listgetFbPageMetricsListGet the list of selectable Facebook Page Insights metrics, such as Total likes, Total reach, Total page views etc.
GET /fb_post/get_metrics_and_breakdowns_listsgetFbPostsMetricsAndBreakdownsMetricsListGet the list of selectable Facebook Post/Video metrics like Post likes, Post total reactions, etc. and breakdowns like Post message, Post image URL, etc.
GET /search_console/get_metrics_and_breakdowns_listsgetGSCMetricsAndBreakdownsListGet the list of selectable Google Search Console metrics like Clicks, Positions, etc. and breakdowns like Landing page, and Search query etc.
GET /bing_ads/get_metrics_and_breakdowns_listsgetBingAdsMetricsAndBreakdownsListGet the list of selectable Bing Ads metrics like Impressions, Cost, Clicks, etc. and breakdowns like Campaign name, Keyword, and Device type etc.
GET /amazon_ads/get_metrics_and_breakdowns_listsgetAmazonAdsMetricsAndBreakdownsListGet the list of selectable Amazon Ads metrics like Purchases, Spend etc. and breakdowns like Campaign name, Keyword text, and ASIN etc.
GET /amazon_seller_central/get_metrics_and_breakdowns_listsgetAmazonSellerCentralMetricsAndBreakdownsListGet the list of selectable Amazon Seller Central metrics like Item price, Orders shipped, etc. and breakdowns like ASIN, Order channel, and Product name etc.
GET /youtube/get_metrics_and_breakdowns_listsgetYouTubeMetricsAndBreakdownsListGet the list of selectable YouTube metrics like Video views, Likes, Comments, etc. and breakdowns like Video ID, Video title, and Channel name etc.
GET /hubspot/get_metrics_and_breakdowns_listsgetHubSpotMetricsAndBreakdownsListGet the list of selectable HubSpot metrics like Contacts, Leads, etc. and breakdowns like Company name, Contact email, and Deal ID etc.
GET /x_ads/get_metrics_and_breakdowns_listsgetXAdsMetricsAndBreakdownsListGet the list of selectable X Ads (Twitter Ads) metrics like Impressions, Clicks, Spend, and breakdowns like Campaign name, Ad group name, and Placement etc.
GET /reddit_ads/get_metrics_and_breakdowns_listsgetBigCommerceMetricsAndBreakdownsListGet the list of selectable BigCommerce metrics like Orders, Revenue, Items sold, and breakdowns like Product name, Customer email, and Order status etc.
GET /zoho_crm/get_metrics_and_breakdowns_listsgetZohoMetricsAndBreakdownsListGet the list of selectable Zoho CRM metrics like deals, leads, and breakdowns like Contact name, Email, etc.
GET /salesforce/get_metrics_and_breakdowns_listsgetSalesforceMetricsAndBreakdownsListGet the list of selectable Salesforce metrics like Opportunity count, Leads, etc. and breakdowns like Opportunity name, Campaign name, etc.
POST /search_barsearchQueryRetrieve real-time reporting data such as impressions, cpc, etc. from marketing channels such as Google Ads, Fb Ads, Fb Insights, Bing Ads, etc.
GET /workspace/getgetWorkspaceRetrieve a list of workspaces that have been created by the user and their data sources, such as Google Ads, Facebook Ads accounts connected with each.
Esquema original API
{
"openapi": "3.1.0",
"info": {
"title": "Adzviser Actions for GPT",
"description": "Equip GPTs with the ability to retrieve real-time reporting data from Google Ads, Facebook Ads, Instagram Insights, Google Analytics, and more.",
"version": "v0.0.1"
},
"servers": [
{
"url": "https://copter.adzviser.com"
}
],
"paths": {
"/mailchimp/get_metrics_and_breakdowns_lists": {
"get": {
"description": "Get the list of selectable Mailchimp metrics, such as Emails sent, Open rate (%), Total clicks, and breakdowns like Campaign name, List name, and Member email etc.",
"operationId": "getMailchimpMetricsAndBreakdownsList",
"parameters": [],
"deprecated": false,
"security": [],
"x-openai-isConsequential": false
}
},
"/klaviyo/get_metrics_and_breakdowns_lists": {
"get": {
"description": "Get the list of selectable Klaviyo metrics, such as Emails recipients, Received SMS, and breakdowns like Campaign name, Flow name, and Person first name etc.",
"operationId": "getKlaviyoMetricsAndBreakdownsList",
"parameters": [],
"deprecated": false,
"security": [],
"x-openai-isConsequential": false
}
},
"/google_my_business/get_metrics_and_breakdowns_lists": {
"get": {
"description": "Get the list of selectable Google My Business metrics, such as Total views, Phone calls, Bookings, and breakdowns like Location name, Website URL, and Address lines etc.",
"operationId": "getBusinessProfileMetricsAndBreakdownsList",
"parameters": [],
"deprecated": false,
"security": [],
"x-openai-isConsequential": false
}
},
"/merchant_center/get_metrics_and_breakdowns_lists": {
"get": {
"description": "Get the list of selectable Merchant Center metrics, such as Impressions, Clicks, Conversions, and breakdowns like Title, Brand, and Availability etc.",
"operationId": "getMerchantCenterMetricsAndBreakdownsList",
"parameters": [],
"deprecated": false,
"security": [],
"x-openai-isConsequential": false
}
},
"/woo_commerce/get_metrics_and_breakdowns_lists": {
"get": {
"description": "Get the list of selectable WooCommerce metrics, such as Gross sales, Returns, Items sold, and breakdowns like Order number, Billing first name, and Shipping phone etc.",
"operationId": "getWooCommerceMetricsAndBreakdownsList",
"parameters": [],
"deprecated": false,
"security": [],
"x-openai-isConsequential": false
}
},
"/linkedin_company_page/get_metrics_and_breakdowns_lists": {
"get": {
"description": "Get the list of selectable LinkedIn Page metrics, such as Content comments, Lifetime followers, Page views, and breakdowns like Content text, and Content URL etc.",
"operationId": "getLinkedInPageMetricsAndBreakdownsList",
"parameters": [],
"deprecated": false,
"security": [],
"x-openai-isConsequential": false
}
},
"/shopify/get_metrics_and_breakdowns_lists": {
"get": {
"description": "Get the list of selectable Shopify metrics, such as Gross sales, Returns, Shipping, and breakdowns like Customer first name, Product SKU, and Order ID etc.",
"operationId": "getShopifyMetricsAndBreakdownsList",
"parameters": [],
"deprecated": false,
"security": [],
"x-openai-isConsequential": false
}
},
"/tiktok_ads/get_metrics_and_breakdowns_lists": {
"get": {
"description": "Get the list of selectable TikTok Ads metrics, such as Clicks, CPM, Cost, and breakdowns like Campaign name, Gender, and Age etc.",
"operationId": "getTikTokAdsMetricsAndBreakdownsList",
"parameters": [],
"deprecated": false,
"security": [],
"x-openai-isConsequential": false
}
},
"/pinterest_ads/get_metrics_and_breakdowns_lists": {
"get": {
"description": "Get the list of selectable Pinterest Ads metrics, such as Impressions paid, Cost, Video views, and breakdowns like Ad group name, and Targeting location etc.",
"operationId": "getPinterestAdsMetricsAndBreakdownsList",
"parameters": [],
"deprecated": false,
"security": [],
"x-openai-isConsequential": false
}
},
"/snapchat_ads/get_metrics_and_breakdowns_lists": {
"get": {
"description": "Get the list of selectable Snapchat Ads metrics such as Impressions, Cost, Leads, and breakdowns like DMA, Ad type, and Campaign name etc.",
"operationId": "getSnapchatAdsMetricsAndBreakdownsList",
"parameters": [],
"deprecated": false,
"security": [],
"x-openai-isConsequential": false
}
},
"/linkedin_ads/get_metrics_and_breakdowns_lists": {
"get": {
"description": "Get the list of selectable LinkedIn Ads metrics, such as Impressions, Reach, Total spent, and breakdowns like Device, Placement, and Campaign name etc.",
"operationId": "getLinkedInAdsMetricsAndBreakdownsList",
"parameters": [],
"deprecated": false,
"security": [],
"x-openai-isConsequential": false
}
},
"/google_ads/get_metrics_and_breakdowns_lists": {
"get": {
"description": "Get the list of selectable Google Ads metrics, such as Cost, Roas, Impressions, and breakdowns like Device, Keyword Text, and Campaign Name etc.",
"operationId": "getGoogleAdsMetricsAndBreakdownsList",
"parameters": [],
"deprecated": false,
"security": [],
"x-openai-isConsequential": false
}
},
"/fb_ads/get_metrics_and_breakdowns_lists": {
"get": {
"description": "Get the list of selectable Facebook Ads metrics, such as Spend, CPC, Clicks, and breakdowns such as Gender, Country, and Device etc.",
"operationId": "getFacebookAdsMetricsAndBreakdownsList",
"parameters": [],
"deprecated": false,
"security": [],
"x-openai-isConsequential": false
}
},
"/ga4/get_metrics_and_breakdowns_lists": {
"get": {
"description": "Get the list of selectable Google Analytics metrics such as Active users, New users, Sessions, and breakdowns like Account name, Session medium, and Country etc.",
"operationId": "getGa4MetricsAndBreakdownsList",
"parameters": [],
"deprecated": false,
"security": [],
"x-openai-isConsequential": false
}
},
"/ig_profile/get_metrics_and_breakdowns_lists": {
"get": {
"description": "Get the list of selectable Instagram Profile metrics like Profile Follower, Profile Impressions, etc., and breakdowns like Profile ID, Profile Name, and Profile Website etc.",
"operationId": "getIgProfileMetricsAndBreakdownsList",
"parameters": [],
"deprecated": false,
"security": [],
"x-openai-isConsequential": false
}
},
"/ig_post/get_metrics_and_breakdowns_lists": {
"get": {
"description": "Get the list of selectable Instagram Post metrics such as Post Comments, Post Follows, Post Likes, and breakdowns like Media URL, Media Caption, and Media Product Type etc.",
"operationId": "getIgPostsMetricsAndBreakdownsList",
"parameters": [],
"deprecated": false,
"security": [],
"x-openai-isConsequential": false
}
},
"/fb_page/get_metrics_list": {
"get": {
"description": "Get the list of selectable Facebook Page Insights metrics, such as Total likes, Total reach, Total page views etc.",
"operationId": "getFbPageMetricsList",
"parameters": [],
"deprecated": false,
"security": [],
"x-openai-isConsequential": false
}
},
"/fb_post/get_metrics_and_breakdowns_lists": {
"get": {
"description": "Get the list of selectable Facebook Post/Video metrics like Post likes, Post total reactions, etc. and breakdowns like Post message, Post image URL, etc.",
"operationId": "getFbPostsMetricsAndBreakdownsMetricsList",
"parameters": [],
"deprecated": false,
"security": [],
"x-openai-isConsequential": false
}
},
"/search_console/get_metrics_and_breakdowns_lists": {
"get": {
"description": "Get the list of selectable Google Search Console metrics like Clicks, Positions, etc. and breakdowns like Landing page, and Search query etc.",
"operationId": "getGSCMetricsAndBreakdownsList",
"parameters": [],
"deprecated": false,
"security": [],
"x-openai-isConsequential": false
}
},
"/bing_ads/get_metrics_and_breakdowns_lists": {
"get": {
"description": "Get the list of selectable Bing Ads metrics like Impressions, Cost, Clicks, etc. and breakdowns like Campaign name, Keyword, and Device type etc.",
"operationId": "getBingAdsMetricsAndBreakdownsList",
"parameters": [],
"deprecated": false,
"security": [],
"x-openai-isConsequential": false
}
},
"/amazon_ads/get_metrics_and_breakdowns_lists": {
"get": {
"description": "Get the list of selectable Amazon Ads metrics like Purchases, Spend etc. and breakdowns like Campaign name, Keyword text, and ASIN etc.",
"operationId": "getAmazonAdsMetricsAndBreakdownsList",
"parameters": [],
"deprecated": false,
"security": [],
"x-openai-isConsequential": false
}
},
"/amazon_seller_central/get_metrics_and_breakdowns_lists": {
"get": {
"description": "Get the list of selectable Amazon Seller Central metrics like Item price, Orders shipped, etc. and breakdowns like ASIN, Order channel, and Product name etc.",
"operationId": "getAmazonSellerCentralMetricsAndBreakdownsList",
"parameters": [],
"deprecated": false,
"security": [],
"x-openai-isConsequential": false
}
},
"/youtube/get_metrics_and_breakdowns_lists": {
"get": {
"description": "Get the list of selectable YouTube metrics like Video views, Likes, Comments, etc. and breakdowns like Video ID, Video title, and Channel name etc.",
"operationId": "getYouTubeMetricsAndBreakdownsList",
"parameters": [],
"deprecated": false,
"security": [],
"x-openai-isConsequential": false
}
},
"/hubspot/get_metrics_and_breakdowns_lists": {
"get": {
"description": "Get the list of selectable HubSpot metrics like Contacts, Leads, etc. and breakdowns like Company name, Contact email, and Deal ID etc.",
"operationId": "getHubSpotMetricsAndBreakdownsList",
"parameters": [],
"deprecated": false,
"security": [],
"x-openai-isConsequential": false
}
},
"/x_ads/get_metrics_and_breakdowns_lists": {
"get": {
"description": "Get the list of selectable X Ads (Twitter Ads) metrics like Impressions, Clicks, Spend, and breakdowns like Campaign name, Ad group name, and Placement etc.",
"operationId": "getXAdsMetricsAndBreakdownsList",
"parameters": [],
"deprecated": false,
"security": [],
"x-openai-isConsequential": false
}
},
"/reddit_ads/get_metrics_and_breakdowns_lists": {
"get": {
"description": "Get the list of selectable BigCommerce metrics like Orders, Revenue, Items sold, and breakdowns like Product name, Customer email, and Order status etc.",
"operationId": "getBigCommerceMetricsAndBreakdownsList",
"parameters": [],
"deprecated": false,
"security": [],
"x-openai-isConsequential": false
}
},
"/zoho_crm/get_metrics_and_breakdowns_lists": {
"get": {
"description": "Get the list of selectable Zoho CRM metrics like deals, leads, and breakdowns like Contact name, Email, etc.",
"operationId": "getZohoMetricsAndBreakdownsList",
"parameters": [],
"deprecated": false,
"security": [],
"x-openai-isConsequential": false
}
},
"/salesforce/get_metrics_and_breakdowns_lists": {
"get": {
"description": "Get the list of selectable Salesforce metrics like Opportunity count, Leads, etc. and breakdowns like Opportunity name, Campaign name, etc.",
"operationId": "getSalesforceMetricsAndBreakdownsList",
"parameters": [],
"deprecated": false,
"security": [],
"x-openai-isConsequential": false
}
},
"/search_bar": {
"post": {
"description": "Retrieve real-time reporting data such as impressions, cpc, etc. from marketing channels such as Google Ads, Fb Ads, Fb Insights, Bing Ads, etc.",
"operationId": "searchQuery",
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/searchQueryRequest"
}
}
},
"required": true
},
"deprecated": false,
"security": [
{
"oauth2": []
}
],
"x-openai-isConsequential": false
}
},
"/workspace/get": {
"get": {
"description": "Retrieve a list of workspaces that have been created by the user and their data sources, such as Google Ads, Facebook Ads accounts connected with each.",
"operationId": "getWorkspace",
"parameters": [],
"deprecated": false,
"security": [
{
"oauth2": []
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/getWorkspaceResponse"
}
}
}
}
},
"x-openai-isConsequential": false
}
}
},
"components": {
"schemas": {
"getWorkspaceResponse": {
"title": "getWorkspaceResponse",
"type": "array",
"description": "The list of workspaces created by the user on adzviser.com/main. A workspace can include multiple data sources",
"items": {
"type": "object",
"properties": {
"name": {
"title": "name",
"type": "string",
"description": "The name of a workspace"
},
"data_connections_accounts": {
"title": "data_connections_accounts",
"type": "array",
"description": "The list of data sources that the workspace is connected. The name can be an account name and type can be Google Ads/Facebook Ads/Bing Ads",
"items": {
"type": "object",
"properties": {
"name": {
"title": "name",
"type": "string",
"description": "The name of a data connection account"
}
}
}
}
}
}
},
"searchQueryRequest": {
"description": "Contains details about queried data source, metrics, breakdowns, time ranges and time granularity, etc.",
"type": "object",
"required": [
"assorted_requests",
"workspace_name",
"date_ranges"
],
"title": "searchQueryRequest",
"properties": {
"assorted_requests": {
"type": "object",
"title": "assorted_requests",
"description": "This object contains API-specific requests for retrieving data from various data sources. Only include requests relevant to the user's query. For instance, if the user requests 'cost on Google ads last month,' include only the `google_ads_request` with the appropriate metrics and breakdowns. Do not include irrelevant or unused requests in this object. Depends on from which data source the user asks for data, call the corresponding APIs defined above to get metrics and breakdowns, if exist. For example, if the user asks for \"cost on Google ads last month\", then call getGoogleAdsMetricsList and getGoogleAdsBreakdownsList to retrieve the latest up-to-date info about how to compose a google_ads_request. A metric is a quantitative measurement. It represents data that can be measured and expressed in numbers. Metrics are used to track performance or behavior. Examples include clicks, impressions, conversions, revenue, etc. A breakdown is a qualitative attribute or descriptor. It provides context for metrics by categorizing or segmenting them. Breakdowns are text. Examples include country, channel, campaign name, etc. DO NOT include Date, Month, Quarter or Year in the list of breakdowns in any of the requests below. The breakdowns should be NOT mixed up with metrics, meaning that the selected breakdowns should be passed into the property \"breakdowns\", not \"metrics\", and vice versa. Last but not least, please always use Python and Code Interpreter to validate and print the JSON object of the composed searchQueryRequest before sending the request to the server (/search_bar). Such a validation on the searchQueryRequest JSON object is to avoid the painful ApiSyntaxErrors.",
"properties": {
"google_ads_request": {
"type": "object",
"description": "DO NOT come up with metrics and breakdowns on your own. You MUST call API getGoogleAdsMetricsAndBreakdownsList to be better informed prior of composing a google_ads_request.",
"required": [
"metrics",
"breakdowns"
],
"properties": {
"metrics": {
"type": "array",
"items": {
"type": "string"
},
"description": "Must call API getGoogleAdsMetricsAndBreakdownsList to retrieve a list of selectable metrics."
},
"breakdowns": {
"type": "array",
"items": {
"type": "string"
},
"description": "Must call API getGoogleAdsMetricsAndBreakdownsList to retrieve a list of selectable breakdowns."
}
}
},
"fb_ads_request": {
"type": "object",
"description": "A request that contains details of demand for Facebook Ads data.",
"required": [
"metrics",
"breakdowns"
],
"properties": {
"metrics": {
"type": "array",
"items": {
"type": "string"
},
"description": "Must call API getFacebookAdsMetricsAndBreakdownsList to retrieve a list of selectable metrics."
},
"breakdowns": {
"type": "array",
"items": {
"type": "string"
},
"description": "Must call API getFacebookAdsMetricsAndBreakdownsList to retrieve a list of selectable breakdowns."
}
}
},
"ga4_request": {
"type": "object",
"description": "A request that contains details of demand for Google Analytics 4 data.",
"required": [
"metrics",
"breakdowns"
],
"properties": {
"metrics": {
"type": "array",
"items": {
"type": "string"
},
"description": "Must call API getGa4MetricsAndBreakdownsList to retrieve a list of selectable metrics."
},
"breakdowns": {
"type": "array",
"items": {
"type": "string"
},
"description": "Must call API getGa4MetricsAndBreakdownsList to retrieve a list of selectable breakdowns."
}
}
},
"ig_profile_insights_request": {
"type": "object",
"description": "A request that contains details of demand for Instagram profile insight data.",
"required": [
"metrics",
"breakdowns"
],
"properties": {
"metrics": {
"type": "array",
"items": {
"type": "string"
},
"description": "Must call API getIgProfileMetricsAndBreakdownsList to retrieve a list of selectable metrics."
},
"breakdowns": {
"type": "array",
"items": {
"type": "string"
},
"description": "Must call API getIgProfileMetricsAndBreakdownsList to retrieve a list of selectable breakdowns."
}
}
},
"ig_posts_insights_request": {
"type": "object",
"description": "A request that contains details of demand for Instagram Post insights data.",
"required": [
"metrics",
"breakdowns"
],
"properties": {
"metrics": {
"type": "array",
"items": {
"type": "string"
},
"description": "Must call API getIgPostsMetricsAndBreakdownsList to retrieve a list of selectable metrics."
},
"breakdowns": {
"type": "array",
"items": {
"type": "string"
},
"description": "Must call API getIgPostsMetricsAndBreakdownsList to retrieve a list of selectable breakdowns."
}
}
},
"bing_ads_request": {
"type": "object",
"description": "A request that contains details of demand for Bing Ads data.",
"required": [
"metrics",
"breakdowns"
],
"properties": {
"metrics": {
"type": "array",
"items": {
"type": "string"
},
"description": "Must call API getBingAdsMetricsAndBreakdownsList to retrieve a list of selectable metrics."
},
"breakdowns": {
"type": "array",
"items": {
"type": "string"
},
"description": "Must call API getBingAdsMetricsAndBreakdownsList to retrieve a list of selectable breakdowns."
}
}
},
"gsc_request": {
"type": "object",
"description": "A request that contains details of demand for Google Search Console data.",
"required": [
"metrics",
"breakdowns",
"get_sitemaps"
],
"properties": {
"metrics": {
"type": "array",
"items": {
"type": "string"
},
"description": "Must call API getGSCMetricsAndBreakdownsList to retrieve a list of selectable metrics."
},
"breakdowns": {
"type": "array",
"items": {
"type": "string"
},
"description": "Must call API getGSCMetricsAndBreakdownsList to retrieve a list of selectable breakdowns."
},
"get_sitemaps": {
"type": "boolean",
"default": false,
"description": "Whether the user wants to retrieve the list of submitted sitemaps details."
}
}
},
"fb_page_insights_request": {
"type": "object",
"description": "A request that contains details of demand for Facebook Page insights data.",
"required": [
"metrics"
],
"properties": {
"metrics": {
"type": "array",
"items": {
"type": "string"
},
"description": "Must call API getFbPageMetricsList to retrieve a list of selectable metrics."
}
}
},
"fb_post_insights_request": {
"type": "object",
"description": "A request that contains details of demand for Facebook Post insights data.",
"required": [
"metrics",
"breakdowns"
],
"properties": {
"metrics": {
"type": "array",
"items": {
"type": "string"
},
"description": "Must call API getFbPostsMetricsAndBreakdownsMetricsList to retrieve a list of selectable metrics."
},
"breakdowns": {
"type": "array",
"items": {
"type": "string"
},
"description": "Must call API getFbPostsMetricsAndBreakdownsMetricsList to retrieve a list of selectable breakdowns."
}
}
},
"tiktok_ads_request": {
"type": "object",
"description": "A request that contains details of demand for TikTok Ads data.",
"required": [
"metrics",
"breakdowns"
],
"properties": {
"metrics": {
"type": "array",
"items": {
"type": "string"
},
"description": "Must call API getTikTokAdsMetricsAndBreakdownsList to retrieve a list of selectable metrics."
},
"breakdowns": {
"type": "array",
"items": {
"type": "string"
},
"description": "Must call API getTikTokAdsMetricsAndBreakdownsList to retrieve a list of selectable breakdowns."
}
}
},
"pinterest_ads_request": {
"type": "object",
"description": "A request that contains details of demand for Pinterest Ads data.",
"required": [
"metrics",
"breakdowns"
],
"properties": {
"metrics": {
"type": "array",
"items": {
"type": "string"
},
"description": "Must call API getPinterestAdsMetricsAndBreakdownsList to retrieve a list of selectable metrics."
},
"breakdowns": {
"type": "array",
"items": {
"type": "string"
},
"description": "Must call API getPinterestAdsMetricsAndBreakdownsList to retrieve a list of selectable breakdowns."
}
}
},
"snapchat_ads_request": {
"type": "object",
"description": "A request that contains details of demand for Snapchat Ads data.",
"required": [
"metrics",
"breakdowns"
],
"properties": {
"metrics": {
"type": "array",
"items": {
"type": "string"
},
"description": "Must call API getSnapchatAdsMetricsAndBreakdownsList to retrieve a list of selectable metrics."
},
"breakdowns": {
"type": "array",
"items": {
"type": "string"
},
"description": "Must call API getSnapchatAdsMetricsAndBreakdownsList to retrieve a list of selectable breakdowns."
}
}
},
"linkedin_ads_request": {
"type": "object",
"description": "A request that contains details of demand for LinkedIn Ads data.",
"required": [
"metrics",
"breakdowns"
],
"properties": {
"metrics": {
"type": "array",
"items": {
"type": "string"
},
"description": "Must call API getLinkedInAdsMetricsAndBreakdownsList to retrieve a list of selectable metrics."
},
"breakdowns": {
"type": "array",
"items": {
"type": "string"
},
"description": "Must call API getLinkedInAdsMetricsAndBreakdownsList to retrieve a list of selectable breakdowns."
}
}
},
"shopify_request": {
"type": "object",
"description": "A request that contains details of demand for Shopify data.",
"required": [
"metrics",
"breakdowns"
],
"properties": {
"metrics": {
"type": "array",
"items": {
"type": "string"
},
"description": "Must call API getShopifyMetricsAndBreakdownsList to retrieve a list of selectable metrics."
},
"breakdowns": {
"type": "array",
"items": {
"type": "string"
},
"description": "Must call API getShopifyMetricsAndBreakdownsList to retrieve a list of selectable breakdowns."
}
}
},
"mailchimp_request": {
"type": "object",
"description": "A request that contains details of demand for Mailchimp data.",
"required": [
"metrics",
"breakdowns"
],
"properties": {
"metrics": {
"type": "array",
"items": {
"type": "string"
},
"description": "Must call API getMailchimpMetricsAndBreakdownsList to retrieve a list of selectable metrics."
},
"breakdowns": {
"type": "array",
"items": {
"type": "string"
},
"description": "Must call API getMailchimpMetricsAndBreakdownsList to retrieve a list of selectable breakdowns."
}
}
},
"klaviyo_request": {
"type": "object",
"description": "A request that contains details of demand for Klaviyo data.",
"required": [
"metrics",
"breakdowns"
],
"properties": {
"metrics": {
"type": "array",
"items": {
"type": "string"
},
"description": "Must call API getKlaviyoMetricsAndBreakdownsList to retrieve a list of selectable metrics."
},
"breakdowns": {
"type": "array",
"items": {
"type": "string"
},
"description": "Must call API getKlaviyoMetricsAndBreakdownsList to retrieve a list of selectable breakdowns."
}
}
},
"google_my_business_request": {
"type": "object",
"description": "A request that contains details of demand for Google My Business (aka Business Profile) data.",
"required": [
"metrics",
"breakdowns"
],
"properties": {
"metrics": {
"type": "array",
"items": {
"type": "string"
},
"description": "Must call API getBusinessProfileMetricsAndBreakdownsList to retrieve a list of selectable metrics."
},
"breakdowns": {
"type": "array",
"items": {
"type": "string"
},
"description": "Must call API getBusinessProfileMetricsAndBreakdownsList to retrieve a list of selectable breakdowns."
}
}
},
"merchant_center_request": {
"type": "object",
"description": "A request that contains details of demand for Merchant Center data.",
"required": [
"metrics",
"breakdowns"
],
"properties": {
"metrics": {
"type": "array",
"items": {
"type": "string"
},
"description": "Must call API getMerchantCenterMetricsAndBreakdownsList to retrieve a list of selectable metrics."
},
"breakdowns": {
"type": "array",
"items": {
"type": "string"
},
"description": "Must call API getMerchantCenterMetricsAndBreakdownsList to retrieve a list of selectable breakdowns."
}
}
},
"woocommerce_request": {
"type": "object",
"description": "A request that contains details of demand for WooCommerce data.",
"required": [
"metrics",
"breakdowns"
],
"properties": {
"metrics": {
"type": "array",
"items": {
"type": "string"
},
"description": "Must call API getWooCommerceMetricsAndBreakdownsList to retrieve a list of selectable metrics."
},
"breakdowns": {
"type": "array",
"items": {
"type": "string"
},
"description": "Must call API getWooCommerceMetricsAndBreakdownsList to retrieve a list of selectable breakdowns."
}
}
},
"linkedin_page_request": {
"type": "object",
"description": "A request that contains details of demand for LinkedIn Company Page data.",
"required": [
"metrics",
"breakdowns"
],
"properties": {
"metrics": {
"type": "array",
"items": {
"type": "string"
},
"description": "Must call API getLinkedInPageMetricsAndBreakdownsList to retrieve a list of selectable metrics."
},
"breakdowns": {
"type": "array",
"items": {
"type": "string"
},
"description": "Must call API getLinkedInPageMetricsAndBreakdownsList to retrieve a list of selectable breakdowns."
}
}
},
"youtube_request": {
"type": "object",
"description": "A request that contains details of demand for YouTube Analytics data.",
"required": [
"metrics",
"breakdowns"
],
"properties": {
"metrics": {
"type": "array",
"items": {
"type": "string"
},
"description": "Must call API getYouTubeMetricsAndBreakdownsList to retrieve a list of selectable metrics."
},
"breakdowns": {
"type": "array",
"items": {
"type": "string"
},
"description": "Must call API getYouTubeMetricsAndBreakdownsList to retrieve a list of selectable breakdowns."
}
}
},
"amazon_ads_request": {
"type": "object",
"description": "A request that contains details of demand for Amazon Ads reporting data.",
"required": [
"metrics",
"breakdowns"
],
"properties": {
"metrics": {
"type": "array",
"items": {
"type": "string"
},
"description": "Must call API getAmazonAdsMetricsAndBreakdownsList to retrieve a list of selectable metrics."
},
"breakdowns": {
"type": "array",
"items": {
"type": "string"
},
"description": "Must call API getAmazonAdsMetricsAndBreakdownsList to retrieve a list of selectable breakdowns."
}
}
},
"amazon_seller_request": {
"type": "object",
"description": "A request that contains details of demand for Amazon Seller Central reporting data.",
"required": [
"metrics",
"breakdowns"
],
"properties": {
"metrics": {
"type": "array",
"items": {
"type": "string"
},
"description": "Must call API getAmazonSellerCentralMetricsAndBreakdownsList to retrieve a list of selectable metrics."
},
"breakdowns": {
"type": "array",
"items": {
"type": "string"
},
"description": "Must call API getAmazonSellerCentralMetricsAndBreakdownsList to retrieve a list of selectable breakdowns."
}
}
},
"hubspot_request": {
"type": "object",
"description": "A request that contains details of demand for HubSpot CRM data.",
"required": [
"metrics",
"breakdowns"
],
"properties": {
"metrics": {
"type": "array",
"items": {
"type": "string"
},
"description": "Must call API getHubSpotMetricsAndBreakdownsList to retrieve a list of selectable metrics."
},
"breakdowns": {
"type": "array",
"items": {
"type": "string"
},
"description": "Must call API getHubSpotMetricsAndBreakdownsList to retrieve a list of selectable breakdowns."
}
}
},
"salesforce_request": {
"type": "object",
"description": "A request that contains details of demand for Salesforce CRM data.",
"required": [
"metrics",
"breakdowns"
],
"properties": {
"metrics": {
"type": "array",
"items": {
"type": "string"
},
"description": "Must call API getSalesforceMetricsAndBreakdownsList to retrieve a list of selectable metrics."
},
"breakdowns": {
"type": "array",
"items": {
"type": "string"
},
"description": "Must call API getSalesforceMetricsAndBreakdownsList to retrieve a list of selectable breakdowns."
}
}
},
"x_ads_request": {
"type": "object",
"description": "A request that contains details of demand for X Ads (Twitter Ads) data.",
"required": [
"metrics",
"breakdowns"
],
"properties": {
"metrics": {
"type": "array",
"items": {
"type": "string"
},
"description": "Must call API getXAdsMetricsAndBreakdownsList to retrieve a list of selectable metrics."
},
"breakdowns": {
"type": "array",
"items": {
"type": "string"
},
"description": "Must call API getXAdsMetricsAndBreakdownsList to retrieve a list of selectable breakdowns."
}
}
},
"bigcommerce_request": {
"type": "object",
"description": "A request that contains details of demand for BigCommerce data.",
"required": [
"metrics",
"breakdowns"
],
"properties": {
"metrics": {
"type": "array",
"items": {
"type": "string"
},
"description": "Must call API getBigCommerceMetricsAndBreakdownsList to retrieve a list of selectable metrics."
},
"breakdowns": {
"type": "array",
"items": {
"type": "string"
},
"description": "Must call API getBigCommerceMetricsAndBreakdownsList to retrieve a list of selectable breakdowns."
}
}
},
"zoho_request": {
"type": "object",
"description": "A request that contains details of demand for Zoho CRM data.",
"required": [
"metrics",
"breakdowns"
],
"properties": {
"metrics": {
"type": "array",
"items": {
"type": "string"
},
"description": "Must call API getZohoMetricsAndBreakdownsList to retrieve a list of selectable metrics."
},
"breakdowns": {
"type": "array",
"items": {
"type": "string"
},
"description": "Must call API getZohoMetricsAndBreakdownsList to retrieve a list of selectable breakdowns."
}
}
}
}
},
"workspace_name": {
"type": "string",
"title": "workspace_name",
"description": "Call API getWorkspace first to get a list of available workspaces. Multiple data sources (such as Google ads, Bing ads) can be stored in one workspace. If the user does not specify a workspace name, then use the available workspace name from the retrieved list based on the data source. If the user has not yet created one, then ask them to go to adzviser.com/main to create a new workspace."
},
"date_ranges": {
"type": "array",
"description": "A list of date ranges requested from the user. They needs to be calculated seperately with Code Interpreter and Python every single time for accuracy. For example, if the user requests \"Google Ads search impression share in May and August\", then this array should be [[\"2024-05-01\", \"2024-05-31\"], [\"2024-08-01\", \"2024-08-31\"]].",
"items": {
"type": "array",
"items": {
"type": "string"
},
"description": "A 2-element array. The first represents the start date and the second the end date. Both are in YYYY-MM-DD format."
}
},
"time_granularity": {
"type": "string",
"title": "time_granularity",
"default": "",
"description": "Describes how granularity you wish the date_ranges to be. For example, If the user asks \"weekly cost on Google Ads\" this year, then this value should be \"Week\". If the user does not specify, then leave it as empty.",
"enum": [
"Date",
"Week",
"Month",
"Quarter"
]
}
}
}
},
"securitySchemes": {
"oauth2": {
"type": "oauth2"
}
}
}
}