:hedgehog: PostHog is the leading platform for building self-driving products. Our developer tools – AI observability, analytics, session replay, flags, experiments, error tracking, logs, and more – capture all the context agents need to diagnose problems, uncover opportunities, and ship fixes. Steer it all from Slack, web, desktop, or the MCP.
Python ab-testingai-analyticsanalyticscdpdata-warehouseexperimentsfeature-flagsjavascriptproduct-analyticspythonreactsession-replaysurveystypescriptweb-analytics
/**
* Auto-generated from the Django backend OpenAPI schema.
* To modify these types, update the Django serializers or views, then run:
* hogli build:openapi
* Questions or issues? #team-devex on Slack
*
* PostHog API - generated
* OpenAPI spec version: 1.0.0
*/
/**
* * `pending` - Pending
* * `acknowledged` - Acknowledged
* * `resolved` - Resolved
* * `dismissed` - Dismissed
*/
export type FieldNoteStatusEnumApi = (typeof FieldNoteStatusEnumApi)[keyof typeof FieldNoteStatusEnumApi]
export const FieldNoteStatusEnumApi = {
Pending: 'pending',
Acknowledged: 'acknowledged',
Resolved: 'resolved',
Dismissed: 'dismissed',
} as const
/**
* * `engineering` - Engineering
* * `data` - Data
* * `product` - Product Management
* * `founder` - Founder
* * `leadership` - Leadership
* * `marketing` - Marketing
* * `sales` - Sales / Success
* * `student` - Student
* * `other` - Other
*/
export type RoleAtOrganizationEnumApi = (typeof RoleAtOrganizationEnumApi)[keyof typeof RoleAtOrganizationEnumApi]
export const RoleAtOrganizationEnumApi = {
Engineering: 'engineering',
Data: 'data',
Product: 'product',
Founder: 'founder',
Leadership: 'leadership',
Marketing: 'marketing',
Sales: 'sales',
Student: 'student',
Other: 'other',
} as const
export type BlankEnumApi = (typeof BlankEnumApi)[keyof typeof BlankEnumApi]
export const BlankEnumApi = {
'': '',
} as const
/**
* @nullable
*/
export type UserBasicApiHedgehogConfig = { [key: string]: unknown } | null
export interface UserBasicApi {
readonly id: number
readonly uuid: string
/**
* @maxLength 200
* @nullable
*/
distinct_id?: string | null
/** @maxLength 150 */
first_name?: string
/** @maxLength 150 */
last_name?: string
/** @maxLength 254 */
email: string
/** @nullable */
is_email_verified?: boolean | null
/** @nullable */
readonly hedgehog_config: UserBasicApiHedgehogConfig
role_at_organization?: RoleAtOrganizationEnumApi | BlankEnumApi | null
}
/**
* Structured element metadata (inferred selectors, attributes, component hints).
*/
export type FieldNoteApiElementContext = { [key: string]: unknown }
/**
* Viewport size when the field note was made, as {width, height}.
* @nullable
*/
export type FieldNoteApiViewport = {
/** Viewport width in pixels. */
width?: number
/** Viewport height in pixels. */
height?: number
} | null
export interface FieldNoteApi {
readonly id: string
/**
* The note the user wrote about the element.
* @maxLength 5000
*/
comment: string
/** Lifecycle of the field note: pending, acknowledged, resolved, or dismissed. Ignored on create.
*
* * `pending` - Pending
* * `acknowledged` - Acknowledged
* * `resolved` - Resolved
* * `dismissed` - Dismissed */
field_note_status?: FieldNoteStatusEnumApi
/**
* Optional note left by the agent when acknowledging, resolving, or dismissing the field note.
* @nullable
*/
resolution?: string | null
/**
* Full URL of the page the field note was made on.
* @maxLength 2048
*/
url: string
/**
* Hostname of the page, used to scope field notes to a site.
* @maxLength 255
*/
host: string
/**
* Path portion of the URL.
* @maxLength 2048
* @nullable
*/
pathname?: string | null
/**
* CSS selector that locates the element on the page.
* @maxLength 4096
*/
selector: string
/**
* Visible text of the element, if any.
* @maxLength 2048
* @nullable
*/
element_text?: string | null
/**
* Serialized autocapture-style element chain from the element up to the document root.
* @maxLength 20000
* @nullable
*/
element_chain?: string | null
/** Structured element metadata (inferred selectors, attributes, component hints). */
element_context?: FieldNoteApiElementContext
/**
* Viewport size when the field note was made, as {width, height}.
* @nullable
*/
viewport?: FieldNoteApiViewport
/**
* URL of an uploaded screenshot captured with the field_note.
* @maxLength 2048
* @nullable
*/
screenshot_url?: string | null
readonly created_at: string
/** @nullable */
readonly updated_at: string | null
readonly created_by: UserBasicApi
}
export interface PaginatedFieldNoteListApi {
count: number
/** @nullable */
next?: string | null
/** @nullable */
previous?: string | null
results: FieldNoteApi[]
}
/**
* Structured element metadata (inferred selectors, attributes, component hints).
*/
export type PatchedFieldNoteApiElementContext = { [key: string]: unknown }
/**
* Viewport size when the field note was made, as {width, height}.
* @nullable
*/
export type PatchedFieldNoteApiViewport = {
/** Viewport width in pixels. */
width?: number
/** Viewport height in pixels. */
height?: number
} | null
export interface PatchedFieldNoteApi {
readonly id?: string
/**
* The note the user wrote about the element.
* @maxLength 5000
*/
comment?: string
/** Lifecycle of the field note: pending, acknowledged, resolved, or dismissed. Ignored on create.
*
* * `pending` - Pending
* * `acknowledged` - Acknowledged
* * `resolved` - Resolved
* * `dismissed` - Dismissed */
field_note_status?: FieldNoteStatusEnumApi
/**
* Optional note left by the agent when acknowledging, resolving, or dismissing the field note.
* @nullable
*/
resolution?: string | null
/**
* Full URL of the page the field note was made on.
* @maxLength 2048
*/
url?: string
/**
* Hostname of the page, used to scope field notes to a site.
* @maxLength 255
*/
host?: string
/**
* Path portion of the URL.
* @maxLength 2048
* @nullable
*/
pathname?: string | null
/**
* CSS selector that locates the element on the page.
* @maxLength 4096
*/
selector?: string
/**
* Visible text of the element, if any.
* @maxLength 2048
* @nullable
*/
element_text?: string | null
/**
* Serialized autocapture-style element chain from the element up to the document root.
* @maxLength 20000
* @nullable
*/
element_chain?: string | null
/** Structured element metadata (inferred selectors, attributes, component hints). */
element_context?: PatchedFieldNoteApiElementContext
/**
* Viewport size when the field note was made, as {width, height}.
* @nullable
*/
viewport?: PatchedFieldNoteApiViewport
/**
* URL of an uploaded screenshot captured with the field_note.
* @maxLength 2048
* @nullable
*/
screenshot_url?: string | null
readonly created_at?: string
/** @nullable */
readonly updated_at?: string | null
readonly created_by?: UserBasicApi
}
export type FieldNotesListParams = {
/**
* Filter to field notes in this lifecycle state (e.g. `pending` for unaddressed feedback).
*/
field_note_status?: FieldNotesListFieldNoteStatus
/**
* Filter to field notes made on this hostname (e.g. `app.example.com`).
*/
host?: string
/**
* Number of results to return per page.
*/
limit?: number
/**
* The initial index from which to return the results.
*/
offset?: number
}
export type FieldNotesListFieldNoteStatus =
(typeof FieldNotesListFieldNoteStatus)[keyof typeof FieldNotesListFieldNoteStatus]
export const FieldNotesListFieldNoteStatus = {
Acknowledged: 'acknowledged',
Dismissed: 'dismissed',
Pending: 'pending',
Resolved: 'resolved',
} as const