MonitorEntityResult
{
"type": "object",
"properties": {
"entity_id": {
"type": "string",
"description": "The entity id as requested. Present on an entity_ids result."
},
"name": {
"type": "string",
"description": "The name as requested. Present on a names result."
},
"type": {
"type": "string",
"enum": [
"person",
"organization",
"product",
"topic",
"channel"
],
"description": "The type as requested, org read as organization. Present on a names result."
},
"canonical_entity_id": {
"type": "string",
"description": "Present when entity_id was merged: the canonical entity the tracker follows."
},
"tracker_id": {
"type": [
"string",
"null"
],
"description": "The tracker that follows the entity: an existing one when the account already tracked it, else the one this request created. Null when no tracker could be used (see reason)."
},
"created": {
"type": "boolean",
"description": "true when this request created the tracker."
},
"attached": {
"type": "boolean",
"description": "true when the tracker is in this monitor after the request, including when it already was."
},
"reason": {
"type": "string",
"enum": [
"entity_not_found",
"entity_type_not_trackable",
"tracker_limit_reached",
"tracked_in_another_monitor"
],
"description": "Why attached is false. Values: entity_not_found (no entity has this id), entity_type_not_trackable (only person, organization, product, topic and channel entities can be tracked), tracker_limit_reached (the plan allows no more trackers; upgrade the plan for more), tracked_in_another_monitor (the account already follows this entity in current_monitor_id; it was left there, so move it with POST /v1/monitors/{id}/trackers if the user wants). A names result can only carry tracker_limit_reached or tracked_in_another_monitor."
},
"current_monitor_id": {
"type": "string",
"description": "With reason tracked_in_another_monitor: the monitor the tracker is in."
}
},
"required": [
"tracker_id",
"created",
"attached"
]
}