Skip to main content

ReportGeneratedCheck

generatedbooleanrequired
readyboolean
hasSourceboolean
inProgressboolean
loadErrorProfileBadReason (string)

Possible values: [unloaded, unmapped, zeroFollows, private, notFound, optOut, unexpected]

errorSourceSource (string)

source social network of profile

Possible values: [ig, fb, tt, tw, li]

Default value: tw
ownedboolean

Present only when the report is finished (generated true / tracked set). Whether the report belongs to the current user (false if unauthenticated).

isDemoboolean

Present only when the report is finished. Whether the report is owned by the configured examples/demo user.

publicboolean

Present only when the report is finished. Whether the report is shared/public

sessionIdstring

Opaque identifier for the current guest session (same value as the browser session cookie). Not a client-writable credential — callers must not treat it as secret or use it to mint parallel guest identities.

Population rules

  • Present only when the request has no authenticated user id (guest / session-cookie path): the value matches the active session id when a session cookie exists.
  • Omitted when the caller is JWT-authenticated (non-empty user id).
  • Omitted when there is no session cookie or session id.
aiChatEnabledboolean

Present only when the report is a demo/example report (isDemo true). True if unauthenticated visitors can use AI chat on this example report; false or absent means REGISTRATION_REQUIRED will be returned for anonymous chat attempts.

ReportGeneratedCheck
{
"generated": true,
"ready": true,
"hasSource": true,
"inProgress": true,
"loadError": "unloaded",
"errorSource": "tw",
"owned": true,
"isDemo": true,
"public": true,
"sessionId": "string",
"aiChatEnabled": true
}