Edit

Share via

Search Telemetry (searchtelemetry) table/entity reference (Microsoft Dataverse)

  • Article

Entity to log telemetry that used to improve search quality

Messages

The following table lists the messages for the Search Telemetry (searchtelemetry) table. Messages represent operations that can be performed on the table. They may also be events.

Name
Is Event?		 Web API Operation SDK for .NET
Create
Event: True		 POST /searchtelemetries
See Create		 Create records
CreateMultiple
Event: True		 CreateMultiple CreateMultipleRequest
Delete
Event: True		 DELETE /searchtelemetries(searchtelemetryid)
See Delete		 Delete records
DeleteMultiple
Event: True		 DeleteMultiple Learn to use messages with the SDK for .NET
Retrieve
Event: True		 GET /searchtelemetries(searchtelemetryid)
See Retrieve		 Retrieve records
RetrieveEntityChanges
Event: True		 RetrieveEntityChangesRequest
RetrieveMultiple
Event: True		 GET /searchtelemetries
See Query data		 Query data
Update
Event: True		 PATCH /searchtelemetries(searchtelemetryid)
See Update		 Update records
UpdateMultiple
Event: True		 UpdateMultiple UpdateMultipleRequest
Upsert
Event: True		 PATCH /searchtelemetries(searchtelemetryid)
See Upsert a table row		 UpsertRequest
UpsertMultiple
Event: True		 UpsertMultiple UpsertMultipleRequest

Events

The following table lists the events for the Search Telemetry (searchtelemetry) table. Events are messages that exist so that you can subscribe to them. Unless you added the event, you shouldn't invoke the message, only subscribe to it.

Name Web API Operation SDK for .NET
BulkRetain BulkRetain Learn to use messages with the SDK for .NET
PurgeRetainedContent PurgeRetainedContent Learn to use messages with the SDK for .NET
Retain Retain Learn to use messages with the SDK for .NET
RollbackRetain RollbackRetain Learn to use messages with the SDK for .NET
ValidateRetentionConfig ValidateRetentionConfig Learn to use messages with the SDK for .NET

Properties

The following table lists selected properties for the Search Telemetry (searchtelemetry) table.

Property Value
DisplayName Search Telemetry
DisplayCollectionName Search Telemetry
SchemaName searchtelemetry
CollectionSchemaName searchtelemetries
EntitySetName searchtelemetries
LogicalName searchtelemetry
LogicalCollectionName searchtelemetries
PrimaryIdAttribute searchtelemetryid
PrimaryNameAttribute userquery
TableType Elastic
OwnershipType OrganizationOwned

Writable columns/attributes

These columns/attributes return true for either IsValidForCreate or IsValidForUpdate (usually both). Listed by SchemaName.

CorrelationId

Property Value
Description CorrelationId for the search
DisplayName CorrelationId
IsValidForForm True
IsValidForRead True
LogicalName correlationid
RequiredLevel None
Type String
Format Text
FormatName Text
ImeMode Auto
IsLocalizable False
MaxLength 100

EyesOnAnalyticsAllowed

Property Value
Description If customer is allow our engineer to eye on
DisplayName EyesOnAnalyticsAllowed
IsValidForForm True
IsValidForRead True
LogicalName eyesonanalyticsallowed
RequiredLevel None
Type Boolean
GlobalChoiceName searchtelemetry_eyesonanalyticsallowed
DefaultValue False
True Label Yes
False Label No

FeedbackData

Property Value
Description Feedback data for the search
DisplayName FeedbackData
IsValidForForm True
IsValidForRead True
LogicalName feedbackdata
RequiredLevel None
Type String
Format Text
FormatName Text
ImeMode Auto
IsLocalizable False
MaxLength 1048577

PartitionId

Property Value
Description Logical partition id. A logical partition consists of a set of records with same partition id.
DisplayName Partition Id
IsValidForForm True
IsValidForRead True
LogicalName partitionid
RequiredLevel None
Type String
Format Text
FormatName Text
ImeMode Auto
IsLocalizable False
MaxLength 100

RequestId

Property Value
Description RequestId for the search
DisplayName RequestId
IsValidForForm True
IsValidForRead True
LogicalName requestid
RequiredLevel None
Type String
Format Text
FormatName Text
ImeMode Auto
IsLocalizable False
MaxLength 100

ScenarioName

Property Value
Description ScenarioName for the search, current will be one of RelevanceSearch/Marketing/Cxp
DisplayName ScenarioName
IsValidForForm True
IsValidForRead True
LogicalName scenarioname
RequiredLevel None
Type String
Format Text
FormatName Text
ImeMode Auto
IsLocalizable False
MaxLength 100

searchtelemetryId

Property Value
Description Unique identifier for entity instances
DisplayName SearchTelemetry Id
IsValidForForm False
IsValidForRead True
LogicalName searchtelemetryid
RequiredLevel SystemRequired
Type Uniqueidentifier

SessionId

Property Value
Description SessionId for the search
DisplayName SessionId
IsValidForForm True
IsValidForRead True
LogicalName sessionid
RequiredLevel None
Type String
Format Text
FormatName Text
ImeMode Auto
IsLocalizable False
MaxLength 100

TTLInSeconds

Property Value
Description Time to live in seconds.
DisplayName Time to live
IsValidForForm True
IsValidForRead True
LogicalName ttlinseconds
RequiredLevel None
Type Integer
MaxValue 2147483647
MinValue 1

UserQuery

Property Value
Description User Query
DisplayName UserQuery
IsValidForForm True
IsValidForRead True
LogicalName userquery
RequiredLevel None
Type String
Format Text
FormatName Text
ImeMode Auto
IsLocalizable False
MaxLength 1000

Read-only columns/attributes

These columns/attributes return false for both IsValidForCreate and IsValidForUpdate. Listed by SchemaName.

CreatedOn

Property Value
Description Date and time when the record was created.
DisplayName Created On
IsValidForForm True
IsValidForRead True
LogicalName createdon
RequiredLevel None
Type DateTime
CanChangeDateTimeBehavior False
DateTimeBehavior UserLocal
Format DateAndTime
ImeMode Inactive
SourceTypeMask 0

versionnumber

Property Value
Description Version number of SearchTelemetry.
DisplayName Version Number
IsValidForForm False
IsValidForRead True
LogicalName versionnumber
RequiredLevel None
Type BigInt
MaxValue 9223372036854775807
MinValue -9223372036854775808

See also

Dataverse table/entity reference
Dataverse Web API Reference
searchtelemetry