GET aggregated/summary/groups

clickmeter.com

Summary: Retrieve statistics about a subset of groups for a timeframe with groups data
Operation ID: Aggregated_GetGroupsSummary
Auth: unknown

Parameters (11)

favourite (boolean, query, optional)

Is the group marked as favourite

fromDay (string, query, optional)

If using a "custom" timeFrame you can specify the starting day (YYYYMMDD)

limit (integer, query, optional)

Limit results to this number

Constraints: {'minLength': 0, 'maxLength': 0}

offset (integer, query, optional)

Offset where to start from

Constraints: {'minLength': 0}

sortBy (string, query, optional)

Field to sort by

sortDirection (string, query, optional)

Direction of sort "asc" or "desc"

Constraints: {'enum': ['asc', 'desc']}

status (string, query, optional)

Status of group ("deleted"/"active")

Constraints: {'enum': ['deleted', 'active']}

tag (string, query, optional)

A comma separated list of tags you want to filter with.

textSearch (string, query, optional)

Filter fields by this pattern

timeFrame (string, query, required)

Timeframe of the request. See list at $timeframeList

Constraints: {'enum': ['today', 'yesterday', 'last7', 'last30', 'lastmonth', 'currentmonth', 'previousmonth', 'last90', 'last120', 'last180', 'last12months', 'lastyear', 'currentyear', 'beginning', 'custom']}

toDay (string, query, optional)

If using a "custom" timeFrame you can specify the ending day (YYYYMMDD)

No probe data for this endpoint yet.