INinfomaniak
Campaigns

Subscribers activity

Changed on

Return statistics about subscribers for a campaign

get/1/newsletters/{domain}/campaigns/{campaign}/report/activity

Request

  • Base URL
    https://api.infomaniak.com
  • URL
    https://api.infomaniak.com/1/newsletters/{domain}/campaigns/{campaign}/report/activity
  • Auth
    none declared

Path parameters

domaininteger required

Unique identifier of the Domain

campaigninteger required

Unique identifier of the Campaign

Query parameters

order_bystring[] nullable
action'bounce' | 'click' | 'complaint' | 'not_open' | 'open' | 'sbounce' | 'unsub' nullable
searchstring
{
  "search": "johndoe"
}
return'total'

Optional : If you pass this parameter with the value total, then the response will be the number of items in the collection, instead of the items themselves.<br /> Part of the total capacity

pageinteger

Optional parameter that define the page number<br /> Part of the pagination capacity

per_pageinteger

Optional parameter that define the number of items per page<br /> Part of the pagination capacity

string
OR
string[]

Optional parameter that define the field used for sorting<br /> Part of the sort capacity

order'asc' | 'desc'

Optional parameter that define the default sort order<br /> Part of the sort capacity

order_forobject

Optional parameter that define the sorting order for a field<br /> By default order is used<br /> Part of the sort capacity

Response

OK

result'success' | 'error' | 'asynchronous' required

Result of the HTTP request

totalinteger

Total number of items Added when using query parameter page

pageinteger

Number of the current page Added when using query parameter page

pagesinteger

Total number of pages Added when using query parameter page

items_per_pageinteger

Number of items per page Added when using query parameter page

Example response

{
  "result": "success",
  "total": 221,
  "page": 2,
  "pages": 15,
  "items_per_page": 15
}

Changes

  • 96ca7c8a0545Revision changes
    • warning

      deleted the query request parameter order_by

    • info

      added the new optional query request parameter order_by

  • 0cd8a60951f5Revision changes
    • warning

      deleted the query request parameter order_by

    • info

      added the new optional query request parameter order_by