Get Account Metrics

get

https://s3partnerapi-staging.solutran.com/2.2/accounts/{id}/metrics

Retrieves account metrics for the specified account
The ID parameter handling depends on the ID-Type header: if set to 'Client', the ID is treated as a ClientAccountId; otherwise, it's treated as a server/internal ID.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

The account identifier (client or server ID).

Query Params

AccountId

int64

required

The unique account identifier for which to retrieve metric data.
This field is required for all metric searches.

ProgramId

string

The program identifier.

StartDate

string

required

The start date for the metric data range in YYYY-MM-DD format.
This field is required and must be a valid date format.

EndDate

string

required

The end date for the metric data range in YYYY-MM-DD format.
This field is required and must be a valid date format.

DefaultSort

string

The default sorting criteria for metric searches, ordered by datetime.

Type

string

required

The activity type(s) to include in the metric search. Supports comma-separated values for multiple types.
This field is required and must contain valid activity types as defined by the search extension.
Valid types are validated against the ExtendableResources list.

SearchCriteria

string

Generates a query string representation of the search criteria.
Currently implemented as a get-only property that returns the default implementation.

PartnerId

string

Optional partner identifier for the request context.

Include

string

A comma-separated list of related resources to include in the response. Not used for balance inquiry endpoint.

Allowed values for this resource: savings. Multiple values can be comma-separated.

Path

string

The API endpoint path for the current request.
Used internally for request tracking and logging purposes.

TotalCount

int32

The total number of records available for the search criteria.
May be hidden from serialization based on HideTotals setting.

Size

int32

The actual number of records returned in the current response.

Offset

int32

The starting position (zero-based) for the current page of results.

Limit

int32

The maximum number of records to return per page.
Default value is 100 records.

Sort

string

The sorting criteria for the current request.
Used internally for query processing and not included in JSON serialization.

MoreExist

boolean

Indicates whether more results exist beyond the current page.
Automatically calculated based on TotalCount, Limit, and Offset unless explicitly overridden.

HideTotals

boolean

Controls whether total count information should be hidden from the response.
Used internally for performance optimization when total counts are expensive to calculate.

SummaryData

string

Additional summary data that can be included with the response.
Used for aggregated information or custom metadata specific to the search results.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

204

No Content

200OK

400Bad Request

401Unauthorized

403Forbidden

422Unprocessable Content