Discover metadata keys present in your signals (experimental) | Paid

import { PaidClient } from "@paid-ai/paid-node";
async function main() {
    const client = new PaidClient({
        token: "YOUR_TOKEN_HERE",
    });
    await client.analyticsExperimental.getSignalsMetadata({});
}
main();

{
  "signals": [
    {
      "signalName": "user_activity",
      "paths": [
        {
          "path": "session.duration",
          "types": [
            "UInt32"
          ]
        },
        {
          "path": "page.url",
          "types": [
            "String"
          ]
        },
        {
          "path": "device.is_mobile",
          "types": [
            "Boolean"
          ]
        }
      ]
    },
    {
      "signalName": "purchase_event",
      "paths": [
        {
          "path": "order.id",
          "types": [
            "String"
          ]
        },
        {
          "path": "order.total_amount",
          "types": [
            "Float64"
          ]
        },
        {
          "path": "customer.loyalty_points",
          "types": [
            "UInt32"
          ]
        }
      ]
    }
  ],
  "meta": {
    "fromDate": "2024-05-01T00:00:00Z",
    "toDate": "2024-05-31T23:59:59Z"
  }
}

⚠️ Experimental — this endpoint may change or be removed without notice and is not subject to v2 backwards-compatibility guarantees. Do not build production-critical integrations against it yet.

Lists the JSON paths (and their observed types) present in the data payload of your signals within a time window (default: last 30 days), grouped by signal name. Use the returned paths in queries against fact_signal, e.g. WHERE data.<path>::String = '...'.

⚠️ **Experimental** — this endpoint may change or be removed without notice and is not subject to v2 backwards-compatibility guarantees. Do not build production-critical integrations against it yet. Lists the JSON paths (and their observed types) present in the `data` payload of your signals within a time window (default: last 30 days), grouped by signal name. Use the returned paths in queries against `fact_signal`, e.g. `WHERE data.<path>::String = '...'`.

Authentication

AuthorizationBearer

API Key authentication using Bearer token

Query parameters

signalNamestringOptional

Restrict discovery to a single signal name.

fromDatedatetimeOptional

Start of the discovery window. Defaults to 30 days ago.

toDatedatetimeOptional

End of the discovery window. Defaults to now.

Response

200

signalslist of objects

metaobject

Errors

400

Bad Request Error

500

Internal Server Error