Internal API

Website modification agent data

4 endpoints.

GET/api/v1/internal/website-mod/agent-data/{entity}

List Agent Data

Parameters

Name	In	Type	Description
`entity`required	path	`string`
`X-Keystone-Data-Token`	header	`string \| null`

Responses

200Successful Response

application/jsonSuccessResponse_Any_

Field Type Description

request_idrequired string

success true default true

datarequired any

metadata

ResponseMetadata | null

ResponseMetadata fields

Field Type Description

pagination

PaginationMetadata | null

PaginationMetadata fields

Field	Type	Description
`limit`required	`integer`
`next_cursor`	`string \| null`
`prev_cursor`	`string \| null`
`has_more`required	`boolean`
`has_prev`	`boolean`	default false
`total_count`	`integer \| null`

status_counts

object | null

object | null fields

Map of string to integer

lifecycle_counts

LifecycleCounts | null

LifecycleCounts fields

Field	Type	Description
`lead`	`integer`	default 0
`prospect`	`integer`	default 0
`customer`	`integer`	default 0
`former_customer`	`integer`	default 0

classification_counts

ClassificationCounts | null

ClassificationCounts fields

Field	Type	Description
`signal`	`object`	object fields Nested object (not expanded)
`touch`	`object`	object fields Nested object (not expanded)
`stage`	`object`	object fields Nested object (not expanded)

meta

ResponseMeta | null

ResponseMeta fields

Field	Type	Description
`total`	`integer \| null`
`total_count`	`integer \| null`
`page`	`integer \| null`
`per_page`	`integer \| null`

400Bad request
401Unauthorized
403Forbidden
404Not found
422Validation error
500Internal server error
503Service unavailable

Error bodies: ErrorResponse. See Errors.

GET/api/v1/internal/website-mod/agent-data/{entity}/{target_id}

Get Agent Data Record

Parameters

Name	In	Type
`entity`required	path	`string`
`target_id`required	path	`string (uuid)`
`X-Keystone-Data-Token`	header	`string \| null`

Responses

200Successful Response

application/jsonSuccessResponse_dict_str__Any__

Field	Type	Description
`request_id`required	`string`
`success`	`true`	default true
`data`required	`object`
`metadata`	`ResponseMetadata \| null`	ResponseMetadata fields ResponseMetadata, expanded above.
`meta`	`ResponseMeta \| null`	ResponseMeta fields ResponseMeta, expanded above.

400Bad request
401Unauthorized
403Forbidden
404Not found
422Validation error
500Internal server error
503Service unavailable

Error bodies: ErrorResponse. See Errors.

GET/api/v1/internal/website-mod/agent-data/schema

Get Agent Data Schema

Parameters

Name	In	Type	Description
`entity`required	query	`string`
`X-Keystone-Data-Token`	header	`string \| null`

Responses

200Successful Response

application/jsonSuccessResponse_dict_str__Any__

Field	Type	Description
`request_id`required	`string`
`success`	`true`	default true
`data`required	`object`
`metadata`	`ResponseMetadata \| null`	ResponseMetadata fields ResponseMetadata, expanded above.
`meta`	`ResponseMeta \| null`	ResponseMeta fields ResponseMeta, expanded above.

400Bad request
401Unauthorized
403Forbidden
404Not found
422Validation error
500Internal server error
503Service unavailable

Error bodies: ErrorResponse. See Errors.

POST/api/v1/internal/website-mod/agent-data/write

Post Agent Data Write

Parameters

Name	In	Type	Description
`X-Keystone-Data-Token`	header	`string \| null`

Request bodyrequired

application/jsonAgentDataWriteBody

Field	Type	Description
`entity`required	`string`	min length 1 · max length 64
`op`required	`enum`	one of "create", "update"
`target_id`	`string (uuid) \| null`
`fields`	`object`
`idempotency_key`required	`string`	min length 1 · max length 128
`summary`	`string`	default "" · max length 200
`allow_duplicate`	`boolean`	default false

Responses

200Successful Response

application/jsonSuccessResponse_AgentDataWriteData_

Field Type Description

request_idrequired string

success true default true

datarequired

AgentDataWriteData

AgentDataWriteData fields

Field	Type	Description
`entity`required	`string`
`op`required	`string`
`target_id`required	`string`
`label`required	`string`
`replayed`	`boolean`	default false
`field_changes`	`AgentDataFieldChange[]`	AgentDataFieldChange[] fields AgentDataFieldChange (not expanded)
`record`	`object`

metadata

ResponseMetadata | null

ResponseMetadata fields

ResponseMetadata, expanded above.

meta

ResponseMeta | null

ResponseMeta fields

ResponseMeta, expanded above.

400Bad request
401Unauthorized
403Forbidden
404Not found
422Validation error
500Internal server error
503Service unavailable

Error bodies: ErrorResponse. See Errors.