analytics

Get traffic sources

Returns the store’s traffic broken down by acquisition source for a named reporting period.

The payload carries the resolved period window, the per-channel split across all seven canonical channels (reps, email, paid, social, organic, referral, direct) with each channel’s gross page views, distinct visitors, visitor share, and period-over-period page-view change, the ranked top referring sites (with a trailing “(other)” row folding the tail), and the total distinct visitors over the window.

A referring site is ranked once even when it reaches the store under several hostnames: each row carries the site’s name alongside one real host observed under it.

GET

api

analytics

traffic

sources

Get traffic sources

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

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

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

	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/sources")

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>"
  },
  "channels": [
    {
      "key": "<string>",
      "page_views": 123,
      "visitors": 123,
      "share": 123,
      "change_pct": 123,
      "orders": 123,
      "revenue": "<string>",
      "conversion_rate": 1
    }
  ],
  "referrers": [
    {
      "host": "<string>",
      "name": "<string>",
      "visitors": 123,
      "page_views": 123,
      "orders": 123,
      "revenue": "<string>",
      "conversion_rate": 1
    }
  ],
  "total_visitors": 123,
  "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 sources for a period — the resolved window, the per-channel split across the seven canonical channels, and the ranked top referring sites, wrapped in the standard API response envelope.

period

object

required

Show child attributes

channels

object[]

required

The seven canonical acquisition channels in fixed order.

Required array length: 7 elements

Show child attributes

referrers

object[]

required

Referring sites ranked by distinct visitors, optionally ending in an "(other)" row folding the tail. A site that reaches the store under several hostnames (facebook.com, m.facebook.com, l.facebook.com) is one row, not one row per hostname.

Show child attributes

total_visitors

integer

required

Total distinct bot-free visitors over the window.

status

integer

required

The HTTP status code echoed in the response envelope.

meta

object

required

Show child attributes

Get traffic sources

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

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

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

	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/sources")

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>"
  },
  "channels": [
    {
      "key": "<string>",
      "page_views": 123,
      "visitors": 123,
      "share": 123,
      "change_pct": 123,
      "orders": 123,
      "revenue": "<string>",
      "conversion_rate": 1
    }
  ],
  "referrers": [
    {
      "host": "<string>",
      "name": "<string>",
      "visitors": 123,
      "page_views": 123,
      "orders": 123,
      "revenue": "<string>",
      "conversion_rate": 1
    }
  ],
  "total_visitors": 123,
  "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

Portal & Widgets

Endpoints

Auth endpoints

Checkout endpoints

Public SDK endpoints

Member endpoints

Payment gateway endpoints

Cart payment endpoints

Commerce endpoints

Webhooks endpoints

Company admin endpoints (v0)

Analytics

Get traffic sources

Authorizations

Query Parameters

Response