{ "openapi": "3.0.0", "info": { "title": "LoopBack Application", "version": "1.0.0" }, "paths": { "/analytics/report-v2": { "post": { "x-controller-name": "InsightsReportController", "x-operation-name": "getAnalyticsReport", "tags": [ "InsightsReportController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Get analytics report from bigQuery" } } } } }, "parameters": [ { "name": "chartType", "in": "query", "description": "Type of the chart", "required": true, "schema": { "type": "string", "enum": [ "AD_REQUEST", "AD_REQUEST_OVERVIEW", "CTR", "CTR_SUPPLIER", "CTR_CAMPAIGN", "CTR_PRODUCT", "CONVERSIONS", "CONVERSIONS_SUPPLIER", "CONVERSIONS_CAMPAIGN", "CONVERSIONS_PRODUCT", "AD_STATS_OUT", "SALES", "ROAS", "ENHANCED_ATTRIBUTION_OVERVIEW_BY_CAMPAIGN", "WEEKLY_REVENUE", "SUPPLIER_SUMMARY", "SEARCH_TERM_FILL_RATE", "SEARCH_TERM_FILL_RATE_WITH_PLACEMENT", "SEARCH_TERM_FILL_RATE_WITH_PLACEMENT_SUMMARY", "CATEGORY_FILL_RATE", "CATEGORY_FILL_RATE_WITH_PLACEMENT", "CATEGORY_FILL_RATE_WITH_PLACEMENT_SUMMARY", "AD_STATS_RETAILER_SNAPSHOT", "AD_STATS_SUPPLIER_SNAPSHOT", "WALLET_TRANSACTION_LEDGER", "WALLET_TRANSACTION_LEDGER_LIVE", "WALLET_BALANCE", "WALLET_BALANCE_LIVE", "SUPPLIER_AD_STATS_COMPARISION", "SPEND", "IMPRESSIONS_TOTAL", "IMPRESSIONS_UNIQUE", "INDIVIDUALS_MESSAGED", "CLICKS", "SKU_ROAS", "BRAND_ROAS", "SKU_PERFORMANCE", "BRAND_PERFORMANCE", "OFFSITE_CAMPAIGN_METRICS", "FILTER_CAMPAIGN_NAME_UNIFIED_UI", "CAMPAIGN_REPORT", "KEYWORD_REPORT", "KEYWORDS_REPORT_LIVE", "PRODUCT_REPORT", "BIG_BASKET_LTV", "TARGET_PRODUCT_REPORT", "TARGET_CTR", "TARGET_ROAS", "TARGET_CPC", "TARGET_CAMPAIGN_REPORT", "TARGET_KEYWORD_REPORT", "PRODUCT_PERFORMANCE_BY_DAY_EXPORT", "BRAND_PERFORMANCE_BY_DAY_EXPORT", "TARGET_PRODUCT_REPORT_SUMMARY", "TARGET_CAMPAIGN_REPORT_SUMMARY", "TARGET_KEYWORD_REPORT_SUMMARY", "PRODUCT_PERFORMANCE_BY_DAY_EXPORT_SUMMARY", "BRAND_PERFORMANCE_BY_DAY_EXPORT_SUMMARY", "CATEGORY_FILL_RATE_SUMMARY", "SEARCH_TERM_FILL_RATE_SUMMARY", "KEYWORD_MATCH_REPORT", "KEYWORD_MATCH_REPORT_CM", "CAMPAIGN_REPORT_SUMMARY", "FILTER_WALLET", "KEYWORD_REPORT_SUMMARY", "SUPPLIER_AD_STATS_COMPARISION_SUMMARY", "PRODUCT_REPORT_SUMMARY", "CAMPAIGN_REPORT_ON_SITE", "KEYWORD_REPORT_ON_SITE", "PRODUCT_REPORT_ON_SITE", "CAMPAIGN_REPORT_SUMMARY_ON_SITE", "KEYWORD_REPORT_SUMMARY_ON_SITE", "PRODUCT_REPORT_SUMMARY_ON_SITE", "FILTER_KEYWORD", "FILTER_SEARCH_TERM", "FILTER_CAMPAIGN_NAME", "FILTER_PRODUCT_NAME", "FILTER_CATALOG_NAME", "FILTER_WALLET_NAME", "INTERNAL_REPORTING", "FILTER_CAMPAIGN_NAME_INTERNAL", "FILTER_ORDER_ID_INTERNAL", "INTERNAL_REPORT_SUMMARY", "FILTER_PLACEMENTS", "CAMPAIGN_KEYWORD_REPORT", "HISTORY_BREAKDOWN", "HISTORY_BREAKDOWN_SUMMARY", "HISTORY_BREAKDOWN_LIVE", "HISTORY_BREAKDOWN_LIVE_SUMMARY", "CAMPAIGN_KEYWORD_SUMMARY", "CAMPAIGN_FILTER_KEYWORD", "CAMPAIGN_FILTER_SEARCH_TERM", "CAMPAIGN_FILTER_PRODUCT_NAME", "CAMPAIGN_PRODUCT_REPORT", "CAMPAIGN_PRODUCT_REPORT_SUMMARY", "PRODUCT_REPORT_LIVE", "PRODUCT_REPORT_LIVE_SUMMARY", "CAMPAIGN_GLANCE_METRICS", "CAMPAIGN_GLANCE_METRICS_LIVE", "CAMPAIGN_PERFORMANCE", "CAMPAIGN_PERFORMANCE_LIVE", "CAMPAIGN_PERFORMANCE_SUMMARY", "CAMPAIGNS", "MULTI_CAMPAIGNS_LIVE", "CAMPAIGNS_SUMMARY", "MULTI_CAMPAIGNS_LIVE_SUMMARY", "MULTI_CAMPAIGNS_ENHANCED", "CAMPAIGN_GLANCE_METRICS_ENHANCED", "MULTI_CAMPAIGN_ENHANCED_METRICS", "MULTI_CAMPAIGN_ENHANCED_METRICS_SUMMARY", "MATCH_TYPE_REPORT", "MATCH_TYPE_REPORT_SUMMARY", "FILTER_PLACEMENTS_FILL_RATE", "CAMPAIGN_OVERVIEW_REPORT", "CAMPAIGN_OVERVIEW_REPORT_SUMMARY", "FILTER_CAMPAIGN_NAME_CAMPAIGN_OVERVIEW", "FILTER_PLATFORM_CAMPAIGN_OVERVIEW", "FILTER_PLACEMENT_CAMPAIGN_OVERVIEW", "FILTER_CAMPAIGN_SUB_TYPE", "FILTER_CAMPAIGN_TYPE", "FILTER_SEARCH_TERM_FILL_RATE", "FILTER_CATEGORY_FILL_RATE", "KEYWORDS_REPORT", "KEYWORDS_REPORT_SUMMARY", "KEYWORDS_REPORT_LIVE_SUMMARY", "UNIFIED_GLANCE_METRICS", "UNIFIED_DELIVERY_CLICKS_SUMMARY", "UNIFIED_SKU_GROUP_PERFORMANCE", "UNIFIED_BRAND_HALO_PERFORMANCE", "UNIFIED_SUMMARY", "UNIFIED_SKU_METADATA", "CATEGORY_REPORT", "CATEGORY_REPORT_SUMMARY", "CATEGORY_LABEL", "CATEGORY_REPORT_LIVE", "CATEGORY_REPORT_LIVE_SUMMARY", "CATEGORY_LABEL_LIVE", "TEAM_GLANCE_METRICS_LIVE", "TEAM_PERFORMANCE_LIVE", "TEAMS_REPORT_LIVE", "TEAMS_REPORT_SUMMARY_LIVE", "TEAM_ACTIVE_SUPPLIERS_LIVE", "CAMPAIGN_STATUS_LIVE" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InsightsReport" } } }, "required": true, "x-parameter-index": 1 }, "operationId": "InsightsReportController.getAnalyticsReport" } }, "/campaign/history-breakdown": { "post": { "x-controller-name": "CampaignReportController", "x-operation-name": "getHistoryBreakdown", "tags": [ "CampaignReportController" ], "responses": { "200": { "description": "Get history breakdown for a campaign", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HistoryBreakdownResponse" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportRequest" } } }, "required": true }, "operationId": "CampaignReportController.getHistoryBreakdown" } }, "/campaign/history-breakdown-summary": { "post": { "x-controller-name": "CampaignReportController", "x-operation-name": "getHistoryBreakdownSummary", "tags": [ "CampaignReportController" ], "responses": { "200": { "description": "Get history breakdown summary for a campaign", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HistoryBreakdownResponse" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportRequest" } } }, "required": true }, "operationId": "CampaignReportController.getHistoryBreakdownSummary" } }, "/campaign/keyword-report": { "post": { "x-controller-name": "CampaignReportController", "x-operation-name": "getCampaignKeyWordReport", "tags": [ "CampaignReportController" ], "responses": { "200": { "description": "Get keyword report for a campaign", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CampaignKeyWordReportResponse" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportRequest" } } }, "required": true }, "operationId": "CampaignReportController.getCampaignKeyWordReport" } }, "/campaign/keyword-report-summary": { "post": { "x-controller-name": "CampaignReportController", "x-operation-name": "getCampaignKeywordSummary", "tags": [ "CampaignReportController" ], "responses": { "200": { "description": "Get keyword report summary for a campaign", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CampaignKeyWordReportResponse" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportRequest" } } }, "required": true }, "operationId": "CampaignReportController.getCampaignKeywordSummary" } }, "/campaign/product-report": { "post": { "x-controller-name": "CampaignReportController", "x-operation-name": "getCampaignProductReport", "tags": [ "CampaignReportController" ], "responses": { "200": { "description": "Get product report for a campaign", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CampaignProductReportResponse" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportRequest" } } }, "required": true }, "operationId": "CampaignReportController.getCampaignProductReport" } }, "/campaign/product-report-summary": { "post": { "x-controller-name": "CampaignReportController", "x-operation-name": "getCampaignProductReportSummary", "tags": [ "CampaignReportController" ], "responses": { "200": { "description": "Get product report for a campaign", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CampaignProductReportResponse" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportRequest" } } }, "required": true }, "operationId": "CampaignReportController.getCampaignProductReportSummary" } }, "/campaigns/enhanced-metrics": { "post": { "x-controller-name": "CampaignReportController", "x-operation-name": "getCampaignsEnhancedMetrics", "tags": [ "CampaignReportController" ], "responses": { "200": { "description": "Get campaigns enhanced metrics report", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CampaignEnhancedMetricsReportResponse" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportRequest" } } }, "required": true }, "operationId": "CampaignReportController.getCampaignsEnhancedMetrics" } }, "/campaigns/enhanced-metrics-summary": { "post": { "x-controller-name": "CampaignReportController", "x-operation-name": "getCampaignsEnhancedMetricsSummary", "tags": [ "CampaignReportController" ], "responses": { "200": { "description": "Get campaigns enhanced metrics summary report", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CampaignEnhancedMetricsReportResponse" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportRequest" } } }, "required": true }, "operationId": "CampaignReportController.getCampaignsEnhancedMetricsSummary" } }, "/campaigns/glance-metrics": { "post": { "x-controller-name": "CampaignReportController", "x-operation-name": "getCampaignsGlanceMetrics", "tags": [ "CampaignReportController" ], "responses": { "200": { "description": "Get glance metrics for a campaign", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlanceMetricsResponse" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportRequest" } } }, "required": true }, "operationId": "CampaignReportController.getCampaignsGlanceMetrics" } }, "/campaigns/performance": { "post": { "x-controller-name": "CampaignReportController", "x-operation-name": "getCampaignsPerformance", "tags": [ "CampaignReportController" ], "responses": { "200": { "description": "Get overtime performance for a campaign", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CampaignPerformanceResponse" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportRequest" } } }, "required": true }, "operationId": "CampaignReportController.getCampaignsPerformance" } }, "/campaigns": { "post": { "x-controller-name": "CampaignReportController", "x-operation-name": "getCampaigns", "tags": [ "CampaignReportController" ], "responses": { "200": { "description": "Get campaigns report", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CampaignReportResponse" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportRequest" } } }, "required": true }, "operationId": "CampaignReportController.getCampaigns" } }, "/campaigns-summary": { "post": { "x-controller-name": "CampaignReportController", "x-operation-name": "getCampaignsSummary", "tags": [ "CampaignReportController" ], "responses": { "200": { "description": "Get campaigns report", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CampaignReportResponse" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportRequest" } } }, "required": true }, "operationId": "CampaignReportController.getCampaignsSummary" } }, "/dashboards/list": { "get": { "x-controller-name": "DashboardController", "x-operation-name": "dashBoardList", "tags": [ "DashboardController" ], "responses": { "200": { "description": "Array of Dashboard model instances", "content": { "application/json": { "schema": { "type": "array", "items": {} } } } } }, "operationId": "DashboardController.dashBoardList" } }, "/dashboards/{id}": { "get": { "x-controller-name": "DashboardController", "x-operation-name": "findById", "tags": [ "DashboardController" ], "responses": { "200": { "description": "Dashboard model instance", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "DashboardController.findById" } }, "/dashboards": { "get": { "x-controller-name": "DashboardController", "x-operation-name": "find", "tags": [ "DashboardController" ], "responses": { "200": { "description": "Array of Dashboard model instances", "content": { "application/json": { "schema": { "type": "array", "items": {} } } } } }, "operationId": "DashboardController.find" } }, "/icons/{id}": { "get": { "x-controller-name": "IconController", "x-operation-name": "findById", "tags": [ "IconController" ], "responses": { "200": { "description": "Icon model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IconWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Icon.Filter" } } } } ], "operationId": "IconController.findById" } }, "/icons": { "get": { "x-controller-name": "IconController", "x-operation-name": "find", "tags": [ "IconController" ], "responses": { "200": { "description": "Array of Icon model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/IconWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Icon.Filter1" } } } } ], "operationId": "IconController.find" } }, "/keywords": { "post": { "x-controller-name": "CampaignReportController", "x-operation-name": "getKeyWordsReport", "tags": [ "CampaignReportController" ], "responses": { "200": { "description": "Get keyword report for a campaign", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CampaignKeyWordReportResponse" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportRequest" } } }, "required": true }, "operationId": "CampaignReportController.getKeyWordsReport" } }, "/keywords-summary": { "post": { "x-controller-name": "CampaignReportController", "x-operation-name": "getKeywordsSummary", "tags": [ "CampaignReportController" ], "responses": { "200": { "description": "Get keyword report summary for a campaign", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CampaignKeyWordReportResponse" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportRequest" } } }, "required": true }, "operationId": "CampaignReportController.getKeywordsSummary" } }, "/kmr": { "post": { "x-controller-name": "CampaignReportController", "x-operation-name": "getKeywordMatchReport", "tags": [ "CampaignReportController" ], "responses": { "200": { "description": "Get Match type report", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CampaignKeyWordReportResponse" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportRequest" } } }, "required": true }, "operationId": "CampaignReportController.getKeywordMatchReport" } }, "/kmr-summary": { "post": { "x-controller-name": "CampaignReportController", "x-operation-name": "getKeywordMatchReportSummary", "tags": [ "CampaignReportController" ], "responses": { "200": { "description": "Get match type report summary for a campaign", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CampaignKeyWordReportResponse" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportRequest" } } }, "required": true }, "operationId": "CampaignReportController.getKeywordMatchReportSummary" } }, "/log-status/latest-date": { "get": { "x-controller-name": "LogStatusController", "x-operation-name": "getLatestLogDate", "tags": [ "LogStatusController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Load latest log status from bigQuery" } } } } }, "operationId": "LogStatusController.getLatestLogDate" } }, "/management/dataset/status": { "get": { "x-controller-name": "HealthStatusController", "x-operation-name": "getCoreDataSetStatus", "tags": [ "HealthStatusController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Load core dataset health status from bigQuery" } } } } }, "parameters": [ { "name": "startDate", "in": "query", "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "schema": { "type": "string" } } ], "operationId": "HealthStatusController.getCoreDataSetStatus" } }, "/management/domo-upload/status": { "get": { "x-controller-name": "HealthStatusController", "x-operation-name": "getDomoUploadStatus", "tags": [ "HealthStatusController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Load domo upload health status from bigQuery" } } } } }, "parameters": [ { "name": "startDate", "in": "query", "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "schema": { "type": "string" } } ], "operationId": "HealthStatusController.getDomoUploadStatus" } }, "/management/global-dw/status": { "get": { "x-controller-name": "HealthStatusController", "x-operation-name": "getGlobalDWStatus", "tags": [ "HealthStatusController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Load global dw health status from bigQuery" } } } } }, "parameters": [ { "name": "startDate", "in": "query", "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "schema": { "type": "string" } } ], "operationId": "HealthStatusController.getGlobalDWStatus" } }, "/management/iam/client/{clientId}/service-account/keys/{id}": { "patch": { "x-controller-name": "IamClientServiceAccountKeyController", "x-operation-name": "update", "tags": [ "IamClientServiceAccountKeyController" ], "responses": { "200": { "description": "Update IAM client service account key instance", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "clientId", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": {} } }, "x-parameter-index": 1 }, "operationId": "IamClientServiceAccountKeyController.update" }, "get": { "x-controller-name": "IamClientServiceAccountKeyController", "x-operation-name": "get", "tags": [ "IamClientServiceAccountKeyController" ], "responses": { "200": { "description": "IAM client service account key instance", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "clientId", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "IamClientServiceAccountKeyController.get" }, "delete": { "x-controller-name": "IamClientServiceAccountKeyController", "x-operation-name": "delete", "tags": [ "IamClientServiceAccountKeyController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Delete IAM client service account key instance" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "clientId", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "IamClientServiceAccountKeyController.delete" } }, "/management/iam/client/{clientId}/service-account/keys": { "post": { "x-controller-name": "IamClientServiceAccountKeyController", "x-operation-name": "create", "tags": [ "IamClientServiceAccountKeyController" ], "responses": { "200": { "description": "Create IAM client service account key instance", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "clientId", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": {} } } }, "operationId": "IamClientServiceAccountKeyController.create" }, "get": { "x-controller-name": "IamClientServiceAccountKeyController", "x-operation-name": "list", "tags": [ "IamClientServiceAccountKeyController" ], "responses": { "200": { "description": "Array of IAM client service account keys", "content": { "application/json": { "schema": { "type": "array", "items": {} } } } } }, "parameters": [ { "name": "clientId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam_client_service_account_key.Filter" } } } } ], "operationId": "IamClientServiceAccountKeyController.list" } }, "/management/iam/client/{id}": { "patch": { "x-controller-name": "IamClientController", "x-operation-name": "update", "tags": [ "IamClientController" ], "responses": { "200": { "description": "Update IAM client instance", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": {} } }, "x-parameter-index": 1 }, "operationId": "IamClientController.update" }, "get": { "x-controller-name": "IamClientController", "x-operation-name": "get", "tags": [ "IamClientController" ], "responses": { "200": { "description": "IAM client instance", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "IamClientController.get" }, "delete": { "x-controller-name": "IamClientController", "x-operation-name": "delete", "tags": [ "IamClientController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Delete IAM client instance" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "IamClientController.delete" } }, "/management/iam/client": { "post": { "x-controller-name": "IamClientController", "x-operation-name": "create", "tags": [ "IamClientController" ], "responses": { "200": { "description": "Create IAM client instance", "content": { "application/json": { "schema": {} } } } }, "requestBody": { "content": { "application/json": { "schema": {} } } }, "operationId": "IamClientController.create" }, "get": { "x-controller-name": "IamClientController", "x-operation-name": "list", "tags": [ "IamClientController" ], "responses": { "200": { "description": "Array of IAM clients", "content": { "application/json": { "schema": { "type": "array", "items": {} } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam_client.Filter" } } } } ], "operationId": "IamClientController.list" } }, "/management/iam/dataset/{id}": { "patch": { "x-controller-name": "IamDatasetController", "x-operation-name": "update", "tags": [ "IamDatasetController" ], "responses": { "200": { "description": "Update IAM dataset instance", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": {} } }, "x-parameter-index": 1 }, "operationId": "IamDatasetController.update" }, "get": { "x-controller-name": "IamDatasetController", "x-operation-name": "get", "tags": [ "IamDatasetController" ], "responses": { "200": { "description": "IAM dataset instance", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "IamDatasetController.get" }, "delete": { "x-controller-name": "IamDatasetController", "x-operation-name": "delete", "tags": [ "IamDatasetController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Delete IAM dataset instance" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "IamDatasetController.delete" } }, "/management/iam/dataset": { "post": { "x-controller-name": "IamDatasetController", "x-operation-name": "create", "tags": [ "IamDatasetController" ], "responses": { "200": { "description": "Create IAM dataset instance", "content": { "application/json": { "schema": {} } } } }, "requestBody": { "content": { "application/json": { "schema": {} } } }, "operationId": "IamDatasetController.create" }, "get": { "x-controller-name": "IamDatasetController", "x-operation-name": "list", "tags": [ "IamDatasetController" ], "responses": { "200": { "description": "Array of IAM datasets", "content": { "application/json": { "schema": { "type": "array", "items": {} } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam_dataset.Filter" } } } } ], "operationId": "IamDatasetController.list" } }, "/management/iam/import": { "post": { "x-controller-name": "IamController", "x-operation-name": "import", "tags": [ "IamController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Import IAM teams from HCL configuration" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "IamController.import" } }, "/management/iam/onsite-offsite/{clientId}": { "patch": { "x-controller-name": "IamOnsiteOffsiteController", "x-operation-name": "updateOrDeleteClientOnsiteOffsite", "tags": [ "IamOnsiteOffsiteController" ], "responses": { "200": { "description": "Return value of IamOnsiteOffsiteController.updateOrDeleteClientOnsiteOffsite" } }, "parameters": [ { "name": "clientId", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } }, "x-parameter-index": 1 }, "operationId": "IamOnsiteOffsiteController.updateOrDeleteClientOnsiteOffsite" }, "get": { "x-controller-name": "IamOnsiteOffsiteController", "x-operation-name": "getClientOnsiteOffsite", "tags": [ "IamOnsiteOffsiteController" ], "responses": { "200": { "description": "Return value of IamOnsiteOffsiteController.getClientOnsiteOffsite" } }, "parameters": [ { "name": "clientId", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "IamOnsiteOffsiteController.getClientOnsiteOffsite" } }, "/management/iam/push": { "post": { "x-controller-name": "IamController", "x-operation-name": "push", "tags": [ "IamController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Push IAM clients to GCP" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "array" } } } }, "operationId": "IamController.push" } }, "/management/iam/report/load": { "post": { "x-controller-name": "IamReportController", "x-operation-name": "loadUsage", "tags": [ "IamReportController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Load IAM client usage" } } } } }, "operationId": "IamReportController.loadUsage" } }, "/management/iam/report/usage/{id}": { "get": { "x-controller-name": "IamReportController", "x-operation-name": "get", "tags": [ "IamReportController" ], "responses": { "200": { "description": "Retrieve clients IAM usage", "content": { "application/json": { "schema": { "type": "array", "properties": { "dataScanned": { "type": "string" }, "apiCalls": { "type": "string" }, "usageDate": { "type": "string" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "rangeStart", "in": "query", "schema": { "type": "string" } }, { "name": "rangeEnd", "in": "query", "schema": { "type": "string" } }, { "name": "grouping", "in": "query", "schema": { "type": "string" } } ], "operationId": "IamReportController.get" } }, "/management/iam/report/usage": { "get": { "x-controller-name": "IamReportController", "x-operation-name": "getAllClients", "tags": [ "IamReportController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Retrieve a list of clients and their IAM usage" } } } } }, "parameters": [ { "name": "rangeStart", "in": "query", "schema": { "type": "string" } }, { "name": "rangeEnd", "in": "query", "schema": { "type": "string" } }, { "name": "grouping", "in": "query", "schema": { "type": "string" } } ], "operationId": "IamReportController.getAllClients" } }, "/management/namespace/geo-regions": { "get": { "x-controller-name": "RegionNamespaceController", "x-operation-name": "autocompleteGeoRegions", "tags": [ "RegionNamespaceController" ], "responses": { "200": { "description": "Geo regions", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } } }, "operationId": "RegionNamespaceController.autocompleteGeoRegions" } }, "/management/namespace/import": { "post": { "x-controller-name": "RegionNamespaceController", "x-operation-name": "import", "tags": [ "RegionNamespaceController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Import namespaces from CSV" } } } } }, "parameters": [ { "name": "mapField", "in": "query", "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "x-parser": "stream", "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" } } } } }, "description": "Request body for multipart/form-data based file upload", "required": true, "x-parameter-index": 1 }, "operationId": "RegionNamespaceController.import" } }, "/management/namespace/last-load": { "get": { "x-controller-name": "RegionNamespaceController", "x-operation-name": "getLastLoadTime", "tags": [ "RegionNamespaceController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Get time of last load from BigQuery" } } } } }, "operationId": "RegionNamespaceController.getLastLoadTime" } }, "/management/namespace/load": { "post": { "x-controller-name": "RegionNamespaceController", "x-operation-name": "load", "tags": [ "RegionNamespaceController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Load new namespaces from BigQuery" } } } } }, "operationId": "RegionNamespaceController.load" } }, "/management/namespace/{id}": { "patch": { "x-controller-name": "RegionNamespaceController", "x-operation-name": "update", "tags": [ "RegionNamespaceController" ], "responses": { "200": { "description": "Update region namespace instance", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": {} } }, "x-parameter-index": 1 }, "operationId": "RegionNamespaceController.update" }, "get": { "x-controller-name": "RegionNamespaceController", "x-operation-name": "get", "tags": [ "RegionNamespaceController" ], "responses": { "200": { "description": "Region namespace instance", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "RegionNamespaceController.get" }, "delete": { "x-controller-name": "RegionNamespaceController", "x-operation-name": "delete", "tags": [ "RegionNamespaceController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Delete region namespace instance" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "RegionNamespaceController.delete" } }, "/management/namespace": { "post": { "x-controller-name": "RegionNamespaceController", "x-operation-name": "create", "tags": [ "RegionNamespaceController" ], "responses": { "200": { "description": "Create region namespace instance", "content": { "application/json": { "schema": {} } } } }, "requestBody": { "content": { "application/json": { "schema": {} } } }, "operationId": "RegionNamespaceController.create" }, "get": { "x-controller-name": "RegionNamespaceController", "x-operation-name": "list", "tags": [ "RegionNamespaceController" ], "responses": { "200": { "description": "Array of region namespaces", "content": { "application/json": { "schema": { "type": "array", "items": {} } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/region_namespace.Filter" } } } } ], "operationId": "RegionNamespaceController.list" } }, "/management/retailer/enhanced-attribution": { "post": { "x-controller-name": "RetailerController", "x-operation-name": "getEnhancedAttributionFlag", "tags": [ "RetailerController" ], "responses": { "200": { "description": "Get Retailer enhanced attribution flags for multiple retailers", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RetailerEnhancedAttributionResponse" } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetailerEnhancedAttributionRequest" } } } }, "operationId": "RetailerController.getEnhancedAttributionFlag" } }, "/management/retailer/import": { "post": { "x-controller-name": "RetailerController", "x-operation-name": "import", "tags": [ "RetailerController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Import retailers from CSV" } } } } }, "parameters": [ { "name": "mapField", "in": "query", "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "x-parser": "stream", "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" } } } } }, "description": "Request body for multipart/form-data based file upload", "required": true, "x-parameter-index": 1 }, "operationId": "RetailerController.import" } }, "/management/retailer/last-load": { "get": { "x-controller-name": "RetailerController", "x-operation-name": "getLastLoadTime", "tags": [ "RetailerController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Get time of last load from BigQuery" } } } } }, "operationId": "RetailerController.getLastLoadTime" } }, "/management/retailer/load": { "post": { "x-controller-name": "RetailerController", "x-operation-name": "load", "tags": [ "RetailerController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Load new retailers from BigQuery" } } } } }, "operationId": "RetailerController.load" } }, "/management/retailer/{id}": { "patch": { "x-controller-name": "RetailerController", "x-operation-name": "update", "tags": [ "RetailerController" ], "responses": { "200": { "description": "Update retailer instance", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": {} } }, "x-parameter-index": 1 }, "operationId": "RetailerController.update" }, "get": { "x-controller-name": "RetailerController", "x-operation-name": "get", "tags": [ "RetailerController" ], "responses": { "200": { "description": "Retailer instance", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "RetailerController.get" }, "delete": { "x-controller-name": "RetailerController", "x-operation-name": "delete", "tags": [ "RetailerController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Delete retailer instance" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "RetailerController.delete" } }, "/management/retailer": { "post": { "x-controller-name": "RetailerController", "x-operation-name": "create", "tags": [ "RetailerController" ], "responses": { "200": { "description": "Create retailer instance", "content": { "application/json": { "schema": {} } } } }, "requestBody": { "content": { "application/json": { "schema": {} } } }, "operationId": "RetailerController.create" }, "get": { "x-controller-name": "RetailerController", "x-operation-name": "list", "tags": [ "RetailerController" ], "responses": { "200": { "description": "Array of retailers", "content": { "application/json": { "schema": { "type": "array", "items": {} } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retailer.Filter" } } } } ], "operationId": "RetailerController.list" } }, "/management/supplier/groups": { "get": { "x-controller-name": "SupplierController", "x-operation-name": "autocompleteSupplierGroups", "tags": [ "SupplierController" ], "responses": { "200": { "description": "Supplier groups", "content": { "application/json": { "schema": {} } } } }, "operationId": "SupplierController.autocompleteSupplierGroups" } }, "/management/supplier/import": { "post": { "x-controller-name": "SupplierController", "x-operation-name": "import", "tags": [ "SupplierController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Import suppliers from CSV" } } } } }, "parameters": [ { "name": "mapField", "in": "query", "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "x-parser": "stream", "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" } } } } }, "description": "Request body for multipart/form-data based file upload", "required": true, "x-parameter-index": 1 }, "operationId": "SupplierController.import" } }, "/management/supplier/last-load": { "get": { "x-controller-name": "SupplierController", "x-operation-name": "getLastLoadTime", "tags": [ "SupplierController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Get time of last load from BigQuery" } } } } }, "operationId": "SupplierController.getLastLoadTime" } }, "/management/supplier/load": { "post": { "x-controller-name": "SupplierController", "x-operation-name": "load", "tags": [ "SupplierController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Load new suppliers from BigQuery" } } } } }, "operationId": "SupplierController.load" } }, "/management/supplier/{id}": { "patch": { "x-controller-name": "SupplierController", "x-operation-name": "update", "tags": [ "SupplierController" ], "responses": { "200": { "description": "Update supplier instance", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": {} } }, "x-parameter-index": 1 }, "operationId": "SupplierController.update" }, "get": { "x-controller-name": "SupplierController", "x-operation-name": "get", "tags": [ "SupplierController" ], "responses": { "200": { "description": "Supplier instance", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "SupplierController.get" }, "delete": { "x-controller-name": "SupplierController", "x-operation-name": "delete", "tags": [ "SupplierController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Delete supplier instance" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "SupplierController.delete" } }, "/management/supplier": { "post": { "x-controller-name": "SupplierController", "x-operation-name": "create", "tags": [ "SupplierController" ], "responses": { "200": { "description": "Create supplier instance", "content": { "application/json": { "schema": {} } } } }, "requestBody": { "content": { "application/json": { "schema": {} } } }, "operationId": "SupplierController.create" }, "get": { "x-controller-name": "SupplierController", "x-operation-name": "list", "tags": [ "SupplierController" ], "responses": { "200": { "description": "Array of suppliers", "content": { "application/json": { "schema": { "type": "array", "items": {} } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/supplier.Filter" } } } } ], "operationId": "SupplierController.list" } }, "/namespace/info": { "get": { "x-controller-name": "NamespaceInfoController", "x-operation-name": "getNamespaceInfo", "tags": [ "NamespaceInfoController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Get namespace info from BigQuery" } } } } }, "parameters": [ { "name": "env_namespace", "in": "query", "schema": { "type": "string" } } ], "operationId": "NamespaceInfoController.getNamespaceInfo" } }, "/off-site/brand-performance": { "post": { "x-controller-name": "OffSiteCampaignReportController", "x-operation-name": "getBrandPerformanceReport", "tags": [ "OffSiteCampaignReportController" ], "responses": { "200": { "description": "Get brand performance report for an off site campaign", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrandPerformanceResponse" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportRequest" } } }, "required": true }, "operationId": "OffSiteCampaignReportController.getBrandPerformanceReport" } }, "/off-site/metrics-report": { "post": { "x-controller-name": "OffSiteCampaignReportController", "x-operation-name": "getMetricsReport", "tags": [ "OffSiteCampaignReportController" ], "responses": { "200": { "description": "Get metrics report for a off site campaign", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OffSiteCampaignMetricsResponse" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportRequest" } } }, "required": true }, "operationId": "OffSiteCampaignReportController.getMetricsReport" } }, "/off-site/sku-performance": { "post": { "x-controller-name": "OffSiteCampaignReportController", "x-operation-name": "getSkuPerformanceReport", "tags": [ "OffSiteCampaignReportController" ], "responses": { "200": { "description": "Get SKU performance report for an off site campaign", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SkuPerformanceResponse" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportRequest" } } }, "required": true }, "operationId": "OffSiteCampaignReportController.getSkuPerformanceReport" } }, "/packages/user-sections": { "get": { "x-controller-name": "PackageAccessController", "x-operation-name": "getAssignedSections", "tags": [ "PackageAccessController" ], "responses": { "200": { "description": "Array of Sections assigned to teams", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Section" } } } } } }, "parameters": [ { "name": "teamId", "in": "query", "schema": { "type": "string" } }, { "name": "envNamespace", "in": "query", "schema": { "type": "string" } } ], "operationId": "PackageAccessController.getAssignedSections" } }, "/packages/{id}/rules": { "put": { "x-controller-name": "PackageAccessController", "x-operation-name": "updatePackageRules", "tags": [ "PackageAccessController" ], "responses": { "200": { "description": "Updated package with rules", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Package" } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PackageRuleRequest" } } }, "x-parameter-index": 1 }, "operationId": "PackageAccessController.updatePackageRules" } }, "/packages/{id}/sections": { "get": { "x-controller-name": "PackageSectionController", "x-operation-name": "find", "tags": [ "PackageSectionController" ], "responses": { "200": { "description": "Array of Package has many Section", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Section" } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } ], "operationId": "PackageSectionController.find" } }, "/packages/{id}": { "patch": { "x-controller-name": "PackageController", "x-operation-name": "updateById", "tags": [ "PackageController" ], "responses": { "204": { "description": "Package PATCH", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Package" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdatedPackage" } } }, "x-parameter-index": 1 }, "operationId": "PackageController.updateById" }, "get": { "x-controller-name": "PackageController", "x-operation-name": "findPackageById", "tags": [ "PackageController" ], "responses": { "200": { "description": "Get specific package model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PackageWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Package.Filter" } } } } ], "operationId": "PackageController.findPackageById" }, "delete": { "x-controller-name": "PackageController", "x-operation-name": "deleteById", "tags": [ "PackageController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Package DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "PackageController.deleteById" } }, "/packages": { "post": { "x-controller-name": "PackageController", "x-operation-name": "createNewPackage", "tags": [ "PackageController" ], "responses": { "200": { "description": "Create package model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Package" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewPackage" } } } }, "operationId": "PackageController.createNewPackage" }, "get": { "x-controller-name": "PackageController", "x-operation-name": "find", "tags": [ "PackageController" ], "responses": { "200": { "description": "Array of Package model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PackageWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Package.Filter" } } } } ], "operationId": "PackageController.find" } }, "/ping": { "get": { "x-controller-name": "PingController", "x-operation-name": "ping", "tags": [ "PingController" ], "responses": { "200": { "description": "Ping Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PingResponse" } } } } }, "operationId": "PingController.ping" } }, "/protected-ping": { "get": { "x-controller-name": "ProtectedPingController", "x-operation-name": "protectedPing", "tags": [ "ProtectedPingController" ], "responses": { "200": { "description": "Return value of ProtectedPingController.protectedPing" } }, "operationId": "ProtectedPingController.protectedPing" } }, "/report/keyword-match-report": { "post": { "x-controller-name": "KeywordMatchReportController", "x-operation-name": "getAnalyticsReport", "tags": [ "KeywordMatchReportController" ], "responses": { "200": { "description": "Get analytics report for keyword match and search term", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeyWordMatchReportResponse" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportRequest" } } }, "required": true }, "operationId": "KeywordMatchReportController.getAnalyticsReport" } }, "/reporting/dataset/last-updated": { "get": { "x-controller-name": "HealthStatusController", "x-operation-name": "getTableLastUpdatedTime", "tags": [ "HealthStatusController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Get last updated time for analytics.viz3_realised_ad_daily_agg_union table" } } } } }, "parameters": [ { "name": "env", "in": "query", "schema": { "type": "string" } }, { "name": "liveTable", "in": "query", "schema": { "type": "boolean" } } ], "operationId": "HealthStatusController.getTableLastUpdatedTime" } }, "/reports/embed": { "get": { "x-controller-name": "ReportController", "x-operation-name": "getEmbed", "tags": [ "ReportController" ], "responses": { "200": { "description": "Domo embed data", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DomoEmbedInfoWithRelations" } } } } }, "parameters": [ { "name": "reportId", "in": "query", "schema": { "type": "string" }, "required": true }, { "name": "teamId", "in": "query", "schema": { "type": "string" }, "required": true }, { "name": "envNamespace", "in": "query", "schema": { "type": "string" }, "required": false } ], "operationId": "ReportController.getEmbed" } }, "/reports/types": { "get": { "x-controller-name": "ReportController", "x-operation-name": "getReportTypes", "tags": [ "ReportController" ], "responses": { "200": { "description": "Report Types", "content": { "application/json": { "schema": { "type": "array" } } } } }, "parameters": [ { "name": "type", "in": "query", "schema": { "type": "string" } } ], "operationId": "ReportController.getReportTypes" } }, "/reports/{id}/teams": { "get": { "x-controller-name": "ReportController", "x-operation-name": "getReportTeams", "tags": [ "ReportController" ], "responses": { "200": { "description": "Array of Teams assigned to current report", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Team" } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "ReportController.getReportTeams" } }, "/reports/{id}": { "patch": { "x-controller-name": "ReportController", "x-operation-name": "updateReport", "tags": [ "ReportController" ], "responses": { "200": { "description": "Report PATCH", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Report" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdatedReport" } } }, "x-parameter-index": 1 }, "operationId": "ReportController.updateReport" }, "get": { "x-controller-name": "ReportController", "x-operation-name": "findById", "tags": [ "ReportController" ], "responses": { "200": { "description": "Report model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Report.Filter" } } } } ], "operationId": "ReportController.findById" }, "delete": { "x-controller-name": "ReportController", "x-operation-name": "deleteById", "tags": [ "ReportController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Report DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "ReportController.deleteById" } }, "/reports": { "post": { "x-controller-name": "ReportController", "x-operation-name": "createNewReport", "tags": [ "ReportController" ], "responses": { "200": { "description": "Create report model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Report" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewReport" } } } }, "operationId": "ReportController.createNewReport" }, "get": { "x-controller-name": "ReportController", "x-operation-name": "find", "tags": [ "ReportController" ], "responses": { "200": { "description": "Array of report data", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ReportWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Report.Filter1" } } } } ], "operationId": "ReportController.find" } }, "/sections/{id}/icon": { "get": { "x-controller-name": "SectionIconController", "x-operation-name": "getIcon", "tags": [ "SectionIconController" ], "responses": { "200": { "description": "Icon belonging to Section", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Icon" } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "SectionIconController.getIcon" } }, "/sections/{id}/reports": { "post": { "x-controller-name": "SectionSectionReportController", "x-operation-name": "create", "tags": [ "SectionSectionReportController" ], "responses": { "200": { "description": "Create Section Report success" } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SectionReportExcluding_id-sectionId-created-updated-deleted-deletedOn-deletedBy_" } } } }, "x-parameter-index": 1 }, "operationId": "SectionSectionReportController.create" }, "get": { "x-controller-name": "SectionSectionReportController", "x-operation-name": "find", "tags": [ "SectionSectionReportController" ], "responses": { "200": { "description": "Array of Section has many SectionReport", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SectionReport" } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } ], "operationId": "SectionSectionReportController.find" }, "delete": { "x-controller-name": "SectionSectionReportController", "x-operation-name": "delete", "tags": [ "SectionSectionReportController" ], "responses": { "204": { "description": "SectionReport DELETE success" } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "section_report.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "SectionSectionReportController.delete" } }, "/sections/{id}": { "patch": { "x-controller-name": "SectionController", "x-operation-name": "updateById", "tags": [ "SectionController" ], "responses": { "204": { "description": "Section PATCH", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SectionWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "iconId": { "type": "string" }, "reportIds": { "type": "array", "items": { "type": "string" } } } } } }, "x-parameter-index": 1 }, "operationId": "SectionController.updateById" }, "delete": { "x-controller-name": "SectionController", "x-operation-name": "deleteById", "tags": [ "SectionController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Section DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "SectionController.deleteById" } }, "/sections/{sectionId}": { "get": { "x-controller-name": "SectionController", "x-operation-name": "findById", "tags": [ "SectionController" ], "responses": { "200": { "description": "Section model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SectionWithRelations" } } } } }, "parameters": [ { "name": "sectionId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Section.Filter" } } } } ], "operationId": "SectionController.findById" } }, "/sections": { "post": { "x-controller-name": "SectionController", "x-operation-name": "createNewSection", "tags": [ "SectionController" ], "responses": { "200": { "description": "Section model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Section" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewSection" } } } }, "operationId": "SectionController.createNewSection" } }, "/user": { "get": { "x-controller-name": "UserController", "x-operation-name": "getUserSettings", "tags": [ "UserController" ], "responses": { "200": { "description": "User settings.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserSettings" } } } } }, "operationId": "UserController.getUserSettings" } }, "/v1/report/campaign/glance-metrics": { "post": { "x-controller-name": "CampaignControllerV1", "x-operation-name": "getMultiCampaignsGlanceMetrics", "tags": [ "CampaignControllerV1" ], "responses": { "200": { "description": "Get multi campaigns summary", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponseV1" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportRequestV1" } } }, "required": true }, "operationId": "CampaignControllerV1.getMultiCampaignsGlanceMetrics" } }, "/v1/report/campaign/history-breakdown/summary": { "post": { "x-controller-name": "CampaignControllerV1", "x-operation-name": "getMultiCampaignsHistoryBreakdownSummary", "tags": [ "CampaignControllerV1" ], "responses": { "200": { "description": "Get history breakdown summary", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponseV1" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportRequestV1" } } }, "required": true }, "operationId": "CampaignControllerV1.getMultiCampaignsHistoryBreakdownSummary" } }, "/v1/report/campaign/history-breakdown": { "post": { "x-controller-name": "CampaignControllerV1", "x-operation-name": "getMultiCampaignsHistoryBreakdown", "tags": [ "CampaignControllerV1" ], "responses": { "200": { "description": "Get history breakdown", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponseV1" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportRequestV1" } } }, "required": true }, "operationId": "CampaignControllerV1.getMultiCampaignsHistoryBreakdown" } }, "/v1/report/campaign/performance/summary": { "post": { "x-controller-name": "CampaignControllerV1", "x-operation-name": "getCampaignPerformanceSummary", "tags": [ "CampaignControllerV1" ], "responses": { "200": { "description": "Get campaign performance summary", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponseV1" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportRequestV1" } } }, "required": true }, "operationId": "CampaignControllerV1.getCampaignPerformanceSummary" } }, "/v1/report/campaign/performance": { "post": { "x-controller-name": "CampaignControllerV1", "x-operation-name": "getCampaignPerformance", "tags": [ "CampaignControllerV1" ], "responses": { "200": { "description": "Get campaign performance metrics", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponseV1" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportRequestV1" } } }, "required": true }, "operationId": "CampaignControllerV1.getCampaignPerformance" } }, "/v1/report/campaign/status": { "post": { "x-controller-name": "CampaignControllerV1", "x-operation-name": "getCampaignStatuses", "tags": [ "CampaignControllerV1" ], "responses": { "200": { "description": "Get campaign statuses for given campaign IDs", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CampaignStatus" } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CampaignStatusRequest" } } }, "required": true }, "operationId": "CampaignControllerV1.getCampaignStatuses" } }, "/v1/report/campaign/summary": { "post": { "x-controller-name": "CampaignControllerV1", "x-operation-name": "getMultiCampaignsSummary", "tags": [ "CampaignControllerV1" ], "responses": { "200": { "description": "Get multi campaigns summary", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponseV1" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportRequestV1" } } }, "required": true }, "operationId": "CampaignControllerV1.getMultiCampaignsSummary" } }, "/v1/report/campaign": { "post": { "x-controller-name": "CampaignControllerV1", "x-operation-name": "getMultiCampaigns", "tags": [ "CampaignControllerV1" ], "responses": { "200": { "description": "Get multi campaigns report", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponseV1" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportRequestV1" } } }, "required": true }, "operationId": "CampaignControllerV1.getMultiCampaigns" } }, "/v1/report/category/labels": { "post": { "x-controller-name": "CategoryReportController", "x-operation-name": "getCategoryLabels", "tags": [ "CategoryReportController" ], "responses": { "200": { "description": "Get category labels", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponseV1" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportRequestV1" } } }, "required": true }, "operationId": "CategoryReportController.getCategoryLabels" } }, "/v1/report/category/summary": { "post": { "x-controller-name": "CategoryReportController", "x-operation-name": "getCategoryReportSummary", "tags": [ "CategoryReportController" ], "responses": { "200": { "description": "Get category report summary", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponseV1" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportRequestV1" } } }, "required": true }, "operationId": "CategoryReportController.getCategoryReportSummary" } }, "/v1/report/category": { "post": { "x-controller-name": "CategoryReportController", "x-operation-name": "getCategoryReport", "tags": [ "CategoryReportController" ], "responses": { "200": { "description": "Get category report", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponseV1" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportRequestV1" } } }, "required": true }, "operationId": "CategoryReportController.getCategoryReport" } }, "/v1/report/keyword/match-type/summary": { "post": { "x-controller-name": "KeywordControllerV1", "x-operation-name": "getKeywordMatchTypeSummary", "tags": [ "KeywordControllerV1" ], "responses": { "200": { "description": "Get keyword match type summary report", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponseV1" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportRequestV1" } } }, "required": true }, "operationId": "KeywordControllerV1.getKeywordMatchTypeSummary" } }, "/v1/report/keyword/match-type": { "post": { "x-controller-name": "KeywordControllerV1", "x-operation-name": "getKeywordMatchTypeReport", "tags": [ "KeywordControllerV1" ], "responses": { "200": { "description": "Get keyword match type report", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponseV1" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportRequestV1" } } }, "required": true }, "operationId": "KeywordControllerV1.getKeywordMatchTypeReport" } }, "/v1/report/keyword/summary": { "post": { "x-controller-name": "KeywordControllerV1", "x-operation-name": "getKeywordReportSummary", "tags": [ "KeywordControllerV1" ], "responses": { "200": { "description": "Get keyword report summary", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponseV1" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportRequestV1" } } }, "required": true }, "operationId": "KeywordControllerV1.getKeywordReportSummary" } }, "/v1/report/keyword": { "post": { "x-controller-name": "KeywordControllerV1", "x-operation-name": "getKeywordReport", "tags": [ "KeywordControllerV1" ], "responses": { "200": { "description": "Get keyword report", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponseV1" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportRequestV1" } } }, "required": true }, "operationId": "KeywordControllerV1.getKeywordReport" } }, "/v1/report/product/summary": { "post": { "x-controller-name": "ProductControllerV1", "x-operation-name": "getProductReportSummary", "tags": [ "ProductControllerV1" ], "responses": { "200": { "description": "Get product report summary", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponseV1" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportRequestV1" } } }, "required": true }, "operationId": "ProductControllerV1.getProductReportSummary" } }, "/v1/report/product": { "post": { "x-controller-name": "ProductControllerV1", "x-operation-name": "getProductReport", "tags": [ "ProductControllerV1" ], "responses": { "200": { "description": "Get product report", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponseV1" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportRequestV1" } } }, "required": true }, "operationId": "ProductControllerV1.getProductReport" } }, "/v1/report/team/activeSuppliers": { "post": { "x-controller-name": "TeamControllerV1", "x-operation-name": "getActiveSuppliers", "tags": [ "TeamControllerV1" ], "responses": { "200": { "description": "Get active suppliers", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponseV1" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportRequestV1" } } }, "required": true }, "operationId": "TeamControllerV1.getActiveSuppliers" } }, "/v1/report/team/glance-metrics": { "post": { "x-controller-name": "TeamControllerV1", "x-operation-name": "getTeamsGlanceMetrics", "tags": [ "TeamControllerV1" ], "responses": { "200": { "description": "Get team glance metrics", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponseV1" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportRequestV1" } } }, "required": true }, "operationId": "TeamControllerV1.getTeamsGlanceMetrics" } }, "/v1/report/team/performance": { "post": { "x-controller-name": "TeamControllerV1", "x-operation-name": "getTeamPerformance", "tags": [ "TeamControllerV1" ], "responses": { "200": { "description": "Get team performance metrics", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponseV1" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportRequestV1" } } }, "required": true }, "operationId": "TeamControllerV1.getTeamPerformance" } }, "/v1/report/team/summary": { "post": { "x-controller-name": "TeamControllerV1", "x-operation-name": "getTeamsSummary", "tags": [ "TeamControllerV1" ], "responses": { "200": { "description": "Get teams summary", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponseV1" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportRequestV1" } } }, "required": true }, "operationId": "TeamControllerV1.getTeamsSummary" } }, "/v1/report/team": { "post": { "x-controller-name": "TeamControllerV1", "x-operation-name": "getTeams", "tags": [ "TeamControllerV1" ], "responses": { "200": { "description": "Get teams", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponseV1" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportRequestV1" } } }, "required": true }, "operationId": "TeamControllerV1.getTeams" } }, "/v1/report/unified/brand-halo-performance": { "post": { "x-controller-name": "UnifiedReportControllerV1", "x-operation-name": "getBrandHaloPerformance", "tags": [ "UnifiedReportControllerV1" ], "responses": { "200": { "description": "Get Brand halo performance report", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponseV1" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportRequestV1" } } }, "required": true }, "operationId": "UnifiedReportControllerV1.getBrandHaloPerformance" } }, "/v1/report/unified/delivery-clicks-summary-report": { "post": { "x-controller-name": "UnifiedReportControllerV1", "x-operation-name": "getDeliveryAndClicksSummaryReport", "tags": [ "UnifiedReportControllerV1" ], "responses": { "200": { "description": "Get delivery and clicks summary report", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponseV1" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportRequestV1" } } }, "required": true }, "operationId": "UnifiedReportControllerV1.getDeliveryAndClicksSummaryReport" } }, "/v1/report/unified/glance-metrics": { "post": { "x-controller-name": "UnifiedReportControllerV1", "x-operation-name": "getGlanceMetrics", "tags": [ "UnifiedReportControllerV1" ], "responses": { "200": { "description": "Get unified report summary", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponseV1" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportRequestV1" } } }, "required": true }, "operationId": "UnifiedReportControllerV1.getGlanceMetrics" } }, "/v1/report/unified/sku-group-performance": { "post": { "x-controller-name": "UnifiedReportControllerV1", "x-operation-name": "getSkuGroupPerformance", "tags": [ "UnifiedReportControllerV1" ], "responses": { "200": { "description": "Get SKU group performance report", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponseV1" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportRequestV1" } } }, "required": true }, "operationId": "UnifiedReportControllerV1.getSkuGroupPerformance" } }, "/v1/report/unified/sku-meta-data": { "post": { "x-controller-name": "UnifiedReportControllerV1", "x-operation-name": "getSkuMetadata", "tags": [ "UnifiedReportControllerV1" ], "responses": { "200": { "description": "Get SKU metadata containing product group information", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponseV1" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportRequestV1" } } }, "required": true }, "operationId": "UnifiedReportControllerV1.getSkuMetadata" } }, "/v1/report/unified/summary": { "post": { "x-controller-name": "UnifiedReportControllerV1", "x-operation-name": "getSummary", "tags": [ "UnifiedReportControllerV1" ], "responses": { "200": { "description": "Get summary data containing both shoppers and revenue information for a team and SKU group", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponseV1" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportRequestV1" } } }, "required": true }, "operationId": "UnifiedReportControllerV1.getSummary" } }, "/v1/report/wallet/balance": { "post": { "x-controller-name": "WalletControllerV1", "x-operation-name": "getWalletBalance", "tags": [ "WalletControllerV1" ], "responses": { "200": { "description": "Get wallet balance report", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponseV1" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportRequestV1" } } }, "required": true }, "operationId": "WalletControllerV1.getWalletBalance" } }, "/v1/report/wallet/ledger": { "post": { "x-controller-name": "WalletControllerV1", "x-operation-name": "getWalletLedger", "tags": [ "WalletControllerV1" ], "responses": { "200": { "description": "Get wallet transaction ledger report", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponseV1" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportRequestV1" } } }, "required": true }, "operationId": "WalletControllerV1.getWalletLedger" } }, "/v2/report/campaign/glance-metrics": { "post": { "x-controller-name": "CampaignControllerV2", "x-operation-name": "getMultiCampaignsGlanceMetrics", "tags": [ "CampaignControllerV2" ], "responses": { "200": { "description": "Get campaign glance metrics (single aggregated row, no pagination)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponseV1" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportRequestV1" } } }, "required": true }, "operationId": "CampaignControllerV2.getMultiCampaignsGlanceMetrics" } }, "/v2/report/campaign/history-breakdown/summary": { "post": { "x-controller-name": "CampaignControllerV2", "x-operation-name": "getMultiCampaignsHistoryBreakdownSummary", "tags": [ "CampaignControllerV2" ], "responses": { "200": { "description": "Get history breakdown summary (single aggregated row)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponseV1" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportRequestV1" } } }, "required": true }, "operationId": "CampaignControllerV2.getMultiCampaignsHistoryBreakdownSummary" } }, "/v2/report/campaign/history-breakdown": { "post": { "x-controller-name": "CampaignControllerV2", "x-operation-name": "getMultiCampaignsHistoryBreakdown", "tags": [ "CampaignControllerV2" ], "responses": { "200": { "description": "Get history breakdown (time series by ingressed_at)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponseV1" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportRequestV1" } } }, "required": true }, "operationId": "CampaignControllerV2.getMultiCampaignsHistoryBreakdown" } }, "/v2/report/campaign/performance/summary": { "post": { "x-controller-name": "CampaignControllerV2", "x-operation-name": "getCampaignPerformanceSummary", "tags": [ "CampaignControllerV2" ], "responses": { "200": { "description": "Get campaign performance summary (single aggregated row)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponseV1" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportRequestV1" } } }, "required": true }, "operationId": "CampaignControllerV2.getCampaignPerformanceSummary" } }, "/v2/report/campaign/performance": { "post": { "x-controller-name": "CampaignControllerV2", "x-operation-name": "getCampaignPerformance", "tags": [ "CampaignControllerV2" ], "responses": { "200": { "description": "Get campaign performance metrics (time series by date)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponseV1" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportRequestV1" } } }, "required": true }, "operationId": "CampaignControllerV2.getCampaignPerformance" } }, "/v2/report/campaign/summary": { "post": { "x-controller-name": "CampaignControllerV2", "x-operation-name": "getMultiCampaignsSummary", "tags": [ "CampaignControllerV2" ], "responses": { "200": { "description": "Get multi campaigns summary (single aggregated row)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponseV1" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportRequestV1" } } }, "required": true }, "operationId": "CampaignControllerV2.getMultiCampaignsSummary" } }, "/v2/report/campaign": { "post": { "x-controller-name": "CampaignControllerV2", "x-operation-name": "getMultiCampaigns", "tags": [ "CampaignControllerV2" ], "responses": { "200": { "description": "Get multi campaigns report. Supports enhanced params (campaignIds, validState, activeState) for LEFT JOIN mode with dim columns.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponseV1" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportRequestV1" } } }, "required": true }, "operationId": "CampaignControllerV2.getMultiCampaigns" } }, "/v2/report/category/labels": { "post": { "x-controller-name": "CategoryReportControllerV2", "x-operation-name": "getCategoryLabels", "tags": [ "CategoryReportControllerV2" ], "responses": { "200": { "description": "Get category labels", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponseV1" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportRequestV1" } } }, "required": true }, "operationId": "CategoryReportControllerV2.getCategoryLabels" } }, "/v2/report/category/summary": { "post": { "x-controller-name": "CategoryReportControllerV2", "x-operation-name": "getCategoryReportSummary", "tags": [ "CategoryReportControllerV2" ], "responses": { "200": { "description": "Get category report summary", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponseV1" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportRequestV1" } } }, "required": true }, "operationId": "CategoryReportControllerV2.getCategoryReportSummary" } }, "/v2/report/category": { "post": { "x-controller-name": "CategoryReportControllerV2", "x-operation-name": "getCategoryReport", "tags": [ "CategoryReportControllerV2" ], "responses": { "200": { "description": "Get category report", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponseV1" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportRequestV1" } } }, "required": true }, "operationId": "CategoryReportControllerV2.getCategoryReport" } }, "/v2/report/keyword/match-type/summary": { "post": { "x-controller-name": "KeywordControllerV2", "x-operation-name": "getKeywordMatchTypeSummary", "tags": [ "KeywordControllerV2" ], "responses": { "200": { "description": "Get keyword match type summary report", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponseV1" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportRequestV1" } } }, "required": true }, "operationId": "KeywordControllerV2.getKeywordMatchTypeSummary" } }, "/v2/report/keyword/match-type": { "post": { "x-controller-name": "KeywordControllerV2", "x-operation-name": "getKeywordMatchTypeReport", "tags": [ "KeywordControllerV2" ], "responses": { "200": { "description": "Get keyword match type report", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponseV1" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportRequestV1" } } }, "required": true }, "operationId": "KeywordControllerV2.getKeywordMatchTypeReport" } }, "/v2/report/keyword/summary": { "post": { "x-controller-name": "KeywordControllerV2", "x-operation-name": "getKeywordReportSummary", "tags": [ "KeywordControllerV2" ], "responses": { "200": { "description": "Get keyword report summary", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponseV1" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportRequestV1" } } }, "required": true }, "operationId": "KeywordControllerV2.getKeywordReportSummary" } }, "/v2/report/keyword": { "post": { "x-controller-name": "KeywordControllerV2", "x-operation-name": "getKeywordReport", "tags": [ "KeywordControllerV2" ], "responses": { "200": { "description": "Get keyword report", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponseV1" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportRequestV1" } } }, "required": true }, "operationId": "KeywordControllerV2.getKeywordReport" } }, "/v2/report/product/summary": { "post": { "x-controller-name": "ProductControllerV2", "x-operation-name": "getProductReportSummary", "tags": [ "ProductControllerV2" ], "responses": { "200": { "description": "Get product report summary", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponseV1" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportRequestV1" } } }, "required": true }, "operationId": "ProductControllerV2.getProductReportSummary" } }, "/v2/report/product": { "post": { "x-controller-name": "ProductControllerV2", "x-operation-name": "getProductReport", "tags": [ "ProductControllerV2" ], "responses": { "200": { "description": "Get product report", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponseV1" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportRequestV1" } } }, "required": true }, "operationId": "ProductControllerV2.getProductReport" } }, "/v2/report/unified/brand-halo-performance": { "post": { "x-controller-name": "UnifiedReportControllerV2", "x-operation-name": "getBrandHaloPerformance", "tags": [ "UnifiedReportControllerV2" ], "responses": { "200": { "description": "Get Brand halo performance report", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponseV1" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportRequestV1" } } }, "required": true }, "operationId": "UnifiedReportControllerV2.getBrandHaloPerformance" } }, "/v2/report/unified/delivery-clicks-summary-report": { "post": { "x-controller-name": "UnifiedReportControllerV2", "x-operation-name": "getDeliveryAndClicksSummaryReport", "tags": [ "UnifiedReportControllerV2" ], "responses": { "200": { "description": "Get delivery and clicks summary report", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponseV1" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportRequestV1" } } }, "required": true }, "operationId": "UnifiedReportControllerV2.getDeliveryAndClicksSummaryReport" } }, "/v2/report/unified/glance-metrics": { "post": { "x-controller-name": "UnifiedReportControllerV2", "x-operation-name": "getGlanceMetrics", "tags": [ "UnifiedReportControllerV2" ], "responses": { "200": { "description": "Get unified glance metrics", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponseV1" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportRequestV1" } } }, "required": true }, "operationId": "UnifiedReportControllerV2.getGlanceMetrics" } }, "/v2/report/unified/sku-group-performance": { "post": { "x-controller-name": "UnifiedReportControllerV2", "x-operation-name": "getSkuGroupPerformance", "tags": [ "UnifiedReportControllerV2" ], "responses": { "200": { "description": "Get SKU group performance report", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponseV1" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportRequestV1" } } }, "required": true }, "operationId": "UnifiedReportControllerV2.getSkuGroupPerformance" } }, "/v2/report/unified/sku-meta-data": { "post": { "x-controller-name": "UnifiedReportControllerV2", "x-operation-name": "getSkuMetadata", "tags": [ "UnifiedReportControllerV2" ], "responses": { "200": { "description": "Get SKU metadata containing product group information", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponseV1" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportRequestV1" } } }, "required": true }, "operationId": "UnifiedReportControllerV2.getSkuMetadata" } }, "/v2/report/unified/summary": { "post": { "x-controller-name": "UnifiedReportControllerV2", "x-operation-name": "getSummary", "tags": [ "UnifiedReportControllerV2" ], "responses": { "200": { "description": "Get summary data containing both shoppers and revenue information for a team and SKU group", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponseV1" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportRequestV1" } } }, "required": true }, "operationId": "UnifiedReportControllerV2.getSummary" } }, "/v2/report/wallet/balance": { "post": { "x-controller-name": "WalletControllerV2", "x-operation-name": "getWalletBalance", "tags": [ "WalletControllerV2" ], "responses": { "200": { "description": "Get wallet balance report", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponseV1" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportRequestV1" } } }, "required": true }, "operationId": "WalletControllerV2.getWalletBalance" } }, "/v2/report/wallet/ledger": { "post": { "x-controller-name": "WalletControllerV2", "x-operation-name": "getWalletLedger", "tags": [ "WalletControllerV2" ], "responses": { "200": { "description": "Get wallet transaction ledger report", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponseV1" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportRequestV1" } } }, "required": true }, "operationId": "WalletControllerV2.getWalletLedger" } }, "/{report}/{filter}": { "post": { "x-controller-name": "DynamicFilterController", "x-operation-name": "getFilter", "tags": [ "DynamicFilterController" ], "responses": { "200": { "description": "Get dynamic filter response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DynamicFilterResponse" } } } } }, "parameters": [ { "name": "report", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "filter", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportRequest" } } }, "required": true, "x-parameter-index": 2 }, "operationId": "DynamicFilterController.getFilter" } } }, "servers": [ { "url": "https://staging-insightsapis.citrusad.com" } ], "components": { "schemas": { "UserSettings": { "title": "UserSettings", "type": "object", "properties": { "isAdmin": { "type": "boolean" } }, "additionalProperties": false }, "Section": { "title": "Section", "type": "object", "properties": { "deleted": { "type": "boolean" }, "deletedOn": { "type": "string", "format": "date-time", "nullable": true }, "deletedBy": { "type": "string", "nullable": true }, "created": { "type": "string", "format": "date-time", "description": "Date the entity was created" }, "updated": { "type": "string", "format": "date-time", "description": "Date the entity was updated" }, "id": { "type": "string", "description": "The unique identifier for a Package" }, "name": { "type": "string" }, "packageId": { "type": "string" }, "iconId": { "type": "string" } }, "description": "{\"indexInfo\":{\"id\":{\"unique\":true}}}", "required": [ "name", "packageId" ], "additionalProperties": false }, "NewSection": { "title": "NewSection", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewSection', exclude: [ 'id' ] })", "properties": { "deleted": { "type": "boolean" }, "deletedOn": { "type": "string", "format": "date-time", "nullable": true }, "deletedBy": { "type": "string", "nullable": true }, "created": { "type": "string", "format": "date-time", "description": "Date the entity was created" }, "updated": { "type": "string", "format": "date-time", "description": "Date the entity was updated" }, "name": { "type": "string" }, "packageId": { "type": "string" }, "iconId": { "type": "string" } }, "required": [ "name", "packageId" ], "additionalProperties": false, "x-typescript-type": "Omit" }, "IconWithRelations": { "title": "IconWithRelations", "type": "object", "description": "(tsType: IconWithRelations, schemaOptions: { includeRelations: true }), {\"indexInfo\":{\"id\":{\"unique\":true}}}", "properties": { "deleted": { "type": "boolean" }, "deletedOn": { "type": "string", "format": "date-time", "nullable": true }, "deletedBy": { "type": "string", "nullable": true }, "created": { "type": "string", "format": "date-time", "description": "Date the entity was created" }, "updated": { "type": "string", "format": "date-time", "description": "Date the entity was updated" }, "id": { "type": "string", "description": "The unique identifier for a Icon" }, "defaultImagePath": { "type": "string" }, "activeImagePath": { "type": "string" } }, "required": [ "defaultImagePath", "activeImagePath" ], "additionalProperties": false, "x-typescript-type": "IconWithRelations" }, "ReportWithRelations": { "title": "ReportWithRelations", "type": "object", "description": "(tsType: ReportWithRelations, schemaOptions: { includeRelations: true }), {\"indexInfo\":{\"id\":{\"unique\":true}}}", "properties": { "deleted": { "type": "boolean" }, "deletedOn": { "type": "string", "format": "date-time", "nullable": true }, "deletedBy": { "type": "string", "nullable": true }, "created": { "type": "string", "format": "date-time", "description": "Date the entity was created" }, "updated": { "type": "string", "format": "date-time", "description": "Date the entity was updated" }, "id": { "type": "string", "description": "The unique identifier for a Report" }, "name": { "type": "string" }, "domoEmbedId": { "type": "string" }, "standardDashboardId": { "type": "string" }, "type": { "type": "string" } }, "required": [ "name" ], "additionalProperties": false, "x-typescript-type": "ReportWithRelations" }, "SectionWithRelations": { "title": "SectionWithRelations", "type": "object", "description": "(tsType: SectionWithRelations, schemaOptions: { includeRelations: true }), {\"indexInfo\":{\"id\":{\"unique\":true}}}", "properties": { "deleted": { "type": "boolean" }, "deletedOn": { "type": "string", "format": "date-time", "nullable": true }, "deletedBy": { "type": "string", "nullable": true }, "created": { "type": "string", "format": "date-time", "description": "Date the entity was created" }, "updated": { "type": "string", "format": "date-time", "description": "Date the entity was updated" }, "id": { "type": "string", "description": "The unique identifier for a Package" }, "name": { "type": "string" }, "packageId": { "type": "string" }, "iconId": { "type": "string" }, "icon": { "$ref": "#/components/schemas/IconWithRelations" }, "foreignKey": {}, "reports": { "type": "array", "items": { "$ref": "#/components/schemas/ReportWithRelations" } } }, "required": [ "name", "packageId" ], "additionalProperties": false, "x-typescript-type": "SectionWithRelations" }, "SectionReport": { "title": "SectionReport", "type": "object", "properties": { "deleted": { "type": "boolean" }, "deletedOn": { "type": "string", "format": "date-time", "nullable": true }, "deletedBy": { "type": "string", "nullable": true }, "created": { "type": "string", "format": "date-time", "description": "Date the entity was created" }, "updated": { "type": "string", "format": "date-time", "description": "Date the entity was updated" }, "id": { "type": "string", "description": "The unique identifier for a Package" }, "sectionId": { "type": "string" }, "reportId": { "type": "string" } }, "description": "{\"indexInfo\":{\"id\":{\"unique\":true}}}", "required": [ "sectionId", "reportId" ], "additionalProperties": false }, "SectionReportExcluding_id-sectionId-created-updated-deleted-deletedOn-deletedBy_": { "title": "SectionReportExcluding_id-sectionId-created-updated-deleted-deletedOn-deletedBy_", "type": "object", "description": "(tsType: Omit, schemaOptions: { exclude: [ 'id', 'sectionId', 'created', 'updated', 'deleted', 'deletedOn', 'deletedBy' ] })", "properties": { "reportId": { "type": "string" } }, "required": [ "reportId" ], "additionalProperties": false, "x-typescript-type": "Omit" }, "Icon": { "title": "Icon", "type": "object", "properties": { "deleted": { "type": "boolean" }, "deletedOn": { "type": "string", "format": "date-time", "nullable": true }, "deletedBy": { "type": "string", "nullable": true }, "created": { "type": "string", "format": "date-time", "description": "Date the entity was created" }, "updated": { "type": "string", "format": "date-time", "description": "Date the entity was updated" }, "id": { "type": "string", "description": "The unique identifier for a Icon" }, "defaultImagePath": { "type": "string" }, "activeImagePath": { "type": "string" } }, "description": "{\"indexInfo\":{\"id\":{\"unique\":true}}}", "required": [ "defaultImagePath", "activeImagePath" ], "additionalProperties": false }, "Report": { "title": "Report", "type": "object", "properties": { "deleted": { "type": "boolean" }, "deletedOn": { "type": "string", "format": "date-time", "nullable": true }, "deletedBy": { "type": "string", "nullable": true }, "created": { "type": "string", "format": "date-time", "description": "Date the entity was created" }, "updated": { "type": "string", "format": "date-time", "description": "Date the entity was updated" }, "id": { "type": "string", "description": "The unique identifier for a Report" }, "name": { "type": "string" }, "domoEmbedId": { "type": "string" }, "standardDashboardId": { "type": "string" }, "type": { "type": "string" } }, "description": "{\"indexInfo\":{\"id\":{\"unique\":true}}}", "required": [ "name" ], "additionalProperties": false }, "NewReport": { "title": "NewReport", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewReport', exclude: [ 'id', 'deleted', 'deletedOn', 'deletedBy', 'created', 'updated' ] })", "properties": { "name": { "type": "string" }, "domoEmbedId": { "type": "string" }, "standardDashboardId": { "type": "string" }, "type": { "type": "string" } }, "required": [ "name" ], "additionalProperties": false, "x-typescript-type": "Omit" }, "UpdatedReport": { "title": "UpdatedReport", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'UpdatedReport', exclude: [ 'id', 'deleted', 'deletedOn', 'deletedBy', 'created', 'updated' ] })", "properties": { "name": { "type": "string" }, "domoEmbedId": { "type": "string" }, "standardDashboardId": { "type": "string" }, "type": { "type": "string" } }, "required": [ "name" ], "additionalProperties": false, "x-typescript-type": "Omit" }, "DomoEmbedInfoWithRelations": { "title": "DomoEmbedInfoWithRelations", "type": "object", "description": "(tsType: DomoEmbedInfoWithRelations, schemaOptions: { includeRelations: true })", "properties": { "embedToken": { "type": "string" }, "embedUrl": { "type": "string" } }, "additionalProperties": false, "x-typescript-type": "DomoEmbedInfoWithRelations" }, "Team": { "title": "Team", "type": "object", "properties": { "id": { "type": "string" }, "teamName": { "type": "string" }, "namespaceName": { "type": "string" }, "group": { "type": "string" }, "companyName": { "type": "string" }, "companyType": { "type": "string" }, "industry": { "type": "string" } }, "required": [ "id", "teamName" ], "additionalProperties": false }, "Package": { "title": "Package", "type": "object", "properties": { "deleted": { "type": "boolean" }, "deletedOn": { "type": "string", "format": "date-time", "nullable": true }, "deletedBy": { "type": "string", "nullable": true }, "created": { "type": "string", "format": "date-time", "description": "Date the entity was created" }, "updated": { "type": "string", "format": "date-time", "description": "Date the entity was updated" }, "id": { "type": "string", "description": "The unique identifier for a Package" }, "name": { "type": "string" }, "rules": { "type": "string" }, "rulesUpdated": { "type": "string", "format": "date-time", "description": "Date the entity was updated" }, "rulesUpdatedBy": { "type": "string" } }, "description": "{\"indexInfo\":{\"id\":{\"unique\":true}}}", "required": [ "name" ], "additionalProperties": false }, "NewPackage": { "title": "NewPackage", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewPackage', exclude: [ 'id', 'deleted', 'deletedOn', 'deletedBy', 'created', 'updated' ] })", "properties": { "name": { "type": "string" }, "rules": { "type": "string" }, "rulesUpdated": { "type": "string", "format": "date-time", "description": "Date the entity was updated" }, "rulesUpdatedBy": { "type": "string" } }, "required": [ "name" ], "additionalProperties": false, "x-typescript-type": "Omit" }, "PackageWithRelations": { "title": "PackageWithRelations", "type": "object", "description": "(tsType: PackageWithRelations, schemaOptions: { includeRelations: true }), {\"indexInfo\":{\"id\":{\"unique\":true}}}", "properties": { "deleted": { "type": "boolean" }, "deletedOn": { "type": "string", "format": "date-time", "nullable": true }, "deletedBy": { "type": "string", "nullable": true }, "created": { "type": "string", "format": "date-time", "description": "Date the entity was created" }, "updated": { "type": "string", "format": "date-time", "description": "Date the entity was updated" }, "id": { "type": "string", "description": "The unique identifier for a Package" }, "name": { "type": "string" }, "rules": { "type": "string" }, "rulesUpdated": { "type": "string", "format": "date-time", "description": "Date the entity was updated" }, "rulesUpdatedBy": { "type": "string" }, "sections": { "type": "array", "items": { "$ref": "#/components/schemas/SectionWithRelations" } } }, "required": [ "name" ], "additionalProperties": false, "x-typescript-type": "PackageWithRelations" }, "UpdatedPackage": { "title": "UpdatedPackage", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'UpdatedPackage', exclude: [ 'id', 'deleted', 'deletedOn', 'deletedBy', 'created', 'updated' ] })", "properties": { "name": { "type": "string" }, "rules": { "type": "string" }, "rulesUpdated": { "type": "string", "format": "date-time", "description": "Date the entity was updated" }, "rulesUpdatedBy": { "type": "string" } }, "required": [ "name" ], "additionalProperties": false, "x-typescript-type": "Omit" }, "PackageRuleRequest": { "title": "PackageRuleRequest", "type": "object", "properties": { "rules": { "type": "string" } }, "additionalProperties": false }, "WhereCondition": { "title": "WhereCondition", "type": "object", "properties": { "dateRange": { "type": "string", "enum": [ "TODAY", "THIS_WEEK", "THIS_MONTH", "THIS_QUARTER", "THIS_YEAR", "YESTERDAY", "PREVIOUS_WEEK", "PREVIOUS_MONTH", "PREVIOUS_QUARTER", "PREVIOUS_YEAR", "BETWEEN", "ALL_TIME" ] }, "aggregationInterval": { "type": "string", "enum": [ "YEAR", "QUARTER", "MONTH", "WEEK", "DAY", "HOUR" ] }, "retailer": { "type": "string" }, "supplier": { "type": "string" }, "campaign": { "type": "string" }, "start": { "type": "string" }, "end": { "type": "string" }, "date": { "type": "string" }, "namespace": { "type": "string" }, "teamId": { "type": "string" }, "teamType": { "type": "string" }, "team": { "type": "string" }, "orderBy": { "type": "array", "items": { "type": "string" } }, "orderByDir": { "type": "string" }, "isUTC": { "type": "boolean" }, "CampaignName": { "type": "string" }, "CampaignType": { "type": "string" }, "AdTypeName": { "type": "string" }, "category": { "type": "string" }, "GenericSearchTerm": { "type": "string" }, "IsFTA": { "type": "boolean" }, "campaign_name": { "type": "string" }, "product_name": { "type": "string" }, "keyword": {}, "search_term": {}, "order_item_id": { "type": "string" }, "platform": { "type": "string" }, "campaign_type": { "type": "string" }, "campaign_subtype": { "type": "string" }, "keyword_match_type": { "type": "string" }, "attributionModel": { "type": "string" }, "WalletName": { "type": "string" }, "OrderType": { "type": "string" }, "campaignGroupName": { "type": "string" }, "WalletId": { "type": "array", "items": { "type": "string" } }, "walletIds": { "type": "array", "items": { "type": "string", "description": "Array of wallet IDs for multi-wallet filtering" } }, "placement": {} }, "required": [ "namespace", "teamId", "teamType" ], "additionalProperties": false }, "InsightsReport": { "title": "InsightsReport", "type": "object", "properties": { "env": { "type": "string" }, "page": { "type": "number" }, "pageSize": { "type": "number" }, "where": { "$ref": "#/components/schemas/WhereCondition" } }, "required": [ "where" ], "additionalProperties": false }, "DynamicFilter": { "title": "DynamicFilter", "type": "object", "properties": { "campaign_name": { "type": "string" }, "product_name": { "type": "string" }, "search_term": { "type": "string" }, "keyword": { "type": "string" }, "wallet_name": { "type": "string" }, "placement": { "type": "string" } }, "additionalProperties": false }, "DynamicFilterResponse": { "title": "DynamicFilterResponse", "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/DynamicFilter" } }, "pageSize": { "type": "number" }, "totalRows": { "type": "number" } }, "additionalProperties": false }, "Filter": { "title": "Filter", "type": "object", "properties": { "dateRange": { "type": "string", "enum": [ "TODAY", "THIS_WEEK", "THIS_MONTH", "THIS_QUARTER", "THIS_YEAR", "YESTERDAY", "PREVIOUS_WEEK", "PREVIOUS_MONTH", "PREVIOUS_QUARTER", "PREVIOUS_YEAR", "BETWEEN", "ALL_TIME" ] }, "aggregationInterval": { "type": "string", "enum": [ "YEAR", "QUARTER", "MONTH", "WEEK", "DAY", "HOUR" ] }, "retailer": { "type": "string" }, "supplier": { "type": "string" }, "campaign": { "type": "string" }, "start": { "type": "string" }, "end": { "type": "string" }, "date": { "type": "string" }, "namespace": { "type": "string" }, "teamId": { "type": "string" }, "supplierIds": { "type": "array", "items": { "type": "string", "items": { "type": "string" } } }, "teamType": { "type": "string" }, "team": { "type": "string" }, "orderBy": { "type": "array", "items": { "type": "string" } }, "orderByDir": { "type": "string" }, "isUTC": { "type": "boolean" }, "CampaignName": { "type": "string" }, "CampaignType": { "type": "string" }, "IsFTA": { "type": "boolean" }, "campaign_name": { "type": "string" }, "product_name": { "type": "string" }, "keyword": {}, "search_term": {}, "keyword_match_type": { "type": "string" }, "wallet_name": { "type": "string" }, "wallet_id": { "type": "string" }, "catalog_id": { "type": "string" }, "placement": { "type": "string" }, "campaign_id": { "type": "string" }, "campaign_type": { "type": "string", "enum": [ "DISPLAY", "BRAND_PAGE", "BANNER", "SHOTGUN_BANNER" ] }, "placement_id": { "type": "string" }, "placement_ids": { "type": "array", "items": { "type": "string", "items": { "type": "string" } } }, "placements": { "type": "array", "items": { "type": "string", "items": { "type": "string" } } }, "ad_type_name": { "type": "string" }, "CatalogId": { "type": "string" }, "WalletId": { "type": "string" }, "campaignNames": { "type": "array", "items": { "type": "string", "items": { "type": "string" } } }, "catalogIds": { "type": "array", "items": { "type": "string", "items": { "type": "string" } } }, "walletIds": { "type": "array", "items": { "type": "string", "description": "Array of wallet IDs for multi-wallet filtering", "items": { "type": "string" } } }, "campaignTypes": { "type": "array", "items": { "type": "string", "items": { "type": "string" } } } }, "required": [ "namespace", "teamId", "teamType" ], "additionalProperties": false }, "ReportRequest": { "title": "ReportRequest", "type": "object", "properties": { "env": { "type": "string" }, "page": { "type": "number" }, "pageSize": { "type": "number" }, "filterBy": { "$ref": "#/components/schemas/Filter" } }, "required": [ "filterBy" ], "additionalProperties": false }, "ApiResponseV1": { "title": "ApiResponseV1", "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object" } }, "pageSize": { "type": "number" }, "totalRows": { "type": "number" }, "message": { "type": "string" }, "lastSyncTime": { "type": "string" }, "nextPageToken": { "type": "string" } }, "required": [ "data", "pageSize", "totalRows" ], "additionalProperties": false }, "ReportFilters": { "title": "ReportFilters", "type": "object", "properties": { "namespace": { "type": "string" }, "teamId": { "type": "string" }, "supplierIds": { "type": "array", "items": { "type": "string", "items": { "type": "string" } } }, "teamType": { "type": "string", "enum": [ "RETAILER", "SUPPLIER" ] }, "dateRange": { "type": "object", "properties": { "start": { "type": "string" }, "end": { "type": "string" } }, "required": [ "start", "end" ] }, "campaignName": { "type": "string" }, "campaignNames": { "type": "array", "items": { "type": "string", "items": { "type": "string" } } }, "campaignType": { "type": "string", "enum": [ "DISPLAY", "BRAND_PAGE", "BANNER", "SHOTGUN_BANNER" ] }, "env": { "type": "string" }, "catalogId": { "type": "string" }, "catalogIds": { "type": "array", "items": { "type": "string", "items": { "type": "string" } } }, "keyword": { "type": "string" }, "placement": { "type": "string" }, "productName": { "type": "string" }, "walletId": { "type": "string" }, "searchTerm": { "type": "string" }, "campaignId": { "type": "string" }, "campaignIds": { "type": "array", "items": { "type": "string" } }, "includeAllCampaigns": { "type": "boolean" }, "validState": { "type": "string" }, "activeState": { "type": "string" }, "keywordMatchType": { "type": "string" }, "isFTA": { "type": "boolean" }, "placementId": { "type": "string" }, "placementIds": { "type": "array", "items": { "type": "string", "items": { "type": "string" } } }, "aggregationInterval": { "type": "string", "enum": [ "YEAR", "QUARTER", "MONTH", "WEEK", "DAY", "HOUR" ] }, "currencyCode": { "type": "string" }, "skuGroupId": { "type": "string" }, "category": {}, "walletIds": { "type": "array", "items": { "type": "string" } }, "campaignTypes": { "type": "array", "items": { "type": "string" } } }, "required": [ "namespace", "teamId", "teamType", "dateRange", "env" ], "additionalProperties": false }, "ReportOptions": { "title": "ReportOptions", "type": "object", "properties": { "isUTC": { "type": "boolean" }, "showLive": { "type": "boolean" }, "columns": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, "Pagination": { "title": "Pagination", "type": "object", "properties": { "page": { "type": "number" }, "pageSize": { "type": "number" }, "pageToken": { "type": "string" } }, "additionalProperties": false }, "Sorting": { "title": "Sorting", "type": "object", "properties": { "orderBy": { "type": "array", "items": { "type": "string", "items": { "type": "string" } } }, "direction": { "type": "string", "enum": [ "asc", "desc" ] } }, "additionalProperties": false }, "ReportRequestV1": { "title": "ReportRequestV1", "type": "object", "properties": { "filters": { "$ref": "#/components/schemas/ReportFilters" }, "options": { "$ref": "#/components/schemas/ReportOptions" }, "pagination": { "$ref": "#/components/schemas/Pagination" }, "sorting": { "$ref": "#/components/schemas/Sorting" } }, "required": [ "filters" ], "additionalProperties": false }, "CampaignStatus": { "title": "CampaignStatus", "type": "object", "properties": { "campaignId": { "type": "string" }, "campaignStatus": { "type": "string" } }, "required": [ "campaignId" ], "additionalProperties": false }, "CampaignStatusRequest": { "title": "CampaignStatusRequest", "type": "object", "properties": { "campaignIds": { "type": "array", "items": { "type": "string", "items": { "type": "string" }, "maxItems": 50 } }, "env": { "type": "string" }, "namespace": { "type": "string" }, "teamId": { "type": "string" } }, "required": [ "campaignIds", "env", "namespace", "teamId" ], "additionalProperties": false }, "RetailerEnhancedAttributionResponse": { "title": "RetailerEnhancedAttributionResponse", "type": "object", "properties": { "retailerId": { "type": "string" }, "enhancedAttributionFlag": { "type": "boolean" } }, "required": [ "retailerId", "enhancedAttributionFlag" ], "additionalProperties": false }, "RetailerEnhancedAttributionRequest": { "title": "RetailerEnhancedAttributionRequest", "type": "object", "properties": { "retailerIds": { "type": "array", "items": { "type": "string" } }, "envNamespace": { "type": "string" } }, "required": [ "retailerIds", "envNamespace" ], "additionalProperties": false }, "OffSiteCampaignMetricsReport": { "title": "OffSiteCampaignMetricsReport", "type": "object", "properties": { "spend": { "type": "number" }, "impressionsTotal": { "type": "number" }, "impressionsUnique": { "type": "number" }, "individualsMessaged": { "type": "number" }, "clicks": { "type": "number" }, "skuRoas": { "type": "number" }, "brandRoas": { "type": "number" } }, "additionalProperties": false }, "OffSiteCampaignMetricsResponse": { "title": "OffSiteCampaignMetricsResponse", "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/OffSiteCampaignMetricsReport" } }, "pageSize": { "type": "number" }, "totalRows": { "type": "number" } }, "additionalProperties": false }, "SkuPerformanceReport": { "title": "SkuPerformanceReport", "type": "object", "properties": { "campaignName": { "type": "string" }, "totalSKUUniqueConverters": { "type": "number" }, "totalSKUOrders": { "type": "number" }, "totalSKUItems": { "type": "number" }, "totalSKURevenueLocalCurrency": { "type": "number" }, "onlineSKUUniqueConverters": { "type": "number" }, "onlineSKUOrders": { "type": "number" }, "onlineSKUItems": { "type": "number" }, "onlineSKURevenueLocalCurrency": { "type": "number" }, "inStoreSKUUniqueConverters": { "type": "number" }, "inStoreSKUOrders": { "type": "number" }, "inStoreSKUItems": { "type": "number" }, "inStoreSKURevenueLocalCurrency": { "type": "number" } }, "additionalProperties": false }, "SkuPerformanceResponse": { "title": "SkuPerformanceResponse", "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SkuPerformanceReport" } }, "pageSize": { "type": "number", "description": "Total number of rows per page" }, "totalRows": { "type": "number", "description": "Total number of rows in the response" } }, "additionalProperties": false }, "BrandPerformanceReport": { "title": "BrandPerformanceReport", "type": "object", "properties": { "campaignName": { "type": "string" }, "totalBrandUniqueConverters": { "type": "number" }, "totalBrandOrders": { "type": "number" }, "totalBrandItems": { "type": "number" }, "totalBrandRevenueLocalCurrency": { "type": "number" }, "onlineBrandUniqueConverters": { "type": "number" }, "onlineBrandOrders": { "type": "number" }, "onlineBrandItems": { "type": "number" }, "onlineBrandRevenueLocalCurrency": { "type": "number" }, "inStoreBrandUniqueConverters": { "type": "number" }, "inStoreBrandOrders": { "type": "number" }, "inStoreBrandItems": { "type": "number" }, "inStoreBrandRevenueLocalCurrency": { "type": "number" } }, "additionalProperties": false }, "BrandPerformanceResponse": { "title": "BrandPerformanceResponse", "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/BrandPerformanceReport" } }, "pageSize": { "type": "number", "description": "Total number of rows per page" }, "totalRows": { "type": "number", "description": "Total number of rows in the response" } }, "additionalProperties": false }, "KeyWordMatchReport": { "title": "KeyWordMatchReport", "type": "object", "properties": { "keyword": { "type": "string" }, "keyword_match_type": { "type": "string" }, "search_term": { "type": "string" }, "clicks": { "type": "number" }, "impressions": { "type": "number" }, "conversions": { "type": "number" }, "ad_spend": { "type": "number" }, "sales_revenue": { "type": "number" }, "ctr": { "type": "number" }, "roas": { "type": "number" } }, "additionalProperties": false }, "KeyWordMatchReportResponse": { "title": "KeyWordMatchReportResponse", "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/KeyWordMatchReport" } }, "pageSize": { "type": "number" }, "totalRows": { "type": "number" } }, "additionalProperties": false }, "HistoryBreakdown": { "title": "HistoryBreakdown", "type": "object", "properties": { "date": { "type": "string", "format": "date-time" }, "impressions": { "type": "number" }, "clicks": { "type": "number" }, "conversions": { "type": "number" }, "unitsSold": { "type": "number" }, "ctr": { "type": "number" }, "conversionRate": { "type": "number" }, "cpc": { "type": "number" }, "cpi": { "type": "number" }, "cpm": { "type": "number", "description": "Cost per 1,000 impressions" }, "cpa": { "type": "number" }, "adSpend": { "type": "number" }, "salesValue": { "type": "number" }, "roas": { "type": "number" }, "roaas": { "type": "number" }, "orderValue": { "type": "number", "description": "The average order value (Total revenue / Conversions)" }, "unitsPerPurchase": { "type": "number", "description": "The average units per purchase (Units sold / Conversions)" } }, "additionalProperties": false }, "HistoryBreakdownResponse": { "title": "HistoryBreakdownResponse", "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/HistoryBreakdown" } }, "pageSize": { "type": "number", "description": "Total number of rows per page" }, "totalRows": { "type": "number", "description": "Total number of rows in the response" } }, "additionalProperties": false }, "CampaignKeyWordReport": { "title": "CampaignKeyWordReport", "type": "object", "properties": { "keyword": { "type": "string" }, "keywordMatchType": { "type": "string" }, "searchTerm": { "type": "string" }, "impressions": { "type": "number" }, "clicks": { "type": "number" }, "conversions": { "type": "number" }, "unitsSold": { "type": "number" }, "salesValue": { "type": "number" }, "ctr": { "type": "number" }, "conversionRate": { "type": "number" }, "cpc": { "type": "number" }, "cpi": { "type": "number" }, "cpm": { "type": "number" }, "cpa": { "type": "number" }, "adSpend": { "type": "number" }, "roas": { "type": "number" }, "roaas": { "type": "number" }, "teamName": { "type": "string" } }, "additionalProperties": false }, "CampaignKeyWordReportResponse": { "title": "CampaignKeyWordReportResponse", "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/CampaignKeyWordReport" } }, "pageSize": { "type": "number" }, "totalRows": { "type": "number" } }, "additionalProperties": false }, "CampaignProductReport": { "title": "CampaignProductReport", "type": "object", "properties": { "productName": { "type": "string" }, "productCode": { "type": "string" }, "catalogId": { "type": "string" }, "impressions": { "type": "number" }, "clicks": { "type": "number" }, "conversions": { "type": "number" }, "cpi": { "type": "number" }, "unitsSold": { "type": "number" }, "ctr": { "type": "number" }, "conversionRate": { "type": "number" }, "cpc": { "type": "number" }, "cpa": { "type": "number" }, "adSpend": { "type": "number" }, "salesValue": { "type": "number" }, "roas": { "type": "number" }, "roaas": { "type": "number" } }, "additionalProperties": false }, "CampaignProductReportResponse": { "title": "CampaignProductReportResponse", "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/CampaignProductReport" } }, "pageSize": { "type": "number" }, "totalRows": { "type": "number" } }, "additionalProperties": false }, "CampaignPerformance": { "title": "CampaignPerformance", "type": "object", "properties": { "date": { "type": "string", "format": "date-time" }, "impressions": { "type": "number" }, "clicks": { "type": "number" }, "conversions": { "type": "number" }, "sales": { "type": "number" }, "adSpend": { "type": "number" }, "conversionRate": { "type": "number" }, "roas": { "type": "number" }, "roaas": { "type": "number" }, "cpc": { "type": "number" } }, "additionalProperties": false }, "CampaignPerformanceResponse": { "title": "CampaignPerformanceResponse", "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/CampaignPerformance" } }, "pageSize": { "type": "number" }, "totalRows": { "type": "number" } }, "additionalProperties": false }, "GlanceMetrics": { "title": "GlanceMetrics", "type": "object", "properties": { "roas": { "type": "number", "description": "Total ROAS calculated" }, "roaas": { "type": "number", "description": "Total ROAAS calculated" }, "ctr": { "type": "number", "description": "Total CTR calculated" }, "cpc": { "type": "number", "description": "Total CPC calculated" }, "cpi": { "type": "number", "description": "Total CPI calculated" }, "cpm": { "type": "number", "description": "Cost per 1,000 impressions" }, "conversions": { "type": "number", "description": "Total conversions captured" }, "conversion_rate": { "type": "number", "description": "Conversions rate" }, "sales_revenue": { "type": "number", "description": "Total sales revenue" }, "impressions": { "type": "number", "description": "Total impressions captured" }, "clicks": { "type": "number", "description": "Total clicks captured" }, "units_sold": { "type": "number", "description": "Total units sold" } }, "additionalProperties": false }, "GlanceMetricsResponse": { "title": "GlanceMetricsResponse", "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/GlanceMetrics" } }, "pageSize": { "type": "number", "description": "Total number of rows per page" }, "totalRows": { "type": "number", "description": "Total number of rows in the response" } }, "additionalProperties": false }, "CampaignReport": { "title": "CampaignReport", "type": "object", "properties": { "id": { "type": "string" }, "campaignName": { "type": "string" }, "adType": { "type": "string" }, "impressions": { "type": "number" }, "clicks": { "type": "number" }, "conversions": { "type": "number" }, "unitsSold": { "type": "number" }, "salesValue": { "type": "number" }, "ctr": { "type": "number" }, "conversionRate": { "type": "number" }, "cpc": { "type": "number" }, "cpi": { "type": "number" }, "cpm": { "type": "number" }, "cpa": { "type": "number" }, "adSpend": { "type": "number" }, "roas": { "type": "number" }, "isFTA": { "type": "string" }, "roaas": { "type": "number" }, "ftaCost": { "type": "number" }, "maxDailySpend": { "type": "number" }, "maxTotalSpend": { "type": "number" }, "searchTermMaxBid": { "type": "number" }, "searchTermMaxBidCount": { "type": "number" }, "searchTermCount": { "type": "number" }, "maxBid": { "type": "number" }, "teamName": { "type": "string" }, "averageUnitsSold": { "type": "number" }, "averageSalesValue": { "type": "number" }, "averageOrderValue": { "type": "number" }, "unitsPerPurchase": { "type": "number" } }, "additionalProperties": false }, "CampaignReportResponse": { "title": "CampaignReportResponse", "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/CampaignReport" } }, "pageSize": { "type": "number" }, "totalRows": { "type": "number" } }, "additionalProperties": false }, "CampaignEnhancedMetricsReport": { "title": "CampaignEnhancedMetricsReport", "type": "object", "properties": { "campaignName": { "type": "string" }, "onlineConvs": { "type": "number" }, "onlineRevenue": { "type": "number" }, "onlineROAS": { "type": "number" }, "onlineaROAS": { "type": "number" }, "haloOnlineConvs": { "type": "number" }, "haloOnlineRevenue": { "type": "number" }, "haloOnlineROAS": { "type": "number" }, "haloOnlineaROAS": { "type": "number" }, "instoreConvs": { "type": "number" }, "instoreRevenue": { "type": "number" }, "instoreROAS": { "type": "number" }, "haloInstoreConvs": { "type": "number" }, "haloInstoreRevenue": { "type": "number" }, "haloInstoreROAS": { "type": "number" }, "totalROAS": { "type": "number" }, "totalaROAS": { "type": "number" }, "id": { "type": "string" }, "adType": { "type": "string" }, "isFTA": { "type": "boolean" }, "teamName": { "type": "string" } }, "additionalProperties": false }, "CampaignEnhancedMetricsReportResponse": { "title": "CampaignEnhancedMetricsReportResponse", "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/CampaignEnhancedMetricsReport" } }, "pageSize": { "type": "number" }, "totalRows": { "type": "number" } }, "additionalProperties": false }, "Icon.Filter": { "type": "object", "title": "Icon.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "deleted": { "type": "boolean" }, "deletedOn": { "type": "boolean" }, "deletedBy": { "type": "boolean" }, "created": { "type": "boolean" }, "updated": { "type": "boolean" }, "id": { "type": "boolean" }, "defaultImagePath": { "type": "boolean" }, "activeImagePath": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "deleted", "deletedOn", "deletedBy", "created", "updated", "id", "defaultImagePath", "activeImagePath" ], "example": "deleted" }, "uniqueItems": true } ], "title": "Icon.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "Icon.Filter1": { "type": "object", "title": "Icon.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "Icon.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "deleted": { "type": "boolean" }, "deletedOn": { "type": "boolean" }, "deletedBy": { "type": "boolean" }, "created": { "type": "boolean" }, "updated": { "type": "boolean" }, "id": { "type": "boolean" }, "defaultImagePath": { "type": "boolean" }, "activeImagePath": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "deleted", "deletedOn", "deletedBy", "created", "updated", "id", "defaultImagePath", "activeImagePath" ], "example": "deleted" }, "uniqueItems": true } ], "title": "Icon.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "iam_client_service_account_key.Filter": { "type": "object", "title": "iam_client_service_account_key.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "iam_client_service_account_key.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "deleted": { "type": "boolean" }, "deletedOn": { "type": "boolean" }, "deletedBy": { "type": "boolean" }, "created": { "type": "boolean" }, "updated": { "type": "boolean" }, "id": { "type": "boolean" }, "serviceAccountId": { "type": "boolean" }, "description": { "type": "boolean" }, "externalId": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "deleted", "deletedOn", "deletedBy", "created", "updated", "id", "serviceAccountId", "description", "externalId" ], "example": "deleted" }, "uniqueItems": true } ], "title": "iam_client_service_account_key.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "iam_client.ScopeFilter": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": {}, "additionalProperties": true }, { "type": "array", "items": { "type": "string" }, "uniqueItems": true } ] }, "include": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": true } } }, "additionalProperties": false, "title": "iam_client.ScopeFilter" }, "iam_client.IncludeFilter.Items": { "title": "iam_client.IncludeFilter.Items", "type": "object", "properties": { "relation": { "type": "string", "enum": [ "members", "serviceAccounts", "datasetAccess", "usage" ] }, "scope": { "$ref": "#/components/schemas/iam_client.ScopeFilter" } } }, "iam_client.Filter": { "type": "object", "title": "iam_client.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "iam_client.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "deleted": { "type": "boolean" }, "deletedOn": { "type": "boolean" }, "deletedBy": { "type": "boolean" }, "created": { "type": "boolean" }, "updated": { "type": "boolean" }, "id": { "type": "boolean" }, "name": { "type": "boolean" }, "type": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "deleted", "deletedOn", "deletedBy", "created", "updated", "id", "name", "type" ], "example": "deleted" }, "uniqueItems": true } ], "title": "iam_client.Fields" }, "include": { "title": "iam_client.IncludeFilter", "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/iam_client.IncludeFilter.Items" }, { "type": "string" } ] } } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "iam_dataset.ScopeFilter": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": {}, "additionalProperties": true }, { "type": "array", "items": { "type": "string" }, "uniqueItems": true } ] }, "include": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": true } } }, "additionalProperties": false, "title": "iam_dataset.ScopeFilter" }, "iam_dataset.IncludeFilter.Items": { "title": "iam_dataset.IncludeFilter.Items", "type": "object", "properties": { "relation": { "type": "string", "enum": [ "filters", "clientAccess", "views" ] }, "scope": { "$ref": "#/components/schemas/iam_dataset.ScopeFilter" } } }, "iam_dataset.Filter": { "type": "object", "title": "iam_dataset.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "iam_dataset.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "deleted": { "type": "boolean" }, "deletedOn": { "type": "boolean" }, "deletedBy": { "type": "boolean" }, "created": { "type": "boolean" }, "updated": { "type": "boolean" }, "id": { "type": "boolean" }, "name": { "type": "boolean" }, "description": { "type": "boolean" }, "externalName": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "deleted", "deletedOn", "deletedBy", "created", "updated", "id", "name", "description", "externalName" ], "example": "deleted" }, "uniqueItems": true } ], "title": "iam_dataset.Fields" }, "include": { "title": "iam_dataset.IncludeFilter", "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/iam_dataset.IncludeFilter.Items" }, { "type": "string" } ] } } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "region_namespace.Filter": { "type": "object", "title": "region_namespace.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "region_namespace.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "deleted": { "type": "boolean" }, "deletedOn": { "type": "boolean" }, "deletedBy": { "type": "boolean" }, "created": { "type": "boolean" }, "updated": { "type": "boolean" }, "status": { "type": "boolean" }, "id": { "type": "boolean" }, "regionNamespace": { "type": "boolean" }, "geoRegion": { "type": "boolean" }, "localTimezone": { "type": "boolean" }, "extractBucketUrl": { "type": "boolean" }, "extractEnabled": { "type": "boolean" }, "changeRequestedBy": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "deleted", "deletedOn", "deletedBy", "created", "updated", "status", "id", "regionNamespace", "geoRegion", "localTimezone", "extractBucketUrl", "extractEnabled", "changeRequestedBy" ], "example": "deleted" }, "uniqueItems": true } ], "title": "region_namespace.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "retailer.Filter": { "type": "object", "title": "retailer.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "retailer.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "deleted": { "type": "boolean" }, "deletedOn": { "type": "boolean" }, "deletedBy": { "type": "boolean" }, "created": { "type": "boolean" }, "updated": { "type": "boolean" }, "status": { "type": "boolean" }, "id": { "type": "boolean" }, "retailerId": { "type": "boolean" }, "retailerName": { "type": "boolean" }, "envNamespace": { "type": "boolean" }, "adsRequestedCap": { "type": "boolean" }, "reservedSearchTerms": { "type": "boolean" }, "periodStartDate": { "type": "boolean" }, "bannerAdsRequestedCap": { "type": "boolean" }, "viewAttributionWindow": { "type": "boolean" }, "clickAttributionWindow": { "type": "boolean" }, "retailerTaxonomyHalo": { "type": "boolean" }, "enhancedAttributionFlag": { "type": "boolean" }, "enhancedAttribution2Flag": { "type": "boolean" }, "viewAttributionWindow2": { "type": "boolean" }, "clickAttributionWindow2": { "type": "boolean" }, "retailerTaxonomyHalo2": { "type": "boolean" }, "attributionTimeFrame": { "type": "boolean" }, "attributionTimeFrame2": { "type": "boolean" }, "retailerGroup1": { "type": "boolean" }, "retailerGroup2": { "type": "boolean" }, "extractInOperation": { "type": "boolean" }, "extractBucketUrl": { "type": "boolean" }, "metadata": { "type": "boolean" }, "changeRequestedBy": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "deleted", "deletedOn", "deletedBy", "created", "updated", "status", "id", "retailerId", "retailerName", "envNamespace", "adsRequestedCap", "reservedSearchTerms", "periodStartDate", "bannerAdsRequestedCap", "viewAttributionWindow", "clickAttributionWindow", "retailerTaxonomyHalo", "enhancedAttributionFlag", "enhancedAttribution2Flag", "viewAttributionWindow2", "clickAttributionWindow2", "retailerTaxonomyHalo2", "attributionTimeFrame", "attributionTimeFrame2", "retailerGroup1", "retailerGroup2", "extractInOperation", "extractBucketUrl", "metadata", "changeRequestedBy" ], "example": "deleted" }, "uniqueItems": true } ], "title": "retailer.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "supplier.Filter": { "type": "object", "title": "supplier.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "supplier.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "deleted": { "type": "boolean" }, "deletedOn": { "type": "boolean" }, "deletedBy": { "type": "boolean" }, "created": { "type": "boolean" }, "updated": { "type": "boolean" }, "status": { "type": "boolean" }, "id": { "type": "boolean" }, "supplierId": { "type": "boolean" }, "supplierName": { "type": "boolean" }, "envNamespace": { "type": "boolean" }, "supplierGroup1": { "type": "boolean" }, "supplierGroup2": { "type": "boolean" }, "supplierGroup3": { "type": "boolean" }, "supplierGroup4": { "type": "boolean" }, "extractInOperation": { "type": "boolean" }, "extractBucketUrl": { "type": "boolean" }, "metadata": { "type": "boolean" }, "changeRequestedBy": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "deleted", "deletedOn", "deletedBy", "created", "updated", "status", "id", "supplierId", "supplierName", "envNamespace", "supplierGroup1", "supplierGroup2", "supplierGroup3", "supplierGroup4", "extractInOperation", "extractBucketUrl", "metadata", "changeRequestedBy" ], "example": "deleted" }, "uniqueItems": true } ], "title": "supplier.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "Package.ScopeFilter": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": {}, "additionalProperties": true }, { "type": "array", "items": { "type": "string" }, "uniqueItems": true } ] }, "include": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": true } } }, "additionalProperties": false, "title": "Package.ScopeFilter" }, "Package.IncludeFilter.Items": { "title": "Package.IncludeFilter.Items", "type": "object", "properties": { "relation": { "type": "string", "enum": [ "sections" ] }, "scope": { "$ref": "#/components/schemas/Package.ScopeFilter" } } }, "Package.Filter": { "type": "object", "title": "Package.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "Package.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "deleted": { "type": "boolean" }, "deletedOn": { "type": "boolean" }, "deletedBy": { "type": "boolean" }, "created": { "type": "boolean" }, "updated": { "type": "boolean" }, "id": { "type": "boolean" }, "name": { "type": "boolean" }, "rules": { "type": "boolean" }, "rulesUpdated": { "type": "boolean" }, "rulesUpdatedBy": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "deleted", "deletedOn", "deletedBy", "created", "updated", "id", "name", "rules", "rulesUpdated", "rulesUpdatedBy" ], "example": "deleted" }, "uniqueItems": true } ], "title": "Package.Fields" }, "include": { "title": "Package.IncludeFilter", "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/Package.IncludeFilter.Items" }, { "type": "string" } ] } } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "PingResponse": { "type": "object", "title": "PingResponse", "properties": { "greeting": { "type": "string" }, "date": { "type": "string" }, "url": { "type": "string" }, "headers": { "type": "object", "properties": { "Content-Type": { "type": "string" } }, "additionalProperties": true } } }, "Report.Filter": { "type": "object", "title": "Report.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "deleted": { "type": "boolean" }, "deletedOn": { "type": "boolean" }, "deletedBy": { "type": "boolean" }, "created": { "type": "boolean" }, "updated": { "type": "boolean" }, "id": { "type": "boolean" }, "name": { "type": "boolean" }, "domoEmbedId": { "type": "boolean" }, "standardDashboardId": { "type": "boolean" }, "type": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "deleted", "deletedOn", "deletedBy", "created", "updated", "id", "name", "domoEmbedId", "standardDashboardId", "type" ], "example": "deleted" }, "uniqueItems": true } ], "title": "Report.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "Report.Filter1": { "type": "object", "title": "Report.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "Report.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "deleted": { "type": "boolean" }, "deletedOn": { "type": "boolean" }, "deletedBy": { "type": "boolean" }, "created": { "type": "boolean" }, "updated": { "type": "boolean" }, "id": { "type": "boolean" }, "name": { "type": "boolean" }, "domoEmbedId": { "type": "boolean" }, "standardDashboardId": { "type": "boolean" }, "type": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "deleted", "deletedOn", "deletedBy", "created", "updated", "id", "name", "domoEmbedId", "standardDashboardId", "type" ], "example": "deleted" }, "uniqueItems": true } ], "title": "Report.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "Section.ScopeFilter": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": {}, "additionalProperties": true }, { "type": "array", "items": { "type": "string" }, "uniqueItems": true } ] }, "include": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": true } } }, "additionalProperties": false, "title": "Section.ScopeFilter" }, "Section.IncludeFilter.Items": { "title": "Section.IncludeFilter.Items", "type": "object", "properties": { "relation": { "type": "string", "enum": [ "icon", "reports" ] }, "scope": { "$ref": "#/components/schemas/Section.ScopeFilter" } } }, "Section.Filter": { "type": "object", "title": "Section.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "deleted": { "type": "boolean" }, "deletedOn": { "type": "boolean" }, "deletedBy": { "type": "boolean" }, "created": { "type": "boolean" }, "updated": { "type": "boolean" }, "id": { "type": "boolean" }, "name": { "type": "boolean" }, "packageId": { "type": "boolean" }, "iconId": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "deleted", "deletedOn", "deletedBy", "created", "updated", "id", "name", "packageId", "iconId" ], "example": "deleted" }, "uniqueItems": true } ], "title": "Section.Fields" }, "include": { "title": "Section.IncludeFilter", "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/Section.IncludeFilter.Items" }, { "type": "string" } ] } } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter
" } }, "securitySchemes": { "jwt": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT" } } }, "security": [ { "jwt": [] } ] }