Get Visibility Timeline

GET

sites

{siteId}

reports

timeline

Get Visibility Timeline

curl --request GET \
  --url https://api.onsomble.ai/v1/sites/{siteId}/reports/timeline \
  --header 'Authorization: Bearer <token>'

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

fetch('https://api.onsomble.ai/v1/sites/{siteId}/reports/timeline', 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.onsomble.ai/v1/sites/{siteId}/reports/timeline",
  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.onsomble.ai/v1/sites/{siteId}/reports/timeline"

	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.onsomble.ai/v1/sites/{siteId}/reports/timeline")

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

{
  "metric": "visibility",
  "groupBy": "brand",
  "brand": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "Acme"
  },
  "series": [
    {
      "key": "acme",
      "label": "Acme",
      "points": [
        {
          "date": "2026-07-31",
          "value": 62.5,
          "scanId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "completedAt": "2026-07-31T09:42:00.000Z"
        }
      ],
      "platform": {
        "id": "chatgpt_app",
        "name": "ChatGPT",
        "method": "web"
      }
    }
  ],
  "filters": {
    "platform": [
      "chatgpt_app",
      "chatgpt_api"
    ],
    "region": [
      "NZ",
      "AU"
    ],
    "startDate": "2026-07-01",
    "endDate": "2026-07-31"
  }
}

Authorizations

Authorization

string

header

required

An API key created in Settings → Account → API Keys.

Path Parameters

siteId

string

required

Query Parameters

promptId

string<uuid>[]

Repeat to limit to these prompts (promptIds).

tag

string[]

Repeat to limit to prompts with these tags.

Example:

["pricing"]

category

string[]

Repeat to limit to prompts in these categories.

Example:

["comparison"]

product

string[]

Repeat to limit to prompts about these products.

Example:

["Car Insurance"]

persona

string[]

Repeat to limit to prompts targeting these personas.

Example:

["Landlords"]

stage

string[]

Repeat to limit to prompts in these journey stages.

Example:

["Decision"]

brandMention

enum<string>

Limit to prompts that do, or do not, mention the tracked brand.

Available options:

mentions_tracked_brand,

does_not_mention_tracked_brand

platform

enum<string>[]

Repeat to select AI platforms. Omit for every platform.

Available options:

claude_api,

chatgpt_api,

gemini_api,

perplexity_sonar_pro,

chatgpt_app,

gemini_app,

google_ai_summaries_app,

google_ai_mode_app,

microsoft_copilot_app,

perplexity_app

region

string[]

Repeat to select region codes. Omit for all regions.

Example:

["NZ:auckland"]

brand

string<uuid>[]

Repeat to limit which brands are returned (brand identity ids). Does not change Share of Voice denominators.

competitorId

string<uuid>[]

Repeat to limit to these tracked competitors (competitorId from the competitors catalogue). Combines with brand. A discovered competitor is refused until it is tracked.

startDate

string

Inclusive lower bound, as a UTC calendar day (YYYY-MM-DD). Omit for none.

Example:

"2026-07-01"

endDate

string

Inclusive upper bound, as a UTC calendar day (YYYY-MM-DD). Omit for none.

Example:

"2026-07-31"

metric

enum<string>

default:visibility

Which metric the series values carry.

Available options:

visibility,

shareOfVoice,

sentiment,

gap

groupBy

enum<string>

default:brand

brand compares every brand measured. platform and region instead track one brand across that dimension - see brandId.

Available options:

brand,

platform,

region

brandId

string<uuid>

Which brand the platform and region series describe. Defaults to the tracked brand. Ignored when groupBy is brand, which compares every brand.

Response

metric

enum<string>

required

Available options:

visibility,

shareOfVoice,

sentiment,

gap

Example:

"visibility"

groupBy

enum<string>

required

Available options:

brand,

platform,

region

Example:

"brand"

brand

object | null

required

The Site's tracked brand, or the one named by brandId. Under groupBy platform or region this is the brand every series describes; under brand it identifies the tracked brand among them. Null when the Site has no brand yet.

Show child attributes

series

object[]

required

Show child attributes

filters

object

required

Show child attributes

Get Visibility Timeline

curl --request GET \
  --url https://api.onsomble.ai/v1/sites/{siteId}/reports/timeline \
  --header 'Authorization: Bearer <token>'

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

fetch('https://api.onsomble.ai/v1/sites/{siteId}/reports/timeline', 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.onsomble.ai/v1/sites/{siteId}/reports/timeline",
  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.onsomble.ai/v1/sites/{siteId}/reports/timeline"

	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.onsomble.ai/v1/sites/{siteId}/reports/timeline")

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

{
  "metric": "visibility",
  "groupBy": "brand",
  "brand": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "Acme"
  },
  "series": [
    {
      "key": "acme",
      "label": "Acme",
      "points": [
        {
          "date": "2026-07-31",
          "value": 62.5,
          "scanId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "completedAt": "2026-07-31T09:42:00.000Z"
        }
      ],
      "platform": {
        "id": "chatgpt_app",
        "name": "ChatGPT",
        "method": "web"
      }
    }
  ],
  "filters": {
    "platform": [
      "chatgpt_app",
      "chatgpt_api"
    ],
    "region": [
      "NZ",
      "AU"
    ],
    "startDate": "2026-07-01",
    "endDate": "2026-07-31"
  }
}

Getting started

Sites

Prompts

Scans

Understanding results

For agencies

Connect AI assistants

Assistant

Account & billing

Concepts & reference

Onsomble API

Changelog

Get Visibility Timeline

Authorizations

Path Parameters

Query Parameters

Response