AIairship
Reports

Custom events per group summary

Get a summary of custom event counts and values associated with the provided group_id. Includes all custom events from the time of the push up to current time.

get/api/reports/events/summary/pergroup/{group_id}

Request

Query parameters

variantinteger
Example:-1

Variant number (0 to 25), or -1 for control events.

pageinteger
Example:2

Identifies the desired page number. Defaults to 1. If page is given a negative or out of bounds value, the default value will be used.

page_sizeinteger
Example:20

Specifies how many results to return per page. Has a default value of 25 and a maximum value of 100.

Response

Returned on success, with the JSON representation of the events in the body of the response.

group_idstring uuid

The UUID representing a specific group push.

next_pagestring url

There might be more than one page of results for this listing. Follow this URL if it is present to the next batch of results. Will only be present if there are successive pages.

okboolean

Success.

prev_pagestring url

Link to the previous page, if available. Will only be present if there are preceding pages.

total_countinteger

Sum of all the count fields in the above array.

total_valueinteger

Sum of all the value fields in the above array.

variantinteger

Variant number (0 to 25) or -1 for control events.

Example response

{
  "events": [
    {
      "count": 4,
      "location": "custom",
      "name": "custom_event_name"
    }
  ],
  "total_count": 12
}

Changes

No recorded changes to this operation across all 9 revisions of this API.