Account analytics summary (with optional point-in-time as-of review)

curl --request GET \
  --url https://api.arcuserp.com/v1/accounts/{id}/analytics/summary \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.arcuserp.com/v1/accounts/{id}/analytics/summary"

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

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

print(response.text)

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

fetch('https://api.arcuserp.com/v1/accounts/{id}/analytics/summary', 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.arcuserp.com/v1/accounts/{id}/analytics/summary",
  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.arcuserp.com/v1/accounts/{id}/analytics/summary"

	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.arcuserp.com/v1/accounts/{id}/analytics/summary")

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

{
  "data": {
    "ttm_revenue": 123,
    "avg_order_value": 123,
    "rfm_recency": 123,
    "rfm_frequency": 123,
    "rfm_monetary": 123,
    "rfm_score": "<string>",
    "rfm_segment": "<string>",
    "account_health_score": 123,
    "account_health_band": "<string>",
    "account_health_trend": "<string>",
    "revenue_trend_pct": 123,
    "days_since_last_order": 123,
    "as_of": "2023-12-25",
    "is_review": true
  }
}

{
  "error": "not_found",
  "code": "not_found",
  "type": "not_found",
  "hint": "The requested order does not exist or does not belong to this entity.",
  "param": "expand[0]",
  "required": "accounts:read",
  "request_id": "req_abc123"
}

{
  "error": "not_found",
  "code": "not_found",
  "type": "not_found",
  "hint": "The requested order does not exist or does not belong to this entity.",
  "param": "expand[0]",
  "required": "accounts:read",
  "request_id": "req_abc123"
}

{
  "error": "not_found",
  "code": "not_found",
  "type": "not_found",
  "hint": "The requested order does not exist or does not belong to this entity.",
  "param": "expand[0]",
  "required": "accounts:read",
  "request_id": "req_abc123"
}

{
  "error": "not_found",
  "code": "not_found",
  "type": "not_found",
  "hint": "The requested order does not exist or does not belong to this entity.",
  "param": "expand[0]",
  "required": "accounts:read",
  "request_id": "req_abc123"
}

Accounts

Account analytics summary (with optional point-in-time as-of review)

Returns the account’s buying-analytics summary: RFM (recency / frequency / monetary + segment), account health score + band + trend, TTM revenue, average order value, and the revenue trend percentage.

Default (no as_of): the stored denormalized analytics columns (refreshed nightly

incrementally on order events).

Point-in-time review (?as_of=YYYY-MM-DD): re-anchors the trailing windows (recency, the 12-month TTM, and the 3-month revenue/frequency trend) to the supplied historical date and recomputes RFM / health / TTM / revenue-trend IN MEMORY. This is a READ-ONLY review — it NEVER persists, never updates the account, never emits events. Useful for migrated accounts whose latest order predates today, so you can see each customer’s standing “as of” the data’s latest point instead of an arbitrary later wall-clock now. Industry precedent: NetSuite SuiteAnalytics “As-Of Date”, Salesforce/HubSpot snapshot-date reports, QuickBooks/Xero “as of date”.

The review response is the same shape as the default plus as_of (the echoed date) and is_review: true.

GET

accounts

{id}

analytics

summary

Account analytics summary (with optional point-in-time as-of review)

curl --request GET \
  --url https://api.arcuserp.com/v1/accounts/{id}/analytics/summary \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.arcuserp.com/v1/accounts/{id}/analytics/summary"

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

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

print(response.text)

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

fetch('https://api.arcuserp.com/v1/accounts/{id}/analytics/summary', 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.arcuserp.com/v1/accounts/{id}/analytics/summary",
  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.arcuserp.com/v1/accounts/{id}/analytics/summary"

	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.arcuserp.com/v1/accounts/{id}/analytics/summary")

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

{
  "data": {
    "ttm_revenue": 123,
    "avg_order_value": 123,
    "rfm_recency": 123,
    "rfm_frequency": 123,
    "rfm_monetary": 123,
    "rfm_score": "<string>",
    "rfm_segment": "<string>",
    "account_health_score": 123,
    "account_health_band": "<string>",
    "account_health_trend": "<string>",
    "revenue_trend_pct": 123,
    "days_since_last_order": 123,
    "as_of": "2023-12-25",
    "is_review": true
  }
}

{
  "error": "not_found",
  "code": "not_found",
  "type": "not_found",
  "hint": "The requested order does not exist or does not belong to this entity.",
  "param": "expand[0]",
  "required": "accounts:read",
  "request_id": "req_abc123"
}

{
  "error": "not_found",
  "code": "not_found",
  "type": "not_found",
  "hint": "The requested order does not exist or does not belong to this entity.",
  "param": "expand[0]",
  "required": "accounts:read",
  "request_id": "req_abc123"
}

{
  "error": "not_found",
  "code": "not_found",
  "type": "not_found",
  "hint": "The requested order does not exist or does not belong to this entity.",
  "param": "expand[0]",
  "required": "accounts:read",
  "request_id": "req_abc123"
}

{
  "error": "not_found",
  "code": "not_found",
  "type": "not_found",
  "hint": "The requested order does not exist or does not belong to this entity.",
  "param": "expand[0]",
  "required": "accounts:read",
  "request_id": "req_abc123"
}

Authorizations

Authorization

string

header

required

API key issued per entity via Settings > Developers > API Keys. Each key carries scopes (e.g. orders:read, products:write). Bearer token format: Authorization: Bearer ark_live_ent_Test keys use ark_test_ent_. Both are issued per entity via Settings > Developers > API Keys.

Path Parameters

string

required

Account UUID or account_number slug.

Query Parameters

as_of

string<date>

Optional point-in-time review anchor (YYYY-MM-DD). Must be a real calendar date and <= today. A malformed or future date returns 400 invalid_as_of_date.

Response

Account analytics summary (review path adds as_of + is_review).

data

object

Show child attributes

Overview

All Endpoints

Account analytics summary (with optional point-in-time as-of review)

Authorizations

Path Parameters

Query Parameters

Response