Create observation
POST /observations. Parameters, permissions, request and response schemas.
POST /observations
Create observation. Requires the REST write token ability. The bearer token selects the Team; a supplied team_id cannot switch tenants. Additional role, entity-policy and plan requirements vary by operation. A Team in blocked billing mode cannot write and receives 402.
Authentication
Use a team API key as Authorization: Bearer YOUR_API_KEY. The token ability and the user’s role must both allow this operation. See authentication.
{
"ability": "write",
"team": "Token-bound Team",
"authorization": "Additional role, entity-policy and plan requirements vary by operation.",
"billing": "Blocked billing mode rejects writes with 402."
}Request body
A request body is required.
application/json
{
"type": "object",
"properties": {
"project_id": {
"type": "integer"
},
"research_collection_id": {
"type": [
"integer",
"null"
]
},
"user_id": {
"type": [
"integer",
"null"
]
},
"name": {
"type": "string",
"maxLength": 255
},
"description": {
"type": [
"string",
"null"
],
"maxLength": 65535
},
"source_type": {
"type": [
"string",
"null"
],
"enum": [
"manual",
"audit",
"experiment",
"survey",
"screen",
"import",
"external_research",
null
]
},
"source_id": {
"type": [
"integer",
"null"
],
"minimum": 1
},
"source_item_key": {
"type": [
"string",
"null"
],
"maxLength": 255
},
"source_label": {
"type": [
"string",
"null"
],
"maxLength": 255
},
"evidence_kind": {
"type": [
"string",
"null"
],
"enum": [
"screenshot_region",
"quote",
"metric_result",
"page_text",
"manual_note",
"audit_observation",
null
]
},
"evidence_payload": {
"description": "JSON object or array. Object keys depend on the provider, form question, or configuration being stored.",
"anyOf": [
{
"type": "object",
"additionalProperties": {
"description": "An arbitrary JSON value retained by a metadata/settings field.",
"oneOf": [
{
"type": "null"
},
{
"type": "boolean"
},
{
"type": "number"
},
{
"type": "string"
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/JsonValue"
}
},
{
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/JsonValue"
}
}
]
}
},
{
"type": "array",
"items": {
"description": "An arbitrary JSON value retained by a metadata/settings field.",
"oneOf": [
{
"type": "null"
},
{
"type": "boolean"
},
{
"type": "number"
},
{
"type": "string"
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/JsonValue"
}
},
{
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/JsonValue"
}
}
]
}
},
{
"type": "null"
}
]
},
"confidence": {
"type": [
"string",
"null"
],
"enum": [
"high",
"medium",
"low",
"unknown",
null
]
},
"observed_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"insight_ids": {
"type": [
"array",
"null"
],
"items": {
"type": "integer"
}
},
"screen_annotation_ids": {
"type": [
"array",
"null"
],
"items": {
"type": "integer"
}
},
"page_ids": {
"type": [
"array",
"null"
],
"items": {
"type": "integer"
}
}
},
"required": [
"project_id",
"name"
],
"title": "StoreObservationRequest"
}{
"project_id": 101,
"name": "Checkout delivery estimate",
"description": null
}Example request
curl --request POST 'https://api.example.test/api/observations' \
--header 'Authorization: Bearer YOUR_API_KEY' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{"project_id":101,"name":"Checkout delivery estimate","description":null}'Examples use fictional data. Replace resource IDs and the API host with your environment’s values.
Responses
200
ObservationResource
Content type: application/json.
{
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"project_id": {
"type": "integer"
},
"research_collection_id": {
"type": [
"integer",
"null"
]
},
"user_id": {
"type": [
"integer",
"null"
]
},
"name": {
"type": "string"
},
"description": {
"type": [
"string",
"null"
]
},
"source_type": {
"type": "string"
},
"source_id": {
"type": [
"integer",
"null"
]
},
"source_item_key": {
"type": [
"string",
"null"
]
},
"source_label": {
"type": [
"string",
"null"
]
},
"evidence_kind": {
"type": [
"string",
"null"
]
},
"evidence_payload": {
"description": "JSON object or array. Object keys depend on the provider, form question, or configuration being stored.",
"anyOf": [
{
"type": "object",
"additionalProperties": {
"description": "An arbitrary JSON value retained by a metadata/settings field.",
"oneOf": [
{
"type": "null"
},
{
"type": "boolean"
},
{
"type": "number"
},
{
"type": "string"
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/JsonValue"
}
},
{
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/JsonValue"
}
}
]
}
},
{
"type": "array",
"items": {
"description": "An arbitrary JSON value retained by a metadata/settings field.",
"oneOf": [
{
"type": "null"
},
{
"type": "boolean"
},
{
"type": "number"
},
{
"type": "string"
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/JsonValue"
}
},
{
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/JsonValue"
}
}
]
}
},
{
"type": "null"
}
]
},
"confidence": {
"type": [
"string",
"null"
]
},
"observed_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"locked": {
"type": "boolean"
},
"accepted_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"accepted_by": {
"type": [
"integer",
"null"
]
},
"dismissed_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"dismissed_by": {
"type": [
"integer",
"null"
]
},
"created_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"updated_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"deleted_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"review_status": {
"type": "string"
}
},
"required": [
"id",
"project_id",
"research_collection_id",
"user_id",
"name",
"description",
"source_type",
"source_id",
"source_item_key",
"source_label",
"evidence_kind",
"evidence_payload",
"confidence",
"observed_at",
"locked",
"accepted_at",
"accepted_by",
"dismissed_at",
"dismissed_by",
"created_at",
"updated_at",
"deleted_at",
"review_status"
],
"title": "ObservationResource"
}
},
"required": [
"data"
]
}{
"data": {
"id": 101,
"project_id": 101,
"research_collection_id": null,
"user_id": null,
"name": "Checkout delivery estimate",
"description": null,
"source_type": "example",
"source_id": null,
"source_item_key": null,
"source_label": null,
"evidence_kind": null,
"evidence_payload": null,
"confidence": null,
"observed_at": null,
"locked": true,
"accepted_at": null,
"accepted_by": null,
"dismissed_at": null,
"dismissed_by": null,
"created_at": null,
"updated_at": null,
"deleted_at": null,
"review_status": "example"
}
}401
Unauthenticated
Content type: application/json.
{
"type": "object",
"properties": {
"message": {
"type": "string",
"description": "Error overview."
}
},
"required": [
"message"
]
}{
"message": "The request could not be completed."
}402
The Team is in read-only billing mode.
Content type: application/json.
{
"type": "object",
"properties": {
"error": {
"type": "string",
"const": "subscription_required"
},
"mode": {
"type": "string",
"const": "blocked"
},
"message": {
"type": "string",
"example": "Your team is in read-only mode. Update billing to make changes."
},
"grace_period_ends_at": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"required": [
"error",
"mode",
"message",
"grace_period_ends_at"
]
}{
"error": "subscription_required",
"mode": "blocked",
"message": "Your team is in read-only mode. Update billing to make changes.",
"grace_period_ends_at": null
}403
Authorization error
Content type: application/json.
{
"type": "object",
"properties": {
"message": {
"type": "string",
"description": "Error overview."
}
},
"required": [
"message"
]
}{
"message": "The request could not be completed."
}422
Validation error
Content type: application/json.
{
"type": "object",
"properties": {
"message": {
"type": "string",
"description": "Errors overview."
},
"errors": {
"type": "object",
"description": "A detailed description of each field that failed validation.",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"required": [
"message",
"errors"
]
}{
"message": "The request could not be completed.",
"errors": {
"name": [
"The name field is required."
]
}
}429
Rate limit exceeded. Honor Retry-After before retrying.
Response headers:
{
"Retry-After": {
"description": "Seconds before retrying.",
"schema": {
"type": "integer"
}
}
}Content type: application/json.
{
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "Too Many Attempts."
}
},
"required": [
"message"
]
}{
"message": "Too Many Attempts."
}See API conventions for error handling, rate limits, pagination, and uploads.