List all reports

Updated:

GET/martech/{connection_id}/report

Returns a list of MarketingReports. Narrow the results with the query parameters before paging, then page through them with limit and offset (the default and maximum page size depend on the integration). Use fields to return only the fields you need and reduce the response size. When the integration supports a total count, it is returned in the X-Total-Count response header. Use each item's id to retrieve, update, or delete it where those operations are supported.

Parameters

limitnumber default=100
offsetnumber default=0
updated_gtedate-time
Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
sort enum
order enum
querystring
Query string to search. eg. email address or name
campaign_idstring
The campaign ID to filter by
list_idstring
The list ID to filter by
start_gtestring
The start date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
end_ltstring
The end date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
fieldsstring array
Fields to return
rawstring
Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar
connection_idstring required
ID of the connection

Returns

idstring
Unique identifier for the campaign report
start_atdate-time
Start time (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
end_atdate-time
End time (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
campaign_idstring
Associated campaign ID
list_idstring
Associated list ID
emails_sentnumber
Total emails sent
abuse_reportsnumber
Number of abuse reports
unsubscribednumber
Number of unsubscribes
sent_atdate-time
Send time (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
hard_bouncesnumber
Hard bounce count
soft_bouncesnumber
Soft bounce count
syntax_errorsnumber
Syntax error count
forwards_countnumber
Forward count
forwards_opensnumber
Forwards opened
opens_totalnumber
Total opens
unique_opensnumber
Unique opens
open_ratenumber
Open rate (decimal)
last_open_atdate-time
Last open timestamp (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
clicks_totalnumber
Total clicks
unique_clicksnumber
Unique clicks
unique_subscriber_clicksnumber
Unique subscriber clicks
click_ratenumber
Click rate (decimal)
last_click_atdate-time
Last click timestamp (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
links array
URL-specific click data
human_opens_totalnumber
Total opens excluding automated/bot/proxy (e.g. Apple Mail Privacy Protection) opens
human_unique_opensnumber
Unique opens excluding automated/bot/proxy opens
human_open_ratenumber
Open rate (decimal) excluding automated/bot/proxy opens
metadata array

Errors

Errors return the HTTP status code and a JSON body with statusCode, error (the short label) and message (a human-readable detail).

{
  "statusCode": 429,
  "error": "Too Many Requests",
  "message": "Too many requests to unified.to API; max requests per minute: N"
}
StatusErrorMeaning
400Bad RequestThe request was malformed or failed validation.
401UnauthorizedThe connection is likely broken; re-authorize it.
403ForbiddenThe connection is missing permissions or scopes.
404Not FoundThe requested resource does not exist.
429Too Many RequestsRate limit exceeded (see the two sources below).
500Internal Server ErrorAn unexpected error occurred.
501Not ImplementedNot supported by this integration.

Errors from the underlying integration pass through: the integration's status comes back as ours (429, 401, 403, 404 or 5xx), usually with its message. When the integration's error body is unclear, Unified extracts what it can and returns a clearer message.

429 Too Many Requests

A 429 has two possible sources:

  • The integration's own rate limit, passed through.
  • Unified's workspace limit: a rolling 60 seconds, set by plan, with the message Too many requests to unified.to API; max requests per minute: N.
const options = {
  method: 'GET',
  url: 'https://api.unified.to/martech/5de520f96e439b002043d8dc/report',
  headers: {
    authorization: 'bearer .....'
  },
  params: {
    limit: 50,
    offset: 0,
    updated_gte: '2026-01-01T00:00:00.000Z',
    sort: 'updated_at',
    order: 'asc',
    query: '',
    campaign_id: '',
    list_id: '',
    start_gte: '',
    end_lt: '',
    fields: '',
    raw: '',
  }
};

const results = await axios.request(options);
Are we missing anything? Let us know
Was this page helpful?