github.com/twilio/twilio-go@v1.20.1/rest/supersim/v1/docs/UsageRecordsApi.md (about)

     1  # UsageRecordsApi
     2  
     3  All URIs are relative to *https://supersim.twilio.com*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**ListUsageRecord**](UsageRecordsApi.md#ListUsageRecord) | **Get** /v1/UsageRecords | 
     8  
     9  
    10  
    11  ## ListUsageRecord
    12  
    13  > []SupersimV1UsageRecord ListUsageRecord(ctx, optional)
    14  
    15  
    16  
    17  List UsageRecords
    18  
    19  ### Path Parameters
    20  
    21  This endpoint does not need any path parameter.
    22  
    23  ### Other Parameters
    24  
    25  Other parameters are passed through a pointer to a ListUsageRecordParams struct
    26  
    27  
    28  Name | Type | Description
    29  ------------- | ------------- | -------------
    30  **Sim** | **string** | SID or unique name of a Sim resource. Only show UsageRecords representing usage incurred by this Super SIM.
    31  **Fleet** | **string** | SID or unique name of a Fleet resource. Only show UsageRecords representing usage for Super SIMs belonging to this Fleet resource at the time the usage occurred.
    32  **Network** | **string** | SID of a Network resource. Only show UsageRecords representing usage on this network.
    33  **IsoCountry** | **string** | Alpha-2 ISO Country Code. Only show UsageRecords representing usage in this country.
    34  **Group** | **string** | Dimension over which to aggregate usage records. Can be: `sim`, `fleet`, `network`, `isoCountry`. Default is to not aggregate across any of these dimensions, UsageRecords will be aggregated into the time buckets described by the `Granularity` parameter.
    35  **Granularity** | **string** | Time-based grouping that UsageRecords should be aggregated by. Can be: `hour`, `day`, or `all`. Default is `all`. `all` returns one UsageRecord that describes the usage for the entire period.
    36  **StartTime** | **time.Time** | Only include usage that occurred at or after this time, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. Default is one month before the `end_time`.
    37  **EndTime** | **time.Time** | Only include usage that occurred before this time (exclusive), specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. Default is the current time.
    38  **PageSize** | **int** | How many resources to return in each list page. The default is 50, and the maximum is 1000.
    39  **Limit** | **int** | Max number of records to return.
    40  
    41  ### Return type
    42  
    43  [**[]SupersimV1UsageRecord**](SupersimV1UsageRecord.md)
    44  
    45  ### Authorization
    46  
    47  [accountSid_authToken](../README.md#accountSid_authToken)
    48  
    49  ### HTTP request headers
    50  
    51  - **Content-Type**: Not defined
    52  - **Accept**: application/json
    53  
    54  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    55  [[Back to Model list]](../README.md#documentation-for-models)
    56  [[Back to README]](../README.md)
    57