Directory

Distribution of the catalog

GET/data-api/v2/directory/{platform}/facets
Scope
directory:read
Freshness
catalog read
Group
Directory
Platforms
7 of 7

What this endpoint answers

How the addressable catalog splits across language, country, category and audience band. X language and country come from an exact hourly rollup; every other axis is estimated from a block sample and labelled as such.

This is a catalog read: it is served from the CRM Solid database in milliseconds, costs one budget unit, and reports how old the reading is in meta.cache_age_s. It needs the directory:read scope (Directory): Read the account and channel catalog across all seven platforms.

Good to know

  • APPROXIMATE BY DESIGN. Every axis marked method: sample is a scaled block sample, not a count. An exact count(*) group by over an 18M-row catalog reads the whole table and blows the query timeout - this is the same reason the directory filter chips are precomputed rather than counted per request.
  • Block sampling reads whole pages, so values that cluster by insertion order carry more noise than their share suggests. Treat small buckets as directional and large ones as reliable.
  • X language and country are exact: the engine writes them into xdir_facets hourly.
  • An axis that cannot be produced inside the query budget is returned as available: false with a reason, never as a slow scan or a silent zero.
  • Facets always describe the addressable scope (active, non-NSFW, handled).

Parameters

Every value the call accepts, with the example the spec ships so the request runs as written.

NameInRequiredExampleWhat it does
platformpathrequiredxWhich catalog to read.
axesqueryoptionallanguage,followersComma-separated axes to compute. Defaults to all four.

Call it

Authenticate with a bearer token or the x-api-key header. Keys are server-to-server credentials. Never embed one in front-end code - call the API from your own backend and forward the result.

curl
curl "https://crmsolid.com/data-api/v2/directory/x/facets" \
  -H "Authorization: Bearer psk_live_..."
JavaScript
const res = await fetch("https://crmsolid.com/data-api/v2/directory/x/facets", {
  headers: {
    Authorization: `Bearer ${process.env.CRM_SOLID_DATA_API_KEY}`,
  },
});

if (!res.ok) {
  const { error } = await res.json();
  throw new Error(`${error.code}: ${error.message} (${error.request_id})`);
}

const { data, meta } = await res.json();
Python
import os

import requests

res = requests.get(
    "https://crmsolid.com/data-api/v2/directory/x/facets",
    headers={"Authorization": f"Bearer {os.environ['CRM_SOLID_DATA_API_KEY']}"},
    timeout=30,
)
res.raise_for_status()

payload = res.json()
data, meta = payload["data"], payload["meta"]

Keys look like psk_live_... for production keys, psk_test_... for test keys and are minted in the panel.

What comes back

Success is { data, meta }. Failure is { error: { code, message, request_id } }. The body below is the spec's own example: the values in it are illustrative readings, not live numbers.

Platform
x
Scope
addressable
Estimated rows
18,312,640
Facets language available
yes
Facets language method
rollup
Facets language approximate
no
Facets language values
2 items
Facets followers available
yes
Facets followers method
sample
Facets followers approximate
yes
Facets followers sampled rows
8,904
Facets followers values
2 items
Facets country available
no
Facets country reason
tiktok has no 'country' in the catalog.
200 GET /directory/{platform}/facets
{
  "data": {
    "platform": "x",
    "scope": "addressable",
    "estimated_rows": 18312640,
    "facets": {
      "language": {
        "available": true,
        "method": "rollup",
        "approximate": false,
        "values": [
          {
            "value": "en",
            "count": 7402118
          },
          {
            "value": "tr",
            "count": 242483
          }
        ]
      },
      "followers": {
        "available": true,
        "method": "sample",
        "approximate": true,
        "sampled_rows": 8904,
        "values": [
          {
            "value": "0-1k",
            "count": 11204882,
            "sampled": 5449
          },
          {
            "value": "1k-10k",
            "count": 4918330,
            "sampled": 2392
          }
        ]
      },
      "country": {
        "available": false,
        "reason": "tiktok has no 'country' in the catalog."
      }
    }
  },
  "meta": {
    "request_id": "req_9f2c41a8b3d5",
    "generated_at": "2026-08-23T09:14:02.317Z",
    "took_ms": 42
  }
}

The meta block

  • request_idstringrequired

    Unique id for this request. Quote it in a support ticket.

  • generated_atstringrequired

    Server time the response was produced.

  • took_msintegerrequired

    Milliseconds spent server-side.

  • pagePageoptional
  • sourcestringoptional

    Which backend served the payload, for endpoints with more than one.

  • cache_age_sintegeroptional

    Age of the underlying data in seconds. 0 for live reads.

When it fails

GET /directory/{platform}/facets documents 8 failure statuses. Branch on error.code, which is stable and enumerated; message is prose and may change.

  • 401Unauthorizedunauthorized | invalid_key

    No key was presented, or the key is unknown, revoked or expired.

  • 402PaymentRequiredpayment_required | subscription_inactive

    The key is valid but the plan behind it cannot serve the call: the included requests are spent and overage is switched off, capped or unfunded (payment_required), or the billing period lapsed and was not renewed (subscription_inactive). Retrying does not help; paying does. The X-Plan-* headers on this response say how far past the line you are.

    Carries X-Plan, X-Plan-Limit, X-Plan-Overage, X-Plan-Period-End, X-Plan-Remaining.

  • 403Forbiddenforbidden_scope | forbidden_ip

    The key is valid but not allowed to make this call: it lacks the scope, or the request came from an address outside the key's allowlist.

  • 404NotFoundnot_found

    The addressed resource does not exist.

  • 422InvalidRequestinvalid_request

    A parameter is malformed, out of range or mutually exclusive with another. `details` names the offending fields.

  • 429RateLimitedrate_limited | quota_exceeded

    Either the burst ceiling for the current minute or the daily quota is spent. Distinguish with the code: rate_limited clears within the minute, quota_exceeded does not clear until 00:00 UTC.

    Carries Retry-After, X-Quota-Limit, X-Quota-Remaining, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset, X-Request-Id.

  • 500InternalErrorinternal_error

    Something failed on our side. Internals are never leaked; quote the request id.

  • 503Unavailableupstream_timeout | upstream_error | not_configured

    The request could not be served right now. BRANCH ON error.code, not on the status: 'upstream_timeout' means a source was too slow (this is what a catalog query hitting its 15-second statement timeout returns, so it is reachable from any endpoint that reads the corpus, not only the live-scrape ones) and the same call is worth retrying with backoff - narrowing it with a smaller limit, a filtered scope or a less popular account makes it far less likely; 'upstream_error' means a source was unreachable, so back off further; 'not_configured' means the capability has no backing service in this deployment, and retrying will never help.

Every response carries X-Request-Id and meta.request_id. Quote it in support requests.

Coverage and limits

This endpoint covers X, Instagram, TikTok, YouTube, Telegram, Bluesky, LinkedIn. Rate limits come from the tier on your key.

XInstagramTikTokYouTubeTelegramBlueskyLinkedIn
TierRequests a minuteRequests a dayLive reads a minute
free301,0005
standard12025,00020
pro600250,00060
unlimited6,00010,000,000600

This call only draws on the ordinary per-minute and per-day columns. Every response reports where you stand in X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset and the X-Plan headers.

Start calling it

A key takes a minute to mint in the panel, no card. The reference covers authentication, the envelope, scopes, rate limits and every error code in one page.

Reference path: /data-api/reference/directory-facets

We value your privacy

We use cookies to improve our site, analyze traffic, and personalize ads. You can accept all, reject non-essential, or customize your choices. Read our Cookie Policy.