analytics_dashboard_home_field

Home > Field momentum header (Phase 003 Card 1)

Returns the three tiles above the Field tab’s 14-day rep- activity chart: reps active on the store-local calendar yesterday (with a same-weekday 12-week median for the sub-label), reps active month-to-date, and the sum of attribution-scoped revenue MTD in the company default currency. typical_for_weekday is null when the tenant has fewer than four same-weekday dates on record — the FE drops the sub-label in that case.

When country is set: the two order-side aggregates (rep_revenue_mtd, rep_revenue_share_pct) filter on orders.country_id. The active-rep tiles (active_yesterday, active_this_month) and typical_for_weekday remain aggregate — share.visited events do not carry a reliable country signal today (see BE service TomDoc for the analytics_events.country_code coverage gap). Consumers should present the active-rep counts as company-wide even under a country pick until ingest populates the column.

GET

api

v202604

analytics

dashboard

field_momentum

Home > Field momentum header (Phase 003 Card 1)

curl --request GET \
  --url https://api.fluid.app/api/v202604/analytics/dashboard/field_momentum \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.fluid.app/api/v202604/analytics/dashboard/field_momentum"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.fluid.app/api/v202604/analytics/dashboard/field_momentum', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.fluid.app/api/v202604/analytics/dashboard/field_momentum",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.fluid.app/api/v202604/analytics/dashboard/field_momentum"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.fluid.app/api/v202604/analytics/dashboard/field_momentum")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "active_yesterday": 1,
  "typical_for_weekday": 1,
  "weekday": "Thursday",
  "active_this_month": 1,
  "rep_revenue_mtd": "12345.67",
  "rep_revenue_share_pct": "24.3",
  "currency": "USD",
  "meta": {
    "timestamp": "2023-11-07T05:31:56Z",
    "request_id": "<string>"
  }
}

{
  "error": {
    "message": "<string>",
    "details": {}
  },
  "meta": {
    "timestamp": "2023-11-07T05:31:56Z",
    "request_id": "<string>"
  }
}

{
  "message": "<string>"
}

{
  "message": "<string>",
  "error": "<string>"
}

{
  "error": {
    "message": "<string>",
    "details": {}
  },
  "meta": {
    "timestamp": "2023-11-07T05:31:56Z",
    "request_id": "<string>"
  }
}

{
  "error": {
    "message": "<string>",
    "details": {}
  },
  "meta": {
    "timestamp": "2023-11-07T05:31:56Z",
    "request_id": "<string>"
  }
}

Authorizations

Authorization

string

header

required

Bearer token authentication. Requires a company-admin token whose role holds reports.view. Additionally, the caller's company must have ANALYTICS_DASHBOARD enabled — otherwise every endpoint returns 404.

Query Parameters

country

string

ISO alpha-2 code of one of the requesting company's configured countries (see GET /countries). When present, every service on this endpoint filters its data to that country and reports money in the country's own currency. Omit (or send "all") for the aggregate-across-countries view, which is the default and matches pre-Phase-004 behavior. Unknown ISO codes or ones the company is not configured for return 400.

Example:

"US"

Response

Field momentum header payload

Home > Field momentum header (Phase 003 Card 1). Three tiles that sit above the 14-day rep-activity chart. active_yesterday counts distinct reps active on the store-local calendar yesterday, where "active" means either a share.visited event keyed to the rep via analytics_events.member_id OR a paid order with orders.attribution_member_id = rep.id. typical_for_weekday is the median across the twelve trailing same-weekday dates, or null when fewer than four of those dates carried any activity. active_this_month and rep_revenue_mtd cover the current calendar month.

active_yesterday

integer

required

Required range: x >= 0

typical_for_weekday

integer | null

required

Same-weekday 12-week median; null when history is too thin.

Required range: x >= 0

weekday

string

required

Day-name of yesterday in the store timezone (e.g. "Friday").

Example:

"Thursday"

active_this_month

integer

required

Required range: x >= 0

rep_revenue_mtd

string

required

Decimal string of attribution-scoped revenue in the company default currency.

Example:

"12345.67"

rep_revenue_mtd / total_company_revenue_mtd × 100, rounded to one decimal, as a decimal string. Null when total company revenue MTD is zero — the FE hides the sub-label in that case rather than rendering 0% of $0.

Example:

"24.3"

currency

string

required

ISO currency code (e.g. "USD").

Example:

"USD"

meta

object

Show child attributes

Home > Field momentum header (Phase 003 Card 1)

curl --request GET \
  --url https://api.fluid.app/api/v202604/analytics/dashboard/field_momentum \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.fluid.app/api/v202604/analytics/dashboard/field_momentum"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.fluid.app/api/v202604/analytics/dashboard/field_momentum', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.fluid.app/api/v202604/analytics/dashboard/field_momentum",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.fluid.app/api/v202604/analytics/dashboard/field_momentum"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.fluid.app/api/v202604/analytics/dashboard/field_momentum")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "active_yesterday": 1,
  "typical_for_weekday": 1,
  "weekday": "Thursday",
  "active_this_month": 1,
  "rep_revenue_mtd": "12345.67",
  "rep_revenue_share_pct": "24.3",
  "currency": "USD",
  "meta": {
    "timestamp": "2023-11-07T05:31:56Z",
    "request_id": "<string>"
  }
}

{
  "error": {
    "message": "<string>",
    "details": {}
  },
  "meta": {
    "timestamp": "2023-11-07T05:31:56Z",
    "request_id": "<string>"
  }
}

{
  "message": "<string>"
}

{
  "message": "<string>",
  "error": "<string>"
}

{
  "error": {
    "message": "<string>",
    "details": {}
  },
  "meta": {
    "timestamp": "2023-11-07T05:31:56Z",
    "request_id": "<string>"
  }
}

{
  "error": {
    "message": "<string>",
    "details": {}
  },
  "meta": {
    "timestamp": "2023-11-07T05:31:56Z",
    "request_id": "<string>"
  }
}

Overview

Task guides

Portal & Widgets

Endpoints

Auth endpoints

Checkout endpoints

Public SDK endpoints

Payment gateway endpoints

Cart payment endpoints

Commerce endpoints

Webhooks endpoints

Company admin endpoints (v0)

Analytics

Home > Field momentum header (Phase 003 Card 1)

Authorizations

Query Parameters

Response