analytics

Get traffic overview

Returns the store’s traffic overview for a named reporting period.

The payload carries the resolved period window, the gross page-view headline with its period-over-period change, the distinct-visitor split into new and returning, the bot-free device mix, a gap-free daily page-view series, the content mix by resource type, and the highest-viewed individual resources — each with its own image, per-day view series, the channel that sent it the most traffic, and the orders and revenue it earned.

Two fields carry readings a client must not coerce. unique_visitors is null, rather than zero, for a window visitor state cannot answer. A resource’s top_channel is null, rather than “direct”, when no channel-stamped visit to it fell in the window.

A resource’s orders and revenue credit exactly the one resource each order’s attributing visit landed on, so they do not decompose store totals and must not be presented as doing so.

GET

api

analytics

traffic

overview

Get traffic overview

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

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

fetch('https://api.fluid.app/api/analytics/traffic/overview', 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/analytics/traffic/overview",
  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/analytics/traffic/overview"

	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/analytics/traffic/overview")

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

{
  "period": {
    "name": "<string>",
    "starts_on": "2023-12-25",
    "ends_on": "2023-12-25",
    "bucket": "<string>"
  },
  "page_views": {
    "total": 123,
    "change_pct": 123
  },
  "unique_visitors": {
    "total": 123,
    "new": 123,
    "returning": 123
  },
  "device_mix": {
    "desktop": 123,
    "mobile": 123,
    "tablet": 123,
    "unknown": 123
  },
  "series": [
    {
      "at": "2023-12-25",
      "page_views": 123
    }
  ],
  "content_mix": {
    "products": 123,
    "pages": 123,
    "posts": 123,
    "media": 123,
    "libraries": 123,
    "enrollment_packs": 123,
    "other": 123
  },
  "top_content": [
    {
      "type": "<string>",
      "id": 123,
      "title": "<string>",
      "page_views": 123,
      "image_url": "<string>",
      "series": [
        123
      ],
      "top_channel": "<string>",
      "top_channel_from": "2023-12-25",
      "orders": 123,
      "revenue": "<string>"
    }
  ],
  "status": 123,
  "meta": {
    "request_uuid": "<string>",
    "timestamp": "2023-11-07T05:31:56Z"
  }
}

{
  "message": "<string>"
}

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

Authorizations

Authorization

string

header

required

Bearer token authentication

Query Parameters

period

string

Named reporting period (default last_30_days). Supported names: today, last_7_days, last_30_days, last_90_days, last_12_months, this_month, last_month. An unsupported name returns 422.

Response

Success

Store-traffic overview for a period — the resolved window, the page-view headline with its period-over-period change, the visitor split, the bot-free device mix, the gap-free daily series, the content mix by resource type, and the highest-viewed individual resources, wrapped in the standard API response envelope.

period

object

required

Show child attributes

page_views

object

required

Show child attributes

unique_visitors

object | null

required

The distinct-visitor split over the window, or null for a window visitor state cannot answer — one that has already closed, or one reaching back before this store began capturing visitors.

Null means "not knowable" and is deliberately distinct from a zero, which means "nobody came". A client must not coerce one into the other. It carries no change_pct, unlike page_views: the numbers come from session state, which records a visitor's most recent activity and so cannot describe the previous window.

Show child attributes

device_mix

object

required

Bot-free page views by device type, always carrying all four keys, zero-filled, so a client can render a stable set of segments.

Show child attributes

series

object[]

required

Gross page views per day over the window, gap-filled so every day in the window has a point, oldest first.

Show child attributes

content_mix

object

required

Gross page views by content type, always carrying all six types plus "other", zero-filled, in a stable order. "other" is the views that resolved to no resource — a storefront root, a cart, a checkout URL.

"promotions" was a seventh key until 2026-07-31. It was removed because it was always zero: no storefront visit has ever resolved to a promotion, and the rollup behind it has never held a row.

The values sum to page_views.total with one exception: for windows predating the store rollup's backfill the per-resource rollups can over-count, and the mix then exceeds the headline. Every value is a real rollup total either way, so a client deriving shares should divide by the mix's own sum rather than by page_views.total — the two agree in the normal case, and dividing by the mix keeps a share at or below 100% in both.

Show child attributes

top_content

object[]

required

The highest-viewed individual resources over the window, ranked by gross page views across every content type and cut to a top-N.

Show child attributes

status

integer

required

The HTTP status code echoed in the response envelope.

meta

object

required

Show child attributes

Get traffic overview

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

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

fetch('https://api.fluid.app/api/analytics/traffic/overview', 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/analytics/traffic/overview",
  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/analytics/traffic/overview"

	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/analytics/traffic/overview")

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

{
  "period": {
    "name": "<string>",
    "starts_on": "2023-12-25",
    "ends_on": "2023-12-25",
    "bucket": "<string>"
  },
  "page_views": {
    "total": 123,
    "change_pct": 123
  },
  "unique_visitors": {
    "total": 123,
    "new": 123,
    "returning": 123
  },
  "device_mix": {
    "desktop": 123,
    "mobile": 123,
    "tablet": 123,
    "unknown": 123
  },
  "series": [
    {
      "at": "2023-12-25",
      "page_views": 123
    }
  ],
  "content_mix": {
    "products": 123,
    "pages": 123,
    "posts": 123,
    "media": 123,
    "libraries": 123,
    "enrollment_packs": 123,
    "other": 123
  },
  "top_content": [
    {
      "type": "<string>",
      "id": 123,
      "title": "<string>",
      "page_views": 123,
      "image_url": "<string>",
      "series": [
        123
      ],
      "top_channel": "<string>",
      "top_channel_from": "2023-12-25",
      "orders": 123,
      "revenue": "<string>"
    }
  ],
  "status": 123,
  "meta": {
    "request_uuid": "<string>",
    "timestamp": "2023-11-07T05:31:56Z"
  }
}

{
  "message": "<string>"
}

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

Overview

Task guides

Endpoints

Auth endpoints

Checkout endpoints

Public SDK endpoints

Payment gateway endpoints

Cart payment endpoints

Commerce endpoints

Webhooks endpoints

Company admin endpoints (v0)

Get traffic overview

Authorizations

Query Parameters

Response