batches_statistics
Creates, updates, deletes, gets or lists a batches_statistics resource.
Overview​
| Name | batches_statistics |
| Type | Resource |
| Id | ovh.sms.batches_statistics |
Fields​
The following fields are returned by SELECT queries:
- get
successful operation
| Name | Datatype | Description |
|---|---|---|
id | string (uuid) | Batch ID |
credits | number | The cost of the batch in credits, computed during batch processing |
delivered | integer | Number of SMS that are delivered |
estimated_credits | number | The estimated cost of the batch in credits, computed before batch processing (wire: estimatedCredits) |
failed | integer | Number of SMS in error |
pending | integer | Number of SMS that are in pending status |
sent | integer | Number of SMS that are sent to the broker |
stoplisted | integer | Number of SMS that received a STOP by the receiver |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | id, service_name | Returns the batch statistics: delivered, sent, pending, failed and stoplisted SMS, and the credits used. |
Parameters​
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
api_host | string | The OVHcloud API host. Selected by OVH_ENDPOINT (ovh-eu, ovh-ca or ovh-us; default ovh-eu). (default: api.eu.ovhcloud.com, x-stackQL-envVarSelector: {"envVar":"OVH_ENDPOINT","default":"ovh-eu","values":{"ovh-eu":"api.eu.ovhcloud.com","ovh-ca":"api.ca.ovhcloud.com","ovh-us":"api.us.ovhcloud.com"}}) |
id | string (uuid) | Id |
service_name | string | The internal name of your SMS offer (wire: serviceName) |
SELECT examples​
- get
Returns the batch statistics: delivered, sent, pending, failed and stoplisted SMS, and the credits used.
SELECT
id,
credits,
delivered,
estimated_credits,
failed,
pending,
sent,
stoplisted
FROM ovh.sms.batches_statistics
WHERE id = '{{ id }}' -- required
AND service_name = '{{ service_name }}' -- required
;