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

     1  # \ReportingApi
     2  
     3  All URIs are relative to *https://platform.devtest.ringcentral.com*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**LoadReportingSettings**](ReportingApi.md#LoadReportingSettings) | **Get** /restapi/v1.0/account/{accountId}/extension/{extensionId}/reporting/settings | Get Reporting Settings
     8  [**UpdateReportingSettings**](ReportingApi.md#UpdateReportingSettings) | **Put** /restapi/v1.0/account/{accountId}/extension/{extensionId}/reporting/settings | Update Reporting Settings
     9  
    10  
    11  # **LoadReportingSettings**
    12  > ReportingSettings LoadReportingSettings(ctx, accountId, extensionId)
    13  Get Reporting Settings
    14  
    15  <p style='font-style:italic;'>Since 1.0.17 (Release 7.2)</p><p>Returns user-defined configuration of CFA (Customer Facing Analytics) reports.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadAccounts</td><td>Viewing user account info (including name, business name, address and phone number/account number)</td></tr></tbody></table><h4>API Group</h4><p>Light</p>
    16  
    17  ### Required Parameters
    18  
    19  Name | Type | Description  | Notes
    20  ------------- | ------------- | ------------- | -------------
    21   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    22    **accountId** | **string**| Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session | [default to ~]
    23    **extensionId** | **string**| Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session | [default to ~]
    24  
    25  ### Return type
    26  
    27  [**ReportingSettings**](ReportingSettings.md)
    28  
    29  ### Authorization
    30  
    31  [OAuth2](../README.md#OAuth2)
    32  
    33  ### HTTP request headers
    34  
    35   - **Content-Type**: Not defined
    36   - **Accept**: application/json
    37  
    38  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
    39  
    40  # **UpdateReportingSettings**
    41  > ReportingSettings UpdateReportingSettings(ctx, accountId, extensionId, setReportingSettingsRequest)
    42  Update Reporting Settings
    43  
    44  <p style='font-style:italic;'></p><p>Sets user-defined configuration of CFA (Customer Facing Analytics) reports.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>EditAccounts</td><td>Viewing and updating user account info (including name, business name, address and phone number/account number)</td></tr></tbody></table><h4>API Group</h4><p>Light</p>
    45  
    46  ### Required Parameters
    47  
    48  Name | Type | Description  | Notes
    49  ------------- | ------------- | ------------- | -------------
    50   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    51    **accountId** | **string**| Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session | [default to ~]
    52    **extensionId** | **string**| Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session | [default to ~]
    53    **setReportingSettingsRequest** | [**SetReportingSettingsRequest**](SetReportingSettingsRequest.md)| JSON body | 
    54  
    55  ### Return type
    56  
    57  [**ReportingSettings**](ReportingSettings.md)
    58  
    59  ### Authorization
    60  
    61  [OAuth2](../README.md#OAuth2)
    62  
    63  ### HTTP request headers
    64  
    65   - **Content-Type**: application/json
    66   - **Accept**: application/json
    67  
    68  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
    69