Qodex.ai

Return all your created email campaigns

GET {{baseUrl}}/emailCampaigns?type=classic&status=archive&startDate=veniam elit in&endDate=veniam elit in&limit=50&offset=0&sort=desc

Request Params

KeyDatatypeRequiredDescription
typestringFilter on the type of the campaigns
statusstringFilter on the status of the campaign
startDatestringMandatory if endDate is used. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent email campaigns.
Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' )
endDatestringMandatory if startDate is used. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent email campaigns.
Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' )
limitnumberNumber of documents per page
offsetnumberIndex of the first document in the page
sortstringSort the results in the ascending/descending order of record creation. Default order is descending if sort is not passed

HEADERS

KeyDatatypeRequiredDescription
Acceptstring

RESPONSES

status: OK

{"count":2,"campaigns":[{"id":12,"name":"EN - Sales Summer 2017","subject":"20% OFF for 2017 Summer Sales","type":"classic","status":"sent","scheduledAt":"2017-06-01T12:30:00.000Z","testSent":true,"header":"[DEFAULT_HEADER]","footer":"[DEFAULT_FOOTER]","sender":{"email":"marketing@mycompany.com","name":"Marketing","id":26},"replyTo":"replyto@domain.com","toField":"{FNAME} {LNAME}","htmlContent":"This is my HTML Content","shareLink":"http://example.com/fhsgccc.html?t=9865448900","tag":"Newsletter","createdAt":"2017-05-01T12:30:00.000Z","modifiedAt":"2017-05-01T12:30:00.000Z","inlineImageActivation":true,"mirrorActive":true,"recurring":false,"recipients":{"lists":[5],"exclusionLists":[13]},"statistics":{"globalStats":{"uniqueClicks":2300,"clickers":2665,"complaints":1,"delivered":19765,"sent":19887,"softBounces":100,"hardBounces":87,"uniqueViews":7779,"trackableViews":5661,"trackableViewsRate":23.45,"estimatedViews":560,"unsubscriptions":2,"viewed":8999},"campaignStats":[{"listId":5,"uniqueClicks":2300,"clickers":2665,"complaints":1,"delivered":19765,"sent":19887,"softBounces":100,"hardBounces":87,"uniqueViews":7779,"trackableViews":5661,"unsubscriptions":2,"viewed":8999,"deferred":30}],"mirrorClick":120,"remaining":1000,"linksStats":{"http://myUrl1.domain.com":80},"statsByDomain":{"yahoo.com":{"uniqueClicks":298,"clickers":533,"complaints":0,"sent":25601,"softBounces":5,"hardBounces":0,"uniqueViews":3527,"unsubscriptions":17,"viewed":5255,"delivered":25596},"hotmail.co.uk":{"uniqueClicks":1970,"clickers":2720,"complaints":5,"sent":117055,"softBounces":111,"hardBounces":0,"uniqueViews":21111,"unsubscriptions":105,"viewed":35251,"delivered":117056}}}},{"id":22,"name":"Weekly - 1","subject":"Week 1 - Newsletter","type":"Classic","status":"draft","scheduledAt":"","testSent":false,"header":"[DEFAULT_HEADER]","footer":"[DEFAULT_FOOTER]","sender":{"email":"newsletter@mycompany.com","name":"Newsletter","id":26},"replyTo":"replyto@domain.com","toField":"{FNAME} {LNAME}","htmlContent":"This is my HTML Content","shareLink":"http://example.com/fhsgccc.html?t=9865448900","tag":"Newsletter","createdAt":"2017-05-01T12:30:00.000Z","modifiedAt":"2017-05-01T12:30:00.000Z","inlineImageActivation":true,"mirrorActive":true,"recurring":false,"recipients":{"lists":[10],"exclusionLists":[45]},"statistics":{"globalStats":{"uniqueClicks":2300,"clickers":2665,"complaints":1,"delivered":19765,"sent":19887,"softBounces":100,"hardBounces":87,"uniqueViews":7779,"trackableViews":5661,"trackableViewsRate":23.45,"estimatedViews":560,"unsubscriptions":2,"viewed":8999},"campaignStats":[{"listId":10,"uniqueClicks":2300,"clickers":2665,"complaints":1,"delivered":19765,"sent":19887,"softBounces":100,"hardBounces":87,"uniqueViews":7779,"trackableViews":5661,"unsubscriptions":2,"viewed":8999,"deferred":30}],"mirrorClick":120,"remaining":1000,"linksStats":{"http://myUrl1.domain.com":{"nbClick":80},"http://myUrl2.domain.com":{"nbClick":80},"http://myUrl3.domain.com":{"nbClick":80}},"statsByDomain":{"gmail":{"uniqueClicks":2300,"clickers":2665,"complaints":1,"delivered":19765,"sent":19887,"softBounces":100,"hardBounces":87,"uniqueViews":7779,"unsubscriptions":2,"viewed":8999,"deferred":30},"aol":{"uniqueClicks":2300,"clickers":2665,"complaints":1,"delivered":19765,"sent":19887,"softBounces":100,"hardBounces":87,"uniqueViews":7779,"unsubscriptions":2,"viewed":8999,"deferred":30}}}}]}