Search Submitted Events
Search events submitted by your organization.
For example, you can use this to display a list of events submitted via Loop Links within your application to your users. See also the Events API documentation for more detail on many of the parameters mentioned below.
Request
HTTP Request
Query Parameters
Parameter | Description |
---|---|
| Full-text search of event information.
E.g. |
| Comma-separated list of link ids. Allows you to filter on events submitted via a specific Loop Link link id.
E.g. |
| Comma-separated list of event ids. Allows you to retrieve specific events.
E.g. |
| Comma-separated list of user ids that submitted events.
E.g. |
| Comma separated list of event states. Possible values:
|
| Comma separated list of event categories.
E.g. |
| Comma separated list of event labels.
E.g. |
| Comma separated list of country codes.
E.g. |
| The date from and/or to the event starts.
Must be used with suffixes |
| The date from and/or to the event ends.
Must be used with suffixes |
| The date from and/or to the event is active.
Must be used with suffixes |
| The date from and/or to the event has been created.
Must be used with suffixes |
| The date from and/or to the event has been updated.
Must be used with suffixes |
| Whether or not to include private events.
Rejected & pending submitted events will always be private.
Possible values:
|
| Filter for submitted events approved, rejected or yet to be treated by the related org.
Possible values: |
| Filter for submitted events approved, rejected or yet to be treated by PHQ.
Possible values: |
| Comma-separated list of sort options.
Prefix the field name with
E.g. |
| The maximum number of results to return. The default limit is |
| The number of results to skip. The default is |
Response
Response Fields
Field | Description |
---|---|
| Total number of results found. |
| List of results where each item is a Submitted Event. Please refer to the Submitted Event Response Fields section below for the structure of each record. |
Submitted Event Response Fields
Field | Description |
---|---|
| The unique identifier of the event.
E.g. |
| Loop Link ID that was used to submit this event. Will only be available on submissions that were made with a Loop Link. |
| The creation date time for the record in ISO 8601 format format.
E.g. |
| The last update date time for the record in ISO 8601 format format.
E.g. |
| Version number of the record. This number increments automatically every time the record is updated. |
| Current review status. All submissions go through a moderation process. This field refers to the PredictHQ moderators. Possible values:
|
| Current review status for customer-initiated reviews. Some organizations are able to review submissions before they're moderated by PredictHQ staff. Possible values:
|
| Indicates whether or not the record was automatically approved. Some organizations are able to have their submissions enter our automatic review process after a period of time with consistent high quality level of submissions. |
| The title of the event.
E.g. |
| A description of the event.
E.g. |
| |
| The publication state of the event. Please see Search Events for a list of possible states. |
| List of metadata associated with the event. E.g. |
| Event dates. E.g. |
| List of labels for the event. E.g. |
| Latitude for the event. E.g. |
| Longitude for the event.
E.g. |
| Address for the event.
E.g. |
| Full formatted address for the event. E.g. |
| City of the event. |
| Region of the event. |
| Postcode of the event. |
| Country code in ISO 3166-1 alpha-2 format. |
|
Examples
Guides
Below are some guides relevant to this API:
Last updated