Generic Resource
PEPPERI NOTIFICATION SERVICE
Actions Queue
CPI Node
TODO training

DataQueries

A resource for creating objects that can be used to query the data-index tables

get
Standard ADAL resource

https://papi.pepperi.com/v1.0/data_index/queries
A standard ADAL resource for create data index queries
Request
Response
Request
Response
200: OK
A list of the data index queries
[
{
// generates a guid on create
"Key": "",
// any resource supported in the data index
"Resource": "all_activities",
// First level of grouping
// xAxis on a graph (or catagories)
// most graphs only support one group
// optional
"GroupBy": [
{
// The field ID to group by
// mandatory
"FieldID": "CreationDateTime",
// An interval to group mutiple values in
// works only for DateTime fields
// optional - default 1
"Interval": "",
// The unit to use to group in intervals
// optional
// "Month" is default
"IntervalUnit": "Days" | "Weeks" | "Months" | "Years",
}
],
// Columns that are aggregated in the result
// Represents series on a graph (columns - yAxis)
// certain fields can be split before being aggregated (BreakBy)
// This will create mutiple colums for one field
// mandatory (at least one in the array)
"Series": [
{
// A list of fields to aggregate for this column
// manadatory (at least one in the array)
"AggregatedFields": [
{
// The field to aggregate
// mandatory
"FieldID": "GrandTotal",
// The operation
// manadatory
"Aggregator": "Sum" | "Count" | "Average",
// Name of the field in the result
// optional - default TBD
"Alias": ""
}
],
// Group values before aggregating them into buckets
// Optional
"BreakBy": {
// The field ID to break the aggregation by
// mandatory
"FieldID": "TSAChain",
// An interval to group mutiple values in
// works only for DateTime fields
// optional - default 1
"Interval": "",
// The unit to use to group in intervals
// optional
// "Month" is default
"IntervalUnit": "Days" | "Weeks" | "Months" | "Years",
// Only break to a certain amount of colums
// optional
"Top": {
// optional - default is the first field in the Fields
// must be one of the aggregated fields
"FieldID": "TSAPrice",
// the maximum colums to break to
"Max": 100,
// Order the results by ascending order before topping off
// optional - default false (Descending)
"Ascending": true,
}
},
// fields that can be used in a runtime filter
"DynamicFilterFields": [],
// A (static) JSON filter to filter the objects by
// optional
"Filter": {},
// Only use object related to the user calling the API
// optional
"Scope": {
// Return only objects where the current user is assign, or where
// a user under my role is assigned
// default - Current
"User": "Current" | "UnderMyRole" | "All",
// Return only object that the Account is assigned to the current user
"Account": "Assigned" | "All",
}
}
]
}
]