martech
report

List all reports

Changed on
get/martech/{connection_id}/report

Request

  • Base URL: https://api.unified.to
  • URL: https://api.unified.to/martech/{connection_id}/report
  • Auth: API key in header authorization

Path parameters

connection_idstring required

ID of the connection

Query parameters

limitnumber
offsetnumber
updated_gtestring

Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

sortstring
orderstring
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[]

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

Response

Successful

idstring

Unique identifier for the campaign report

start_atstring date-time

Start time (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

end_atstring date-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_atstring date-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_atstring date-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_atstring date-time

Last click timestamp (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

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

rawobject

Raw data from integration

Changes

  • 39502239a975Revision changes
    • info

      added the enum value metadata to the property items/ of the query request parameter fields

    • info

      added the optional property / to the response with the status

  • a29ffd62ac71Revision changes
    • breaking

      the response's body type changed from no type to array for status