Retrieves advanced analytics metrics based on the specified parameters. You can retrieve either daily or monthly metrics using the
Note: Daily metrics are calculated and updated every three hours, starting at 1 a.m. in UTC. Meanwhile, monthly metrics are calculated after the last day of the month.
The following table lists the parameters that this action supports.
Specifies a metric to retrieve, in accordance with the required and optional parameters. Acceptable values are the following:
Specifies the time range of the metric. Acceptable values are daily and monthly. For both daily and monthly metrics,
Specifies the start year of the metric's time range, in YYYY format.
Specifies the end year of the metric's time range, in YYYY format.
Specifies the start month of the metric's time range as an integer from 1 to 12, inclusive.
Specifies the end month of the metric's time range as an integer from 1 to 12, inclusive.
Specifies the number of results to return per page. Acceptable values range from 1 to 1,000, inclusive. (Default: 1,000)
Specifies a page token that indicates the starting index of a chunk of results to retrieve. If not specified, the index is set as 0.
Specifies by what groups to divide the metrics. Acceptable values are channel_type, custom_channel_type, and custom_message_type. These values are effective only when the
Specifies the start day of the metric's time range as an integer from 1 to 31, inclusive. This parameter should be specified in conjunction with the
Specifies the end day of the metric's time range as an integer from 1 to 31, inclusive. This parameter should be specified in conjunction with the
Determines whether to export the metric as a CSV file instead of including it in the response. If set to true, the response includes the URL to download the exported file. (Default: false)
If successful, this action returns a list of an advanced analytics data in the response body.
Note: If the number of custom channel types or custom message types exceeds 400, this action returns only
valueswhose custom_channel_type or custom_message_type has a value of null.
Also when the
export_as_csvparameter is set to true, the response body includes an URL for the file. Meanwhile, specifying
segmentsfor the other seven metrics may return an error.
metric_type is messages and
segments is channel_type, the values include information on which channel type the data belongs to.
The retrieved metric.
The array of one or more data types that are retrieved on the metrics.
The list of Advanced analytics data that match the specified parameters.
The value that can be used in the
In the case of an error, an error object is returned. A detailed list of error codes is available here.