PRprivy
Reports

List display performance

Changed on

Rank your displays by performance over a period — signups by default, or any of the documented sort keys. Displays whose value for the chosen sort key is zero are left out entirely, and ranking stops at 50 displays, which also caps the reported total_count. Use /v1/reports/displays/{display_id} for one display's full stat set, including average order value and A/B test results.

Required scope: reports_read

get/reports/displays

Request

  • Base URL
    https://api.privy.com/v1
  • Auth
    HTTP bearer

Query parameters

period'last_7_days' | 'last_30_days' | 'last_90_days' | 'this_month' | 'last_month' | 'custom'

The date range to report over, resolved in the account's time zone. Pass custom together with start_date and end_date.

start_datestring date

Inclusive start of a custom period (ISO 8601 date). Required when period=custom, ignored otherwise.

end_datestring date

Inclusive end of a custom period (ISO 8601 date). Required when period=custom, ignored otherwise. Custom periods are capped at 366 days.

sort'signups' | 'signup_rate' | 'views' | 'revenue' | 'orders'

The metric to rank displays by, best first.

pageinteger

Page number (starts at 1).

per_pageinteger

Number of results per page. Values outside 10–100 are clamped to the nearest bound.

Headers

Privy-Account-Idstring

Target a subaccount instead of the main connected account. Pass a subaccount id from get_account's subaccounts list. Only direct subaccounts of the connected account are reachable — omit this for the main account itself.

Response

Displays ranked by the requested sort, with the resolved period.

Example response

{
  "data": [
    {
      "display_id": "gk2P8Zw1Lq",
      "title": "Summer Sale Popup",
      "display_type": "popup",
      "status": "live",
      "published_date": "2026-06-01",
      "stats": {
        "views": {
          "value": 42,
          "unit": "count"
        },
        "signups": {
          "value": 42,
          "unit": "count"
        },
        "signup_rate": {
          "value": 42,
          "unit": "count"
        },
        "attributed_orders": {
          "value": 42,
          "unit": "count"
        },
        "attributed_revenue": {
          "value": 42,
          "unit": "count"
        }
      }
    }
  ],
  "period": {
    "label": "last_30_days",
    "start_date": "2026-06-21",
    "end_date": "2026-07-20"
  },
  "pagination": {
    "page": 1,
    "per_page": 25,
    "total_count": 142,
    "total_pages": 6
  }
}

Changes

  • cf0885e90d5aRevision changes
    • warning

      added the new forbidden enum value to the / response property for the response status

    • warning

      added the new forbidden enum value to the / response property for the response status

    • warning

      added the new forbidden enum value to the / response property for the response status

    • warning

      added the new forbidden enum value to the / response property for the response status

    • warning

      added the new segment_builder_required enum value to the / response property for the response status

    • warning

      added the new segment_builder_required enum value to the / response property for the response status

    • warning

      added the new segment_builder_required enum value to the / response property for the response status

    • warning

      added the new segment_builder_required enum value to the / response property for the response status

  • fe500ab59b3bRevision changes
    • info

      endpoint added