MOLOCO Report API

openapi: 3.2.0
info:
  title: Moloco Report API
  version: '1.0'
  description: 'Operations tagged Report across 4 of this provider''s published API definitions: mcm-management-api.json, moloco-ads-campaign-management-api.json, moloco-ads-campaign-management-openapi.yml, moloco-commerce-media-management-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://<platform>-mgmt.mcm-api.moloco.com
- url: https://api.moloco.cloud
tags:
- name: Report
paths:
  /rmp/mgmt/v1/platforms/{platform_id}/ad-accounts/{ad_account_id}/audience-report:
    post:
      summary: QueryAudienceSummary
      description: Read summarized reporting information of campaign with respect to audience targeting.
      operationId: RmpManagementApi_QueryAudienceSummary
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/publicReadAudienceReportSummaryResponse'
        '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:
                date_start:
                  type: string
                  description: Date in 'YYYY-MM-DD' when summary begins. Inclusive. The allowed maximum duration for the date range is 30 days.
                date_end:
                  type: string
                  description: Date in 'YYYY-MM-DD' when summary ends. Inclusive. The allowed maximum duration for the date range is 30 days.
                limit:
                  type: string
                  format: int64
                  description: Maximum number of rows to be returned. Cannot exceed 50,000.
              description: ReadAudienceReportSummary request.
              required:
              - date_start
              - date_end
              additionalProperties: true
        required: true
      tags:
      - Report
      security:
      - ApiKeyAuth: []
    servers:
    - url: https://<platform>-mgmt.mcm-api.moloco.com
  /rmp/mgmt/v1/platforms/{platform_id}/ad-accounts/{ad_account_id}/keyword-report:
    post:
      summary: QueryKeywordSummary
      description: Read summarized reporting information of campaigned keywords.
      operationId: RmpManagementApi_QueryKeywordSummary
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/publicReadKeywordReportSummaryResponse'
        '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:
                date_start:
                  type: string
                  description: Date in 'YYYY-MM-DD' when summary begins. Inclusive. The allowed maximum duration for the date range is 30 days.
                date_end:
                  type: string
                  description: Date in 'YYYY-MM-DD' when summary ends. Inclusive. The allowed maximum duration for the date range is 30 days.
                limit:
                  type: string
                  format: int64
                  description: Maximum number of rows to be returned. Cannot exceed 50,000.
              description: ReadKeywordReportSummary request.
              required:
              - date_start
              - date_end
              additionalProperties: true
        required: true
      tags:
      - Report
      security:
      - ApiKeyAuth: []
    servers:
    - url: https://<platform>-mgmt.mcm-api.moloco.com
  /rmp/mgmt/v1/platforms/{platform_id}/ad-accounts/{ad_account_id}/placement-report:
    post:
      summary: QueryPlacementSummary
      description: Read summarized reporting information of campaign with respect to placement targeting.
      operationId: RmpManagementApi_QueryPlacementSummary
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/publicReadPlacementReportSummaryResponse'
        '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:
                date_start:
                  type: string
                  description: Date in 'YYYY-MM-DD' when summary begins. Inclusive. The allowed maximum duration for the date range is 30 days.
                date_end:
                  type: string
                  description: Date in 'YYYY-MM-DD' when summary ends. Inclusive. The allowed maximum duration for the date range is 30 days.
                limit:
                  type: string
                  format: int64
                  description: Maximum number of rows to be returned. Cannot exceed 50,000.
              description: ReadPlacementReportSummary request.
              required:
              - date_start
              - date_end
              additionalProperties: true
        required: true
      tags:
      - Report
      security:
      - ApiKeyAuth: []
    servers:
    - url: https://<platform>-mgmt.mcm-api.moloco.com
  /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
              additionalProperties: true
        required: true
      tags:
      - Report
      security:
      - ApiKeyAuth: []
    servers:
    - url: https://<platform>-mgmt.mcm-api.moloco.com
  /rmp/mgmt/v1/platforms/{platform_id}/ad-manager-accounts/{ad_manager_account_id}/report:
    post:
      summary: QueryAdManagerAccountSummary
      description: Read summarized reporting information of an ad manager account.
      operationId: RmpManagementApi_QueryAdManagerAccountSummary
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/publicReadAdManagerAccountReportSummaryResponse'
        '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_manager_account_id
        description: Identifier of the ad manager account who requests management api. It is passed as a path parameter.
        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. If timezone is empty, 'UTC' will be used for the default value. 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/v1AdManagerAccountReportSummaryGroupByColumn'
                  description: A list of columns to be grouped by.
                limit:
                  type: string
                  format: int64
                  description: Maximum number of rows to be returned. Cannot exceed 50,000
              description: ReadAdManagerAccountReportSummary request.
              required:
              - date_start
              - date_end
              additionalProperties: true
        required: true
      tags:
      - Report
      security:
      - ApiKeyAuth: []
    servers:
    - url: https://<platform>-mgmt.mcm-api.moloco.com
  /rmp/mgmt/v1/platforms/{platform_id}/report:
    post:
      summary: QueryPlatformSummary
      description: Read summarized reporting information of a platform.
      operationId: RmpManagementApi_QueryPlatformSummary
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/publicQueryPlatformSummaryResponse'
        '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
      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/v1PlatformSummaryGroupByColumn'
                  description: A list of columns to be grouped by. Please note that among the group_by options, ITEM and CREATIVE cannot be used together. Furthermore, AD_MANAGER_ACCOUNT can be only used with CURRENCY.
                order_by:
                  type: array
                  items:
                    $ref: '#/components/schemas/v1PlatformSummaryOrderByColumn'
                  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
                ad_account_id:
                  type: string
                  description: AdAccount id.
              description: QueryPlatformSummary request.
              required:
              - date_start
              - date_end
              additionalProperties: true
        required: true
      tags:
      - Report
      security:
      - ApiKeyAuth: []
    servers:
    - url: https://<platform>-mgmt.mcm-api.moloco.com
  /cm/v1/reports:
    get:
      summary: List up reports.
      description: List up reports in the given Workplace and AdAccount.
      operationId: DspApi_ListReports
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/messagesListReportsResponse'
        default:
          description: Error. Detailed cause can be found in the `details` field.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/messagesListReportsError'
      parameters:
      - name: ad_account_id
        description: ID of the AdAccount to list up reports.
        in: query
        required: true
        schema:
          type: string
      tags:
      - Report
      security:
      - Bearer: []
    post:
      summary: Create a new report.
      description: Create a new report of a specific AdAccount.
      operationId: DspApi_CreateReport
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/messagesCreateReportResponse'
        default:
          description: Error. Detailed cause can be found in the `details` field.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/messagesCreateReportError'
      parameters:
      - name: ad_account_id
        description: The AdAccount ID of Campaigns to create the reports.
        in: query
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/dspReport'
        description: The details of the new report specification.
        required: true
      tags:
      - Report
      security:
      - Bearer: []
    servers:
    - url: https://api.moloco.cloud
  /cm/v1/reports/{report_id}:
    get:
      summary: Read an existing report.
      description: Read an existing report.
      operationId: DspApi_ReadReport
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/messagesReadReportResponse'
        default:
          description: Error. Detailed cause can be found in the `details` field.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/messagesReadReportError'
      parameters:
      - name: report_id
        description: Report ID to read.
        in: path
        required: true
        schema:
          type: string
      tags:
      - Report
      security:
      - Bearer: []
    delete:
      summary: Delete an existing report.
      description: Delete an existing report.
      operationId: DspApi_DeleteReport
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/messagesDeleteReportResponse'
        default:
          description: Error. Detailed cause can be found in the `details` field.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/messagesDeleteReportError'
      parameters:
      - name: report_id
        description: Report ID to delete.
        in: path
        required: true
        schema:
          type: string
      tags:
      - Report
      security:
      - Bearer: []
    servers:
    - url: https://api.moloco.cloud
  /cm/v1/reports/{report_id}/status:
    get:
      summary: Read report status.
      description: Read the most recent report status. It will also show URLs containing report contents.
      operationId: DspApi_ReadReportStatus
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/messagesReadReportStatusResponse'
        default:
          description: Error. Detailed cause can be found in the `details` field.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/messagesReadReportStatusError'
      parameters:
      - name: report_id
        description: Report ID to read the status.
        in: path
        required: true
        schema:
          type: string
      tags:
      - Report
      security:
      - Bearer: []
    servers:
    - url: https://api.moloco.cloud
components:
  schemas:
    v1ReportSummaryFilterColumn:
      type: string
      enum:
      - UNKNOWN_FILTER_FIELD
      - CAMPAIGN_FILTER
      default: UNKNOWN_FILTER_FIELD
    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.
          additionalProperties: true
      required:
      - type
      - category
      additionalProperties: true
    v1AudienceReportSummaryRow:
      type: object
      properties:
        campaign_id:
          type: string
          description: Campaign id.
        campaign_title:
          type: string
          description: Campaign title.
        audience:
          type: string
          description: Audience. It is audience label if the audience_type is 'CUSTOM'.
        imp_count:
          type: string
          format: int64
          description: Impression count.
        click_count:
          type: string
          format: int64
          description: Click count.
        ctr:
          type: number
          format: double
          description: CTR. Click divided by Impressions.
        purchase_count:
          type: string
          format: int64
          description: Purchase count captured by direct and indirect attribution.
        revenue:
          type: string
          format: int64
          description: Money earned captured by direct and indirect attribution. It is in a micro unit.
        cpc:
          type: number
          format: double
          description: CPC (Cost Per Click) in a micro unit.
        money_spent:
          type: string
          format: int64
          description: Money spent. It is in a micro unit.
        roas:
          type: number
          format: double
          description: ROAS captured by direct and indirect attribution, in percent.
      description: AudienceReportSummaryRow represents a row of summarized reporting of audiences.
      additionalProperties: true
    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.
        asset_id:
          type: string
          description: Asset id.
        inventory_id:
          type: string
          description: Inventory id.
        imp_count:
          type: string
          format: int64
          description: Impression count.
        imp_item_count:
          type: string
          format: int64
          description: Per item impression count. Only populated for item-level group by results with Sponsored Brand campaign.
        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.
        ctr_item:
          type: number
          format: double
          description: CTR per item-level impression. Click divided by imp_item_count, in percent. Only populated for item-level group by results with Sponsored Brand campaign.
        imp_to_purchase:
          type: number
          format: double
          description: CTR multiplied by CR (CTR x CR).
        imp_item_to_purchase:
          type: number
          format: double
          description: Purchase rate per item-level impression. Purchase divided by imp_item_count, in percent. Only populated for item-level group by results with Sponsored Brand campaign.
        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
          descri

# --- truncated at 32 KB (63 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/moloco/refs/heads/main/openapi/moloco-report-api-openapi.yml