Capabilities

Publishable keys never see secret-only families or secret-only endpoints. Families light up as the matching data exists in your account. For example, dealers appear once your account has wholesale sales, and locations and store performance appear for accounts with a retail channel.

GET /cx/v1/capabilities

curl https://api.plunk.io/cx/v1/capabilities \
  -H "Authorization: Bearer pk_live_••••"

{
  "tenant": "youraccount",
  "tenantType": "retailer",
  "mode": "live",
  "aggregationFloor": 5,
  "labels": {
    "location": "Showroom"
  },
  "families": [
    {
      "name": "products",
      "key": "publishable",
      "scopes": ["products:read", "recommendations:read"],
      "label": null,
      "endpoints": [
        "GET /cx/v1/products/top/{range}",
        "GET /cx/v1/products/{id}",
        "GET /cx/v1/products/search",
        "GET /cx/v1/products/trending",
        "GET /cx/v1/recommendations",
        "GET /cx/v1/recommendations/model"
      ]
    },
    {
      "name": "store-performance",
      "key": "secret",
      "scopes": ["store-performance:read"],
      "label": "Showroom",
      "endpoints": [
        "GET /cx/v1/stores/{range}",
        "GET /cx/v1/stores/{range}/{storeId}"
      ]
    }
  ]
}

Fields

Field	What it means
`tenant`	Your account’s identifier.
`tenantType`	`manufacturer`, `retailer` or `vertical`. Retailers see locations and store performance. Manufacturers see dealers and dealer performance. A vertical account (a manufacturer that also sells direct) sees both.
`mode`	`live` or `test`, from the key you presented.
`aggregationFloor`	The minimum order count for a row to appear on publishable reads (5).
`labels`	The terms your account uses on screen, such as “Showroom” for locations, when configured. Paths never change; only display terms do.
`families[]`	Each family your key can reach: its `name`, the minimum key class (`key`), its `scopes`, its display `label` and its concrete `endpoints`.

Families

Family	Key	Page
`ingest`, `inventory-ingest`	Publishable (events), secret (sales, order status, inventory)	Ingest
`products`	Publishable	Products and recommendations
`reviews`	Publishable	Reviews
`locations`	Publishable	Locations
`markets`	Publishable	Markets
`catalog`	Secret	Catalog and availability
`visitor`	Secret	Visitor
`dealers`, `dealer-performance`	Secret	Dealers
`store-performance`	Secret	Store performance
`audience-performance`	Secret	Audience performance
`customer-sales`	Secret	Customer sales
`contact-interest`	Secret	Contact interest
`forecasting`	Secret	Forecasting
`enrich`	Secret	Enrich
`comcol`	Secret	COM/COL requests
`images`	Secret	Images

Was this helpful?

Still stuck? Contact support and include the job or page you were on.