docs.litmus.comLitmus API Docs · Litmus

Litmus {"id":"5658ca695a9e990d004a5cce","name":"Litmus","subdomain":"litmus","versions":[{"version":"1","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"_id":"5658ca6a5a9e990d004a5cd1","releaseDate":"2015-11-27T21:26:02.346Z"}],"current_version":{"version_clean":"1.0.0","version":"1"},"oauth":{"enabled":false},"api":{"name":"","url":"","contenttype":"form","auth":"basic","explorer":true,"proxyEnabled":true,"jwt":false,"authextra":[],"headers":[],"object_definitions":[]},"apiAlt":[{"name":"Email Analytics","url":"https://analytics-api.litmus.com/api/v:version","contenttype":"json","auth":"basic","explorer":true,"proxyEnabled":true,"jwt":false,"authextra":[],"headers":[],"object_definitions":[],"_id":"565f2ff3413e06170093debc"},{"name":"Instant","url":"https://instant-api.litmus.com/v:version","contenttype":"json","auth":"token","explorer":true,"proxyEnabled":true,"jwt":false,"authextra":[{"key":"key","default":"","type":"ba_username","_id":"566856531fb5701900f893df"}],"headers":[],"object_definitions":[],"_id":"565ff34fb182df0d00d4e467"},{"name":"Previews","url":"https://previews-api.litmus.com/api/v:version","contenttype":"json","auth":"basic","explorer":true,"proxyEnabled":true,"jwt":false,"authextra":[],"headers":[],"object_definitions":[],"_id":"5666858b3360850d00336cf2"},{"name":"Spam","url":"https://api.litmus.com/v2","contenttype":"json","auth":"token","explorer":true,"proxyEnabled":true,"jwt":false,"authextra":[{"key":"oauth-token","default":"","type":"manual","_id":"57876dbdaff9b81900afc6a3"}],"headers":[{"key":"Authorization","value":"Bearer [[app:api-token]]","_id":"57876dbdaff9b81900afc6a4"}],"object_definitions":[],"_id":"57876c24bbe6c40e009f7324"},{"name":"V2","url":"https://api.litmus.com/v2","contenttype":"json","auth":"token","explorer":false,"proxyEnabled":true,"jwt":false,"authextra":[{"key":"Authorization","default":"Bearer XXXXXX","type":"header","_id":"5afecce47fb5ce0003e30c6a"},{"key":"Authorization","default":"Basic YYYYYYY","type":"header","_id":"5afecce47fb5ce0003e30c69"}],"headers":[],"object_definitions":[],"_id":"5afecbde7fb5ce0003e30c62"}],"plan_details":{"name":"Business","is_active":true,"cost":199,"versions":10000,"custom_domain":true,"custom_pages":true,"whitelabel":true,"errors":true,"password":true,"landing_page":true,"stylesheet":true,"javascript":true,"html":true,"extra_html":true,"admins":true},"intercom":"","intercom_secure_emailonly":false,"flags":{"allow_hub2":false,"hub2":false,"migrationRun":false,"oauth":false,"swagger":false,"correctnewlines":false,"speedyRender":false,"allowXFrame":false,"jwt":false,"hideGoogleAnalytics":false,"stripe":false,"disableDiscuss":false,"ssl":false,"autoSslGeneration":true,"newApiExplorer":false},"asset_base_url":""} Documentation Main Litmus API Docs Instant Instant API post Create an email get List supported email clients get List supported email client configurations get Request a preview get Directly request a preview image post Pre-request previews before download Identifying End Users Performance Email Analytics Email Analytics API post Creating a campaign post Get campaign meta data put Update a campaign put Activate a campaign Summary reports post Open counts reports (guid) post Open count reports (month) post Open count reports (range) post Advanced open counts report Engagement reports get Engagement report get Detailed engagement report get Group engagement report get Mail engagement report get Detailed mail engagement report Platform reports get Mail client usage report get Group usage report get Browser usage report get Rendering category report Activity reports get Activity summary report get Activity report Getting raw data put Request the data via email FTP / SFTP put Real-time callbacks Legacy Previews Legacy Previews API post Create test get Retrieve test get Testing applications get Result get Spam seed addresses get Link tests Using mobile results Index OAuth OAuth Integration Guide get Request user identity data get List a user's default email clients get Request a user-specific client configuration URL {"_id":"56668cadce8caf0d006018b4","excerpt":"","githubsync":"","next":{"description":"","pages":[]},"user":"5658ca325a9e990d004a5ccd","body":"[block:callout]\n{\n \"type\": \"danger\",\n \"body\": \"This documentation exists as a reference for customers and partners that have already been granted access to our API’s. New access to our API’s is currently on hold whilst we work to update them. If you have any questions please feel free to contact [ [email protected] ](mailto: [email protected] ).\"\n}\n[/block]\n# Overview\n\nLitmus APIs enable you to integrate industry-leading tools into your own products and applications. We offer solutions for both Email Previews and Email Analytics, so you or your customers can preview their email designs, and learn more about their subscriber base through powerful metrics.\n\nThe [Litmus Instant API](doc:instant-api) is the easiest and fastest way to get super speedy email client screenshots into your service. In fact, it's what Litmus uses to power its email client previews within Builder. If you haven't checked that out already, we'd recommend giving it a try to see the API in action.\n\nThe [Litmus Email Analytics API](doc:email-analytics) allows you to create new campaigns, generate HTML tracking code to insert into your outgoing emails, and the ability to access in-depth metrics detailing the ‘when,’ ‘where,’ and ‘how’ an email is opened.\n\nThe [Legacy Previews API](doc:legacy-previews) allows you to run email previews, spam tests, link-check tests, and perform code analysis.\n\n## REST Based\n\nThe latest version of all of our API's are REST based—this makes them easy to integrate no matter which technology you use! We have partners integrate with our APIs using C#, Visual Basic, PHP, Ruby, Python, Perl, and Java. \n\n## Status\n\nYou can check the status of the API and other services via our status page: https://status.litmus.com/.\n\n## Support\n\nHaving trouble implementing one of our API's? Don't see an example of something you want to do? Not sure if we support your language or platform? Have any other questions or problems? Our support engineers are experts at navigating all kinds of API related issues. Contact us at [ [email protected] ](mailto: [email protected] ).","category":"56668bca7cc81e0d00253f77","createdAt":"2015-12-08T07:54:21.004Z","order":0,"updates":[],"parentDoc":null,"version":"5658ca6a5a9e990d004a5cd1","hidden":false,"link_external":false,"link_url":"","isReference":false,"project":"5658ca695a9e990d004a5cce","slug":"litmus-api-documentation","sync_unique":"","title":"Litmus API Docs","__v":12,"api":{"url":"","auth":"required","params":[],"results":{"codes":[]},"settings":""},"type":"basic","metadata":{"title":"","description":"","image":[]},"childrenPages":[]} Litmus API Docs [block:callout] { "type": "danger", "body": "This documentation exists as a reference for customers and partners that have already been granted access to our API’s. New access to our API’s is currently on hold whilst we work to update them. If you have any questions please feel free to contact [ [email protected] ](mailto: [email protected] )." } [/block] # Overview Litmus APIs enable you to integrate industry-leading tools into your own products and applications. We offer solutions for both Email Previews and Email Analytics, so you or your customers can preview their email designs, and learn more about their subscriber base through powerful metrics. The [Litmus Instant API](doc:instant-api) is the easiest and fastest way to get super speedy email client screenshots into your service. In fact, it's what Litmus uses to power its email client previews within Builder. If you haven't checked that out already, we'd recommend giving it a try to see the API in action. The [Litmus Email Analytics API](doc:email-analytics) allows you to create new campaigns, genera...