API reference / Custom Metrics

Submit Custom Metric Values

MD View as MarkdownPlain text version of this page

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

POST /api/custom-metrics

Token needs the create ability. About tokens

Upserts daily custom-metric values for one or more locations, keyed by the location's external_id. Locations not found for the tenant are skipped (logged, not errored). Requires the create ability.

Request body application/json

metric string required

A custom metric key, e.g. custom:loyalty_signups. Must be a custom key available to the tenant.
businessDateOn string (date) required
locationValues array of object required
- locationId integer required
  
  The location's external_id.
- value number required

Responses

- message string
- message string
- message string
- errors object

curl -X POST "https://app.franchisesee.com/api/custom-metrics" \
  -H "Authorization: Bearer $FRANCHISESEE_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "metric": "custom:loyalty_signups",
    "businessDateOn": "2026-06-01",
    "locationValues": [
        {
            "locationId": 1024,
            "value": 37
        },
        {
            "locationId": 1025,
            "value": 12
        }
    ]
}'

use Illuminate\Support\Facades\Http;

$response = Http::withToken(env('FRANCHISESEE_TOKEN'))
    ->acceptJson()
    ->post('https://app.franchisesee.com/api/custom-metrics', [
        'metric' => 'custom:loyalty_signups',
        'businessDateOn' => '2026-06-01',
        'locationValues' => [
            [
                'locationId' => 1024,
                'value' => 37,
            ],
            [
                'locationId' => 1025,
                'value' => 12,
            ],
        ],
    ]);

const response = await fetch('https://app.franchisesee.com/api/custom-metrics', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.FRANCHISESEE_TOKEN}`,
    Accept: 'application/json',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
        "metric": "custom:loyalty_signups",
        "businessDateOn": "2026-06-01",
        "locationValues": [
            {
                "locationId": 1024,
                "value": 37
            },
            {
                "locationId": 1025,
                "value": 12
            }
        ]
    }),
});

const data = await response.json();

import os
import requests

response = requests.request(
    "POST",
    "https://app.franchisesee.com/api/custom-metrics",
    headers={"Authorization": f"Bearer {os.environ['FRANCHISESEE_TOKEN']}", "Accept": "application/json"},
    json={
        "metric": "custom:loyalty_signups",
        "businessDateOn": "2026-06-01",
        "locationValues": [
            {
                "locationId": 1024,
                "value": 37,
            },
            {
                "locationId": 1025,
                "value": 12,
            },
        ],
    },
)

data = response.json()

Response

{
    "message": "Unauthenticated."
}

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

{
    "message": "The name field is required.",
    "errors": {
        "name": [
            "The name field is required."
        ]
    }
}