searchtelemetry table/entity reference
Note
Unsure about table vs. entity? See Developers: Understand terminology in Microsoft Dataverse.
Entity to log telemetry that used to improve search quality
Added by: msdyn_RelevanceSearch Solution
Messages
| Message | Web API Operation | SDK Assembly |
|---|---|---|
| Create | POST [org URI]/api/data/v9.0/searchtelemetries See Create |
CreateRequest or Create |
| Delete | DELETE [org URI]/api/data/v9.0/searchtelemetries(searchtelemetryid) See Delete |
DeleteRequest or Delete |
| Retrieve | GET [org URI]/api/data/v9.0/searchtelemetries(searchtelemetryid) See Retrieve |
RetrieveRequest or Retrieve |
| RetrieveEntityChanges | RetrieveEntityChangesRequest | |
| RetrieveMultiple | GET [org URI]/api/data/v9.0/searchtelemetries See Query Data |
RetrieveMultipleRequest or RetrieveMultiple |
| Update | PATCH [org URI]/api/data/v9.0/searchtelemetries(searchtelemetryid) See Update |
UpdateRequest or Update |
| Upsert | UpsertRequest |
Properties
| Property | Value |
|---|---|
| CollectionSchemaName | searchtelemetries |
| DisplayCollectionName | Search Telemetry |
| DisplayName | Search Telemetry |
| EntitySetName | searchtelemetries |
| IsBPFEntity | False |
| LogicalCollectionName | searchtelemetries |
| LogicalName | searchtelemetry |
| OwnershipType | OrganizationOwned |
| PrimaryIdAttribute | searchtelemetryid |
| PrimaryNameAttribute | userquery |
| SchemaName | searchtelemetry |
Writable columns/attributes
These columns/attributes return true for either IsValidForCreate or IsValidForUpdate (usually both). Listed by SchemaName.
- CorrelationId
- EyesOnAnalyticsAllowed
- FeedbackData
- RequestId
- ScenarioName
- searchtelemetryId
- SessionId
- TTLInSeconds
- UserQuery
CorrelationId
| Property | Value |
|---|---|
| Description | CorrelationId for the search |
| DisplayName | CorrelationId |
| FormatName | Text |
| IsLocalizable | False |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | correlationid |
| MaxLength | 100 |
| RequiredLevel | None |
| Type | String |
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 |
EyesOnAnalyticsAllowed Choices/Options
| Value | Label | Description |
|---|---|---|
| 1 | Yes | |
| 0 | No |
DefaultValue: False
FeedbackData
| Property | Value |
|---|---|
| Description | Feedback data for the search |
| DisplayName | FeedbackData |
| FormatName | Text |
| IsLocalizable | False |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | feedbackdata |
| MaxLength | 1048577 |
| RequiredLevel | None |
| Type | String |
RequestId
| Property | Value |
|---|---|
| Description | RequestId for the search |
| DisplayName | RequestId |
| FormatName | Text |
| IsLocalizable | False |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | requestid |
| MaxLength | 100 |
| RequiredLevel | None |
| Type | String |
ScenarioName
| Property | Value |
|---|---|
| Description | ScenarioName for the search, current will be one of RelevanceSearch/Marketing/Cxp |
| DisplayName | ScenarioName |
| FormatName | Text |
| IsLocalizable | False |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | scenarioname |
| MaxLength | 100 |
| RequiredLevel | None |
| Type | String |
searchtelemetryId
| Property | Value |
|---|---|
| Description | Unique identifier for entity instances |
| DisplayName | SearchTelemetry Id |
| IsValidForForm | False |
| IsValidForRead | True |
| IsValidForUpdate | False |
| LogicalName | searchtelemetryid |
| RequiredLevel | SystemRequired |
| Type | Uniqueidentifier |
SessionId
| Property | Value |
|---|---|
| Description | SessionId for the search |
| DisplayName | SessionId |
| FormatName | Text |
| IsLocalizable | False |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | sessionid |
| MaxLength | 100 |
| RequiredLevel | None |
| Type | String |
TTLInSeconds
| Property | Value |
|---|---|
| Description | Time to live in seconds. |
| DisplayName | Time to live |
| Format | None |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | ttlinseconds |
| MaxValue | 2147483647 |
| MinValue | 1 |
| RequiredLevel | None |
| Type | Integer |
UserQuery
| Property | Value |
|---|---|
| Description | User Query |
| DisplayName | UserQuery |
| FormatName | Text |
| IsLocalizable | False |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | userquery |
| MaxLength | 1000 |
| RequiredLevel | None |
| Type | String |
Read-only columns/attributes
These columns/attributes return false for both IsValidForCreate or IsValidForUpdate. Listed by SchemaName.
CreatedOn
| Property | Value |
|---|---|
| DateTimeBehavior | UserLocal |
| Description | Date and time when the record was created. |
| DisplayName | Created On |
| Format | DateAndTime |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | createdon |
| RequiredLevel | None |
| Type | DateTime |
See also
About the table reference
Web API Reference
searchtelemetry EntityType