Skip to content

Latest commit

 

History

History
87 lines (51 loc) · 3.25 KB

EventsApi.md

File metadata and controls

87 lines (51 loc) · 3.25 KB
Raw

\EventsApi

All URIs are relative to https://DOMAIN.api.engagement.dimelo.com/1.0

Method HTTP request Description
GetAllEvents Get /events Getting all events
GetEvent Get /events/{eventId} Getting an event from its id

GetAllEvents

GetAllEventsResponse GetAllEvents(ctx, optional) Getting all events

This method renders events ordered by creation date (descending). Authorization​: Only users whose role can search event permission.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
optional *GetAllEventsOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GetAllEventsOpts struct

Name Type Description Notes
q optional.String To filter events on given query. Query works exactly like threads query but only have those keywords: content, content_thread, name_in, created_before, created_after, user. Order can be created_at.desc (default) or created_at.asc. e.g. q=name_in:"content.replied"%20content_thread:"7f946431b6eebffafae642cc"%20created_after:"2014-03-20"%20user:"4ee91f197aa58d01b500000f"%20order:"created_at.asc" * DateTime parameters should be ISO-8601 * you can specify multiple value for a given keyword: q=name_in:’content.replied’&name_in:’content.ignored’ Please refer to ​Search & filtering parameters​ for more details.
offset optional.Int32 The record index to start. Default value is 0.
limit optional.Int32 The max number of records to return. Default value is 30, max value is 150.

Return type

GetAllEventsResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetEvent

Event GetEvent(ctx, eventId) Getting an event from its id

This method renders an event from given id. If token’s user role does not have “search event” permission a 404 HTTP response will be returned. Authorization​: Only users who’s role can search event permission.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
eventId string

Return type

Event

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]