analytics

Get traffic campaigns

Returns the store’s UTM-tagged traffic broken down by campaign for a named reporting period.

The payload carries the resolved period window, the tagged-traffic summary headline (distinct tagged visitors, their share of all visitors, and the number of active campaigns), the ranked per-campaign split keyed by the (campaign, source, medium) tuple with a trailing “(other)” row folding the tail, and the five per-dimension UTM rankings (sources, mediums, campaigns, contents, terms).

GET

api

analytics

traffic

campaigns

Get traffic campaigns

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

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

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

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

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>"
  },
  "summary": {
    "tagged_visitors": 123,
    "tagged_share": 123,
    "active_campaigns": 123
  },
  "campaigns": [
    {
      "name": "<string>",
      "source": "<string>",
      "medium": "<string>",
      "visitors": 123,
      "page_views": 123,
      "other": true,
      "orders": 123,
      "revenue": "<string>",
      "conversion_rate": 1
    }
  ],
  "utm": {
    "sources": [
      {
        "value": "<string>",
        "visitors": 123,
        "page_views": 123,
        "other": true
      }
    ],
    "mediums": [
      {
        "value": "<string>",
        "visitors": 123,
        "page_views": 123,
        "other": true
      }
    ],
    "campaigns": [
      {
        "value": "<string>",
        "visitors": 123,
        "page_views": 123,
        "other": true
      }
    ],
    "contents": [
      {
        "value": "<string>",
        "visitors": 123,
        "page_views": 123,
        "other": true
      }
    ],
    "terms": [
      {
        "value": "<string>",
        "visitors": 123,
        "page_views": 123,
        "other": true
      }
    ]
  },
  "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 campaigns for a period — the resolved window, the tagged-traffic summary headline, the ranked per-campaign split, and the five per-dimension UTM rankings, wrapped in the standard API response envelope.

period

object

required

Show child attributes

summary

object

required

Show child attributes

campaigns

object[]

required

Campaigns ranked by distinct visitors, keyed by the (campaign, source, medium) tuple, optionally ending in an "(other)" row folding the tail.

Show child attributes

utm

object

required

Show child attributes

status

integer

required

The HTTP status code echoed in the response envelope.

meta

object

required

Show child attributes

Get traffic campaigns

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

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

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

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

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>"
  },
  "summary": {
    "tagged_visitors": 123,
    "tagged_share": 123,
    "active_campaigns": 123
  },
  "campaigns": [
    {
      "name": "<string>",
      "source": "<string>",
      "medium": "<string>",
      "visitors": 123,
      "page_views": 123,
      "other": true,
      "orders": 123,
      "revenue": "<string>",
      "conversion_rate": 1
    }
  ],
  "utm": {
    "sources": [
      {
        "value": "<string>",
        "visitors": 123,
        "page_views": 123,
        "other": true
      }
    ],
    "mediums": [
      {
        "value": "<string>",
        "visitors": 123,
        "page_views": 123,
        "other": true
      }
    ],
    "campaigns": [
      {
        "value": "<string>",
        "visitors": 123,
        "page_views": 123,
        "other": true
      }
    ],
    "contents": [
      {
        "value": "<string>",
        "visitors": 123,
        "page_views": 123,
        "other": true
      }
    ],
    "terms": [
      {
        "value": "<string>",
        "visitors": 123,
        "page_views": 123,
        "other": true
      }
    ]
  },
  "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 campaigns

Authorizations

Query Parameters

Response