analytics

Search traffic campaign placements

Searches real campaign placements by campaign name for a named reporting period. Matching is case-insensitive and treats pattern characters as literal text. Rows are ranked by distinct visitors, then campaign, source, and medium. The bounded response never contains a synthetic “(other)” row; truncated tells the client to request a narrower query. Results are served only for companies cut over to campaign serving facts. Companies not yet cut over receive a normal 200 response with an empty rows array and truncated set to false.

GET

api

analytics

traffic

campaign-placements

Search traffic campaign placements

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

import requests

url = "https://api.fluid.app/api/analytics/traffic/campaign-placements"

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

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

print(response.text)

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

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

	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/campaign-placements")

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": "day"
  },
  "rows": [
    {
      "name": "<string>",
      "source": "<string>",
      "medium": "<string>",
      "visitors": 1,
      "page_views": 1,
      "orders": 1,
      "revenue": "<string>",
      "conversion_rate": 1
    }
  ],
  "truncated": true,
  "status": 200,
  "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"
  }
}

{
  "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.

string

required

Literal campaign-name fragment, matched case-insensitively.

Required string length: 2 - 100

Response

Bounded campaign placement search results

Bounded real campaign placements matching one literal name query.

period

object

required

Resolved UTC reporting window shared by traffic reads.

Show child attributes

rows

object[]

required

Real campaign placements ranked by distinct visitors with deterministic tuple tie-breaks.

Maximum array length: 25

Show child attributes

truncated

boolean

required

True when more real placements matched than this bounded response returned.

status

enum<integer>

required

Available options:

200

meta

object

required

Standard metadata emitted by Api::Response.

Show child attributes

Search traffic campaign placements

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

import requests

url = "https://api.fluid.app/api/analytics/traffic/campaign-placements"

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

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

print(response.text)

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

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

	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/campaign-placements")

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": "day"
  },
  "rows": [
    {
      "name": "<string>",
      "source": "<string>",
      "medium": "<string>",
      "visitors": 1,
      "page_views": 1,
      "orders": 1,
      "revenue": "<string>",
      "conversion_rate": 1
    }
  ],
  "truncated": true,
  "status": 200,
  "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"
  }
}

{
  "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

Search traffic campaign placements

Authorizations

Query Parameters

Response