API reference / Metrics & Leaderboards

Get Sources

MD View as MarkdownPlain text version of this page

Open in ClaudeAsk questions about this page Open in ChatGPTAsk questions about this page

GET /api/v1/data/sources

Token needs the read ability. About tokens

Retrieves the source reference-data options. When metric is supplied, the result is narrowed to the sources valid for that metric. Requires the read ability.

Query parameters

metric string

Optional metric key to scope the returned sources.

Responses

- data array of ReferenceData required
  - value string required
  - label string required
- message string
- message string

curl "https://app.franchisesee.com/api/v1/data/sources" \
  -H "Authorization: Bearer $FRANCHISESEE_TOKEN" \
  -H "Accept: application/json"

use Illuminate\Support\Facades\Http;

$response = Http::withToken(env('FRANCHISESEE_TOKEN'))
    ->acceptJson()
    ->get('https://app.franchisesee.com/api/v1/data/sources');

const response = await fetch('https://app.franchisesee.com/api/v1/data/sources', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.FRANCHISESEE_TOKEN}`,
    Accept: 'application/json',
  },
});

const data = await response.json();

import os
import requests

response = requests.request(
    "GET",
    "https://app.franchisesee.com/api/v1/data/sources",
    headers={"Authorization": f"Bearer {os.environ['FRANCHISESEE_TOKEN']}", "Accept": "application/json"},
)

data = response.json()

Response

{
    "data": [
        {
            "value": "net_sales_amount",
            "label": "Net sales"
        }
    ]
}

{
    "message": "Unauthenticated."
}

{
    "message": "This API token does not have the 'create' ability."
}