Reporting Data APIs

YES

A simple path = '...' Operator Expression specifying the array path

path = 'actors.candidates'

YES

The constraint on the array elements, without the array path prefix.

Can be any Search Expression, and may contain nested containsElementMatching Functions

firstName = 'John' AND lastName = 'Doe'

Aggregation

POST

api/rep/collections/{reportingObjectConfigurationId}/~aggregate

• expression: A Search Expression

• groups: Indicates on which field(s) the results should be grouped. An operator can be used when there is a required granularity for the group. For instance if we group directly on a datetime field, each elements can end up in a singleton group since all datetimes may differ at least at the sub second level. This is not what we want generally, we want to plot on granularity of hours or days for instance. In order to group at a higher granularity one can provide HOUR, DAY, WEEK, MONTH, YEAR as the operator.

• aggregates: A list of aggregates. An aggregation operator needs to be provided such as SUM, AVG (average), MIN, MAX or COUNT. In the case of COUNT the aggregate name is not necessary since this operator will count the elements instead of doing an operation on a particular field.

{
    "expression": {
        "AND": [
            {
                "prop": "identity.firstName",
                "op": "EQUALS",
                "values": [
                    "John"
                ]
            },
            {
                "prop": "identity.lastName",
                "op": "EQUALS",
                "values": [
                    "Doe"
                ]
            },
             {
                "prop": "user-agent.os.family",
                "op": "EQUALS",
                "values": [
                    "Windows"
                ]
             }
        ],
    "groups": [
         { 
             "name": "date", 
             "operator": "HOUR" 
         },
    ],
    "aggregates": [ 
	    { 
			"name": "nb", 
			"operator": "SUM" 
		}
	]
}

The above request will

• search all elements in the collection targeted by the Reporting Object Configuration matching ideintity.firstName = 'John', identity.lastName = 'Doe' AND "user-agent.os.family" = 'WINDOWS',

• group the results on the date field with a granularity of 1 hour,

• and finally it will, for each groups, compute the sum of of all Document’s nb

Each groups wille be returned as a Document with a single _nbSum field (constructed as _<name of field><capitalized name of the aggregation operator>)

Search

POST

api/rep/collections/{reportingObjectConfigurationId}/~search

• expression: A Search Expression

• pagination: The page index and size. Can be null but in that case a projection is required (see projection bullet below).

• sort: A sort configuration on property and direction.

• projection: A set of fields name.  Allows to restrict the response documents fields to the ones declared. If not set or empty, all fields will be returned. Mandatory if no pagination is provided (data should be kept short if there are no pagination as this can be tremendously costly to return all elements with all their fields).

{
    "expression": {
        "prop": "user-agent.os.family",
        "op": "EQUALS",
        "values": [
            "Windows"
        ]
    },
    "pagination": {
        "index": 0,
        "size": 20
    },
    "sort": {
        "property": "user",
        "direction": "DESC"
    },
    "projection": ["name", "version", "type"]
}

sys.rep-query-execute

Documents insertion or update

POST

api/rep/collections/{reportingObjectConfigurationId}/~save

Asynchronously inserts a list of documents in the Collection targeted by this Reporting Object Configuration id. 

The collectionWriteConfiguration.writable field of this configuration must be true.

The insertion of documents is done using an unordered strategy, meaning that order of documents in the supplied list can be different after execution.

If there is a problem with the insertion of a document, this strategy will also ignore the problematic document and continue the bulk insertion for remaining documents.

Provided that the collectionWriteConfiguration.appendOnly flag is not set on the targeted Reporting Object Configuration, documents can contain a field "_id" if one wants to insert them with a specific id or to update them. If the flag is true, documents containing an id will be silently ignored.

A maximum or 10 000 Documents can be inserted in a single request.

Example of payload:

{
    "documents": [
        {
            
            "stringField": "test1",
            "dateField": "2021-12-01T00:00:00Z"
        },
        {
            
            "stringField": "test2",
            "dateField": "2021-12-01T00:00:00Z"
        }
    ]
} 

sys.rep-collection-write