> ## Documentation Index
> Fetch the complete documentation index at: https://developers.everflow.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Entity Report

The main reporting endpoint for advertisers. Pivot your performance data by up to 10 dimensions over a date range. Returns table data, time-series performance, and an aggregated summary.

Data is automatically scoped to the authenticated advertiser — no advertiser filter is needed. The API key determines which advertiser's data is returned.

Maximum reporting interval is one year (365 days). Results are limited to 10,000 rows. To stay under the limit, use `query.metric_filters` to drop rows below a threshold — for example, filter to rows with cost by adding `{ "metric_type": "revenue", "operator": "greater_than", "metric_value": 0 }` (an advertiser's cost is the `revenue` metric).


## OpenAPI

````yaml openapi/advertiser-reporting.yaml post /advertisers/reporting/entity
openapi: 3.0.3
info:
  title: Everflow Advertiser API - Reporting
  description: >
    Reporting endpoints for the Everflow Advertiser API. These endpoints are
    accessed by advertiser users using their own API key and return data scoped
    to the authenticated advertiser's account only.
  version: 1.0.0
servers:
  - description: Production Server
    url: https://api.eflow.team/v1
security: []
tags:
  - name: Advertiser Reporting
    description: Reporting endpoints available to advertiser users.
paths:
  /advertisers/reporting/entity:
    post:
      tags:
        - Advertiser Reporting
      summary: Entity Reporting
      requestBody:
        required: true
        content:
          application/json:
            example:
              from: '2024-01-01'
              to: '2024-01-31'
              timezone_id: 67
              currency_id: USD
              columns:
                - column: offer
              query:
                filters: []
            schema:
              type: object
              required:
                - from
                - to
                - timezone_id
                - currency_id
                - columns
              properties:
                from:
                  type: string
                  description: Start date for the reporting period. Format `YYYY-MM-DD`.
                to:
                  type: string
                  description: End date for the reporting period. Format `YYYY-MM-DD`.
                timezone_id:
                  type: integer
                  description: Timezone identifier for the request.
                currency_id:
                  type: string
                  description: Currency code for monetary values (e.g. "USD").
                columns:
                  type: array
                  minItems: 1
                  maxItems: 10
                  description: >
                    Columns to group/pivot data by. Minimum 1, maximum 10. Only
                    one time column (hour, date, week, month, year) is allowed
                    per request.
                  items:
                    type: object
                    required:
                      - column
                    properties:
                      column:
                        type: string
                        enum:
                          - offer
                          - affiliate
                          - creative
                          - offer_url
                          - country
                          - country_code
                          - region
                          - city
                          - dma
                          - carrier
                          - platform
                          - isp
                          - os_version
                          - device_type
                          - device_model
                          - device_make
                          - browser
                          - language
                          - sub1
                          - sub2
                          - sub3
                          - sub4
                          - sub5
                          - sub6
                          - sub7
                          - sub8
                          - sub9
                          - sub10
                          - source_id
                          - connection_type
                          - advertiser_campaign_name
                          - app_identifier
                          - bundle_id
                          - meta_platform
                          - score_rating
                          - total_rating
                          - size
                          - developer
                          - version
                          - hour
                          - date
                          - week
                          - month
                          - year
                        description: >
                          The dimension to group by. Time columns (hour, date,
                          week, month, year) are mutually exclusive — only one
                          allowed at a time.
                query:
                  type: object
                  description: >-
                    Query configuration for filtering, metric filtering, and
                    exclusions.
                  properties:
                    filters:
                      type: array
                      description: >
                        Filters to narrow results. Same resource_type filters
                        use OR logic; different resource_type filters use AND
                        logic.
                      items:
                        type: object
                        required:
                          - filter_id_value
                          - resource_type
                        properties:
                          filter_id_value:
                            type: string
                            description: >-
                              The value to filter on (e.g. offer ID, country
                              name).
                          resource_type:
                            type: string
                            enum:
                              - offer
                              - affiliate
                              - creative
                              - country
                              - country_code
                              - sub1
                              - sub2
                              - sub3
                              - sub4
                              - sub5
                              - sub6
                              - sub7
                              - sub8
                              - sub9
                              - sub10
                              - carrier
                              - device_platform
                              - device_type
                              - device_make
                              - browser
                              - language
                              - connection_type
                              - source_id
                              - offer_url
                              - device_model
                              - os_version
                              - coupon_code
                              - adv1
                              - adv2
                              - adv3
                              - adv4
                              - adv5
                              - adv6
                              - adv7
                              - adv8
                              - adv9
                              - adv10
                            description: The resource type / dimension to filter on.
                    metric_filters:
                      type: array
                      description: >-
                        Filters rows based on aggregated metric thresholds (e.g.
                        return only rows where cost > 0). Applied after
                        aggregation, before the row limit.
                      items:
                        type: object
                        properties:
                          metric_type:
                            type: string
                            enum:
                              - impression
                              - total_click
                              - unique_click
                              - cv
                              - event
                              - revenue
                              - gross_sales
                            description: >-
                              The metric to filter on. Note: an advertiser's
                              "cost" is the `revenue` metric — use `metric_type:
                              revenue` to filter on cost.
                          metric_value:
                            type: number
                            description: Threshold value.
                          operator:
                            type: string
                            enum:
                              - less_than
                              - less_than_or_equal
                              - greater_than
                              - greater_than_or_equal
                            description: Comparison operator.
                    exclusions:
                      type: array
                      description: >-
                        Exclusion filters to remove specific dimension values
                        from results.
                      items:
                        type: object
                        properties:
                          filter_id_value:
                            type: string
                            description: The value to exclude.
                          resource_type:
                            type: string
                            description: The resource type / dimension to exclude on.
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  table:
                    type: array
                    description: >-
                      Array of reporting data rows grouped by the requested
                      columns.
                    items:
                      type: object
                      properties:
                        columns:
                          type: array
                          description: Dimension values for this row.
                          items:
                            type: object
                            properties:
                              column_type:
                                type: string
                                description: >-
                                  The column/dimension type (matches the
                                  requested column value).
                              id:
                                type: string
                                description: >-
                                  Dimension value identifier (e.g. offer ID,
                                  country name).
                              label:
                                type: string
                                description: Human-readable label for the dimension value.
                        reporting:
                          $ref: '#/components/schemas/ReportingMetrics'
                  performance:
                    type: array
                    description: Time-series performance data points.
                    items:
                      type: object
                      properties:
                        unix:
                          type: integer
                          description: Unix timestamp for the time period.
                        reporting:
                          $ref: '#/components/schemas/ReportingMetrics'
                  summary:
                    $ref: '#/components/schemas/ReportingMetrics'
                    description: >-
                      Aggregated summary across all rows. A flat object with the
                      same metric keys as ReportingMetrics.
      security:
        - API Key: []
components:
  schemas:
    ReportingMetrics:
      type: object
      description: Aggregated performance metrics.
      properties:
        imp:
          type: integer
          description: Impression count.
        total_click:
          type: integer
          description: Total click count.
        unique_click:
          type: integer
          description: Unique click count.
        invalid_click:
          type: integer
          description: Invalid/filtered click count.
        cv:
          type: integer
          description: Conversion count.
        event:
          type: integer
          description: Post-conversion event count.
        cvr:
          type: number
          description: Conversion rate (percentage).
        evr:
          type: number
          description: Event rate.
        ctr:
          type: number
          description: Click-through rate (impressions to clicks).
        cost:
          type: number
          description: Total cost (advertiser spend).
        cpc:
          type: number
          description: Cost per click.
        cpm:
          type: number
          description: Cost per mille (per 1,000 impressions).
        gross_sales:
          type: number
          description: Total gross sales amount.
  securitySchemes:
    API Key:
      description: >
        The advertiser's API key generated from the Advertiser Portal. Uses the
        same X-Eflow-Api-Key header as other Everflow APIs, but the key belongs
        to the advertiser user rather than the network admin.
      in: header
      name: X-Eflow-Api-Key
      type: apiKey

````