API reference / Metrics & Leaderboards

Get Periods

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/periods

Token needs the read ability. About tokens

Retrieves the period reference-data options (excludes custom). Requires the read ability.

Responses

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

curl "https://app.franchisesee.com/api/v1/data/periods" \
  -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/periods');

const response = await fetch('https://app.franchisesee.com/api/v1/data/periods', {
  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/periods",
    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."
}