--- updatedAt: 2025-02-07T00:18:03.000Z agentTools: projectIndex: https://mcm-docs.moloco.com/v1.1/llms.txt --- # QueryAdAccountSummary Read summarized reporting information of an ad account. # OpenAPI definition ```json { "openapi": "3.0.0", "info": { "title": "Management API", "description": "MOLOCO RMP Management API provides functionalities for MOLOCO RMP systems.", "version": "1.0", "contact": { "name": "Moloco Inc.", "url": "https://www.molocoads.com" } }, "paths": { "/rmp/mgmt/v1/platforms/{platform_id}/ad-accounts/{ad_account_id}/report": { "post": { "summary": "QueryAdAccountSummary", "description": "Read summarized reporting information of an ad account.", "operationId": "RmpManagementApi_QueryAdAccountSummary", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/publicQueryAdAccountSummaryResponse" } } } }, "400": { "description": "Bad request. Detailed cause can be found in the response message.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/publicRepresentedError" } } } }, "401": { "description": "Unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/publicRepresentedError" } } } }, "403": { "description": "Permission denied.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/publicRepresentedError" } } } }, "404": { "description": "Not found. One or more required resources do not exist.You can see the details in the response message.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/publicRepresentedError" } } } }, "500": { "description": "Internal server error. Detailed cause can be found in the response message.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/publicRepresentedError" } } } } }, "parameters": [ { "name": "platform_id", "description": "Identifier of the platform who requests management api. It is passed as a path parameter.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ad_account_id", "description": "AdAccount id.", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "timezone": { "type": "string", "description": "Timezone of date_start and date_end. To be deprecated. Only platform timezone is accepted. Must be in IANA timezone name format, e.g. Asia/Seoul." }, "date_start": { "type": "string", "description": "Date in 'YYYY-MM-DD' when summary begins. Inclusive. Note the allowed maximum duration for the date range is 186 days, to cover the period of any entire month." }, "date_end": { "type": "string", "description": "Date in 'YYYY-MM-DD' when summary ends. Inclusive. Note the allowed maximum duration for the date range is 186 days, to cover the period of any entire month." }, "group_by": { "type": "array", "items": { "$ref": "#/components/schemas/v1AdAccountSummaryGroupByColumn" }, "description": "A list of columns to be grouped by. Please note that among the group_by options, ITEM and CREATIVE cannot be used together" }, "order_by": { "type": "array", "items": { "$ref": "#/components/schemas/v1AdAccountSummaryOrderByColumn" }, "description": "A list of columns to be ordered by." }, "filter": { "type": "array", "items": { "$ref": "#/components/schemas/managementv1QueryFilter" }, "description": "Query Filter. Only 1 allowed since we only support CAMPAIGN_FILTER." }, "limit": { "type": "string", "format": "int64", "description": "Maximum number of rows to be returned. Cannot exceed 50,000" } }, "description": "QueryAdAccountSummary request.", "required": [ "date_start", "date_end" ] } } }, "required": true }, "tags": [ "Report" ] } } }, "security": [ { "ApiKeyAuth": [] } ], "x-readme": { "explorer-enabled": false }, "servers": [ { "url": "https://-mgmt.mcm-api.moloco.com" } ], "components": { "securitySchemes": { "ApiKeyAuth": { "type": "apiKey", "name": "x-api-key", "in": "header" } }, "schemas": { "RepresentedErrorDetail": { "type": "object", "properties": { "type": { "type": "string", "description": "The type of the metadata." }, "category": { "$ref": "#/components/schemas/commonErrorCategory" }, "metadata": { "type": "object", "description": "The metadata of the responded error." } }, "required": [ "type", "category" ] }, "commonErrorCategory": { "type": "string", "enum": [ "DEFAULT_ERROR_CATEGORY", "INPUT_VALIDATION", "TIMESTAMP_MISMATCH", "FEATURE_NOT_ALLOWED", "REINVITE_NOT_ALLOWED", "LAST_OWNER_REVOKE_NOT_ALLOWED", "LAST_OWNER_DELETE_NOT_ALLOWED", "INSUFFICIENT_SPENDING_LIMIT", "AD_ACCOUNT_ALREADY_OWNED", "INSUFFICIENT_WALLET_BALANCE", "MAX_CAMPAIGN_COUNT_REACHED", "MODIFY_ARCHIVED_CAMPAIGN_NOT_ALLOWED", "INVALID_CAMPAIGN_STATUS_FOR_ARCHIVE", "INVALID_MANAGED_CPT_CAMPAIGN_SCHEDULE", "INACTIVE_AD_ACCOUNT", "DUPLICATE_AUDIENCE", "EXCEED_MAX_IMAGE_SIZE", "MAX_LABEL_COUNT_REACHED", "MAX_LABEL_VALUE_COUNT_REACHED", "MAX_LABEL_VALUE_RELATIONSHIP_COUNT_REACHED", "PLATFORM_INSIGHT_UNAVAILABLE" ], "default": "DEFAULT_ERROR_CATEGORY", "title": "- INPUT_VALIDATION: INPUT_VALIDATION: reserved for 1 ~ 99\n - TIMESTAMP_MISMATCH: TIMESTAMP_MISSMATCH: reserved for 100 ~ 199\n - FEATURE_NOT_ALLOWED: General policy: 1000 ~ 1999\n - REINVITE_NOT_ALLOWED: User policy: 2000 ~ 2999\n - INSUFFICIENT_SPENDING_LIMIT: Account policy: 3000 ~ 3999\nThis policy includes ad manager account, ad account, and wallet related policies\n - MAX_CAMPAIGN_COUNT_REACHED: Campaign policy: 4000 ~ 4999\n - EXCEED_MAX_IMAGE_SIZE: Asset policy: 5000 ~ 5999\n - MAX_LABEL_COUNT_REACHED: Labeling policy: 6000 ~ 6999\n - PLATFORM_INSIGHT_UNAVAILABLE: Insight metric policy: 7000 ~ 7999" }, "commonHaloMetricDouble": { "type": "object", "properties": { "direct": { "type": "number", "format": "double", "description": "Metrics captured by direct attribution." }, "indirect": { "type": "number", "format": "double", "description": "Metrics captured by indirect attribution." }, "total": { "type": "number", "format": "double", "description": "Total metrics captured by direct + indirect attribution." } } }, "commonHaloMetricInt": { "type": "object", "properties": { "direct": { "type": "string", "format": "int64", "description": "Metrics captured by direct attribution." }, "indirect": { "type": "string", "format": "int64", "description": "Metrics captured by indirect attribution." }, "total": { "type": "string", "format": "int64", "description": "Total metrics captured by direct + indirect attribution." } } }, "managementv1QueryFilter": { "type": "object", "properties": { "column": { "$ref": "#/components/schemas/v1ReportSummaryFilterColumn" }, "filter_operator": { "$ref": "#/components/schemas/v1ReportSummaryFilterOperator" }, "value": { "type": "string", "description": "ID to be filtered by. To be used with EQ operator." }, "values": { "type": "array", "items": { "type": "string" }, "description": "IDs to be filtered by. To be used with IN operator. IN operator is only supported for Campaign Filter column." } } }, "publicQueryAdAccountSummaryResponse": { "type": "object", "properties": { "rows": { "type": "array", "items": { "$ref": "#/components/schemas/v1AdAccountSummaryRow" }, "description": "Rows of ad-account-level summarized reporting." } }, "description": "QueryAdAccountSummary response", "required": [ "rows" ] }, "publicRepresentedError": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "description": "The status code, which should be an enum value of google.rpc.Code.(https://developers.google.com/actions-center/reference/grpc-api/status_codes)" }, "message": { "type": "string", "description": "The detailed message of responded error." }, "details": { "type": "array", "items": { "$ref": "#/components/schemas/RepresentedErrorDetail" }, "description": "The detailed information of responded error. Please refer to the error category section in guides for more detailed information.(https://rmp-docs.moloco.com/docs/management-api-error-categories)" } }, "title": "Overridden from grpc status(https://github.com/grpc/grpc/blob/master/src/proto/grpc/status/status.proto)", "required": [ "code", "message", "details" ] }, "v1AdAccountSummaryGroupByColumn": { "type": "string", "enum": [ "UNKNOWN_GROUP_BY", "DATE", "AD_ACCOUNT", "CURRENCY", "CAMPAIGN", "ITEM", "INVENTORY_ID", "CREATIVE" ], "default": "UNKNOWN_GROUP_BY", "description": " - UNKNOWN_GROUP_BY: This value is not part of the API specification." }, "v1AdAccountSummaryOrderByColumn": { "type": "string", "enum": [ "UNKNOWN_ORDER_BY", "TIME_DATE", "TIME_DATE_DESC", "TIMEZONE", "TIMEZONE_DESC", "CURRENCY_DIM", "CURRENCY_DIM_DESC", "AD_ACCOUNT_ID", "AD_ACCOUNT_ID_DESC", "AD_ACCOUNT_TITLE", "AD_ACCOUNT_TITLE_DESC", "CATALOG_ITEM_TITLE", "CATALOG_ITEM_TITLE_DESC", "CAMPAIGN_ID", "CAMPAIGN_ID_DESC", "CAMPAIGN_TITLE", "CAMPAIGN_TITLE_DESC", "CATALOG_ITEM_ID", "CATALOG_ITEM_ID_DESC", "INVENTORY_DIM", "INVENTORY_DIM_DESC", "CREATIVE_ID", "CREATIVE_ID_DESC", "CREATIVE_TITLE", "CREATIVE_TITLE_DESC", "IMP_COUNT", "IMP_COUNT_DESC", "CLICK_COUNT", "CLICK_COUNT_DESC", "MONEY_SPENT", "MONEY_SPENT_DESC", "PURCHASE_COUNT", "PURCHASE_COUNT_DESC", "REVENUE", "REVENUE_DESC", "ROAS", "ROAS_DESC", "CPC", "CPC_DESC", "CR", "CR_DESC", "CTR", "CTR_DESC", "IMP_TO_PURCHASE", "IMP_TO_PURCHASE_DESC", "NUM_AD_ACCOUNTS", "NUM_AD_ACCOUNTS_DESC", "ITEMS_PER_AD_ACCOUNT", "ITEMS_PER_AD_ACCOUNT_DESC", "ACOS", "ACOS_DESC", "CPM", "CPM_DESC" ], "default": "UNKNOWN_ORDER_BY", "title": "- UNKNOWN_ORDER_BY: This value is not part of the API specification.\n - IMP_COUNT: Metrics" }, "v1AdAccountSummaryRow": { "type": "object", "properties": { "date": { "type": "string", "description": "Date in 'YYYY-MM-DD'." }, "timezone": { "type": "string", "description": "Timezone of date in the data." }, "currency": { "type": "string", "description": "Currency." }, "ad_account_id": { "type": "string", "description": "Ad account id." }, "ad_account_title": { "type": "string", "description": "Ad account title." }, "campaign_id": { "type": "string", "description": "Campaign id." }, "campaign_title": { "type": "string", "description": "Campaign title." }, "catalog_item_id": { "type": "string", "description": "Catalog item id." }, "catalog_item_title": { "type": "string", "description": "Catalog item title." }, "creative_id": { "type": "string", "description": "Creative id." }, "creative_title": { "type": "string", "description": "Creative title." }, "inventory_id": { "type": "string", "description": "Inventory id." }, "imp_count": { "type": "string", "format": "int64", "description": "Impression count." }, "click_count": { "type": "string", "format": "int64", "description": "Click count." }, "money_spent": { "type": "string", "format": "int64", "description": "Money spent. It is in a micro unit." }, "purchase_count": { "type": "string", "format": "int64", "description": "Purchase count." }, "purchase_breakdown": { "$ref": "#/components/schemas/commonHaloMetricInt" }, "revenue": { "type": "string", "format": "int64", "description": "Money earned. It is in a micro unit." }, "revenue_breakdown": { "$ref": "#/components/schemas/commonHaloMetricInt" }, "roas": { "type": "number", "format": "double", "description": "ROAS in percent." }, "roas_breakdown": { "$ref": "#/components/schemas/commonHaloMetricDouble" }, "cr": { "type": "number", "format": "double", "description": "CR. Click to Purchase rate." }, "ctr": { "type": "number", "format": "double", "description": "CTR. Click divided by Impressions." }, "imp_to_purchase": { "type": "number", "format": "double", "description": "CTR multiplied by CR (CTR x CR)." }, "num_ad_accounts": { "type": "string", "format": "int64", "description": "Number of active ad accounts during selected time period (platform summary specific)." }, "items_per_ad_account": { "type": "number", "format": "double", "description": "Items per ad account (platform summary specific)." }, "cpc": { "type": "number", "format": "double", "description": "CPC (Cost Per Click) in a micro unit." }, "acos": { "type": "number", "format": "double", "description": "Advertising cost of sales in percent. Ad Spending / Revenue" }, "cpm": { "type": "number", "format": "double", "description": "CPM (Cost Per 1,000 Impressions) in a micro unit." } }, "description": "AdAccountSummaryRow represents a row of ad-account-level summarized reporting." }, "v1ReportSummaryFilterColumn": { "type": "string", "enum": [ "UNKNOWN_FILTER_FIELD", "CAMPAIGN_FILTER" ], "default": "UNKNOWN_FILTER_FIELD" }, "v1ReportSummaryFilterOperator": { "type": "string", "enum": [ "UNKNOWN_FILTER_OPERATOR", "EQ", "IN" ], "default": "UNKNOWN_FILTER_OPERATOR" } } } } ```