Entity
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Public entity id in the form \"ent_{n}\". Always the canonical entity id."
},
"canonical_id": {
"type": "string",
"description": "Public id of the canonical entity. Identical to id."
},
"name": {
"type": "string",
"description": "Canonical entity name."
},
"type": {
"type": "string",
"description": "Entity type. Values: person (an individual), organization (a company or institution; legacy entities may read company or brand), product (a product or service), topic (a subject or theme), channel (a media source such as a YouTube channel), unknown (type was never classified)."
},
"platform": {
"type": [
"string",
"null"
],
"description": "Source platform for channel entities, e.g. \"youtube\". Null unless the entity is platform-bound."
},
"url": {
"type": [
"string",
"null"
],
"description": "Canonical external URL for the entity. Null when none is known."
},
"image_url": {
"type": [
"string",
"null"
],
"description": "Entity image URL. Null until an image has been resolved."
},
"image_checked_at": {
"type": [
"string",
"null"
],
"description": "Timestamp of the last image resolution attempt. Null until the image pipeline has visited this entity."
},
"appearance_count": {
"type": "integer",
"default": 0,
"description": "Number of indexed appearances and mentions of this entity. 0 when never counted."
},
"owner_entity_id": {
"type": [
"string",
"null"
],
"description": "Public id (\"ent_{n}\") of the owning entity, e.g. the organization behind a product. Null unless an ownership link exists."
},
"is_canonical": {
"type": "boolean",
"description": "True when the id you supplied is the canonical entity. False when your id was merged into this canonical record."
},
"merged_from_id": {
"type": [
"string",
"null"
],
"description": "Public id you supplied when it differs from the canonical entity, i.e. your id was merged into this record. Null unless a merge redirect happened."
},
"slug": {
"type": [
"string",
"null"
],
"description": "URL slug, the site's canonical id for every type but channel. Null when never slugged."
},
"route": {
"type": [
"string",
"null"
],
"description": "Site-relative route of this entity's page on arcmira.com, e.g. \"/org/ramp\", \"/person/jane-doe\", \"/yt/@TBPNLive\". Null for a type the site has no page for."
},
"page": {
"type": [
"string",
"null"
],
"description": "The entity's page on arcmira.com, absolute. Link the name to it when you write the entity into an answer. Null for a type the site has no page for."
},
"appearances_page": {
"type": [
"string",
"null"
],
"description": "For a person, the list of their appearances on arcmira.com (their page opens on it). Null for every other type."
},
"mentions_page": {
"type": [
"string",
"null"
],
"description": "For a person, the list of mentions of them on arcmira.com, page/mentions. Null for every other type: their page is the mentions list already."
}
},
"required": [
"id",
"canonical_id",
"name",
"type",
"platform",
"url",
"image_url",
"image_checked_at",
"owner_entity_id",
"is_canonical",
"merged_from_id",
"slug",
"route",
"page",
"appearances_page",
"mentions_page"
]
}