github.com/grokify/go-ringcentral-client@v0.3.31/engagedigital/v1/client/docs/EventsApi.md (about)

     1  # \EventsApi
     2  
     3  All URIs are relative to *https://DOMAIN.api.engagement.dimelo.com/1.0*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**GetAllEvents**](EventsApi.md#GetAllEvents) | **Get** /events | Getting all events
     8  [**GetEvent**](EventsApi.md#GetEvent) | **Get** /events/{eventId} | Getting an event from its id
     9  
    10  
    11  
    12  ## GetAllEvents
    13  
    14  > GetAllEventsResponse GetAllEvents(ctx, optional)
    15  Getting all events
    16  
    17  This method renders events ordered by creation date (descending).  Authorization​: Only users whose role can search event permission.
    18  
    19  ### Required Parameters
    20  
    21  
    22  Name | Type | Description  | Notes
    23  ------------- | ------------- | ------------- | -------------
    24  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    25   **optional** | ***GetAllEventsOpts** | optional parameters | nil if no parameters
    26  
    27  ### Optional Parameters
    28  
    29  Optional parameters are passed through a pointer to a GetAllEventsOpts struct
    30  
    31  
    32  Name | Type | Description  | Notes
    33  ------------- | ------------- | ------------- | -------------
    34   **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. | 
    35   **offset** | **optional.Int32**| The record index to start. Default value is 0. | 
    36   **limit** | **optional.Int32**| The max number of records to return. Default value is 30, max value is 150. | 
    37  
    38  ### Return type
    39  
    40  [**GetAllEventsResponse**](GetAllEventsResponse.md)
    41  
    42  ### Authorization
    43  
    44  No authorization required
    45  
    46  ### HTTP request headers
    47  
    48  - **Content-Type**: Not defined
    49  - **Accept**: application/json
    50  
    51  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    52  [[Back to Model list]](../README.md#documentation-for-models)
    53  [[Back to README]](../README.md)
    54  
    55  
    56  ## GetEvent
    57  
    58  > Event GetEvent(ctx, eventId)
    59  Getting an event from its id
    60  
    61  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.
    62  
    63  ### Required Parameters
    64  
    65  
    66  Name | Type | Description  | Notes
    67  ------------- | ------------- | ------------- | -------------
    68  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    69  **eventId** | **string**|  | 
    70  
    71  ### Return type
    72  
    73  [**Event**](Event.md)
    74  
    75  ### Authorization
    76  
    77  No authorization required
    78  
    79  ### HTTP request headers
    80  
    81  - **Content-Type**: Not defined
    82  - **Accept**: application/json
    83  
    84  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    85  [[Back to Model list]](../README.md#documentation-for-models)
    86  [[Back to README]](../README.md)
    87