Skip to content
Artbucket

A brand's signals

GET
/api/v1/brands/{slug}/insights
curl --request GET \
  --url http://localhost:3000/api/v1/brands/example/insights \
  --header 'Authorization: Bearer <token>'

Over the last 30 days: reads of its BrandHub files (brand.json, llms.txt, tokens), and views of its pages on portals. Fetches and checks name a file, so the brand’s are the files its rules held in its recent releases: from them, this week’s answers and refusals, and release adoption, the fetches since the latest release on it or on an older one.

Scope: write.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
slug
required
string

Brand slug

Responses

Section titled “Responses”

200

Section titled “200”

The signals

Media typeapplication/json
object
data
required
object
days
required

How far back it counts

integer
>= -9007199254740991 <= 9007199254740991
pulls
required

Reads of its BrandHub files: brand.json, llms.txt, tokens

integer
>= -9007199254740991 <= 9007199254740991
views
required

Portal page views of its pages

integer
>= -9007199254740991 <= 9007199254740991
week
required

The last week. Its files are the ones its rules held in its recent releases

object
days
required
integer
>= -9007199254740991 <= 9007199254740991
answers
required

Its files served, uses of them checked, and its BrandHub files read

integer
>= -9007199254740991 <= 9007199254740991
agents
required

Of those, asked by agents

integer
>= -9007199254740991 <= 9007199254740991
refused
required

Uses of its files refused

integer
>= -9007199254740991 <= 9007199254740991
adoption
required
Any of:
object
release
required

The latest release

object
number
required
integer
>= -9007199254740991 <= 9007199254740991
publishedAt
required
string format: date-time
/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$/
days
required

Fetches of its files a day each since the release (30 days at most), on it or on an older release

Array<object>
object
day
required
string
current
required
integer
>= -9007199254740991 <= 9007199254740991
older
required
integer
>= -9007199254740991 <= 9007199254740991
share
required
Any of:
integer
<= 100
older
required

Where files of an older release (or replaced in their stack) were still fetched this week, most first

Array<object>
object
asset
required
object
id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
title
required
string
version
required
Any of:
integer
>= -9007199254740991 <= 9007199254740991
preview
required

Whether /a/{id} can make a picture of it

boolean
supersededBy
required
Any of:
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
release
required
Any of:
integer
>= -9007199254740991 <= 9007199254740991
referrer
required

The host that loaded it

string | null
surface
required
string
Allowed values: app api mcp portal share hub link public
client
required

The agent’s key name, for an agent

string | null
fetches
required
integer
>= -9007199254740991 <= 9007199254740991
last
required

The last day it was fetched

string
Example
{
  "data": {
    "adoption": {
      "older": [
        {
          "surface": "app"
        }
      ]
    }
  }
}

default

Section titled “default”

An error

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
detail
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "detail": "example"
  }
}