search_criteria |
Required? |
Explanation |
domain= |
Optional |
Limits the list where the domain attribute matches the string expression. The string may include wild characters ('*'). Since domains contain an embedded dot ("."), the period must be explicitly expressed in the search string. For example, 'edu.byu' will limit the search to a specific domain, 'edu.*' will limit the search to all 'edu' domains, and '*.byu*' will limit the search to any domain that starts with 'byu' in the first part of the domain. |
entity=
|
Optional |
Limits the list where the entity attribute matches the string expression. The string may include wild characters ('*'). |
event_date= |
Optional |
Defines a data range for the search. The expected parameter should be of the format '(start_date, end_date)'. The dates should be standard ISO format. |
event_type= |
Optional |
Limits the list where the event_type attribute matches the string expression. The string may include wild characters ('*'). |
page_size |
Optional |
Defaults to 10. Maximum is 500. |
page_start |
Optional |
Defaults to 1. |
Note: When multiple parameters are provided, they are ANDed together. You are not allowed to provide two different instances of the same parameter in the same request. For example, you are not allowed to request '?endpoint=*hr.byu.edu*&endpoint=*fs.byu.edu' in an attempt to get all push client end point for the hr.byu.edu or the fs.byu.edu hosts. You would have to make two requests.
The return set is always from the most recent to the oldest. Within the same day, the collection is order by domain, entity, and event_type.
Example Invocations
{Base URL}/summaries?domain=edu.byu&entity=PRO&event_type=Address%20Changed
|
{Base URL}/summaries?domain=edu.byu&entity=PRO&page_size=50
|
{Base URL}/summaries?page_size=20&event_date=(2015-01-01,2015-01-01)
|
{Base URL}/summaries?page_size=200&domain=edu.byu&entity=PRO&event_type=Address%20Changed&event_date=(2013-01-15,2015-01-01)
|
{Base URL}/summaries?page_size=200&page_start=201&domain=edu.byu&entity=PRO&event_type=Address%20Changed&event_date=(2013-01-15,2015-01-01)
|