AccountStats
Lists the spend metric for the specified Ad Account.
Select
The cmdlet will use the Snapchat Ads API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the cmdlet.
- AccountId supports the following operators: =,IN; If specified, it will override the value of the AccountId connection property. Otherwise, if no value is specified, the cmdlet will try to get the first account from the list returned by the Accounts view.
- StartTime supports the following operator: =
- EndTime supports the following operator: =
- Granularity supports the following operator: =
SELECT * FROM AccountStats WHERE StartTime = '01/02/2019' AND EndTime = '10/14/2020'
SELECT * FROM AccountStats WHERE Granularity = 'LIFETIME' AND AccountId = '40b748fb-d16f-4b3a-8d63-a3547d01ba57'
Note: If a time window is not specified, the stats for the last seven days or the last 31 days will be returned based on the specified granularity.
Columns
| Name | Type | References | Description |
| AccountId | String | The Id of the entity to query. | |
| StartTime | Datetime | Scopes the retrieved data to data collected in the window of time between StartTime and EndTime. Must be expressed in whole hours. | |
| EndTime | Datetime | Scopes the retrieved data to data collected in the window of time between StartTime and EndTime. Must be expressed in whole hours. | |
| FinalizedDataEndTime | Datetime | This defines the time up until when reporting metrics are finalized. You can query for all metrics before this time including uniques and reach and they will have the final numbers. For any time after the FinalizedDataEndTime the metrics are still undergoing de-duplication and finalization and may change accordingly. | |
| IntervalStartTime | Datetime | Start time of the current interval. This applies only to Granularity DAY and HOUR. | |
| IntervalEndTime | Datetime | End time of the current interval. This applies only to Granularity DAY and HOUR. | |
| Granularity | String | Determines how granular the data points will be returned within the time range specified by StartTime and EndTime. For instance, when set to HOUR, you will be presented with a datapoint for each hour between StartTime and EndTime.
The allowed values are LIFETIME, TOTAL, DAY, HOUR. The default value is DAY. | |
| Spend | Decimal | Amount Spent. |
Pseudo-Columns
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description | |
| RetrieveSampleStats | Bool | Whether to return sample (fake) stats or not. |