The v1/realtime_metrics endpoint in the Clarisights API requires the user to send a GET request with authentication to, and returns the list of available real-time metrics grouped by channel. Please note that analytics metrics are not available for advertising channels in this endpoint, since joining is not supported for realtime API jobs.

The response would be in this format -
{"[channel]": Array<{name: "metric", query: "metric"}>}
For example -
{ "metrics": { "facebook": [ { "name": "FB: Impressions", "query": "fb_impressions" }]} 

The query values are present for all realtime metrics and are the unique identifiers of realtime metrics on Clarisights. They is used to specify the chosen metrics under the metrics field in the v1/jobs endpoint.

Please note that real-time API jobs are available only for Facebook ad channel data at present.

Did this answer your question?