analytics

Get traffic by rep

Returns the traffic a store’s field of reps drove for a named reporting period — the leaderboard behind the Reps tab and the two traffic tiles above it.

A visit is credited to a rep by identity rather than by channel: it carries the rep’s attribution_member_id, or a share_id whose share belongs to them, or both. Where both are present and disagree, the stamped member wins. Identity has been recorded since long before the channel column existed, so this reaches back further than the channel-keyed figures on the Sources tab, and the two will not agree over a long window.

visitor_share and the ranked rows come from that one filter, so the tile and the leaderboard beneath it cannot disagree. Its denominator is every visitor the store saw over the requested window and is deliberately not narrowed to the first rep-driven visit: months before the field drove anything held no rep traffic, and dilution is the answer rather than a distortion.

Rows are ranked by distinct visitors descending, ties broken on the rep’s name, and cut to a top N. Because one visitor can be sent by two reps, the rows’ visitors need not sum to total_visitors and must not be rendered as a share of a whole. Reps the merchant hid from leaderboards are omitted from the rows while their traffic still counts toward active_reps and visitor_share, and a rep whose member record has since been deleted still ranks and is still named.

Each row also names the resource that drew the most of that rep’s traffic, or null when none did. That column is read from the per-resource rollups rather than from the events, so it answers only for traffic that landed on a tracked resource — about half of rep traffic, and a different half per store. A null there is a rep whose traffic never touched one, not a gap in their numbers.

unattributed is not a rep. It folds the rep-classified traffic that names nobody — an admin-owned share has no member — so the rows plus the remainder reconcile with visitor_share. It carries no member_id and no name, and is served beside the rows rather than among them.

GET

api

analytics

traffic

reps

Get traffic by rep

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

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

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

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

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>"
  },
  "active_reps": {
    "current": 123,
    "previous": 123,
    "change_pct": 123
  },
  "visitor_share": 0.5,
  "total_visitors": 123,
  "reps": [
    {
      "member_id": "<string>",
      "name": "<string>",
      "visitors": 123,
      "visits": 123,
      "series": [
        123
      ],
      "top_asset": {
        "title": "<string>",
        "thumbnail_url": "<string>"
      }
    }
  ],
  "unattributed": {
    "visitors": 123,
    "visits": 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

The traffic a store's field of reps drove over a period — the resolved window, how many reps were active, the field's share of every visitor, the ranked leaderboard, and the remainder that names nobody, wrapped in the standard API response envelope.

period

object

required

Show child attributes

active_reps

object

required

How many reps drove traffic, with the comparison every other headline figure carries.

Show child attributes

Distinct visitors who arrived on a rep-carrying visit over every distinct visitor in the window, rounded to four decimals, and 0 when the store saw none. Computed from the same identity filter as the rows, and its denominator is not narrowed to the first rep-driven visit.

Required range: 0 <= x <= 1

total_visitors

integer

required

Total distinct bot-free visitors over the window — the denominator visitor_share is taken against.

reps

object[]

required

Reps ranked by distinct visitors descending, ties broken on name, cut to a top N. Reps hidden from leaderboards are absent.

Show child attributes

unattributed

object

required

The rep-classified traffic that names nobody, folded into one remainder — chiefly visits arriving through an admin-owned share, which carries no member. It is not a rep row, and carries neither a member_id nor a name.

Show child attributes

status

integer

required

The HTTP status code echoed in the response envelope.

meta

object

required

Show child attributes

Get traffic by rep

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

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

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

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

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>"
  },
  "active_reps": {
    "current": 123,
    "previous": 123,
    "change_pct": 123
  },
  "visitor_share": 0.5,
  "total_visitors": 123,
  "reps": [
    {
      "member_id": "<string>",
      "name": "<string>",
      "visitors": 123,
      "visits": 123,
      "series": [
        123
      ],
      "top_asset": {
        "title": "<string>",
        "thumbnail_url": "<string>"
      }
    }
  ],
  "unattributed": {
    "visitors": 123,
    "visits": 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

Endpoints

Auth endpoints

Checkout endpoints

Public SDK endpoints

Payment gateway endpoints

Cart payment endpoints

Commerce endpoints

Webhooks endpoints

Company admin endpoints (v0)

Get traffic by rep

Authorizations

Query Parameters

Response