Coveo · JSON-LD Context

Coveo Analytics Context

JSON-LD context defining the semantic vocabulary for Coveo Analytics from Coveo.

4 Classes 23 Properties 3 Namespaces
View Context View on GitHub

Namespaces

coveo: https://platform.cloud.coveo.com/schema#
schema: https://schema.org/
xsd: http://www.w3.org/2001/XMLSchema#

Classes

SearchEvent ClickEvent CustomEvent ViewEvent

Properties

Property Type Container
anonymous boolean
language
device
userAgent
originLevel1
originLevel2
originLevel3
userGroups list
customData
searchQueryUid
queryText
numberOfResults integer
responseTime integer
results list
advancedQuery
queryPipeline
documentUri reference
documentUrl reference
documentTitle
documentAuthor
rankingModifier
actionCause
actionType

JSON-LD Document

Raw ↑ 
{
  "@context": {
    "@version": 1.1,
    "@vocab": "https://schema.org/",
    "coveo": "https://platform.cloud.coveo.com/schema#",
    "schema": "https://schema.org/",
    "xsd": "http://www.w3.org/2001/XMLSchema#",

    "anonymous":     {"@id": "coveo:anonymous",     "@type": "xsd:boolean"},
    "language":      {"@id": "schema:inLanguage"},
    "device":        {"@id": "coveo:device"},
    "userAgent":     {"@id": "coveo:userAgent"},
    "originLevel1":  {"@id": "coveo:originLevel1"},
    "originLevel2":  {"@id": "coveo:originLevel2"},
    "originLevel3":  {"@id": "coveo:originLevel3"},
    "userGroups":    {"@id": "coveo:userGroups",    "@container": "@list"},
    "customData":    {"@id": "coveo:customData"},

    "searchQueryUid":{"@id": "coveo:searchQueryUid"},
    "queryText":     {"@id": "schema:query"},
    "numberOfResults":{"@id":"coveo:numberOfResults","@type":"xsd:integer"},
    "responseTime":  {"@id": "coveo:responseTime",  "@type": "xsd:integer"},
    "results":       {"@id": "coveo:results",       "@container": "@list"},
    "advancedQuery": {"@id": "coveo:advancedQuery"},
    "queryPipeline": {"@id": "coveo:queryPipeline"},

    "documentUri":   {"@id": "coveo:documentUri",   "@type": "@id"},
    "documentUrl":   {"@id": "schema:url",          "@type": "@id"},
    "documentTitle": {"@id": "schema:name"},
    "documentAuthor":{"@id": "schema:author"},
    "rankingModifier":{"@id":"coveo:rankingModifier"},

    "actionCause":   {"@id": "coveo:actionCause"},
    "actionType":    {"@id": "coveo:actionType"},

    "SearchEvent":   "coveo:SearchEvent",
    "ClickEvent":    "coveo:ClickEvent",
    "CustomEvent":   "coveo:CustomEvent",
    "ViewEvent":     "schema:ViewAction"
  }
}