/reports/data/table

post

https://api.mixmax.com/v1/reports/data/table

Queries messages and meetings. If you're looking to query for any analytics in Mixmax, this is likely the API you want.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

type

string

required

Defaults to (none)

Eg meetings, messages, sequences

groupBy

string

How to group the results. If type is 'messages', this can be one of: delegator, customerDomain, message, recipient, emailsByDomain, sender (default), senderGroup, time, template. If type is 'meetings', this can be one of: groupmember (default), teammate, group.

query

string

Defaults to (return all messages)

Query to run, eg "sent:last30days from:everyone". See above note about where to discover more about our query language..

fields

string

Defaults to (return all fields)

Comma-delimited list of fields to fetch, eg "delivered,opened"

limit

int32

Defaults to 1000

Maximum number of fields to return. Limited to 10,000.

offset

int32

Defaults to 0

Offset for paging. To fetch the first page: limit=50, offset=0. The second page can be fetched via: limit=50, offset=50.

sortBy

string

Defaults to sent (when type=messages), start (when type=meetings)

The field to sort by.

sortDesc

boolean

Defaults to true

timezone

string

Defaults to UTC

When understanding times, eg if you pass query=date:last30days, use this timezone.

Response

Language

Credentials

Header

Loading…

Response

Choose an example:

application/json

200200