# Get Send Statistics Data - GetUSMSSendStatistics

## Overview

Obtain Sending Statistics Data






## Definition

### Public Parameters

| Parameter Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **Action**     | string  | Corresponding API command name, the current API is `GetUSMSSendStatistics`.                      | **Yes** |
| **PublicKey**  | string  | The user's public key can be obtained from [Console](https://console.scloudsg.com/uaccount/api_manage)                                             | **Yes** |
| **Signature**  | string  | User signature generated based on public key and API command, see [Signature Algorithm](/docs/api/summary/signature.md)  | **Yes** |

### Request Parameters

| Parameter Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **ProjectId** | string | Project ID, if not filled in, the default project will be used. Sub-accounts must fill in. Please refer to the [GetProjectList interface](/docs/api/summary/get_project_list).<br /> |**Yes**|
| **Page** | int | Page number, starting from 0 |**Yes**|
| **NumPerPage** | int | Number of records per page |**Yes**|
| **OrderBy** | string | Sort field, such as BrevityCode means sorting by BrevityCode, used in conjunction with OrderType. Currently supports SendDate, BrevityCode. |**Yes**|
| **OrderType** | string | Sorting method, asc - ascending order desc - descending order |**Yes**|
| **StartDate** | string | Start date, format is YYYY-MM-DD |**Yes**|
| **EndDate** | string | End date, format is YYYY-MM-DD |**Yes**|
| **Domestic** | int | Domestic tag, 0-International SMS 1-Domestic SMS |**Yes**|
| **BrevityCode** | string | International short codes, such as 'CN' represents China. When querying multiple countries, use '-' to separate, such as 'CN-ID'. |No|
| **Purpose** | int | Message type, 1-Verification Code 2-Notification 3-Marketing |No|

### Response Field

| Field Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **RetCode** | int | Return status code. If it is 0, it means successful return. If it is not 0, it means failure. |**Yes**|
| **Action** | string | Operation command name. |**Yes**|
| **Message** | string | Returns an error message, providing detailed description when `RetCode` is non-zero. |No|
| **Total** | int | Return Record Count |No|
| **StatisticsData** | [*StatisticsData*](#statisticsdata) | The sum set of sending data statistics that meet the query conditions, see the StatisticsData model for specific field information. |No|
| **Data** | array[[*StatisticsDataInfo*](#statisticsdatainfo)] | The collection of send data statistics based on the day as the statistical dimension, the statistical data fields of each day are detailed in the StatisticsDataInfo model. |No|

#### Data Model


#### StatisticsData

| Field Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **UnknownCount** | int | Unknown Status Quantity (Number of Submissions) |**Yes**|
| **SuccessCount** | int | Number of Successful Sendings (Submission Count) |**Yes**|
| **SendCostCount** | int | Total Sent (Split Count) |**Yes**|
| **FailCount** | int | Number of Failed Sendings (Submission Count) |**Yes**|
| **SendCount** | int | Total Sent (Number of Submissions) |**Yes**|
| **SuccessCostCount** | int | Number of Successful Sends (Split Counts) |**Yes**|
| **FailCostCount** | int | Number of Failed Sends (Split Count) |**Yes**|
| **UnknownCostCount** | int | Unknown Status Quantity (Split Count) |**Yes**|
| **SubmitFailCount** | int | Submission Failure Count (Number of Submissions) |**Yes**|
| **SubmitFailCostCount** | int | Submission Failure Count (Split Count) |**Yes**|

#### StatisticsDataInfo

| Field Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **Count** | int | Total Sent (Number of Submissions) |**Yes**|
| **FailedCostCount** | int | Number of Failed Sends (Split Count) |**Yes**|
| **BrevityCode** | string | International/Regional Identification Code |**Yes**|
| **CostCount** | int | Total Sent (Split Count) |**Yes**|
| **SendDate** | string | Send Time |**Yes**|
| **FailedCount** | int | Number of Failed Sendings (Submission Count) |**Yes**|
| **SuccessRate** | float | Send Success Rate |**Yes**|
| **SuccessCount** | int | Number of Successful Sendings (Submission Count) |**Yes**|
| **UnknownCount** | int | Unknown Status Quantity (Number of Submissions) |**Yes**|
| **SuccessCostCount** | int | Number of Successful Sends (Split Counts) |**Yes**|
| **UnknownCostCount** | int | Unknown Status Quantity (Split Count) |**Yes**|
| **UserId** | string | UserId |**Yes**|
| **SubmitFailedCount** | int | Submission Failure Count (Number of Submissions) |**Yes**|
| **SubmitFailedCostCount** | int | Submission Failure Count (Split Count) |**Yes**|

## Example

### Request Example
    
```
https://api.scloudsg.com/?Action=GetUSMSSendStatistics
&Region=cn-zj
&Zone=cn-zj-01
&Page=2
&NumPerPage=2
&Order=GwQuSnMR
&StartDate=yPETXquo
&EndDate=vkmOkLMy
&Domestic=2
&BrevityCode=hwYqXpyR
&Purpose=9
&OrderType=ghVSXsjL
&Download=1
&Removed=5
&ProjectId=TfFeiEbC
```

### Response Example
    
```json
{
  "Action": "GetUSMSSendStatisticsResponse",
  "Data": [
    {
      "BrevityCode": "soqoREYM",
      "CostCount": 8,
      "Count": 4,
      "FailedCostCount": 4,
      "FailedCount": 5,
      "SendDate": "psXUJfzi",
      "SuccessCostCount": "TYVTPEdC",
      "SuccessCount": 7,
      "SuccessRate": 6.23654,
      "UnknownCostCount": "MvPkzmxR",
      "UnknownCount": "XebrtyfY"
    }
  ],
  "Message": "EXorXtNv",
  "RetCode": 0,
  "StatisticsData": {},
  "Total": 9
}
```