# ArtikCloud::MessagesApi

All URIs are relative to *https://api.artik.cloud/v1.1*

Method | HTTP request | Description
------------- | ------------- | -------------
[**get_aggregates_histogram**](MessagesApi.md#get_aggregates_histogram) | **GET** /messages/analytics/histogram | Get Histogram aggregates
[**get_field_presence**](MessagesApi.md#get_field_presence) | **GET** /messages/presence | Get normalized message presence
[**get_last_normalized_messages**](MessagesApi.md#get_last_normalized_messages) | **GET** /messages/last | Get Last Normalized Message
[**get_message_aggregates**](MessagesApi.md#get_message_aggregates) | **GET** /messages/analytics/aggregates | Get Normalized Message Aggregates
[**get_normalized_messages**](MessagesApi.md#get_normalized_messages) | **GET** /messages | Get Normalized Messages
[**send_message_action**](MessagesApi.md#send_message_action) | **POST** /messages | Send Message Action


# **get_aggregates_histogram**
> AggregatesHistogramResponse get_aggregates_histogram(start_date, end_date, opts)

Get Histogram aggregates

Get Histogram on normalized messages.

### Example
```ruby
# load the gem
require 'artikcloud'
# setup authorization 
ArtikCloud.configure do |config|
  # Configure OAuth2 access token for authorization: artikcloud_oauth
  config.access_token = 'YOUR ACCESS TOKEN'
end

api_instance = ArtikCloud::MessagesApi.new

start_date = 789 # Integer | Timestamp of earliest message (in milliseconds since epoch).

end_date = 789 # Integer | Timestamp of latest message (in milliseconds since epoch).

opts = { 
  sdid: "sdid_example", # String | Source device ID of the messages being searched.
  field: "field_example", # String | Message field being queried for building histogram.
  interval: "interval_example" # String | Interval of time for building histogram blocks. (Valid values: minute, hour, day, month, year)
}

begin
  #Get Histogram aggregates
  result = api_instance.get_aggregates_histogram(start_date, end_date, opts)
  p result
rescue ArtikCloud::ApiError => e
  puts "Exception when calling MessagesApi->get_aggregates_histogram: #{e}"
end
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **start_date** | **Integer**| Timestamp of earliest message (in milliseconds since epoch). | 
 **end_date** | **Integer**| Timestamp of latest message (in milliseconds since epoch). | 
 **sdid** | **String**| Source device ID of the messages being searched. | [optional] 
 **field** | **String**| Message field being queried for building histogram. | [optional] 
 **interval** | **String**| Interval of time for building histogram blocks. (Valid values: minute, hour, day, month, year) | [optional] 

### Return type

[**AggregatesHistogramResponse**](AggregatesHistogramResponse.md)

### Authorization

[artikcloud_oauth](../README.md#artikcloud_oauth)

### HTTP reuqest headers

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



# **get_field_presence**
> FieldPresenceEnvelope get_field_presence(start_date, end_date, interval, opts)

Get normalized message presence

Get normalized message presence.

### Example
```ruby
# load the gem
require 'artikcloud'
# setup authorization 
ArtikCloud.configure do |config|
  # Configure OAuth2 access token for authorization: artikcloud_oauth
  config.access_token = 'YOUR ACCESS TOKEN'
end

api_instance = ArtikCloud::MessagesApi.new

start_date = 789 # Integer | startDate

end_date = 789 # Integer | endDate

interval = "interval_example" # String | String representing grouping interval. One of: 'minute' (1 hour limit), 'hour' (1 day limit), 'day' (31 days limit), 'month' (1 year limit), or 'year' (10 years limit).

opts = { 
  sdid: "sdid_example", # String | Source device ID of the messages being searched.
  field_presence: "field_presence_example" # String | String representing a field from the specified device ID.
}

begin
  #Get normalized message presence
  result = api_instance.get_field_presence(start_date, end_date, interval, opts)
  p result
rescue ArtikCloud::ApiError => e
  puts "Exception when calling MessagesApi->get_field_presence: #{e}"
end
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **start_date** | **Integer**| startDate | 
 **end_date** | **Integer**| endDate | 
 **interval** | **String**| String representing grouping interval. One of: 'minute' (1 hour limit), 'hour' (1 day limit), 'day' (31 days limit), 'month' (1 year limit), or 'year' (10 years limit). | 
 **sdid** | **String**| Source device ID of the messages being searched. | [optional] 
 **field_presence** | **String**| String representing a field from the specified device ID. | [optional] 

### Return type

[**FieldPresenceEnvelope**](FieldPresenceEnvelope.md)

### Authorization

[artikcloud_oauth](../README.md#artikcloud_oauth)

### HTTP reuqest headers

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



# **get_last_normalized_messages**
> NormalizedMessagesEnvelope get_last_normalized_messages(opts)

Get Last Normalized Message

Get last messages normalized.

### Example
```ruby
# load the gem
require 'artikcloud'
# setup authorization 
ArtikCloud.configure do |config|
  # Configure OAuth2 access token for authorization: artikcloud_oauth
  config.access_token = 'YOUR ACCESS TOKEN'
end

api_instance = ArtikCloud::MessagesApi.new

opts = { 
  count: 56, # Integer | Number of items to return per query.
  sdids: "sdids_example", # String | Comma separated list of source device IDs (minimum: 1).
  field_presence: "field_presence_example" # String | String representing a field from the specified device ID.
}

begin
  #Get Last Normalized Message
  result = api_instance.get_last_normalized_messages(opts)
  p result
rescue ArtikCloud::ApiError => e
  puts "Exception when calling MessagesApi->get_last_normalized_messages: #{e}"
end
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **count** | **Integer**| Number of items to return per query. | [optional] 
 **sdids** | **String**| Comma separated list of source device IDs (minimum: 1). | [optional] 
 **field_presence** | **String**| String representing a field from the specified device ID. | [optional] 

### Return type

[**NormalizedMessagesEnvelope**](NormalizedMessagesEnvelope.md)

### Authorization

[artikcloud_oauth](../README.md#artikcloud_oauth)

### HTTP reuqest headers

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



# **get_message_aggregates**
> AggregatesResponse get_message_aggregates(sdid, field, start_date, end_date)

Get Normalized Message Aggregates

Get Aggregates on normalized messages.

### Example
```ruby
# load the gem
require 'artikcloud'
# setup authorization 
ArtikCloud.configure do |config|
  # Configure OAuth2 access token for authorization: artikcloud_oauth
  config.access_token = 'YOUR ACCESS TOKEN'
end

api_instance = ArtikCloud::MessagesApi.new

sdid = "sdid_example" # String | Source device ID of the messages being searched.

field = "field_example" # String | Message field being queried for aggregates.

start_date = 789 # Integer | Timestamp of earliest message (in milliseconds since epoch).

end_date = 789 # Integer | Timestamp of latest message (in milliseconds since epoch).


begin
  #Get Normalized Message Aggregates
  result = api_instance.get_message_aggregates(sdid, field, start_date, end_date)
  p result
rescue ArtikCloud::ApiError => e
  puts "Exception when calling MessagesApi->get_message_aggregates: #{e}"
end
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **sdid** | **String**| Source device ID of the messages being searched. | 
 **field** | **String**| Message field being queried for aggregates. | 
 **start_date** | **Integer**| Timestamp of earliest message (in milliseconds since epoch). | 
 **end_date** | **Integer**| Timestamp of latest message (in milliseconds since epoch). | 

### Return type

[**AggregatesResponse**](AggregatesResponse.md)

### Authorization

[artikcloud_oauth](../README.md#artikcloud_oauth)

### HTTP reuqest headers

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



# **get_normalized_messages**
> NormalizedMessagesEnvelope get_normalized_messages(opts)

Get Normalized Messages

Get the messages normalized

### Example
```ruby
# load the gem
require 'artikcloud'
# setup authorization 
ArtikCloud.configure do |config|
  # Configure OAuth2 access token for authorization: artikcloud_oauth
  config.access_token = 'YOUR ACCESS TOKEN'
end

api_instance = ArtikCloud::MessagesApi.new

opts = { 
  uid: "uid_example", # String | User ID. If not specified, assume that of the current authenticated user. If specified, it must be that of a user for which the current authenticated user has read access to.
  sdid: "sdid_example", # String | Source device ID of the messages being searched.
  mid: "mid_example", # String | The SAMI message ID being searched.
  field_presence: "field_presence_example", # String | String representing a field from the specified device ID.
  filter: "filter_example", # String | Filter.
  offset: "offset_example", # String | A string that represents the starting item, should be the value of 'next' field received in the last response. (required for pagination)
  count: 56, # Integer | count
  start_date: 789, # Integer | startDate
  end_date: 789, # Integer | endDate
  order: "order_example" # String | Desired sort order: 'asc' or 'desc'
}

begin
  #Get Normalized Messages
  result = api_instance.get_normalized_messages(opts)
  p result
rescue ArtikCloud::ApiError => e
  puts "Exception when calling MessagesApi->get_normalized_messages: #{e}"
end
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **uid** | **String**| User ID. If not specified, assume that of the current authenticated user. If specified, it must be that of a user for which the current authenticated user has read access to. | [optional] 
 **sdid** | **String**| Source device ID of the messages being searched. | [optional] 
 **mid** | **String**| The SAMI message ID being searched. | [optional] 
 **field_presence** | **String**| String representing a field from the specified device ID. | [optional] 
 **filter** | **String**| Filter. | [optional] 
 **offset** | **String**| A string that represents the starting item, should be the value of 'next' field received in the last response. (required for pagination) | [optional] 
 **count** | **Integer**| count | [optional] 
 **start_date** | **Integer**| startDate | [optional] 
 **end_date** | **Integer**| endDate | [optional] 
 **order** | **String**| Desired sort order: 'asc' or 'desc' | [optional] 

### Return type

[**NormalizedMessagesEnvelope**](NormalizedMessagesEnvelope.md)

### Authorization

[artikcloud_oauth](../README.md#artikcloud_oauth)

### HTTP reuqest headers

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



# **send_message_action**
> MessageIDEnvelope send_message_action(data)

Send Message Action

Send a message or an Action:<br/><table><tr><th>Combination</th><th>Parameters</th><th>Description</th></tr><tr><td>Send Message</td><td>sdid, type=message</td><td>Send a message from a Source Device</td></tr><tr><td>Send Action</td><td>ddid, type=action</td><td>Send an action to a Destination Device</td></tr><tr><td>Common</td><td>data, ts, token</td><td>Parameters that can be used with the above combinations.</td></tr></table>

### Example
```ruby
# load the gem
require 'artikcloud'
# setup authorization 
ArtikCloud.configure do |config|
  # Configure OAuth2 access token for authorization: artikcloud_oauth
  config.access_token = 'YOUR ACCESS TOKEN'
end

api_instance = ArtikCloud::MessagesApi.new

data = ArtikCloud::MessageAction.new # MessageAction | Message or Action object that is passed in the body


begin
  #Send Message Action
  result = api_instance.send_message_action(data)
  p result
rescue ArtikCloud::ApiError => e
  puts "Exception when calling MessagesApi->send_message_action: #{e}"
end
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **data** | [**MessageAction**](MessageAction.md)| Message or Action object that is passed in the body | 

### Return type

[**MessageIDEnvelope**](MessageIDEnvelope.md)

### Authorization

[artikcloud_oauth](../README.md#artikcloud_oauth)

### HTTP reuqest headers

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