PFProfilesGetEntityProfilesRequest

PFProfilesGetEntityProfilesRequest data model. Given a set of entity types and entity identifiers will retrieve all readable profiles properties for the caller. Profiles that the caller is not allowed to read will silently not be included in the results.

Syntax

typedef struct PFProfilesGetEntityProfilesRequest {  
    PFStringDictionaryEntry const* customTags;  
    uint32_t customTagsCount;  
    bool const* dataAsObject;  
    PFEntityKey const* entities;  
    uint32_t entitiesCount;  
    bool includeStatistics;  
} PFProfilesGetEntityProfilesRequest;  

Members

customTags   PFStringDictionaryEntry const*
may be nullptr

(Optional) The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).

customTagsCount   uint32_t

Count of customTags

dataAsObject   bool const*
may be nullptr

(Optional) Determines whether the objects will be returned as an escaped JSON string or as a un-escaped JSON object. Default is JSON string.

entities   PFEntityKey const*

Entity keys of the profiles to load. Must be between 1 and 25.

entitiesCount   uint32_t

Count of entities

includeStatistics   bool

Determines whether the entity statistics will be returned in the entity profile. Default is false.

Requirements

Header: PFProfilesTypes.h

See also

PFProfilesTypes members