Skip to content
Docs
Follow yggy on LinkedInFollow @yggy_tech on X

Organization analytics

GET
/api/v1/analytics
 
curl --request GET \
  --url 'https://api.yggy.tech/api/v1/analytics?bucket=minute' \
  --header 'Authorization: Bearer <token>'

Returns time-series analytics for documents, token usage, and knowledge graph growth.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
days

Lookback in days when from/to are omitted (default 30, max 365)

string

Lookback in days when from/to are omitted (default 30, max 365)

from

Inclusive start (YYYY-MM-DD or ISO-8601 datetime)

string

Inclusive start (YYYY-MM-DD or ISO-8601 datetime)

to

Inclusive end (YYYY-MM-DD or ISO-8601 datetime)

string

Inclusive end (YYYY-MM-DD or ISO-8601 datetime)

bucket

Bucket interval (minute, hour, day)

string
Allowed values: minute hour day

Bucket interval (minute, hour, day)

sections

Comma-separated sections: documents, graphTotals, graphSeries, tokens, storage (default: all)

string

Comma-separated sections: documents, graphTotals, graphSeries, tokens, storage (default: all)

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Analytics data

Media type application/json
object
period
required
object
from
required
string
to
required
string
days
required
number
documents
required
object
total
required
number
completed
required
number
failed
required
number
pending
required
number
processing
required
number
stored
required

Saved without analysis, waiting for credits

number
successRate
required

Percentage 0-100

number
avgProcessingTimeMs
required
number | null
byContentType
required
object
key
additional properties
number
byExtractionTier
required
object
key
additional properties
number
byExtractionMode
required
object
key
additional properties
number
overTime
required
Array<object>
object
date
required

ISO date string (YYYY-MM-DD)

string
count
required
number
completedOverTime
required
Array<object>
object
date
required

ISO date string (YYYY-MM-DD)

string
count
required
number
failedOverTime
required
Array<object>
object
date
required

ISO date string (YYYY-MM-DD)

string
count
required
number
forecast
required
Array<object>
object
date
required

ISO date string (YYYY-MM-DD)

string
value
required
number
upper
required
number
lower
required
number
failedForecast
required
Array<object>
object
date
required

ISO date string (YYYY-MM-DD)

string
value
required
number
upper
required
number
lower
required
number
graph
required
object
totalEntities
required
number
totalTriples
required
number
triplesOverTime
required
Array<object>
object
date
required

ISO date string (YYYY-MM-DD)

string
count
required
number
triplesForecast
required
Array<object>
object
date
required

ISO date string (YYYY-MM-DD)

string
value
required
number
upper
required
number
lower
required
number
entitiesOverTime
required
Array<object>
object
date
required

ISO date string (YYYY-MM-DD)

string
count
required
number
entitiesForecast
required
Array<object>
object
date
required

ISO date string (YYYY-MM-DD)

string
value
required
number
upper
required
number
lower
required
number
tokens
required
object
tpmCap
required

Organization Graph Intelligence tokens-per-minute cap

number
dailyCap
required

TPM cap expressed as tokens per UTC day

number
total
required

Total tokens consumed in period

number
peakTpm
required

Peak 1-minute rate observed in period

number
totalBreaches
required

Total rate breaches observed in period

number
overTime
required
Array<object>
object
date
required
string
used
required

Total tokens used in this bucket

number
cap
required

TPM rate limit cap

number
peakTpm
required

Peak 1-minute tokens/minute rate in this bucket

number
tpmBreaches
required

Number of minutes in this bucket exceeding the TPM cap

number
storage
required

Hot vs. cold triple split (point-in-time estimates)

object
hotTriples
required

Estimated triples in the live graph

number
coldTriples
required

Triples in cold object storage (manifest count)

number
hydratingTriples
required

Triples currently promoting back to hot

number
blobObjects
required

Distinct cold archive blobs backing this scope

number
blobBytes
required

Summed blob bytes (partial when bytesTruncated)

number
bytesTruncated
required

True when blobBytes hit the stat cap and is partial

boolean
byProject
required

Per-project split (org endpoint only, capped)

Array<object>
object
projectExternalId
required
string
mode
required

Effective storage policy: hot-first or cold-first

string
hotTriples
required

Estimated triples in the live graph

number
coldTriples
required

Triples in cold object storage (manifest count)

number
hydratingTriples
required

Triples currently promoting back to hot

number
projectsTruncated
required

True when byProject hit the project cap

boolean
degradedSections
required

Sibling fetches that timed out or failed; corresponding fields may be partial or estimated

Array<string>
Example generated
{
  "period": {
    "from": "example",
    "to": "example",
    "days": 1
  },
  "documents": {
    "total": 1,
    "completed": 1,
    "failed": 1,
    "pending": 1,
    "processing": 1,
    "stored": 1,
    "successRate": 1,
    "avgProcessingTimeMs": 1,
    "byContentType": {
      "additionalProperty": 1
    },
    "byExtractionTier": {
      "additionalProperty": 1
    },
    "byExtractionMode": {
      "additionalProperty": 1
    },
    "overTime": [
      {
        "date": "example",
        "count": 1
      }
    ],
    "completedOverTime": [
      {
        "date": "example",
        "count": 1
      }
    ],
    "failedOverTime": [
      {
        "date": "example",
        "count": 1
      }
    ],
    "forecast": [
      {
        "date": "example",
        "value": 1,
        "upper": 1,
        "lower": 1
      }
    ],
    "failedForecast": [
      {
        "date": "example",
        "value": 1,
        "upper": 1,
        "lower": 1
      }
    ]
  },
  "graph": {
    "totalEntities": 1,
    "totalTriples": 1,
    "triplesOverTime": [
      {
        "date": "example",
        "count": 1
      }
    ],
    "triplesForecast": [
      {
        "date": "example",
        "value": 1,
        "upper": 1,
        "lower": 1
      }
    ],
    "entitiesOverTime": [
      {
        "date": "example",
        "count": 1
      }
    ],
    "entitiesForecast": [
      {
        "date": "example",
        "value": 1,
        "upper": 1,
        "lower": 1
      }
    ]
  },
  "tokens": {
    "tpmCap": 1,
    "dailyCap": 1,
    "total": 1,
    "peakTpm": 1,
    "totalBreaches": 1,
    "overTime": [
      {
        "date": "example",
        "used": 1,
        "cap": 1,
        "peakTpm": 1,
        "tpmBreaches": 1
      }
    ]
  },
  "storage": {
    "hotTriples": 1,
    "coldTriples": 1,
    "hydratingTriples": 1,
    "blobObjects": 1,
    "blobBytes": 1,
    "bytesTruncated": true,
    "byProject": [
      {
        "projectExternalId": "example",
        "mode": "example",
        "hotTriples": 1,
        "coldTriples": 1,
        "hydratingTriples": 1
      }
    ],
    "projectsTruncated": true
  },
  "degradedSections": [
    "example"
  ]
}

400

Section titled “400 ”

Bad request

Media type application/json
object
error
required
string
Example generated
{
  "error": "example"
}

401

Section titled “401 ”

Unauthorized

Media type application/json
object
error
required
string
Example generated
{
  "error": "example"
}

500

Section titled “500 ”

Internal server error

Media type application/json
object
error
required
string
Example generated
{
  "error": "example"
}