Skip to main content
GET /v1/revenuecat/charts/:chartName/options
Returns the available configuration options for a specific chart — resolutions, segments, and filters. Use this before calling the Chart Data endpoint to discover valid parameter values.
Requires a RevenueCat secret API key (sk_xxx). This is a lightweight metadata call (1 credit).

Path Parameters

NameTypeRequiredDescription
chartNamestringYesChart identifier (see Available Charts)

Headers

NameTypeRequiredDescription
X-RC-KeystringYesYour RevenueCat secret API key (starts with sk_)
X-RC-ProjectstringNoRevenueCat project ID. Auto-detected if you have one project.

Code Examples

curl -X GET "https://api.appeeky.com/v1/revenuecat/charts/revenue/options" \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "X-RC-Key: sk_YOUR_REVENUECAT_SECRET_KEY"

Response

{
  "data": {
    "resolutions": [
      { "id": "day", "display_name": "Daily" },
      { "id": "week", "display_name": "Weekly" },
      { "id": "month", "display_name": "Monthly" },
      { "id": "quarter", "display_name": "Quarterly" },
      { "id": "year", "display_name": "Yearly" }
    ],
    "segments": [
      { "id": "app", "display_name": "App" },
      { "id": "country", "display_name": "Country" },
      { "id": "product_identifier", "display_name": "Product" },
      { "id": "store", "display_name": "Store" },
      { "id": "offering", "display_name": "Offering" }
    ],
    "filters": [
      {
        "id": "app",
        "display_name": "App",
        "values": [
          { "id": "app8845704621", "display_name": "My App (App Store)" }
        ]
      },
      {
        "id": "country",
        "display_name": "Country",
        "values": [
          { "id": "US", "display_name": "United States" },
          { "id": "GB", "display_name": "United Kingdom" }
        ]
      }
    ]
  }
}

Response Fields

Resolutions

Available time granularity options for the chart’s resolution parameter.
FieldTypeDescription
idstringResolution identifier (pass to chart)
display_namestringHuman-readable name

Segments

Available dimensions to segment chart data by. Pass the id as the segment query parameter.
FieldTypeDescription
idstringSegment identifier (pass to chart)
display_namestringHuman-readable name

Filters

Available filter dimensions and their possible values.
FieldTypeDescription
idstringFilter dimension identifier
display_namestringHuman-readable name
valuesarrayAvailable values for this filter
Each filter value:
FieldTypeDescription
idstringValue identifier (use in filter JSON)
display_namestringHuman-readable name
Use the options response to build dynamic filter UIs or validate parameters before requesting chart data. The available options vary per chart — for example, the churn chart may support different segments than the revenue chart.

Errors

StatusCodeWhen
400MISSING_RC_KEYX-RC-Key header not provided
400INVALID_CHART_NAMEChart name is not one of the valid options
401UNAUTHORIZEDInvalid RevenueCat API key
404RESOURCE_MISSINGProject not found or Charts not enabled