This API allows you to create a new account alias. Successful alias creation will result in the API returning the ID of the new alias. Data is returned in the following formats: XML, JSON, CSV and Serialized
\n","auth":{"type":"apikey","apikey":{"value":"{{your-api-key-here}}","key":"This API allows you to update the information for an existing account alias. Data is returned in the following formats: XML, JSON, CSV and Serialized.
\n","auth":{"type":"apikey","apikey":{"value":"{{your-api-key-here}}","key":"(Required) The unique identifier of the alias account. Required if external_is blank.
\n","type":"text/plain"},"key":"id","value":"(Integer)"},{"disabled":true,"description":{"content":"(Required) The user's first name.
\n","type":"text/plain"},"key":"fistname","value":"(String)"},{"disabled":true,"description":{"content":"(Required) The user's last name.
\n","type":"text/plain"},"key":"lastname","value":"(String)"},{"disabled":true,"description":{"content":"(Required) The unique/valid email of the account alias.
\n","type":"text/plain"},"key":"email","value":"Valid Email"},{"disabled":true,"description":{"content":"The password for the account.
\n","type":"text/plain"},"key":"password","value":"(String)"},{"disabled":true,"description":{"content":"Force the user to reset their password on the first login.
\n","type":"text/plain"},"key":"forcepasswordreset","value":"(Boolean)"},{"disabled":true,"description":{"content":"Email login credentials to the user being created.
\n","type":"text/plain"},"key":"emailcredentials","value":"(Boolean)"}],"variable":[]}},"response":[{"id":"20824d50-c10b-4cb5-9764-79c3c450749c","name":"Update Alias","originalRequest":{"method":"PUT","header":[{"key":"X-API-KEY","value":"{{apikey}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"id\": 123,\n \"firstname\": \"First\",\n \"lastname\": \"Last\",\n \"email\": \"flast@company.com\",\n \"password\": \"(String)\",\n \"forcepasswordreset\": 1,\n \"emailcredentials\": 1\n}","options":{"raw":{"language":"json"}}},"url":"https://api.everest.validity.com/api/1.0/account/alias"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\"\n}"}],"_postman_id":"950e6f55-2c6e-4a3b-87cb-9619db294b01"},{"name":"Delete Alias","id":"4ce3b457-14d5-4dfe-8fad-a22b6c0d4500","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"body":{"mode":"raw","raw":"{\n \"id\": (integer)\n}","options":{"raw":{"language":"json"}}},"url":"https://api.everest.validity.com/api/1.0/account/alias","description":"This API allows you to delete an account alias by ID.
\n","auth":{"type":"apikey","apikey":{"value":"{{your-api-key-here}}","key":"This API call provides a broad overview of children account(s) including the email address, API key, enabled products, and the current/max usage of those products. Data is returned in the following formats: XML, JSON, CSV and Serialized.
\n","auth":{"type":"apikey","apikey":{"value":"{{your-api-key-here}}","key":"The unique identifier of the child account.
\n","type":"text/plain"},"key":"id","value":"(Integer)"},{"description":{"content":"The external identifier of the alias.
\n","type":"text/plain"},"key":"external_id","value":"(String)"},{"description":{"content":"Search for a partial match in the child account's name.
\n","type":"text/plain"},"key":"search","value":"(String)"}],"variable":[]}},"response":[{"id":"fe8840d4-874c-4aaa-9012-6698fe5aaf2b","name":"Get Child Account(s)","originalRequest":{"method":"GET","header":[{"key":"X-API-KEY","value":"{{apikey}}"}],"url":{"raw":"https://api.everest.validity.com/api/1.0/account/childaccount?id=2","host":["https://api.everest.validity.com/api/1.0"],"path":["account","childaccount"],"query":[{"key":"id","value":"2"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"[\r\n {\r\n \"id\": 2,\r\n \"email\": \"child-account@validity.com\",\r\n \"external_id\": 1234,\r\n \"api_key\": \"123abc\",\r\n \"loginslug\": \"child-account-1234\",\r\n \"company\": \"Child Account 1234\",\r\n \"has_inboxinformant\": \"n\",\r\n \"inbox_max\": 0,\r\n \"inbox_used\": 0,\r\n \"inbox_expires\": null,\r\n \"has_blacklistinformant\": \"n\",\r\n \"blacklist_max\": 0,\r\n \"blacklist_used\": null,\r\n \"blacklist_expires\": null,\r\n \"has_reputation\": \"n\",\r\n \"reputation_expires\": null,\r\n \"has_designinformant\": \"n\",\r\n \"design_max\": 0,\r\n \"design_used\": 0,\r\n \"design_expires\": null,\r\n \"has_emailinformant\": \"n\",\r\n \"emailinformant_max\": null,\r\n \"emailinformant_used\": 0,\r\n \"emailinformant_expires\": null,\r\n \"has_dmarc\": \"n\",\r\n \"dmarc_max\": null,\r\n \"dmarc_used\": 0,\r\n \"dmarc_expires\": null,\r\n \"has_validation\": \"n\",\r\n \"validation_start\": null,\r\n \"validation_expires\": null,\r\n \"validationmax\": null,\r\n \"validationmaxtype\": null,\r\n \"validation_used\": 0,\r\n \"validation_used_unique\": 0\r\n }\r\n]"}],"_postman_id":"0c43971e-5742-4eb1-a394-33560e593b92"},{"name":"Create Child Account","id":"c661de53-dd21-4c5d-a760-359bdbf110f9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"email\": \"250okSDF@sjlefke.com\",\n \"password\": \"REDACTED\",\n \"name\": \"666\",\n \"packagecontractstart\": \"2022-01-01\",\n \"packagecontractexpire\": \"2026-01-01\",\n \"inbox\": \"y\",\n \"inbox_type\": \"pro\",\n \"max_inbox\": 10000,\n \"max_blacklist\": 0,\n \"inbox_period\": \"annual\",\n \"blacklist\": \"n\",\n \"reputation\": \"n\",\n \"design\": \"y\",\n \"max_design\": 1000,\n \"design_period\": \"annual\",\n \"emailformat\": \"n\",\n \"inbox_used\": 0,\n \"design_used\": 0\n}\n","options":{"raw":{"language":"json"}}},"url":"https://api.everest.validity.com/api/1.0/account/childaccount","description":"This API allows you to create a new child account. Successful account creation will result in the API returning the ID of the new child account. Data is returned in the following formats: XML, JSON, CSV and Serialized.
\n","auth":{"type":"apikey","apikey":{"value":"{{your-api-key-here}}","key":"This API allows you to create a new child account. Successful account creation will result in the API returning the ID of the new child account. Data is returned in the following formats: XML, JSON, CSV and Serialized.
\n","auth":{"type":"apikey","apikey":{"value":"{{your-api-key-here}}","key":"This API allows you to delete a child account by ID. Data is returned in the following formats: XML, JSON, CSV and Serialized.
\n","auth":{"type":"apikey","apikey":{"value":"{{your-api-key-here}}","key":"This API allows you to generate an API key for a new or existing child account. Successful account creation will result in the API returning the API key of the child account. Data is returned in the following formats: XML, JSON, CSV and Serialized.
\n","auth":{"type":"apikey","apikey":{"value":"{{your-api-key-here}}","key":"This API call provides a historical list of GDPR Requests.
\n","auth":{"type":"apikey","apikey":{"value":"{{your-api-key-here}}","key":"In accordance with Article 15 of the GDPR, 250ok will aim to provide its customers with transparency and ease-of-access to their data. Through the GDPR Request Form, customers can access, export (or transfer), erase, or anonymize their personal data. Lastly, customers can restrict the processing of data subjects at any time by pausing data forwarding to 250ok.
\n","auth":{"type":"apikey","apikey":{"value":"{{your-api-key-here}}","key":"This API call provides a list of webhook endpoints for the specified account.
\nThis documentation will explain the data schema used to send email-based information to a user's 250ok account via the 250ok Universal Endpoint (referred to simply as endpoint).
\n","auth":{"type":"apikey","apikey":{"value":"{{your-api-key-here}}","key":"This API allows you to create a new webhook endpoint. Successful account creation will result in the API returning the integration key and receiving URL of the endpoint.
\n","auth":{"type":"apikey","apikey":{"value":"{{your-api-key-here}}","key":"This API allows you to modify an existing webhook endpoint, such as changing its description.
\n","auth":{"type":"apikey","apikey":{"value":"{{your-api-key-here}}","key":"This API allows you to delete a webhook endpoint by integration key. Data is returned in the following formats: XML, JSON, CSV and Serialized.
Returns a full list of Validation result classifications, along with the definition, risk, common reasons, and recommendation for each result type.
\n","auth":{"type":"apikey","apikey":{"value":"{{your-api-key-here}}","key":"Returns validation results for a specific address.
\nAfter processing, the results object contains the input address, the final result, and relevant diagnostic information.
\nThe category will return one of the following: valid, email_address_invalid, email_domain_invalid, email_account_invalid, accept_all, role_address, disposable, unknown, but the diagnostics object may change depending on the result classification.
\nFor example, if an email address is believed to contain a typo domain, the typo flag will be set to true and the typo_suggestion will contain what is believed to be the intended domain.
\n","auth":{"type":"apikey","apikey":{"value":"{{your-api-key-here}}","key":"(Required) The name or description of the list
\n","type":"text"},{"key":"emails","value":"email1@domain.com;email2@domain.com;email3@domain.com","description":"(Required) String of delimiter-separated email addresses
\n","type":"text"},{"key":"delimiter","value":";","description":"The delimiter separating the email addresses, such as commas (,) or new lines (\\n)
\n","type":"text"}]},"url":"{{host}}/validation/lists","description":"Allows batch validation of a new list using a description and a string of email addresses. By default, addresses will be parsed as a CSV using a comma as the delimiter.
\nOptional delimiter values:
\n- \n
, (comma)
\n \n; (semicolon)
\n \n\\n (new line)
\n \n\\t (tab)
\n \n| (pipe)
\n \n
Returns a full list of validation results from an account. The status field may vary until all addresses have been scanned, at which time status will switch to complete.
\nDuring processing, the processed field will increment its percentage to reflect the progress of the scan.
\nAfter processing, the list results contain the total number (and percentage) of addressess classified under each result group. Those addresses can be exported or downloaded using the specific export endpoints listed in the endpoints object.
\n","auth":{"type":"apikey","apikey":{"value":"{{your-api-key-here}}","key":"Returns a specific set of validation results from an account. The status field may vary until all addresses have been scanned, at which time status will switch to complete.
\nDuring processing, the processed field will increment its percentage to reflect the progress of the scan.
\nAfter processing, the list results contain the total number (and percentage) of addressess classified under each result group. Those addresses can be exported or downloaded using the specific export endpoints listed in the endpoints object.
\n","auth":{"type":"apikey","apikey":{"value":"{{your-api-key-here}}","key":"After processing is complete, results can be exported individually or in bulk, grouped by classification. The Get Exports endpoint will provide an endpoints:{} consisting of the individual export URLs.
\n","auth":{"type":"apikey","apikey":{"value":"{{your-api-key-here}}","key":"Returns a specific set of email addresses based on the result classifications retrieved from Get Lists, Get List, or Get Exports.
\n","auth":{"type":"apikey","apikey":{"value":"{{your-api-key-here}}","key":"Throughout the Validation documentation you'll see the use of variables like {{apikey}} that can be swapped out using your real API key. If you use Postman, this collection is available for download along with a shared variable template to define your host and apikey variables.
\n","event":[{"listen":"prerequest","script":{"id":"dbbf6636-d57d-4252-867d-b70aeedeb268","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"e061074f-091c-4504-a720-c33a51ed534b","type":"text/javascript","exec":[""]}}],"_postman_id":"ea6a753c-3267-4df7-afb1-593de2d40c1f","auth":{"type":"apikey","apikey":{"value":"{{your-api-key-here}}","key":"Returns a list of domains in your Prospect search history.
\n","auth":{"type":"apikey","apikey":{"value":"{{your-api-key-here}}","key":"Returns the 90-day blacklistings count, trap volume, estimated monthly sending volume, and a list of available endpoints to retrieve additional data feeds: traps by day, by ESP, blacklists, authentication, WHOIS, etc.
\nYou can pass authenticated=1 to exclude unauthenticated mail from the data feeds and endpoints, which will remove illegitimate and spoofed traffic.
\nError Responses
\n- \n
- 400 Invalid search ID. \n
- 400 No domain matches selected. Please refer to the 'Search - Select Matches (POST)' endpoint to select a minimum of 1 domain match. \n
- 404 Search ID not found. \n
Returns a list of subdomains, exact matches, fuzzy matches, and related domains matching your search criteria. The 90-day trap counts for the domain matches are also included to determine which matches account for the most volume.
\nError Responses
\n- \n
- 400 'domain' is a required field. \n
- 400 Invalid domain value. \n
POST your selection of domain matches using a comma-separated or pipe-delimited set of domains. Domains submitted that were not listed in the available_domains field from Prospect Search will be discarded.
\nError Responses
\n- \n
- 400 Invalid search ID. \n
- 400 'matches' is a required field. \n
- 400 The contents of 'matches' must use the 'available_domains' from /prospect/search. \n
Returns a traps: {} object containing the total number of trap hits, hits by type (pristine, typo, recycled), hits by day, and hits by IP address.
\nYou can pass authenticated=1 to exclude unauthenticated mail from the data feeds and endpoints, which will remove illegitimate and spoofed traffic.
\nError Responses
\n- \n
- 400 Invalid search ID. \n
- 404 Search ID not found. \n
Returns an esps: {} object containing the total number of trap hits, total hits by ESP, hits by day by ESP.
\nYou can pass authenticated=1 to exclude unauthenticated mail from the data feeds and endpoints, which will remove illegitimate and spoofed traffic.
\nError Responses
\n- \n
- 400 Invalid search ID. \n
- 404 Search ID not found. \n
Returns an blacklists: {} object containing:
\n- \n
- day: total blacklisted items by day \n
- daylist: total blacklisted items by day, by list \n
- blacklist: total blacklisted items by list \n
- item: total blacklisted items by item (IP address) \n
- itemlist: total blacklisted by item, by list \n
Error Responses
\n- \n
- 400 Invalid search ID. \n
- 404 Search ID not found. \n
Returns an authentication: {} object containing your domain selections and their WHOIS records (registration date and expiration), pecentage of mail volume, SPF and DMARC records, and SPF lookups.
\nError Responses
\n- \n
- 400 Invalid search ID. \n
- 404 Search ID not found. \n
Returns WHOIS and registration information about a domain including the company, creation date, and expiration date.
\n","auth":{"type":"apikey","apikey":{"value":"{{your-api-key-here}}","key":"Deletes a search from your Prospect search history.
\nError Responses
\n- \n
- 400 Invalid search ID. \n
- 404 Search ID not found. \n
Throughout the API documentation you'll see the use of variables like {{apikey}} that can be swapped out using your real API key. If you use Postman, this collection is available for download along with a shared variable template to define your host and apikey variables.
\nWorkflow overview:
\n- \n
- Create a new Prospect Search using a single top-level domain, which will return a list of available sending domains (available_matches) that you can select to refine your search. This list includes exact domain matches, subdomains, related domains, and fuzzy matches. \n
- POST your selection of domain matches to Search - Select Matches using a comma-separated or pipe-delimited set of domains. \n
- After your match selection, GET the Get Search - Overview to retrieve the 90-day blacklistings count, trap volume, estimated monthly sending volume, and a list of available endpoints to retrieve additional data feeds: traps by day, by ESP, blacklists, authentication, WHOIS, etc. \n
- Each available Get Search endpoint may contain a meta: {} object that provides help text or explanations of fields to help you interpret the data. \n
- Retrieve your Prospect search history at any time using Search History \n
Seed List returns a full list of seed addresses for an account.
\n","auth":{"type":"apikey","apikey":{"value":"{{your-api-key-here}}","key":"Regions & Providers returns a region along with the supported ISPs within it, or a list of targetable regions to configure your seed list.
\n","auth":{"type":"apikey","apikey":{"value":"{{your-api-key-here}}","key":"(Required) Either an array or comma separated list of region ids.
\n"}]},"url":"{{host}}/inbox/seeds/","auth":{"type":"apikey","apikey":{"value":"{{your-api-key-here}}","key":"All Lists provides an overview of each available mailing list.
\n","auth":{"type":"apikey","apikey":{"value":"{{your-api-key-here}}","key":"List by ID provides detailed information about a specified mailing list including a full breakdown of each mailbox provider.
\n","auth":{"type":"apikey","apikey":{"value":"{{your-api-key-here}}","key":"Domains by List provides a full breakdown of domain distribution from your mailing list sample.
\n","auth":{"type":"apikey","apikey":{"value":"{{your-api-key-here}}","key":"Delete List allows you to delete one of your mailing list samples.
\n","auth":{"type":"apikey","apikey":{"value":"{{your-api-key-here}}","key":"Name of the list
\n","type":"text"},{"key":"list","value":"","description":"List of email addresses or (preferably) the domain portion of the addresses
\n","type":"text"},{"key":"delimiter","value":"","description":"Separator between email addresses (defaults to new line)
\n","type":"text"}]},"url":"{{host}}/inbox/optimizer","description":"Create List allows submitting a new mailing list sample for analysis.
\n","auth":{"type":"apikey","apikey":{"value":"{{your-api-key-here}}","key":"Apply List Weighting enables you to weight your seedlist based on the results of a Seedlist Optimizer sample. See Create List for instructions on how to upload a list sample for optimization.
\n","auth":{"type":"apikey","apikey":{"value":"{{your-api-key-here}}","key":"The page of results to be retrieved.
\n","type":"text/plain"},"key":"page","value":"(integer)"},{"disabled":true,"description":{"content":"The page size of paginated data.
\n","type":"text/plain"},"key":"limit","value":"(integer)"},{"disabled":true,"description":{"content":"Limits test results to those executed after the specified date.
\n","type":"text/plain"},"key":"startdate","value":"YYYY-MM-DD"},{"disabled":true,"description":{"content":"Limits test results to those executed before the specified date.
\n","type":"text/plain"},"key":"enddate","value":"YYYY-MM-DD"},{"disabled":true,"description":{"content":"Filter by a valid IP address
\n","type":"text/plain"},"key":"ip","value":"127.0.0.1"},{"disabled":true,"description":{"content":"Filter by SPF domain
\n","type":"text/plain"},"key":"spfdomain","value":"spf.domain.com"},{"disabled":true,"description":{"content":"Filter by DKIM domain
\n","type":"text/plain"},"key":"dkimdomain","value":"dkim.domain.com"},{"disabled":true,"description":{"content":"Filter by region ID (/inbox/seeds/providers)
\n","type":"text/plain"},"key":"region_id","value":"3"},{"disabled":true,"description":{"content":"Filter by child account ID (/accounts/) - you may pass multiple user IDs.
\n","type":"text/plain"},"key":"user_id[]","value":"1111"},{"disabled":true,"description":{"content":"Filter by from address
\n","type":"text/plain"},"key":"from","value":"from@domain.com"},{"disabled":true,"description":{"content":"Filter by from domain
\n","type":"text/plain"},"key":"fromdomain","value":"domain.com"},{"disabled":true,"description":{"content":"Filter by Inbox test subject line
\n","type":"text/plain"},"key":"subject","value":"Some Subject Line"},{"disabled":true,"description":{"content":"Filter by custom x-header value (I.e. X-250ok-CID: 1111.2222)
\n","type":"text/plain"},"key":"xcid","value":"1111.2222"},{"disabled":true,"description":{"content":"Filter by custom tags - you may pass multiple tags
\n","type":"text/plain"},"key":"tags[]","value":"tag1"},{"disabled":true,"description":{"content":"Filter by custom properties other than tags - you may pass multiple property names
\n","type":"text/plain"},"key":"custompropertyname[]","value":"custom_name"},{"disabled":true,"description":{"content":"Filter by custom properties other than tags - you may pass multiple property values
\n","type":"text/plain"},"key":"custompropertyvalue[]","value":"custom_value"}],"variable":[]}},"response":[{"id":"e32954ea-2bbc-49d6-8099-ac525d065c02","name":"All Inbox Tests","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/inbox/tests?startdate=2021-01-01","host":["{{host}}"],"path":["inbox","tests"],"query":[{"key":"startdate","value":"2021-01-01"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.17.6"},{"key":"Date","value":"Mon, 04 Jan 2021 15:46:51 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"2775"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/7.3.24"},{"key":"Access-Control-Allow-Origin","value":"https://everest.validity.com"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Set-Cookie","value":"session=s596kk5nnlnobld3f9nhj4k4t74ajs75; expires=Mon, 04-Jan-2021 19:46:49 GMT; Max-Age=14400; path=/; domain=.appdev.250ok.com; secure; HttpOnly; SameSite=None"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Headers","value":"Authorization,Accept,Keep-Alive,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type,Content-Range,Range,x-api-key"},{"key":"Access-Control-Allow-Methods","value":"GET,POST,OPTIONS,PUT,DELETE,PATCH"}],"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"params\": {\n \"startdate\": \"2021-01-01T05:00:00+00:00\",\n \"page\": null,\n \"limit\": null,\n \"enddate\": \"1970-01-01T00:00:00+00:00\",\n \"ip\": null,\n \"spfdomain\": null,\n \"dkimdomain\": null,\n \"region_id\": null\n },\n \"pages\": 1,\n \"total\": 1\n },\n \"results\": [\n {\n \"id\": 1,\n \"created\": \"2021-01-03 18:02:45\",\n \"subject\": \"Inbox Test 1\",\n \"xheader\": {\n \"key\": \"X-250ok-CID\",\n \"value\": \"1111.2222\"\n },\n \"from\": \"from@domain.com\",\n \"friendlyfrom\": \"Your Friendly From\",\n \"seeds\": {\n \"inbox\": 781,\n \"spam\": 101,\n \"missing\": 14\n },\n \"placement\": {\n \"inbox\": 87.2,\n \"spam\": 11.3,\n \"missing\": 1.5\n },\n \"authentication\": {\n \"spf\": 96.9,\n \"dkim\": 100,\n \"dmarc\": 100\n },\n \"status\": \"processing\",\n \"mtr\": 2.6,\n \"overage\": false\n }\n ]\n}"}],"_postman_id":"ca63251c-1c6a-4ad2-a602-3dbdf2c74534"},{"name":"Inbox Test by ID","id":"c3ad6c18-76a0-4f30-ac2a-7c3fd8fdde04","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{host}}/inbox/tests/{{campaign_id}}","auth":{"type":"apikey","apikey":{"value":"{{your-api-key-here}}","key":"Full Message provides the full raw message, html and text version, and headers from a particular Inbox test.
\n","auth":{"type":"apikey","apikey":{"value":"{{your-api-key-here}}","key":"All Providers returns detailed mailbox performance for all providers in a given Inbox test.
\n","auth":{"type":"apikey","apikey":{"value":"{{your-api-key-here}}","key":"Delete Test allows you to manually delete an Inbox test.
\n","auth":{"type":"apikey","apikey":{"value":"{{your-api-key-here}}","key":"Mailbox Provider health shows daily deliverability (Inbox, Spam, Missing) averages and trends across the Everest community. This can be used as a benchmark to compare your deliverability results with other Everest users. It will show a sum Inbox, Spam, and Missing % for the time range, and then it will show those same numbers broken down by day.
\nAccepts additional parameters as filters:
\n- \n
provider (i.e. /inbox/health/1/provider/15/)
\n \nregion (i.e. /inbox/health/1/)
\n \nstartdate
\n \nenddate
\n \n
Which are documented in the request examples.
\n","auth":{"type":"apikey","apikey":{"value":"{{your-api-key-here}}","key":"You can select to have all mail matching a specific from address to be optimized through VTO delivery as long as the DKIM domain and selector also match
\n"},{"key":"subject","value":"This is a subject line!","type":"text","description":"Please provide the exact subject line string when provisioning campaigns. Please note that emojis or other special characters might result in issues.We recommend to check the exact subject string as it appears within a mail header by sending yourself a test email.
\n"},{"key":"identificationmethod","value":"subject","type":"text","description":"Available options are 'body-tag', 'subject', 'xheader-generate'.
\n"},{"key":"dkimdomain","value":"reply.validity.com","type":"text"},{"key":"dkimselector","value":"dkimselector1","type":"text"},{"key":"starttime","value":"2020-10-08 04:38:00","type":"text","description":"The start date of the campaign In UTC
\n"},{"key":"endtime","value":"2020-10-14 04:38:00","type":"text","description":"An ideal campaign should run for at least 48 hours to take advantage of the VTO benefits. Maximum duration is 30 days
\n"},{"key":"endresolutionmode","value":"sendAll","type":"text","description":"A unique option of VTO campaigns is the ability to decide what to do with undelivered emails at the end of the campaign run time. Undelivered means recipients for that specific campaigns have notcome online during the campaign run time.
\n'sendAll': Deliver all undelivered mail to the inbox (referred to as \"Draining\"; attempts normal delivery pattern)
\n'ignore': Discard all undelivered mail
\n"},{"key":"optinforabtest","value":"1","type":"text","description":"Available options are 0 or 1. If we enable an A/B test we will automatically select a subset of the recipients targeted for a VTOcampaign and deliver emails without VTO optimization while the bulk of the emails will be optimizedthrough VTO.
\n"}]},"url":"{{host}}/vto/campaigns","auth":{"type":"apikey","apikey":{"value":"{{your-api-key-here}}","key":"For VTO campaigns which are manually provisioned (ie: They are not set up through the Everest UI), campaigns should be created via API at least 48 hours before campaign start.
\nTo provision and set up a VTO campaign we need at least the following information:
\n- \n
- DKIM domain \n
- DKIM selector \n
- Campaign Identifier identifying the campaign to be optimized \n
- Start Date and Time of the campaign (in UTC by default) \n
- End Date and Time (This is the time Verizon stops delivering mail via VTO; an ideal campaign should run for at least 48 hours to take advantage of the VTO benefits. Maximum duration is 30 days) \n
- Campaign behavior at the end of the campaign (The options are to deliver all undelivered mail to the Inbox or to discard (ie: Delete) all undelivered mail) \n
Returns a list of all supported blocklists. Blocklists can be filtered by type using the type=ip or type=domain query filters.
Returns a list active blacklist listings for your IPs, domains, profiles and providers. Additional resources are provided for each listing type.
\n","auth":{"type":"apikey","apikey":{"value":"{{your-api-key-here}}","key":"The blocklists resource provides access to data on supported IP and domain blacklists.
\n","event":[{"listen":"prerequest","script":{"id":"7ba022ea-d719-40fd-b81c-7edbc5d5fdce","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"a099b122-a22e-413d-b698-3ba530727674","type":"text/javascript","exec":[""]}}],"_postman_id":"755f9d5c-a284-4982-8e3d-d1c48cbe62b4","auth":{"type":"apikey","apikey":{"value":"{{your-api-key-here}}","key":"List current reputation profiles along with any blocklist hits and issue metrics.
\n","auth":{"type":"apikey","apikey":{"value":"{{your-api-key-here}}","key":"Fetch data for a specific reputation profile along with any blocklist hits and issue metrics.
\n","auth":{"type":"apikey","apikey":{"value":"{{your-api-key-here}}","key":"List all profile items for a specified reputation profile.
\n","auth":{"type":"apikey","apikey":{"value":"{{your-api-key-here}}","key":"List all rDNS issues associated with a specified profile.
List all of the reputation profile items that are being tracked.
\n","auth":{"type":"apikey","apikey":{"value":"{{your-api-key-here}}","key":"May be 'all', 'ip' or 'domain'.
\n","type":"text"}]},"url":"{{host}}/reputation/profiles","description":"Create a new reputation profile, specifying the type of blocklist to track or specific blocklist providers.
\nAvailable Fields
\n- \n
nameRequired, the name of this profile \ntypeOptional, the type of blocklist to track. Must be one ofall,ipordomain. If specified,blocklist_idsis ignored. \nblocklist_idsOptional, IDs of specific blocklist providers. Provider IDs are available under the/reputation/blocklistsresource. \n
One of the type or blocklist_ids fields must be specified.
(Required) The profile's name.
\n","type":"text"},{"key":"type","value":"all","description":"(Required if blocklists not set) May be 'all', 'ip' or 'domain'.
\n","type":"text"},{"key":"blocklists","value":"1,2,5","description":"(Required if type not set) An array of blocklist ids.
\n","type":"text","disabled":true},{"key":"enabled","value":"1","description":"Whether or not the profile is enabled for monitoring. May be 0 or 1.
\n","type":"text","disabled":true}]},"url":"{{host}}/reputation/profiles/1","description":"Update the blocklist IDs or type associated with a specified reputation profile.
\nAvailable Fields
\n- \n
nameOptional, update the name of this profile \ntypeOptional, replace type of blocklists to track. Must be one ofall,ipordomain. If specified,blocklist_idsis ignored. \nblocklist_idsOptional, replace the specific blocklist provider IDs associated with this profile. Provider IDs are available under the/reputation/blocklistsresource. \n
One of the type or blocklist_ids fields must be specified.
Delete a specified profile. This action cannot be undone.
\n","auth":{"type":"apikey","apikey":{"value":"{{your-api-key-here}}","key":"(Required) The unique identifier of the monitor summary
\n","key":"item","type":"text","value":"1.2.3.4"},{"description":"(Required) Type of monitored items to add: 'ip', 'cidr', 'ip_range', 'domain_name', or 'shared_domain'
\n","key":"type","type":"text","value":"ip"},{"key":"description","value":"","description":"(Optional) The description field for the item.
\n","type":"text","disabled":true},{"key":"esps","value":"11,348","description":"(Required for shared_domain type) Array or comma separated list of esp ids.
\n","type":"text","disabled":true}]},"url":"{{host}}/reputation/profiles/1/items","description":"Add a new tracking item to a specified profile.
\nAvailable Fields
\n- \n
itemRequired, the value of the item to track. This may be a CIDR range, IP address or range, or a domain name. \ntypeRequired, the type of item being tracked. Must be one ofcidr,domain_name,ip_range,iporshared_domain. \ndescriptionOptional, the description for this profile tracking item. \n
Delete a specified item on a profile. Profile items can be listed using the /reputation/profiles/{{profile_id}}/items resource.
The /reputation/profiles resource provides reputation profile management and analysis.
Fetch information about trap hits for each of your current reputation profiles.
\n","auth":{"type":"apikey","apikey":{"value":"{{your-api-key-here}}","key":"Fetch information about trap hits in your mail stream broken out by date.
\n","auth":{"type":"apikey","apikey":{"value":"{{your-api-key-here}}","key":"Fetch information about trap hits in your mail stream broken out by the FROM address.
Fetch information about trap hits in your mail stream broken out by the from domain.
\n","auth":{"type":"apikey","apikey":{"value":"{{your-api-key-here}}","key":"Fetch information about trap hits in your mail stream broken out by the message SUBJECT.
Fetch information about trap hits in your mail stream broken out by the \"friendly\" from name.
\n","auth":{"type":"apikey","apikey":{"value":"{{your-api-key-here}}","key":"Fetch information about trap hits in your mail stream broken out by the sending IP.
\n","auth":{"type":"apikey","apikey":{"value":"{{your-api-key-here}}","key":"The traps resource provides data about various spam trap types and hits.
\n","event":[{"listen":"prerequest","script":{"id":"d563c231-01a3-46ab-8386-222358fa5084","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"0aacb1b0-4d0f-47f6-aca2-0fe95899951d","type":"text/javascript","exec":[""]}}],"_postman_id":"f8bcfce5-78dc-496a-a83c-d68975d333f1","auth":{"type":"apikey","apikey":{"value":"{{your-api-key-here}}","key":"The page of results to be retrieved.
\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"The page size of paginated data.
\n","type":"text/plain"},"key":"limit","value":"100"},{"description":{"content":"Limits test results to those executed after the specified date.
\n","type":"text/plain"},"key":"startdate","value":"2020-10-12 00:00:00"},{"description":{"content":"Limits test results to those executed before the specified date.
\n","type":"text/plain"},"key":"enddate","value":"2020-10-15 00:00:00"},{"description":{"content":"Filter by trap type(s): pristine, recycled, typo
\n","type":"text/plain"},"key":"traptype","value":"pristine"},{"description":{"content":"Filter by a valid IP address (array or comma-separated list of IP addresses)
\n","type":"text/plain"},"key":"ip","value":"127.0.0.1"},{"description":{"content":"Filter by subject line
\n","type":"text/plain"},"key":"subject","value":"Some Subject Line!"},{"description":{"content":"Filter by from domain
\n","type":"text/plain"},"key":"fromdomain","value":"domain.com"},{"description":{"content":"Filter by from address
\n","type":"text/plain"},"key":"fromaddress","value":"address@domain.com"},{"description":{"content":"Filter by friendly from
\n","type":"text/plain"},"key":"friendlyfrom","value":"Acme Co."},{"description":{"content":"Filter by profile ID
\n","type":"text/plain"},"key":"profile_id","value":"1"}],"variable":[]}},"response":[{"id":"003c85d9-a37f-4e8d-bbd0-21c9deef15c3","name":"Detailed Events (Traps)","originalRequest":{"method":"GET","header":[{"key":"","value":"","disabled":true}],"url":{"raw":"{{host}}/reputation/events/traps?page=1&limit=100&startdate=2020-10-07 04:00:00&enddate=2020-10-07 17:23:04&type=pristine","host":["{{host}}"],"path":["reputation","events","traps"],"query":[{"key":"page","value":"1","description":"The page of results to be retrieved."},{"key":"limit","value":"100","description":"The page size of paginated data."},{"key":"startdate","value":"2020-10-07 04:00:00","description":"Limits test results to those executed after the specified date."},{"key":"enddate","value":"2020-10-07 17:23:04","description":"Limits test results to those executed before the specified date."},{"key":"type","value":"pristine","description":"Filter by trap type(s): pristine, recycled, typo"},{"key":"ip","value":"127.0.0.1","description":"Filter by a valid IP address (or comma-separated list of IP addresses)","disabled":true},{"key":"subject","value":"Some Subject Line!","description":"Filter by subject line","disabled":true},{"key":"fromdomain","value":"domain.com","description":"Filter by from domain","disabled":true},{"key":"fromaddress","value":"address@domain.com","description":"Filter by from address","disabled":true},{"key":"friendlyfrom","value":"Acme Co.","description":"Filter by friendly from","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.17.6"},{"key":"Date","value":"Wed, 06 Jan 2021 18:00:17 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"843"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/7.3.24"},{"key":"Access-Control-Allow-Origin","value":"https://everest.validity.com"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Headers","value":"Authorization,Accept,Keep-Alive,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type,Content-Range,Range,x-api-key"},{"key":"Access-Control-Allow-Methods","value":"GET,POST,OPTIONS,PUT,DELETE,PATCH"}],"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"params\": {\n \"page\": 1,\n \"limit\": 100,\n \"startdate\": \"2020-10-07T04:00:00+00:00\",\n \"enddate\": \"2020-10-07T17:23:04+00:00\",\n \"type\": \"pristine\",\n \"ip\": null,\n \"subject\": null,\n \"fromdomain\": null,\n \"fromaddress\": null,\n \"friendlyfrom\": null\n },\n \"total\": 31409,\n \"pages\": 315,\n \"next\": \"/api/2.0/reputation/events/traps?page=2&limit=1&startdate=2020-10-07+09%3A00%3A00&enddate=2020-10-07+22%3A23%3A04&type=pristine\"\n },\n \"results\": [\n {\n \"date\": \"2020-10-07 17:23:59\",\n \"type\": \"typo\",\n \"trap_since\": \"2017-02-17 15:17:21\",\n \"subject\": \"Smart Android TV™ $279 (Was $429.99)!\",\n \"fromaddress\": \"store@retailer.com\",\n \"fromdomain\": \"retailer.com\",\n \"fromdomain_5322\": \"retailer.com\",\n \"friendlyfrom\": \"Retail Company Co.\",\n \"ip\": \"127.0.0.1\",\n \"rdns\": \"rdns.retailer.com\",\n \"country\": \"US\",\n \"dkim\": \"pass\",\n \"dkim_domain\": \"email.retailer.com\",\n \"spf\": \"pass\",\n \"spf_domain\": \"email.retailer.com\"\n } // ...\n ]\n}"}],"_postman_id":"71a690a2-c906-4f5e-a7db-b7f7ccee2ebd"},{"name":"Detailed Events (Suspicious)","id":"a8e91cb0-d143-48bc-8e60-bd2ff16ee643","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{host}}/reputation/events/suspicious?page=1&limit=100&startdate=2020-10-07 04:00:00&enddate=2020-10-07 17:23:04&type=pristine&ip=127.0.0.1&subject=Some Subject Line!&fromdomain=domain.com&fromaddress=address@domain.com&friendlyfrom=Acme Co.","auth":{"type":"apikey","apikey":{"value":"{{your-api-key-here}}","key":"The page of results to be retrieved.
\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"The page size of paginated data.
\n","type":"text/plain"},"key":"limit","value":"100"},{"description":{"content":"Limits test results to those executed after the specified date.
\n","type":"text/plain"},"key":"startdate","value":"2020-10-07 04:00:00"},{"description":{"content":"Limits test results to those executed before the specified date.
\n","type":"text/plain"},"key":"enddate","value":"2020-10-07 17:23:04"},{"description":{"content":"Filter by trap type(s): pristine, recycled, typo
\n","type":"text/plain"},"key":"type","value":"pristine"},{"description":{"content":"Filter by a valid IP address (or comma-separated list of IP addresses)
\n","type":"text/plain"},"key":"ip","value":"127.0.0.1"},{"description":{"content":"Filter by subject line
\n","type":"text/plain"},"key":"subject","value":"Some Subject Line!"},{"description":{"content":"Filter by from domain
\n","type":"text/plain"},"key":"fromdomain","value":"domain.com"},{"description":{"content":"Filter by from address
\n","type":"text/plain"},"key":"fromaddress","value":"address@domain.com"},{"description":{"content":"Filter by friendly from
\n","type":"text/plain"},"key":"friendlyfrom","value":"Acme Co."}],"variable":[]}},"response":[{"id":"472cffe4-b7fc-4236-b149-275840de1b43","name":"Detailed Events (Suspicious)","originalRequest":{"method":"GET","header":[{"key":"","value":"","disabled":true}],"url":{"raw":"{{host}}/reputation/events/suspicious?page=1&limit=100&startdate=2020-10-07 04:00:00&enddate=2020-10-07 17:23:04&type=pristine","host":["{{host}}"],"path":["reputation","events","suspicious"],"query":[{"key":"page","value":"1","description":"The page of results to be retrieved."},{"key":"limit","value":"100","description":"The page size of paginated data."},{"key":"startdate","value":"2020-10-07 04:00:00","description":"Limits test results to those executed after the specified date."},{"key":"enddate","value":"2020-10-07 17:23:04","description":"Limits test results to those executed before the specified date."},{"key":"type","value":"pristine","description":"Filter by trap type(s): pristine, recycled, typo"},{"key":"ip","value":"127.0.0.1","description":"Filter by a valid IP address (or comma-separated list of IP addresses)","disabled":true},{"key":"subject","value":"Some Subject Line!","description":"Filter by subject line","disabled":true},{"key":"fromdomain","value":"domain.com","description":"Filter by from domain","disabled":true},{"key":"fromaddress","value":"address@domain.com","description":"Filter by from address","disabled":true},{"key":"friendlyfrom","value":"Acme Co.","description":"Filter by friendly from","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.17.6"},{"key":"Date","value":"Wed, 06 Jan 2021 18:00:17 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"843"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/7.3.24"},{"key":"Access-Control-Allow-Origin","value":"https://everest.validity.com"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Headers","value":"Authorization,Accept,Keep-Alive,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type,Content-Range,Range,x-api-key"},{"key":"Access-Control-Allow-Methods","value":"GET,POST,OPTIONS,PUT,DELETE,PATCH"}],"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"params\": {\n \"page\": 1,\n \"limit\": 100,\n \"startdate\": \"2020-10-07T04:00:00+00:00\",\n \"enddate\": \"2020-10-07T17:23:04+00:00\",\n \"type\": \"pristine\",\n \"ip\": null,\n \"subject\": null,\n \"fromdomain\": null,\n \"fromaddress\": null,\n \"friendlyfrom\": null\n },\n \"total\": 31409,\n \"pages\": 315,\n \"next\": \"/api/2.0/reputation/events/traps?page=2&limit=1&startdate=2020-10-07+09%3A00%3A00&enddate=2020-10-07+22%3A23%3A04&type=pristine\"\n },\n \"results\": [\n {\n \"date\": \"2020-10-07 17:23:59\",\n \"type\": \"typo\",\n \"trap_since\": \"2017-02-17 15:17:21\",\n \"subject\": \"This might be phishing!\",\n \"fromaddress\": \"store@retailer.com\",\n \"fromdomain\": \"retailer.com\",\n \"fromdomain_5322\": \"retailer.com\",\n \"friendlyfrom\": \"Retail Company Co.\",\n \"ip\": \"127.0.0.1\",\n \"rdns\": \"rdns.retailer.com\",\n \"country\": \"US\",\n \"dkim\": \"fail\",\n \"dkim_domain\": \"email.retailer.com\",\n \"spf\": \"fail\",\n \"spf_domain\": \"email.retailer.com\"\n } // ...\n ]\n}"}],"_postman_id":"a8e91cb0-d143-48bc-8e60-bd2ff16ee643"}],"id":"ef4a421f-2a28-4904-94e6-b7f9895529ec","description":"The events resource provides event-level detail of your spam trap hits or suspicious messages.
\n","event":[{"listen":"prerequest","script":{"id":"5a59e498-cfcb-43dc-b3ba-004a135c3511","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"06eeeb67-e008-4f5b-b686-f3b98c2c1907","type":"text/javascript","exec":[""]}}],"_postman_id":"ef4a421f-2a28-4904-94e6-b7f9895529ec","auth":{"type":"apikey","apikey":{"value":"{{your-api-key-here}}","key":"Detailed Sender Score information on an IP.
\n","auth":{"type":"apikey","apikey":{"value":"{{your-api-key-here}}","key":"Please see timezone param list for details about the id's.
\n","auth":{"type":"apikey","apikey":{"value":"{{your-api-key-here}}","key":"Data Type: DateTime.
\n","type":"text/plain"},"key":"startdate","value":""},{"disabled":true,"description":{"content":"Data Type: DateTime.
\n","type":"text/plain"},"key":"enddate","value":""},{"disabled":true,"description":{"content":"Data Type: Nullable(String)
\n","type":"text/plain"},"key":"source","value":""},{"disabled":true,"description":{"content":"Data Type: String
\n","type":"text/plain"},"key":"integrationkey","value":""},{"disabled":true,"description":{"content":"Data Type: String
\n","type":"text/plain"},"key":"provider","value":""},{"disabled":true,"description":{"content":"Data Type: Nullable(String)
\n","type":"text/plain"},"key":"todomain","value":""},{"disabled":true,"description":{"content":"Data Type: Nullable(String)
\n","type":"text/plain"},"key":"campaign_id","value":""},{"disabled":true,"description":{"content":"Data Type: varchar(50) null.
\n","type":"text/plain"},"key":"platform","value":""},{"disabled":true,"description":{"content":"Data Type: String
\n","type":"text/plain"},"key":"country","value":""},{"disabled":true,"description":{"content":"Data Type: String
\n","type":"text/plain"},"key":"region","value":""},{"disabled":true,"description":{"content":"Data Type: String
\n","type":"text/plain"},"key":"city","value":""},{"disabled":true,"description":{"content":"Data Type: String
\n","type":"text/plain"},"key":"enthusiasm","value":""},{"disabled":true,"description":{"content":"Data Type: Enum8('unknown' = 0, 'morning' = 1, 'afternoon' = 2, 'evening' = 3, 'night' = 4). \nMorning: 6 AM - Noon recipient local time. Afternoon: Noon - 6 PM. Evening: 6 PM - Midnight. Late Night: Midnight - 6 AM.
\n","type":"text/plain"},"key":"timeofday","value":""},{"disabled":true,"description":{"content":"Data Type: Integer
\n","type":"text/plain"},"key":"timezone","value":""},{"disabled":true,"description":{"content":"Data Type: String
\n","type":"text/plain"},"key":"recipient","value":""}],"variable":[]}},"response":[{"id":"bd5fc2d8-a42c-4ab5-9a3b-350b7e4293ae","name":"Detailed Read Events","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"","disabled":true}],"url":{"raw":"{{host}}/analytics/events/read/","host":["{{host}}"],"path":["analytics","events","read",""],"query":[{"key":"startdate","value":"","description":"Data Type: DateTime. ","disabled":true},{"key":"enddate","value":"","description":"Data Type: DateTime. ","disabled":true},{"key":"source","value":"","description":"Data Type: Nullable(String). ","disabled":true},{"key":"integrationkey","value":"","description":"Data Type: String. ","disabled":true},{"key":"provider","value":"","description":"Data Type: String.","disabled":true},{"key":"todomain","value":null,"description":"Data Type: Nullable(String). ","disabled":true},{"key":"campaign_id","value":null,"description":"Data Type: Nullable(String). ","disabled":true},{"key":"platform","value":null,"description":"Data Type: varchar(50) null.","disabled":true},{"key":"country","value":null,"description":"Data Type: String.","disabled":true},{"key":"region","value":null,"description":"Data Type: String.","disabled":true},{"key":"city","value":null,"description":"Data Type: String.","disabled":true},{"key":"enthusiasm","value":null,"disabled":true},{"key":"timeofday","value":null,"description":"Data Type: Enum8('unknown' = 0, 'morning' = 1, 'afternoon' = 2, 'evening' = 3, 'night' = 4). \nMorning: 6 AM - Noon recipient local time. Afternoon: Noon - 6 PM. Evening: 6 PM - Midnight. Late Night: Midnight - 6 AM.","disabled":true},{"key":"timezone","value":null,"description":"Data Type: Integer","disabled":true},{"key":"recipient","value":null,"disabled":true}]}},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"params\": {\n \"startdate\": \"2021-05-18T00:00:00+00:00\",\n \"enddate\": \"2021-06-16T23:59:00+00:00\",\n \"source\": null,\n \"integrationkey\": null,\n \"provider\": null,\n \"todomain\": null,\n \"pixel\": null,\n \"campaign_id\": null,\n \"platform\": null,\n \"country\": null,\n \"region\": null,\n \"city\": null,\n \"enthusiasm\": null,\n \"timeofday\": null,\n \"timezone\": null,\n \"recipient\": null\n },\n \"total\":819932,\n \"limit\":100,\n \"pages\":8200\n },\n \"results\": [\n {\n \"created\": \"2025-01-06 07:00:00\",\n \"campaign_id\": null,\n \"message_id\": null,\n \"ip\": \"\",\n \"fromaddress\": \"rendertest00003203639_00176027025@250okdesign.com\",\n \"provider\": \"Mail.ru\",\n \"source\": \"ses\",\n \"integrationkey\": null,\n \"seconds\": null,\n \"url\": null,\n \"country\": \"RU\",\n \"region\": \"\",\n \"city\": \"\",\n \"timeofday\": \"morning\",\n \"properties.key\": [\n \"eventType\",\n \"headersTruncated\",\n \"sendingAccountId\",\n \"source\",\n \"timestamp\"\n ],\n \"properties.value\": [\n \"Open\",\n \"False\",\n \"616752873841\",\n \"rendertest00003203639_00176027025@250okdesign.com\",\n \"2025-01-06T06:59:49.289Z\"\n ],\n \"recipient\": \"email@domain.com\",\n \"pixel\": null,\n \"timezone\": \"Europe/Moscow\",\n \"platform\": \"Other\",\n \"device\": \"Linux Unknown\",\n \"client\": \"Default Browser Unknown\",\n \"rdns\": null,\n \"smtpfrom\": null,\n \"smtpto\": null,\n \"smtplog\": null,\n \"code\": null,\n \"reason\": null,\n \"subject\": null\n },\n {\n \"created\": \"2025-01-06 07:00:01\",\n \"campaign_id\": null,\n \"message_id\": null,\n \"ip\": \"\",\n \"fromaddress\": \"rendertest00003203639_00176027024@250okdesign.com\",\n \"provider\": \"Mail.ru\",\n \"source\": \"ses\",\n \"integrationkey\": null,\n \"seconds\": null,\n \"url\": null,\n \"country\": \"RU\",\n \"region\": \"\",\n \"city\": \"\",\n \"timeofday\": \"morning\",\n \"properties.key\": [\n \"eventType\",\n \"headersTruncated\",\n \"sendingAccountId\",\n \"source\",\n \"timestamp\"\n ],\n \"properties.value\": [\n \"Open\",\n \"False\",\n \"616752873841\",\n \"rendertest00003203639_00176027024@250okdesign.com\",\n \"2025-01-06T06:59:49.601Z\"\n ],\n \"recipient\": \"email@domain.com\",\n \"pixel\": null,\n \"timezone\": \"Europe/Moscow\",\n \"platform\": \"Desktop\",\n \"device\": \"Windows 10\",\n \"client\": \"Chrome 119\",\n \"rdns\": null,\n \"smtpfrom\": null,\n \"smtpto\": null,\n \"smtplog\": null,\n \"code\": null,\n \"reason\": null,\n \"subject\": null\n }\n ]\n}"}],"_postman_id":"56547f5d-089e-4604-917a-bc73aaaaac72"},{"name":"Detailed Click Events","id":"d11c33d8-f7cb-48a4-beb8-90f9d1b64995","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{host}}/analytics/events/click","description":"Please see timezone param list for details about the id's.
\n","auth":{"type":"apikey","apikey":{"value":"{{your-api-key-here}}","key":"Data Type: DateTime.
\n","type":"text/plain"},"key":"startdate","value":""},{"disabled":true,"description":{"content":"Data Type: DateTime.
\n","type":"text/plain"},"key":"enddate","value":""},{"disabled":true,"description":{"content":"Data Type: Nullable(String)
\n","type":"text/plain"},"key":"source","value":""},{"disabled":true,"description":{"content":"Data Type: String
\n","type":"text/plain"},"key":"integrationkey","value":""},{"disabled":true,"description":{"content":"Data Type: String
\n","type":"text/plain"},"key":"provider","value":""},{"disabled":true,"description":{"content":"Data Type: Nullable(String)
\n","type":"text/plain"},"key":"todomain","value":""},{"disabled":true,"description":{"content":"Data Type: Nullable(String)
\n","type":"text/plain"},"key":"campaign_id","value":""},{"disabled":true,"description":{"content":"Data Type: varchar(50) null.
\n","type":"text/plain"},"key":"platform","value":""},{"disabled":true,"description":{"content":"Data Type: String
\n","type":"text/plain"},"key":"country","value":""},{"disabled":true,"description":{"content":"Data Type: String
\n","type":"text/plain"},"key":"region","value":""},{"disabled":true,"description":{"content":"Data Type: String
\n","type":"text/plain"},"key":"city","value":""},{"disabled":true,"description":{"content":"Data Type: String
\n","type":"text/plain"},"key":"enthusiasm","value":""},{"disabled":true,"description":{"content":"Data Type: Enum8('unknown' = 0, 'morning' = 1, 'afternoon' = 2, 'evening' = 3, 'night' = 4). \nMorning: 6 AM - Noon recipient local time. Afternoon: Noon - 6 PM. Evening: 6 PM - Midnight. Late Night: Midnight - 6 AM.
\n","type":"text/plain"},"key":"timeofday","value":""},{"disabled":true,"description":{"content":"Data Type: Integer
\n","type":"text/plain"},"key":"timezone","value":""},{"disabled":true,"description":{"content":"Data Type: String
\n","type":"text/plain"},"key":"recipient","value":""}],"variable":[]}},"response":[{"id":"64dd0f3b-defc-49e4-9c09-1970200b544a","name":"Detailed Click Events","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"","disabled":true}],"url":{"raw":"{{host}}/analytics/events/click/","host":["{{host}}"],"path":["analytics","events","click",""],"query":[{"key":"startdate","value":"","description":"Data Type: DateTime. ","disabled":true},{"key":"enddate","value":"","description":"Data Type: DateTime. ","disabled":true},{"key":"source","value":"","description":"Data Type: Nullable(String). ","disabled":true},{"key":"integrationkey","value":"","description":"Data Type: String. ","disabled":true},{"key":"provider","value":"","description":"Data Type: String.","disabled":true},{"key":"todomain","value":null,"description":"Data Type: Nullable(String). ","disabled":true},{"key":"campaign_id","value":null,"description":"Data Type: Nullable(String). ","disabled":true},{"key":"platform","value":null,"description":"Data Type: varchar(50) null.","disabled":true},{"key":"country","value":null,"description":"Data Type: String.","disabled":true},{"key":"region","value":null,"description":"Data Type: String.","disabled":true},{"key":"city","value":null,"description":"Data Type: String.","disabled":true},{"key":"enthusiasm","value":null,"disabled":true},{"key":"timeofday","value":null,"description":"Data Type: Enum8('unknown' = 0, 'morning' = 1, 'afternoon' = 2, 'evening' = 3, 'night' = 4). \nMorning: 6 AM - Noon recipient local time. Afternoon: Noon - 6 PM. Evening: 6 PM - Midnight. Late Night: Midnight - 6 AM.","disabled":true},{"key":"timezone","value":null,"description":"Data Type: Integer","disabled":true},{"key":"recipient","value":null,"disabled":true}]}},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"params\": {\n \"startdate\": \"2021-05-18T00:00:00+00:00\",\n \"enddate\": \"2021-06-16T23:59:00+00:00\",\n \"source\": null,\n \"integrationkey\": null,\n \"provider\": null,\n \"todomain\": null,\n \"pixel\": null,\n \"campaign_id\": null,\n \"platform\": null,\n \"country\": null,\n \"region\": null,\n \"city\": null,\n \"enthusiasm\": null,\n \"timeofday\": null,\n \"timezone\": null,\n \"recipient\": null\n },\n \"total\":8308,\n \"limit\":8308,\n \"pages\":84\n },\n \"results\": [\n {\n \"created\": \"2025-01-06 02:33:27\",\n \"campaign_id\": null,\n \"message_id\":null,\n \"ip\": \"\",\n \"fromaddress\": \"validity@everest.validity.com\",\n \"provider\": \"MimeCast\",\n \"source\": \"ses\",\n \"integrationkey\": null,\n \"seconds\": null,\n \"url\": \"https://validity.com/\",\n \"country\": \"US\",\n \"region\": \"Oregon\",\n \"city\": \"Boardman\",\n \"timeofday\": \"morning\",\n \"properties.key\": [\n \"eventType\",\n \"headersTruncated\",\n \"sendingAccountId\",\n \"source\",\n \"timestamp\"\n ],\n \"properties.value\": [\n \"Click\",\n \"False\",\n \"616752873841\",\n \"validity@everest.validity.com\",\n \"2025-01-06T06:59:49.289Z\"\n ],\n \"recipient\": \"email@domain.com\",\n \"pixel\": null,\n \"timezone\": \"Europe/Moscow\",\n \"platform\": \"Other\",\n \"device\": \"Windows 10\",\n \"client\": \"Chrome 113\",\n \"rdns\": null,\n \"smtpfrom\": null,\n \"smtpto\": null,\n \"smtplog\": null,\n \"code\": null,\n \"reason\": null,\n \"subject\": null\n },\n {\n \"created\": \"2025-01-06 08:46:32\",\n \"campaign_id\": null,\n \"message_id\": null,\n \"ip\": \"\",\n \"fromaddress\": \"validity@everest.validity.com\",\n \"provider\": \"Office 365\",\n \"source\": \"ses\",\n \"integrationkey\": null,\n \"seconds\": null,\n \"url\": \"https://validity.com/\",\n \"country\": \"JP\",\n \"region\": \"Tokyo\",\n \"city\": \"\",\n \"timeofday\": \"afternoon\",\n \"properties.key\": [\n \"eventType\",\n \"headersTruncated\",\n \"sendingAccountId\",\n \"source\",\n \"timestamp\"\n ],\n \"properties.value\": [\n \"Click\",\n \"False\",\n \"616752873841\",\n \"validity@everest.validity.com\",\n \"2025-01-06T06:59:49.601Z\"\n ],\n \"recipient\": \"email@domain.com\",\n \"pixel\": null,\n \"timezone\": \"Europe/Moscow\",\n \"platform\": \"Desktop\",\n \"device\": \"Windows 10\",\n \"client\": \"Chrome 119\",\n \"rdns\": null,\n \"smtpfrom\": null,\n \"smtpto\": null,\n \"smtplog\": null,\n \"code\": null,\n \"reason\": null,\n \"subject\": null\n }\n ]\n}"}],"_postman_id":"d11c33d8-f7cb-48a4-beb8-90f9d1b64995"},{"name":"Detailed Forward Events","id":"91c6e16f-abc4-4fd3-a43b-5c0cfab38462","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{host}}/analytics/events/forward","description":"Please see timezone param list for details about the id's.
\n","auth":{"type":"apikey","apikey":{"value":"{{your-api-key-here}}","key":"Data Type: DateTime.
\n","type":"text/plain"},"key":"startdate","value":""},{"disabled":true,"description":{"content":"Data Type: DateTime.
\n","type":"text/plain"},"key":"enddate","value":""},{"disabled":true,"description":{"content":"Data Type: Nullable(String)
\n","type":"text/plain"},"key":"source","value":""},{"disabled":true,"description":{"content":"Data Type: String
\n","type":"text/plain"},"key":"integrationkey","value":""},{"disabled":true,"description":{"content":"Data Type: String
\n","type":"text/plain"},"key":"provider","value":""},{"disabled":true,"description":{"content":"Data Type: Nullable(String)
\n","type":"text/plain"},"key":"todomain","value":""},{"disabled":true,"description":{"content":"Data Type: Nullable(String)
\n","type":"text/plain"},"key":"campaign_id","value":""},{"disabled":true,"description":{"content":"Data Type: varchar(50) null.
\n","type":"text/plain"},"key":"platform","value":""},{"disabled":true,"description":{"content":"Data Type: String
\n","type":"text/plain"},"key":"country","value":""},{"disabled":true,"description":{"content":"Data Type: String
\n","type":"text/plain"},"key":"region","value":""},{"disabled":true,"description":{"content":"Data Type: String
\n","type":"text/plain"},"key":"city","value":""},{"disabled":true,"description":{"content":"Data Type: String
\n","type":"text/plain"},"key":"enthusiasm","value":""},{"disabled":true,"description":{"content":"Data Type: Enum8('unknown' = 0, 'morning' = 1, 'afternoon' = 2, 'evening' = 3, 'night' = 4). \nMorning: 6 AM - Noon recipient local time. Afternoon: Noon - 6 PM. Evening: 6 PM - Midnight. Late Night: Midnight - 6 AM.
\n","type":"text/plain"},"key":"timeofday","value":""},{"disabled":true,"description":{"content":"Data Type: Integer
\n","type":"text/plain"},"key":"timezone","value":""},{"disabled":true,"description":{"content":"Data Type: String
\n","type":"text/plain"},"key":"recipient","value":""}],"variable":[]}},"response":[{"id":"b0cbe9aa-3abe-4c9e-a466-a1c9d3cdd7b1","name":"Detailed Forward Events","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"","disabled":true}],"url":{"raw":"{{host}}/analytics/events/forward/","host":["{{host}}"],"path":["analytics","events","forward",""],"query":[{"key":"startdate","value":"","description":"Data Type: DateTime. ","disabled":true},{"key":"enddate","value":"","description":"Data Type: DateTime. ","disabled":true},{"key":"source","value":"","description":"Data Type: Nullable(String). ","disabled":true},{"key":"integrationkey","value":"","description":"Data Type: String. ","disabled":true},{"key":"provider","value":"","description":"Data Type: String.","disabled":true},{"key":"todomain","value":null,"description":"Data Type: Nullable(String). ","disabled":true},{"key":"campaign_id","value":null,"description":"Data Type: Nullable(String). ","disabled":true},{"key":"platform","value":null,"description":"Data Type: varchar(50) null.","disabled":true},{"key":"country","value":null,"description":"Data Type: String.","disabled":true},{"key":"region","value":null,"description":"Data Type: String.","disabled":true},{"key":"city","value":null,"description":"Data Type: String.","disabled":true},{"key":"enthusiasm","value":null,"disabled":true},{"key":"timeofday","value":null,"description":"Data Type: Enum8('unknown' = 0, 'morning' = 1, 'afternoon' = 2, 'evening' = 3, 'night' = 4). \nMorning: 6 AM - Noon recipient local time. Afternoon: Noon - 6 PM. Evening: 6 PM - Midnight. Late Night: Midnight - 6 AM.","disabled":true},{"key":"timezone","value":null,"description":"Data Type: Integer","disabled":true},{"key":"recipient","value":null,"disabled":true}]}},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"params\": {\n \"startdate\": \"2021-05-18T00:00:00+00:00\",\n \"enddate\": \"2021-06-16T23:59:00+00:00\",\n \"source\": null,\n \"integrationkey\": null,\n \"provider\": null,\n \"todomain\": null,\n \"pixel\": null,\n \"campaign_id\": null,\n \"platform\": null,\n \"country\": null,\n \"region\": null,\n \"city\": null,\n \"enthusiasm\": null,\n \"timeofday\": null,\n \"timezone\": null,\n \"recipient\": null\n },\n \"total\":9000,\n \"limit\":100,\n \"pages\":90\n },\n \"results\": [\n {\n \"created\": \"2025-01-06 14:10:45\",\n \"campaign_id\": null,\n \"message_id\": null,\n \"ip\": \"\",\n \"fromaddress\": \"validity@everest.validity.com\",\n \"provider\": \"MimeCast\",\n \"source\": \"ses\",\n \"integrationkey\": null,\n \"seconds\": null,\n \"url\": \"https://validity.com/\",\n \"country\": \"US\",\n \"region\": \"Oregon\",\n \"city\": \"Boardman\",\n \"timeofday\": \"morning\",\n \"properties.key\": [\n \"eventType\",\n \"headersTruncated\",\n \"sendingAccountId\",\n \"source\",\n \"timestamp\"\n ],\n \"properties.value\": [\n \"forward\",\n \"False\",\n \"616752873841\",\n \"validity@everest.validity.com\",\n \"2025-01-06T06:59:49.289Z\"\n ],\n \"recipient\": \"email@domain.com\",\n \"pixel\": null,\n \"timezone\": \"Europe/Moscow\",\n \"platform\": \"Other\",\n \"device\": \"Windows 10\",\n \"client\": \"Chrome 113\",\n \"rdns\": null,\n \"smtpfrom\": null,\n \"smtpto\": null,\n \"smtplog\": null,\n \"code\": null,\n \"reason\": null,\n \"subject\": null\n },\n {\n \"created\": \"2025-01-06 08:46:32\",\n \"campaign_id\": null,\n \"message_id\": null,\n \"ip\": \"\",\n \"fromaddress\": \"validity@everest.validity.com\",\n \"provider\": \"Office 365\",\n \"source\": \"ses\",\n \"integrationkey\": null,\n \"seconds\": null,\n \"url\": \"https://validity.com/\",\n \"country\": \"JP\",\n \"region\": \"Tokyo\",\n \"city\": \"\",\n \"timeofday\": \"afternoon\",\n \"properties.key\": [\n \"eventType\",\n \"headersTruncated\",\n \"sendingAccountId\",\n \"source\",\n \"timestamp\"\n ],\n \"properties.value\": [\n \"forward\",\n \"False\",\n \"616752873841\",\n \"validity@everest.validity.com\",\n \"2025-01-06T06:59:49.601Z\"\n ],\n \"recipient\": \"email@domain.com\",\n \"pixel\": null,\n \"timezone\": \"Europe/Moscow\",\n \"platform\": \"Desktop\",\n \"device\": \"Windows 10\",\n \"client\": \"Chrome 119\",\n \"rdns\": null,\n \"smtpfrom\": null,\n \"smtpto\": null,\n \"smtplog\": null,\n \"code\": null,\n \"reason\": null,\n \"subject\": null\n }\n ]\n}"}],"_postman_id":"91c6e16f-abc4-4fd3-a43b-5c0cfab38462"},{"name":"Detailed Print Events","id":"61177b66-c3e0-454a-8672-e0fd4a89a64e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{host}}/analytics/events/print","description":"Please see timezone param list for details about the id's.
\n","auth":{"type":"apikey","apikey":{"value":"{{your-api-key-here}}","key":"Data Type: DateTime.
\n","type":"text/plain"},"key":"startdate","value":""},{"disabled":true,"description":{"content":"Data Type: DateTime.
\n","type":"text/plain"},"key":"enddate","value":""},{"disabled":true,"description":{"content":"Data Type: Nullable(String)
\n","type":"text/plain"},"key":"source","value":""},{"disabled":true,"description":{"content":"Data Type: String
\n","type":"text/plain"},"key":"integrationkey","value":""},{"disabled":true,"description":{"content":"Data Type: String
\n","type":"text/plain"},"key":"provider","value":""},{"disabled":true,"description":{"content":"Data Type: Nullable(String)
\n","type":"text/plain"},"key":"todomain","value":""},{"disabled":true,"description":{"content":"Data Type: Nullable(String)
\n","type":"text/plain"},"key":"campaign_id","value":""},{"disabled":true,"description":{"content":"Data Type: varchar(50) null.
\n","type":"text/plain"},"key":"platform","value":""},{"disabled":true,"description":{"content":"Data Type: String
\n","type":"text/plain"},"key":"country","value":""},{"disabled":true,"description":{"content":"Data Type: String
\n","type":"text/plain"},"key":"region","value":""},{"disabled":true,"description":{"content":"Data Type: String
\n","type":"text/plain"},"key":"city","value":""},{"disabled":true,"description":{"content":"Data Type: String
\n","type":"text/plain"},"key":"enthusiasm","value":""},{"disabled":true,"description":{"content":"Data Type: Enum8('unknown' = 0, 'morning' = 1, 'afternoon' = 2, 'evening' = 3, 'night' = 4). \nMorning: 6 AM - Noon recipient local time. Afternoon: Noon - 6 PM. Evening: 6 PM - Midnight. Late Night: Midnight - 6 AM.
\n","type":"text/plain"},"key":"timeofday","value":""},{"disabled":true,"description":{"content":"Data Type: Integer
\n","type":"text/plain"},"key":"timezone","value":""},{"disabled":true,"description":{"content":"Data Type: String
\n","type":"text/plain"},"key":"recipient","value":""}],"variable":[]}},"response":[{"id":"2027313a-f46d-4eed-b592-f6fb32a7db3d","name":"Detailed Print Events","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"","disabled":true}],"url":{"raw":"{{host}}/analytics/events/print/","host":["{{host}}"],"path":["analytics","events","print",""],"query":[{"key":"startdate","value":"","description":"Data Type: DateTime. ","disabled":true},{"key":"enddate","value":"","description":"Data Type: DateTime. ","disabled":true},{"key":"source","value":"","description":"Data Type: Nullable(String). ","disabled":true},{"key":"integrationkey","value":"","description":"Data Type: String. ","disabled":true},{"key":"provider","value":"","description":"Data Type: String.","disabled":true},{"key":"todomain","value":null,"description":"Data Type: Nullable(String). ","disabled":true},{"key":"campaign_id","value":null,"description":"Data Type: Nullable(String). ","disabled":true},{"key":"platform","value":null,"description":"Data Type: varchar(50) null.","disabled":true},{"key":"country","value":null,"description":"Data Type: String.","disabled":true},{"key":"region","value":null,"description":"Data Type: String.","disabled":true},{"key":"city","value":null,"description":"Data Type: String.","disabled":true},{"key":"enthusiasm","value":null,"disabled":true},{"key":"timeofday","value":null,"description":"Data Type: Enum8('unknown' = 0, 'morning' = 1, 'afternoon' = 2, 'evening' = 3, 'night' = 4). \nMorning: 6 AM - Noon recipient local time. Afternoon: Noon - 6 PM. Evening: 6 PM - Midnight. Late Night: Midnight - 6 AM.","disabled":true},{"key":"timezone","value":null,"description":"Data Type: Integer","disabled":true},{"key":"recipient","value":null,"disabled":true}]}},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"params\": {\n \"startdate\": \"2021-05-18T00:00:00+00:00\",\n \"enddate\": \"2021-06-16T23:59:00+00:00\",\n \"source\": null,\n \"integrationkey\": null,\n \"provider\": null,\n \"todomain\": null,\n \"pixel\": null,\n \"campaign_id\": null,\n \"platform\": null,\n \"country\": null,\n \"region\": null,\n \"city\": null,\n \"enthusiasm\": null,\n \"timeofday\": null,\n \"timezone\": null,\n \"recipient\": null\n },\n \"total\":778,\n \"limit\":100,\n \"pages\":7\n },\n \"results\": [\n {\n \"created\": \"2025-01-06 07:34:36\",\n \"campaign_id\": null,\n \"message_id\": null,\n \"ip\": \"\",\n \"fromaddress\": \"validity@everest.validity.com\",\n \"provider\": \"MimeCast\",\n \"source\": \"ses\",\n \"integrationkey\": null,\n \"seconds\": null,\n \"url\": \"https://validity.com/\",\n \"country\": \"US\",\n \"region\": \"Oregon\",\n \"city\": \"Boardman\",\n \"timeofday\": \"morning\",\n \"properties.key\": [\n \"eventType\",\n \"headersTruncated\",\n \"sendingAccountId\",\n \"source\",\n \"timestamp\"\n ],\n \"properties.value\": [\n \"print\",\n \"False\",\n \"616752873841\",\n \"validity@everest.validity.com\",\n \"2025-01-06T06:59:49.289Z\"\n ],\n \"recipient\": \"email@domain.com\",\n \"pixel\": null,\n \"timezone\": \"Europe/Moscow\",\n \"platform\": \"Other\",\n \"device\": \"Windows 10\",\n \"client\": \"Chrome 113\",\n \"rdns\": null,\n \"smtpfrom\": null,\n \"smtpto\": null,\n \"smtplog\": null,\n \"code\": null,\n \"reason\": null,\n \"subject\": null\n },\n {\n \"created\": \"2025-01-06 08:46:32\",\n \"campaign_id\": null,\n \"message_id\": null,\n \"ip\": \"\",\n \"fromaddress\": \"validity@everest.validity.com\",\n \"provider\": \"Office 365\",\n \"source\": \"ses\",\n \"integrationkey\": null,\n \"seconds\": null,\n \"url\": \"https://validity.com/\",\n \"country\": \"JP\",\n \"region\": \"Tokyo\",\n \"city\": \"\",\n \"timeofday\": \"afternoon\",\n \"properties.key\": [\n \"eventType\",\n \"headersTruncated\",\n \"sendingAccountId\",\n \"source\",\n \"timestamp\"\n ],\n \"properties.value\": [\n \"print\",\n \"False\",\n \"616752873841\",\n \"validity@everest.validity.com\",\n \"2025-01-06T06:59:49.601Z\"\n ],\n \"recipient\": \"email@domain.com\",\n \"pixel\": null,\n \"timezone\": \"Europe/Moscow\",\n \"platform\": \"Desktop\",\n \"device\": \"Windows 10\",\n \"client\": \"Chrome 119\",\n \"rdns\": null,\n \"smtpfrom\": null,\n \"smtpto\": null,\n \"smtplog\": null,\n \"code\": null,\n \"reason\": null,\n \"subject\": null\n }\n ]\n}"}],"_postman_id":"61177b66-c3e0-454a-8672-e0fd4a89a64e"},{"name":"Platform Recipients","id":"4128c44f-d8c4-4564-82d8-dce64a11c95a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{host}}/analytics/distribution/desktop","description":"Please see timezone param list for details about the id's.
\n","auth":{"type":"apikey","apikey":{"value":"{{your-api-key-here}}","key":"Data Type: DateTime
\n","type":"text/plain"},"key":"startdate","value":""},{"disabled":true,"description":{"content":"Data Type: DateTime
\n","type":"text/plain"},"key":"enddate","value":""},{"disabled":true,"description":{"content":"Data Type: Nullable(String)
\n","type":"text/plain"},"key":"source","value":""},{"disabled":true,"description":{"content":"Data Type: String
\n","type":"text/plain"},"key":"integrationkey","value":""},{"disabled":true,"description":{"content":"Data Type: String
\n","type":"text/plain"},"key":"country","value":""},{"disabled":true,"description":{"content":"Data Type: String
\n","type":"text/plain"},"key":"region","value":""},{"disabled":true,"description":{"content":"Data Type: String
\n","type":"text/plain"},"key":"city","value":""},{"disabled":true,"description":{"content":"Data Type: Integer
\n","type":"text/plain"},"key":"timezone","value":""},{"disabled":true,"description":{"content":"Data Type: String
\n","type":"text/plain"},"key":"provider","value":""},{"disabled":true,"description":{"content":"Data Type: Nullable(String)
\n","type":"text/plain"},"key":"campaign_id","value":""},{"disabled":true,"description":{"content":"Data Type: Nullable(String)
\n","type":"text/plain"},"key":"todomain","value":""},{"disabled":true,"description":{"content":"Data Type: String
\n","type":"text/plain"},"key":"recipient","value":""},{"disabled":true,"description":{"content":"Data Type: varchar(50) null
\n","type":"text/plain"},"key":"platform","value":""}],"variable":[]}},"response":[{"id":"c2cfd597-8ab3-483b-b567-367910e6f5bf","name":"Platform Recipients","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/analytics/distribution/desktop","host":["{{host}}"],"path":["analytics","distribution","desktop"],"query":[{"key":"startdate","value":"2021-04-01 12:00:00","disabled":true},{"key":"enddate","value":"2021-04-15 12:00:00","disabled":true},{"key":"source","value":"250ok","disabled":true},{"key":"integrationkey","value":"pixel","disabled":true},{"key":"country","value":"US","disabled":true},{"key":"region","value":"California","disabled":true},{"key":"city","value":"San Francisco","disabled":true},{"key":"timezone","value":"America/Los_Angeles","disabled":true},{"key":"provider","value":"Gmail","type":"text","disabled":true},{"key":"campaign_id","value":"12345","disabled":true},{"key":"todomain","value":"domain.com","disabled":true},{"key":"recipient","value":"user@domain.com","disabled":true},{"key":"platform","value":"mobile","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.17.6"},{"key":"Date","value":"Tue, 05 Oct 2021 14:03:51 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"233084"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":""},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Headers","value":"Authorization,Accept,Keep-Alive,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type,Content-Range,Range,x-api-key"},{"key":"Access-Control-Allow-Methods","value":"GET,POST,OPTIONS,PUT,DELETE,PATCH"}],"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"params\": {\n \"startdate\": \"2021-09-06T00:00:00+00:00\",\n \"enddate\": \"2021-10-05T00:00:00+00:00\",\n \"source\": null,\n \"integrationkey\": null,\n \"provider\": null,\n \"todomain\": null,\n \"pixel\": null,\n \"campaign_id\": null,\n \"platform\": null,\n \"country\": null,\n \"region\": null,\n \"city\": null,\n \"enthusiasm\": null,\n \"timeofday\": null,\n \"timezone\": null,\n \"recipient\": null\n },\n \"total\": 3,\n \"limit\": 5000,\n \"pages\": 1\n },\n \"results\": [\n {\n \"toaddress\": \"recipient1@domain.com\",\n \"firstseen\": \"9/6/2021\",\n \"lastseen\": \"10/4/2021\",\n \"country\": null,\n \"region\": null,\n \"city\": null,\n \"platform\": \"Desktop\",\n \"device\": \"Windows\",\n \"client\": \"Edge\",\n \"timezone\": null\n },\n {\n \"toaddress\": \"recipient2@domain.com\",\n \"firstseen\": \"9/17/2021\",\n \"lastseen\": \"9/17/2021\",\n \"country\": null,\n \"region\": null,\n \"city\": null,\n \"platform\": \"Desktop\",\n \"device\": \"Windows\",\n \"client\": \"Edge\",\n \"timezone\": null\n },\n {\n \"toaddress\": \"recipient3@domain.com\",\n \"firstseen\": \"9/14/2021\",\n \"lastseen\": \"9/21/2021\",\n \"country\": null,\n \"region\": null,\n \"city\": null,\n \"platform\": \"Desktop\",\n \"device\": \"Windows\",\n \"client\": \"Edge\",\n \"timezone\": null\n }, ...\n ]\n}"}],"_postman_id":"4128c44f-d8c4-4564-82d8-dce64a11c95a"},{"name":"Recent Activity","id":"a61589ac-0b85-4f6c-8569-b3669f38ebfd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{host}}/analytics/engagement/activity","description":"Please see timezone param list for details about the id's.
\n","auth":{"type":"apikey","apikey":{"value":"{{your-api-key-here}}","key":"Data Type: DateTime
\n","type":"text/plain"},"key":"startdate","value":""},{"disabled":true,"description":{"content":"Data Type: DateTime
\n","type":"text/plain"},"key":"enddate","value":""},{"disabled":true,"description":{"content":"Data Type: Nullable(String)
\n","type":"text/plain"},"key":"source","value":""},{"disabled":true,"description":{"content":"Data Type: String
\n","type":"text/plain"},"key":"integrationkey","value":""},{"disabled":true,"description":{"content":"Data Type: String
\n","type":"text/plain"},"key":"provider","value":""},{"disabled":true,"description":{"content":"Data Type: Nullable(String)
\n","type":"text/plain"},"key":"todomain","value":""},{"disabled":true,"description":{"content":"Data Type: Nullable(String)
\n","type":"text/plain"},"key":"campaign_id","value":""},{"disabled":true,"description":{"content":"Date Type: varchar(50) null.
\n","type":"text/plain"},"key":"platform","value":""},{"disabled":true,"description":{"content":"Data Type: String
\n","type":"text/plain"},"key":"country","value":""},{"disabled":true,"description":{"content":"Data Type: String
\n","type":"text/plain"},"key":"region","value":""},{"disabled":true,"description":{"content":"Data Type: String
\n","type":"text/plain"},"key":"city","value":""},{"disabled":true,"description":{"content":"Data Type: Enum8('unknown' = 0, 'morning' = 1, 'afternoon' = 2, 'evening' = 3, 'night = 4)
\n","type":"text/plain"},"key":"timeofday","value":""},{"disabled":true,"description":{"content":"Data Type: Integer
\n","type":"text/plain"},"key":"timezone","value":""},{"disabled":true,"description":{"content":"Data Type: String
\n","type":"text/plain"},"key":"recipient","value":""},{"disabled":true,"description":{"content":"Data Type: String
\n","type":"text/plain"},"key":"enthusiasm","value":""}],"variable":[]}},"response":[{"id":"e5801707-6d8f-4c10-8f54-beffcb64cacf","name":"Recent Activity","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/analytics/engagement/activity?startdate=&enddate=&source=&integrationkey=&provider=&todomain&campaign_id&platform&country®ion&city&timeofday&timezone&recipient&enthusiasm","host":["{{host}}"],"path":["analytics","engagement","activity"],"query":[{"key":"startdate","value":"","description":"Data Type: DateTime"},{"key":"enddate","value":"","description":"Data Type: DateTime"},{"key":"source","value":"","description":"Data Type: Nullable(String)"},{"key":"integrationkey","value":"","description":"Data Type: String"},{"key":"provider","value":"","description":"Data Type: String"},{"key":"todomain","value":null,"description":"Data Type: Nullable(String)"},{"key":"campaign_id","value":null,"description":"Data Type: Nullable(String)"},{"key":"platform","value":null,"description":"Data Type: varchar(50) null."},{"key":"country","value":null,"description":"Data Type: String"},{"key":"region","value":null,"description":"Data Type: String"},{"key":"city","value":null,"description":"Data Type: String"},{"key":"timeofday","value":null,"description":"Data Type: Enum8('unknown' = 0, 'morning' = 1, 'afternoon' = 2, 'evening' = 3, 'night = 4)"},{"key":"timezone","value":null,"description":"Data Type: Integer"},{"key":"recipient","value":null},{"key":"enthusiasm","value":null}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.17.6"},{"key":"Date","value":"Thu, 14 Jan 2021 16:24:10 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"3528"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/7.3.24"},{"key":"Access-Control-Allow-Origin","value":"https://everest.validity.com"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Headers","value":"Authorization,Accept,Keep-Alive,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type,Content-Range,Range,x-api-key"},{"key":"Access-Control-Allow-Methods","value":"GET,POST,OPTIONS,PUT,DELETE,PATCH"}],"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"params\": {\n \"startdate\": \"2020-12-15T05:00:00+00:00\",\n \"enddate\": \"2021-01-14T05:00:00+00:00\",\n \"timeofday\": [\n \"morning\"\n ],\n \"platform\": [\n \"desktop\",\n \"mobile\"\n ],\n \"country\": [\n \"US\"\n ],\n \"provider\": null,\n \"todomain\": null,\n \"pixel\": null,\n \"campaign_id\": null,\n \"region\": null,\n \"timezone_id\": null,\n \"enthusiasm\": null,\n \"device_id\": null,\n \"client_id\": null,\n \"recipient\": null\n },\n \"opens\": 4896,\n \"uniques\": 2072,\n \"forwards\": 17,\n \"uniqueforwards\": 14,\n \"prints\": 595,\n \"uniqueprints\": 365\n },\n \"results\": [\n {\n \"day\": \"2020-12-15\",\n \"opens\": 198,\n \"uniques\": 104,\n \"forwards\": 3,\n \"uniqueforwards\": 2,\n \"prints\": 14,\n \"uniqueprints\": 12\n },\n {\n \"day\": \"2020-12-16\",\n \"opens\": 228,\n \"uniques\": 111,\n \"forwards\": 3,\n \"uniqueforwards\": 3,\n \"prints\": 19,\n \"uniqueprints\": 15\n },\n {\n \"day\": \"2020-12-17\",\n \"opens\": 58,\n \"uniques\": 29,\n \"forwards\": 6,\n \"uniqueforwards\": 4,\n \"prints\": 12,\n \"uniqueprints\": 5\n },\n {\n \"day\": \"2020-12-18\",\n \"opens\": 76,\n \"uniques\": 36,\n \"forwards\": 3,\n \"uniqueforwards\": 3,\n \"prints\": 5,\n \"uniqueprints\": 5\n },\n {\n \"day\": \"2020-12-19\",\n \"opens\": 29,\n \"uniques\": 16,\n \"forwards\": 0,\n \"uniqueforwards\": 0,\n \"prints\": 3,\n \"uniqueprints\": 3\n },\n {\n \"day\": \"2020-12-20\",\n \"opens\": 28,\n \"uniques\": 18,\n \"forwards\": 0,\n \"uniqueforwards\": 0,\n \"prints\": 5,\n \"uniqueprints\": 3\n },\n {\n \"day\": \"2020-12-21\",\n \"opens\": 278,\n \"uniques\": 111,\n \"forwards\": 0,\n \"uniqueforwards\": 0,\n \"prints\": 27,\n \"uniqueprints\": 10\n },\n {\n \"day\": \"2020-12-22\",\n \"opens\": 114,\n \"uniques\": 56,\n \"forwards\": 0,\n \"uniqueforwards\": 0,\n \"prints\": 6,\n \"uniqueprints\": 6\n },\n {\n \"day\": \"2020-12-23\",\n \"opens\": 121,\n \"uniques\": 63,\n \"forwards\": 0,\n \"uniqueforwards\": 0,\n \"prints\": 23,\n \"uniqueprints\": 10\n },\n {\n \"day\": \"2020-12-24\",\n \"opens\": 63,\n \"uniques\": 40,\n \"forwards\": 0,\n \"uniqueforwards\": 0,\n \"prints\": 28,\n \"uniqueprints\": 19\n },\n {\n \"day\": \"2020-12-25\",\n \"opens\": 24,\n \"uniques\": 20,\n \"forwards\": 0,\n \"uniqueforwards\": 0,\n \"prints\": 14,\n \"uniqueprints\": 13\n },\n {\n \"day\": \"2020-12-26\",\n \"opens\": 180,\n \"uniques\": 53,\n \"forwards\": 0,\n \"uniqueforwards\": 0,\n \"prints\": 14,\n \"uniqueprints\": 13\n },\n {\n \"day\": \"2020-12-27\",\n \"opens\": 37,\n \"uniques\": 15,\n \"forwards\": 0,\n \"uniqueforwards\": 0,\n \"prints\": 9,\n \"uniqueprints\": 6\n },\n {\n \"day\": \"2020-12-28\",\n \"opens\": 206,\n \"uniques\": 76,\n \"forwards\": 0,\n \"uniqueforwards\": 0,\n \"prints\": 24,\n \"uniqueprints\": 14\n },\n {\n \"day\": \"2020-12-29\",\n \"opens\": 179,\n \"uniques\": 69,\n \"forwards\": 0,\n \"uniqueforwards\": 0,\n \"prints\": 11,\n \"uniqueprints\": 10\n },\n {\n \"day\": \"2020-12-30\",\n \"opens\": 144,\n \"uniques\": 65,\n \"forwards\": 0,\n \"uniqueforwards\": 0,\n \"prints\": 11,\n \"uniqueprints\": 10\n },\n {\n \"day\": \"2020-12-31\",\n \"opens\": 112,\n \"uniques\": 60,\n \"forwards\": 0,\n \"uniqueforwards\": 0,\n \"prints\": 20,\n \"uniqueprints\": 12\n },\n {\n \"day\": \"2021-01-01\",\n \"opens\": 102,\n \"uniques\": 39,\n \"forwards\": 0,\n \"uniqueforwards\": 0,\n \"prints\": 33,\n \"uniqueprints\": 14\n },\n {\n \"day\": \"2021-01-02\",\n \"opens\": 60,\n \"uniques\": 33,\n \"forwards\": 0,\n \"uniqueforwards\": 0,\n \"prints\": 11,\n \"uniqueprints\": 11\n },\n {\n \"day\": \"2021-01-03\",\n \"opens\": 204,\n \"uniques\": 67,\n \"forwards\": 0,\n \"uniqueforwards\": 0,\n \"prints\": 16,\n \"uniqueprints\": 10\n },\n {\n \"day\": \"2021-01-04\",\n \"opens\": 433,\n \"uniques\": 119,\n \"forwards\": 0,\n \"uniqueforwards\": 0,\n \"prints\": 29,\n \"uniqueprints\": 15\n },\n {\n \"day\": \"2021-01-05\",\n \"opens\": 273,\n \"uniques\": 140,\n \"forwards\": 0,\n \"uniqueforwards\": 0,\n \"prints\": 30,\n \"uniqueprints\": 21\n },\n {\n \"day\": \"2021-01-06\",\n \"opens\": 367,\n \"uniques\": 130,\n \"forwards\": 0,\n \"uniqueforwards\": 0,\n \"prints\": 21,\n \"uniqueprints\": 15\n },\n {\n \"day\": \"2021-01-07\",\n \"opens\": 251,\n \"uniques\": 128,\n \"forwards\": 0,\n \"uniqueforwards\": 0,\n \"prints\": 46,\n \"uniqueprints\": 22\n },\n {\n \"day\": \"2021-01-08\",\n \"opens\": 127,\n \"uniques\": 70,\n \"forwards\": 1,\n \"uniqueforwards\": 1,\n \"prints\": 38,\n \"uniqueprints\": 20\n },\n {\n \"day\": \"2021-01-09\",\n \"opens\": 185,\n \"uniques\": 66,\n \"forwards\": 1,\n \"uniqueforwards\": 1,\n \"prints\": 16,\n \"uniqueprints\": 12\n },\n {\n \"day\": \"2021-01-10\",\n \"opens\": 81,\n \"uniques\": 47,\n \"forwards\": 0,\n \"uniqueforwards\": 0,\n \"prints\": 17,\n \"uniqueprints\": 14\n },\n {\n \"day\": \"2021-01-11\",\n \"opens\": 305,\n \"uniques\": 99,\n \"forwards\": 0,\n \"uniqueforwards\": 0,\n \"prints\": 26,\n \"uniqueprints\": 14\n },\n {\n \"day\": \"2021-01-12\",\n \"opens\": 304,\n \"uniques\": 123,\n \"forwards\": 0,\n \"uniqueforwards\": 0,\n \"prints\": 31,\n \"uniqueprints\": 14\n },\n {\n \"day\": \"2021-01-13\",\n \"opens\": 129,\n \"uniques\": 69,\n \"forwards\": 0,\n \"uniqueforwards\": 0,\n \"prints\": 36,\n \"uniqueprints\": 17\n }\n ]\n}"}],"_postman_id":"a61589ac-0b85-4f6c-8569-b3669f38ebfd"},{"name":"Platform Distribution","id":"ac821b5d-8874-4923-b0d8-f03d54fbbd66","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{host}}/analytics/distribution/","description":"The Apple Privacy Proxy pre-fetches images (upon delivery) for devices on a charger/internet connection, which will inflate your open counts but also serves as a strong indicator of valid addresses. Yahoo! Privacy Proxy is similar since they also pre-fetch images, but only in instances where the recipient is using the Yahoo! mail client. Gmail on the other hand does not pre-fetch images, so the open counts accurately reflect your audience's open activity. Desktop, mobile, etc. will likely contain Yahoo! or Apple addresses where less restrictive mail clients were in use.
\nPlease see timezone param list for details about the id's.
\n","auth":{"type":"apikey","apikey":{"value":"{{your-api-key-here}}","key":"Data Type: DateTime
\n","type":"text/plain"},"key":"startdate","value":""},{"disabled":true,"description":{"content":"Data Type: DateTime
\n","type":"text/plain"},"key":"enddate","value":""},{"disabled":true,"description":{"content":"Date Type: Nullable(String)
\n","type":"text/plain"},"key":"source","value":""},{"disabled":true,"description":{"content":"Data Type: String
\n","type":"text/plain"},"key":"integrationkey","value":""},{"disabled":true,"description":{"content":"Data Type: String
\n","type":"text/plain"},"key":"country","value":""},{"disabled":true,"description":{"content":"Data Type: String
\n","type":"text/plain"},"key":"region","value":""},{"disabled":true,"description":{"content":"Data Type: String
\n","type":"text/plain"},"key":"city","value":""},{"disabled":true,"description":{"content":"Data Type: Integer
\n","type":"text/plain"},"key":"timezone","value":""},{"disabled":true,"description":{"content":"Data Type: String
\n","type":"text/plain"},"key":"provider","value":""},{"disabled":true,"description":{"content":"Date Type: Nullable(String)
\n","type":"text/plain"},"key":"campaign_id","value":""},{"disabled":true,"description":{"content":"Date Type: Nullable(String)
\n","type":"text/plain"},"key":"todomain","value":""},{"disabled":true,"description":{"content":"Data Type: String
\n","type":"text/plain"},"key":"recipient","value":""},{"disabled":true,"description":{"content":"Data Type: varchar(50) null.
\n","type":"text/plain"},"key":"platform","value":""}],"variable":[]}},"response":[{"id":"63a8621d-aefe-46ca-9d5c-168e4da4ed6b","name":"Platform Distribution","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/analytics/distribution/","host":["{{host}}"],"path":["analytics","distribution",""],"query":[{"key":"startdate","value":"2021-04-01 12:00:00","disabled":true},{"key":"enddate","value":"2021-04-15 12:00:00","disabled":true},{"key":"source","value":"250ok","disabled":true},{"key":"integrationkey","value":"pixel","disabled":true},{"key":"country","value":"US","disabled":true},{"key":"region","value":"California","disabled":true},{"key":"city","value":"San Francisco","disabled":true},{"key":"timezone","value":"America/Los_Angeles","disabled":true},{"key":"provider","value":"Gmail","type":"text","disabled":true},{"key":"campaign_id","value":"12345","disabled":true},{"key":"todomain","value":"domain.com","disabled":true},{"key":"recipient","value":"user@domain.com","disabled":true},{"key":"platform","value":"mobile","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.17.6"},{"key":"Date","value":"Tue, 05 Oct 2021 13:38:40 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"1634"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":""},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Headers","value":"Authorization,Accept,Keep-Alive,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type,Content-Range,Range,x-api-key"},{"key":"Access-Control-Allow-Methods","value":"GET,POST,OPTIONS,PUT,DELETE,PATCH"}],"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"params\": {\n \"startdate\": \"2021-09-06T00:00:00+00:00\",\n \"enddate\": \"2021-10-05T00:00:00+00:00\",\n \"source\": null,\n \"integrationkey\": null,\n \"provider\": null,\n \"todomain\": null,\n \"pixel\": null,\n \"campaign_id\": null,\n \"platform\": null,\n \"country\": null,\n \"region\": null,\n \"city\": null,\n \"enthusiasm\": null,\n \"timeofday\": null,\n \"timezone\": null,\n \"recipient\": null\n },\n \"use_case\": {\n \"proxy_apple\": \"Valid recipients\",\n \"proxy_google\": \"Valid recipients, unique opens\",\n \"proxy_yahoo\": \"Valid recipients\",\n \"desktop\": \"Valid recipients, opens, geolocation, client/device\",\n \"mobile\": \"Valid recipients, opens, geolocation, client/device\",\n \"tablet\": \"Valid recipients, opens, geolocation, client/device\",\n \"other\": \"otentially false positives (content scanners, bots)\"\n }\n },\n \"results\": {\n \"proxy_apple\": {\n \"label\": \"Apple Privacy Proxy\",\n \"percent\": 0,\n \"recipients\": 35,\n \"opens\": 269,\n \"endpoints\": [\n \"/analytics/distribution/proxy_apple\"\n ]\n },\n \"proxy_google\": {\n \"label\": \"Google Image Proxy\",\n \"percent\": 17.6,\n \"recipients\": 458,\n \"opens\": 180572,\n \"endpoints\": [\n \"/analytics/distribution/proxy_google\"\n ]\n },\n \"proxy_yahoo\": {\n \"label\": \"Yahoo! Privacy Proxy\",\n \"percent\": 0,\n \"recipients\": 3,\n \"opens\": 3,\n \"endpoints\": [\n \"/analytics/distribution/proxy_yahoo\"\n ]\n },\n \"desktop\": {\n \"label\": \"Desktop\",\n \"percent\": 64.5,\n \"recipients\": 1113,\n \"opens\": 660392,\n \"endpoints\": [\n \"/analytics/distribution/desktop\"\n ]\n },\n \"mobile\": {\n \"label\": \"Mobile\",\n \"percent\": 16.2,\n \"recipients\": 204,\n \"opens\": 166307,\n \"endpoints\": [\n \"/analytics/distribution/mobile\"\n ]\n },\n \"tablet\": {\n \"label\": \"Tablet\",\n \"percent\": 0,\n \"recipients\": 5,\n \"opens\": 19,\n \"endpoints\": [\n \"/analytics/distribution/tablet\"\n ]\n },\n \"other\": {\n \"label\": \"Other\",\n \"percent\": 1,\n \"recipients\": 69,\n \"opens\": 16317,\n \"endpoints\": [\n \"/analytics/distribution/other\"\n ]\n }\n }\n}"}],"_postman_id":"ac821b5d-8874-4923-b0d8-f03d54fbbd66"},{"name":"Detailed Events","id":"c46c9b9c-f3d6-4b26-a4d4-09771dd9149c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{host}}/analytics/events/","description":"Please see timezone param list for details about the id's.
\n","auth":{"type":"apikey","apikey":{"value":"{{your-api-key-here}}","key":"Data Type: DateTime.
\n","type":"text/plain"},"key":"startdate","value":""},{"disabled":true,"description":{"content":"Data Type: DateTime.
\n","type":"text/plain"},"key":"enddate","value":""},{"disabled":true,"description":{"content":"Data Type: Nullable(String)
\n","type":"text/plain"},"key":"source","value":""},{"disabled":true,"description":{"content":"Data Type: String
\n","type":"text/plain"},"key":"integrationkey","value":""},{"disabled":true,"description":{"content":"Data Type: String
\n","type":"text/plain"},"key":"provider","value":""},{"disabled":true,"description":{"content":"Data Type: Nullable(String)
\n","type":"text/plain"},"key":"todomain","value":""},{"disabled":true,"description":{"content":"Data Type: Nullable(String)
\n","type":"text/plain"},"key":"campaign_id","value":""},{"disabled":true,"description":{"content":"Data Type: varchar(50) null.
\n","type":"text/plain"},"key":"platform","value":""},{"disabled":true,"description":{"content":"Data Type: String
\n","type":"text/plain"},"key":"country","value":""},{"disabled":true,"description":{"content":"Data Type: String
\n","type":"text/plain"},"key":"region","value":""},{"disabled":true,"description":{"content":"Data Type: String
\n","type":"text/plain"},"key":"city","value":""},{"disabled":true,"description":{"content":"Data Type: String
\n","type":"text/plain"},"key":"enthusiasm","value":""},{"disabled":true,"description":{"content":"Data Type: Enum8('unknown' = 0, 'morning' = 1, 'afternoon' = 2, 'evening' = 3, 'night' = 4). \nMorning: 6 AM - Noon recipient local time. Afternoon: Noon - 6 PM. Evening: 6 PM - Midnight. Late Night: Midnight - 6 AM.
\n","type":"text/plain"},"key":"timeofday","value":""},{"disabled":true,"description":{"content":"Data Type: Integer
\n","type":"text/plain"},"key":"timezone","value":""},{"disabled":true,"description":{"content":"Data Type: String
\n","type":"text/plain"},"key":"recipient","value":""}],"variable":[]}},"response":[{"id":"0dc8b8f8-4c81-449d-a9d7-51ba3b796d23","name":"Detailed Events","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"","type":"text","disabled":true}],"url":{"raw":"{{host}}/analytics/events/","host":["{{host}}"],"path":["analytics","events",""],"query":[{"key":"startdate","value":"","description":"Data Type: DateTime. ","disabled":true},{"key":"enddate","value":"","description":"Data Type: DateTime. ","disabled":true},{"key":"source","value":"","description":"Data Type: Nullable(String). ","disabled":true},{"key":"integrationkey","value":"","description":"Data Type: String. ","disabled":true},{"key":"provider","value":"","description":"Data Type: String.","disabled":true},{"key":"todomain","value":null,"description":"Data Type: Nullable(String). ","disabled":true},{"key":"campaign_id","value":null,"description":"Data Type: Nullable(String). ","disabled":true},{"key":"platform","value":null,"description":"Data Type: varchar(50) null.","disabled":true},{"key":"country","value":null,"description":"Data Type: String.","disabled":true},{"key":"region","value":null,"description":"Data Type: String.","disabled":true},{"key":"city","value":null,"description":"Data Type: String.","disabled":true},{"key":"enthusiasm","value":null,"disabled":true},{"key":"timeofday","value":null,"description":"Data Type: Enum8('unknown' = 0, 'morning' = 1, 'afternoon' = 2, 'evening' = 3, 'night' = 4). \nMorning: 6 AM - Noon recipient local time. Afternoon: Noon - 6 PM. Evening: 6 PM - Midnight. Late Night: Midnight - 6 AM.","disabled":true},{"key":"timezone","value":null,"description":"Data Type: Integer","disabled":true},{"key":"recipient","value":null,"disabled":true}]}},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"params\": {\n \"startdate\": \"2021-05-18T00:00:00+00:00\",\n \"enddate\": \"2021-06-16T23:59:00+00:00\",\n \"source\": null,\n \"integrationkey\": null,\n \"provider\": null,\n \"todomain\": null,\n \"pixel\": null,\n \"campaign_id\": null,\n \"platform\": null,\n \"country\": null,\n \"region\": null,\n \"city\": null,\n \"enthusiasm\": null,\n \"timeofday\": null,\n \"timezone\": null,\n \"recipient\": null\n }\n },\n \"results\": {\n \"types\": {\n \"click\": 9697,\n \"total\": 4027933,\n \"forward\": 778,\n \"read\": 765223,\n \"print\": 1784,\n \"bounced\": 4390,\n \"filtered\": 208,\n \"created\": 1625518,\n \"delivered\": 1620335\n }\n }\n}"}],"_postman_id":"c46c9b9c-f3d6-4b26-a4d4-09771dd9149c"},{"name":"Overview","id":"c478fd2b-148a-4948-b95e-0ad10b04de0a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{host}}/analytics/engagement","description":"Please see timezone param list for details about the id's.
\n","auth":{"type":"apikey","apikey":{"value":"{{your-api-key-here}}","key":"Timezone Param
\nFor timezone please refer to the following list for id seclection. Do not use the name.
Hint: Pass a 'country' parameter to view Regions by Country. Example: ?country=US
- \n
- Read: 8 or more seconds. \n
- Skimmed: 2 or more seconds, but less than 8 seconds. \n
- Glanced: less than 2 seconds. \n
- \n
- Morning: 6 AM - Noon recipient local time. \n
- Afternoon: Noon - 6 PM. \n
- Evening: 6 PM - Midnight. \n
- Late Night: Midnight - 6 AM. \n
Audience Explorer data is dervied from pixel opening events.
\n","event":[{"listen":"prerequest","script":{"id":"bd89ec16-4068-4848-850e-84de5b0d7f70","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"4e0da8d5-2550-4341-8bcf-f9fcf7b8888d","type":"text/javascript","exec":[""]}}],"_postman_id":"79ab29ec-63ad-4310-ad13-80e2cf520014","auth":{"type":"apikey","apikey":{"value":"{{your-api-key-here}}","key":"If your ESP does not provide volume statistics by IP address, IP performance may estimate based on the combined volume of message deliveries and bounces.
\n","auth":{"type":"apikey","apikey":{"value":"{{your-api-key-here}}","key":"Filtered messages are those suppressed prior to send by your email service provider, often times because of delivery issues in the past.
\n","auth":{"type":"apikey","apikey":{"value":"{{your-api-key-here}}","key":"[0, 1] Option to include a 'campaign' parameter or tag
\n","type":"text/plain"},"key":"includecampaign","value":"1"},{"description":{"content":"[0, 1] Option to include your custom properties and parameters
\n","type":"text/plain"},"key":"includeparams","value":"1"},{"description":{"content":"(Optional) [single, double]
\n","type":"text/plain"},"key":"quotes","value":"single"}],"variable":[]}},"response":[{"id":"dda0c304-a79d-49bb-b7ea-1d68532e5e14","name":"Pixel: Tracking Code","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/analytics/pixels/1/code?includecampaign=1&includeparams=1","host":["{{host}}"],"path":["analytics","pixels","1","code"],"query":[{"key":"includecampaign","value":"1"},{"key":"includeparams","value":"1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.17.6"},{"key":"Date","value":"Fri, 15 Jan 2021 16:22:15 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"1075"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/7.3.24"},{"key":"Access-Control-Allow-Origin","value":"https://everest.validity.com"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Headers","value":"Authorization,Accept,Keep-Alive,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type,Content-Range,Range,x-api-key"},{"key":"Access-Control-Allow-Methods","value":"GET,POST,OPTIONS,PUT,DELETE,PATCH"}],"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"params\": {\n \"includecampaign\": \"1\",\n \"includeparams\": \"1\"\n }\n },\n \"results\": \"(Required) The name or subject line of the pixel
\n"},{"key":"provider_id","value":"35","type":"text","description":"(Required) The provider ID of your email service provider, which can be retrieved from the Pixels: Providers endpoint. If your provider isn't listed, you can submit '0'
\n"},{"key":"domain_id","value":"2","type":"text","description":"(Required) The domain ID of your analytics tracking domain, which can be retrieved from the Custom Domains endpoint.
\n"},{"key":"quotes","value":"single","type":"text","description":"[single, double] Option to use double or single quotes for the tracking pixel HTML
\n"},{"key":"includecampaign","value":"1","type":"text","description":"[0, 1] Option to include your custom properties and parameters
\n"},{"key":"includeparams","value":"1","type":"text","description":"[0, 1] Option to include your custom properties and parameters
\n"}]},"url":"{{host}}/analytics/pixels","auth":{"type":"apikey","apikey":{"value":"{{your-api-key-here}}","key":"'domain' or 'subdomain'. If using a subdomain, you the value must match '{your_cname}.250analytics.com'
\n","type":"text"}]},"url":"{{host}}/analytics/domains","auth":{"type":"apikey","apikey":{"value":"{{your-api-key-here}}","key":"Workflow tips on apply filters and parameters
\nThe Engagement collection has the same standardized filters available in the Everest interface. For an up-to-date list, all available filters will be returned in API responses in the meta.params object.
In the Audience Explorer sub-collection you'll find the corresponding API endpoints containing the valid filtering values and options.
\nHelpful tips on response objects
\nOpens:
\nOpens may vary across tracking mediums due to pixels firing false positives from spam filters, campaign editors, or preview panes in popular mail clients. Counts may vary depending on how a given pixel provider handles these cases.
\nUniques:
\nUnique opens are the total opens per unique email address. Total opens includes things like re-opens, forwarded messages, or any instance where an email is opened multiple times using one unique tracking pixel/email address.
\n","event":[{"listen":"prerequest","script":{"id":"1e153e21-209d-46a8-983c-76fdf2feb07b","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"269e2622-3997-4dd1-8efe-fbae5e1628df","type":"text/javascript","exec":[""]}}],"_postman_id":"98bb20e4-9250-4ce0-a13d-ae9fea8f10a2","auth":{"type":"apikey","apikey":{"value":"{{your-api-key-here}}","key":"Retrieves all domains listed in your Google Postmaster Tools integration.
\n","auth":{"type":"apikey","apikey":{"value":"{{your-api-key-here}}","key":"Retrieves the high-level overview of a specific domain in your Google Postmaster Tools integration.
\n","auth":{"type":"apikey","apikey":{"value":"{{your-api-key-here}}","key":"Shows rejected/temp-failed traffic vs all authenticated traffic coming from each domain. Messages are typically rejected or temp-failed with the SMTP error codes 550 or 421 respectively.
\n","auth":{"type":"apikey","apikey":{"value":"{{your-api-key-here}}","key":"Provides a sense of whether the Gmail spam filter might mark emails from that Domain or IP as spam or not. The 'totals' object contains the total count of low/medium/good domain classifications during the provided date range.
\n","auth":{"type":"apikey","apikey":{"value":"{{your-api-key-here}}","key":"Provides a sense of whether the Gmail spam filter might mark emails from that Domain or IP as spam or not. The 'totals' object contains the total count of low/bad/medium/good IP classifications during the provided date range.
\n","auth":{"type":"apikey","apikey":{"value":"{{your-api-key-here}}","key":"Provides a sense of whether the Gmail spam filter might mark emails from that Domain or IP as spam or not. The 'totals' object contains the total count of low/bad/medium/good IP classifications during the provided date range.
\n","auth":{"type":"apikey","apikey":{"value":"{{your-api-key-here}}","key":"Shows the volume of user-report spam vs. email that was sent to the inbox. Only emails authenticated by DKIM are eligible for spam rate calculation (User Reported Spam Rate).
\n","auth":{"type":"apikey","apikey":{"value":"{{your-api-key-here}}","key":"For senders who have implemented the Gmail Spam Feedback Loop (FBL), this shows the identifiers flagged by FBL and their corresponding spam rates.
\n","auth":{"type":"apikey","apikey":{"value":"{{your-api-key-here}}","key":"Authenticated Traffic: shows traffic that passed SPF, DKIM & DMARC, over all received traffic that attempted authentication. Inbound and Outbound TLS encyryption rates are also included.
\n","auth":{"type":"apikey","apikey":{"value":"{{your-api-key-here}}","key":"Throughout the API documentation you'll see the use of variables like {{apikey}} that can be swapped out using your real API key. If you use Postman, this collection is available for download along with a shared variable template to define your host and apikey variables.
\nThe Google Postmaster Tools API is available for customers with a Google Postmaster Tools integration containing verified domains.
\nResponse Helpers
\n- \n
- Each available endpoint may contain a meta: {} object that provides help text or explanations of fields to help you interpret the data. \n
- Similarly, individual endpoint response objects may contain a meta: {} field to provide helpful information on how to best utilize the results and their respective endpoints. \n
- In cases where individual endpoints are available, i.e. from Get Domains, an endpoints:{} object will be included to provide URL endpoints for subsequent calls to retrieve larger result sets. \n
- In cases where responses contain over 1,000 result records, an additional endpoints:{} object will be included with the auto-incremented offsets available based on the total result count. \n
Error Responses
\n- \n
- 404 We couldn't find any Google Postmaster Tools domains associated with your account. \n
- 404 We couldn't find any Google Postmaster Tools domains matching 'domain.com'. \n
- 404 The 'offset' parameter must be numeric. \n
- 404 Unknown method \n
Signal Spam - Overview
\n","auth":{"type":"apikey","apikey":{"value":"{{your-api-key-here}}","key":"YYYY-MM-DD. Optional, if omitted defaults to 30 days prior.
\n","type":"text/plain"},"key":"startdate","value":"2021-04-17"},{"description":{"content":"YYYY-MM-DD. Optional, if omitted defaults to the current day.
\n","type":"text/plain"},"key":"enddate","value":"2021-05-17"},{"description":{"content":"Optional. IP address or IP address wildcard (right side).
\n","type":"text/plain"},"key":"ip","value":null}],"variable":[]}},"response":[{"id":"9e23eefb-151f-43a5-836d-c5025c566b53","name":"Signal Spam - By Day","originalRequest":{"method":"GET","header":[]},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"params\": {\n \"startdate\": \"2021-04-17T00:00:00+00:00\",\n \"enddate\": \"2021-05-17T00:00:00+00:00\"\n }\n },\n \"results\": {\n \"2021-04-17\": {\n \"count\": 9422,\n \"percent\": 4.642,\n \"provider\": {\n \"orange\": 8210,\n \"sfr\": 1089,\n \"laposte\": 123\n }\n },\n \"2021-04-18\": {\n \"count\": 6298,\n \"percent\": 3.103,\n \"provider\": {\n \"orange\": 5230,\n \"sfr\": 990,\n \"laposte\": 78\n }\n },\n \"2021-04-19\": {\n \"count\": 6047,\n \"percent\": 2.979,\n \"provider\": {\n \"orange\": 4959,\n \"sfr\": 1007,\n \"laposte\": 81\n }\n },\n \"2021-04-20\": {\n \"count\": 6444,\n \"percent\": 3.175,\n \"provider\": {\n \"orange\": 5391,\n \"sfr\": 961,\n \"laposte\": 92\n }\n },\n \"2021-04-21\": {\n \"count\": 6424,\n \"percent\": 3.165,\n \"provider\": {\n \"orange\": 4934,\n \"sfr\": 1408,\n \"laposte\": 82\n }\n },\n \"2021-04-22\": {\n \"count\": 6768,\n \"percent\": 3.334,\n \"provider\": {\n \"orange\": 5558,\n \"sfr\": 1122,\n \"laposte\": 88\n }\n },\n \"2021-04-23\": {\n \"count\": 4509,\n \"percent\": 2.221,\n \"provider\": {\n \"orange\": 3559,\n \"sfr\": 900,\n \"laposte\": 50\n }\n },\n \"2021-04-24\": {\n \"count\": 5221,\n \"percent\": 2.572,\n \"provider\": {\n \"orange\": 4322,\n \"sfr\": 802,\n \"laposte\": 97\n }\n },\n \"2021-04-25\": {\n \"count\": 5799,\n \"percent\": 2.857,\n \"provider\": {\n \"orange\": 4541,\n \"sfr\": 1186,\n \"laposte\": 72\n }\n },\n \"2021-04-26\": {\n \"count\": 5426,\n \"percent\": 2.673,\n \"provider\": {\n \"orange\": 4333,\n \"sfr\": 992,\n \"laposte\": 101\n }\n },\n \"2021-04-27\": {\n \"count\": 4860,\n \"percent\": 2.394,\n \"provider\": {\n \"orange\": 4174,\n \"sfr\": 615,\n \"laposte\": 71\n }\n },\n \"2021-04-28\": {\n \"count\": 6833,\n \"percent\": 3.366,\n \"provider\": {\n \"orange\": 5768,\n \"sfr\": 962,\n \"laposte\": 103\n }\n },\n \"2021-04-29\": {\n \"count\": 6490,\n \"percent\": 3.197,\n \"provider\": {\n \"orange\": 5020,\n \"sfr\": 1317,\n \"laposte\": 153\n }\n },\n \"2021-04-30\": {\n \"count\": 5644,\n \"percent\": 2.781,\n \"provider\": {\n \"orange\": 4294,\n \"sfr\": 1234,\n \"laposte\": 116\n }\n },\n \"2021-05-01\": {\n \"count\": 4546,\n \"percent\": 2.24,\n \"provider\": {\n \"orange\": 3292,\n \"sfr\": 1142,\n \"laposte\": 112\n }\n },\n \"2021-05-02\": {\n \"count\": 5483,\n \"percent\": 2.701,\n \"provider\": {\n \"orange\": 4394,\n \"sfr\": 948,\n \"laposte\": 141\n }\n },\n \"2021-05-03\": {\n \"count\": 6818,\n \"percent\": 3.359,\n \"provider\": {\n \"orange\": 4989,\n \"sfr\": 1630,\n \"laposte\": 199\n }\n },\n \"2021-05-04\": {\n \"count\": 8195,\n \"percent\": 4.037,\n \"provider\": {\n \"orange\": 6030,\n \"sfr\": 1945,\n \"laposte\": 220\n }\n },\n \"2021-05-05\": {\n \"count\": 7560,\n \"percent\": 3.725,\n \"provider\": {\n \"orange\": 5545,\n \"sfr\": 1743,\n \"laposte\": 272\n }\n },\n \"2021-05-06\": {\n \"count\": 9831,\n \"percent\": 4.843,\n \"provider\": {\n \"orange\": 7406,\n \"sfr\": 2230,\n \"laposte\": 195\n }\n },\n \"2021-05-07\": {\n \"count\": 6293,\n \"percent\": 3.1,\n \"provider\": {\n \"orange\": 4627,\n \"sfr\": 1580,\n \"laposte\": 86\n }\n },\n \"2021-05-08\": {\n \"count\": 5637,\n \"percent\": 2.777,\n \"provider\": {\n \"orange\": 4478,\n \"sfr\": 1099,\n \"laposte\": 60\n }\n },\n \"2021-05-09\": {\n \"count\": 6485,\n \"percent\": 3.195,\n \"provider\": {\n \"orange\": 5308,\n \"sfr\": 1115,\n \"laposte\": 62\n }\n },\n \"2021-05-10\": {\n \"count\": 8473,\n \"percent\": 4.174,\n \"provider\": {\n \"orange\": 6444,\n \"sfr\": 1917,\n \"laposte\": 112\n }\n },\n \"2021-05-11\": {\n \"count\": 8903,\n \"percent\": 4.386,\n \"provider\": {\n \"orange\": 6859,\n \"sfr\": 1904,\n \"laposte\": 140\n }\n },\n \"2021-05-12\": {\n \"count\": 5381,\n \"percent\": 2.651,\n \"provider\": {\n \"orange\": 4012,\n \"sfr\": 1186,\n \"laposte\": 183\n }\n },\n \"2021-05-13\": {\n \"count\": 6058,\n \"percent\": 2.985,\n \"provider\": {\n \"orange\": 4511,\n \"sfr\": 1467,\n \"laposte\": 80\n }\n },\n \"2021-05-14\": {\n \"count\": 7468,\n \"percent\": 3.679,\n \"provider\": {\n \"orange\": 5596,\n \"sfr\": 1741,\n \"laposte\": 131\n }\n },\n \"2021-05-15\": {\n \"count\": 7932,\n \"percent\": 3.908,\n \"provider\": {\n \"orange\": 5769,\n \"sfr\": 2007,\n \"laposte\": 156\n }\n },\n \"2021-05-16\": {\n \"count\": 11730,\n \"percent\": 5.779,\n \"provider\": {\n \"orange\": 8331,\n \"sfr\": 2959,\n \"laposte\": 440\n }\n }\n }\n}"}],"_postman_id":"8babe77d-78dd-4e33-84e0-e92701a2a9c0"},{"name":"Signal Spam - By IP","id":"ec41ab3c-5e9f-443f-a09f-2aed6348080b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{host}}/integrations/signalspam/ip?startdate=2021-04-17&enddate=2021-05-17","auth":{"type":"apikey","apikey":{"value":"{{your-api-key-here}}","key":"YYYY-MM-DD. Optional, if omitted defaults to 30 days prior.
\n","type":"text/plain"},"key":"startdate","value":"2021-04-17"},{"description":{"content":"YYYY-MM-DD. Optional, if omitted defaults to the current day.
\n","type":"text/plain"},"key":"enddate","value":"2021-05-17"},{"disabled":true,"description":{"content":"Optional. IP address or IP address wildcard (right side).
\n","type":"text/plain"},"key":"ip","value":null}],"variable":[]}},"response":[{"id":"2209650b-2c6f-4f8c-a947-24f3aa620974","name":"Signal Spam - By IP","originalRequest":{"method":"GET","header":[]},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"params\": {\n \"startdate\": \"2021-04-17T00:00:00+00:00\",\n \"enddate\": \"2021-05-17T00:00:00+00:00\"\n },\n \"total\": 2,\n \"limit\": 100,\n \"pages\": 1,\n \"complaints\": 4765\n },\n \"results\": {\n \"192.168.1.1\": {\n \"rdns\": \"one.one.internal.validity.com\",\n \"count\": 2336,\n \"percent\": 49.024,\n \"provider\": {\n \"orange\": 1967,\n \"sfr\": 351,\n \"laposte\": 18\n }\n },\n \"192.168.1.2\": {\n \"rdns\": \"two.one.internal.validity.com\",\n \"count\": 2429,\n \"percent\": 50.976,\n \"provider\": {\n \"orange\": 2052,\n \"sfr\": 350,\n \"laposte\": 27\n }\n }\n }\n}"}],"_postman_id":"ec41ab3c-5e9f-443f-a09f-2aed6348080b"}],"id":"ac5d1132-9e38-4b42-8461-e5f063b956fe","_postman_id":"ac5d1132-9e38-4b42-8461-e5f063b956fe","description":"","auth":{"type":"apikey","apikey":{"value":"{{your-api-key-here}}","key":"Optional. Can be retrieved via the Webhook Endpoints api.
\n","type":"text/plain"},"key":"integrationkey","value":""},{"disabled":true,"description":{"content":"Optional. In the format YYYY-MM-DD HH:MM:SS
\n","type":"text/plain"},"key":"startdate","value":null},{"disabled":true,"description":{"content":"Optional. In the format YYYY-MM-DD HH:MM:SS
\n","type":"text/plain"},"key":"enddate","value":null}],"variable":[]}},"response":[{"id":"5eb13d3a-dd90-41b1-8bce-2cc50bbdf342","name":"Webhook Errors","originalRequest":{"method":"GET","header":[]},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"params\": {\n \"startdate\": \"2021-04-17T23:43:15+00:00\",\n \"enddate\": \"2021-05-17T23:43:15+00:00\"\n },\n \"total\": 1,\n \"limit\": 100,\n \"pages\": 1\n },\n \"results\": [\n {\n \"id\": \"cf5fc4f4f6124effb80d20b87123edea\",\n \"message\": \"Attribute(name='bounceCode', default=None, validator=_AndValidator(_validators=(functools.partial(- \n
\nloginslugspecifies an account's SSO endpoint name \n
\nowner_emailspecifies the account owner's email address \n
\nowner_firstnamespecifies the account owner's first name \n
\nowner_lastnamespecifies the account owner's last name \n
Combine with enddate to limit the period over which usage is calculated
\n","type":"text/plain"},"key":"startdate","value":"YYYY-MM-DD"},{"disabled":true,"description":{"content":"Combine with startdate to limit the period over which usage is calculated
\n","type":"text/plain"},"key":"enddate","value":"YYYY-MM-DD"}],"variable":[]}},"response":[{"id":"aefa4c07-c993-4936-abdc-777a208707b5","name":"Get Account","originalRequest":{"method":"GET","header":[],"url":"{{host}}/accounts/{{account_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.17.6"},{"key":"Date","value":"Wed, 16 Dec 2020 17:37:21 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"517"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/7.3.20"},{"key":"Access-Control-Allow-Origin","value":"https://everest.validity.com"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Headers","value":"Authorization,Accept,Keep-Alive,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type,Content-Range,Range,x-api-key"},{"key":"Access-Control-Allow-Methods","value":"GET,POST,OPTIONS,PUT,DELETE,PATCH"}],"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"usage_vto\": \"/api/2.0/vto/usage\",\n \"volume_tiers\": [\n \"1 (< 1M)\",\n \"2 (< 3M)\",\n \"3 (3-12M)\",\n \"4 (12-36M)\",\n \"5 (36-120M)\",\n \"6 (120-240M)\",\n \"7 (240M-600M)\",\n \"8 (600M+)\"\n ]\n },\n \"results\": {\n \"id\": 30,\n \"name\": \"Everest by Validity\",\n \"owner_email\": \"sales@validity.com\",\n \"owner_firstname\": \"Everest\",\n \"owner_lastname\": \"API\",\n \"package\": \"Enterprise\",\n \"expiration\": \"2026-12-31\",\n \"volumetier\": 8,\n \"created\": \"2012-05-23T14:56:36+00:00\",\n \"updated\": \"2020-12-16T17:44:30+00:00\",\n \"descendent_of\": 0,\n \"external_id\": \"abc123\",\n \"loginslug\": \"everest-by-validity\",\n \"preferences\": {\n \"enforce_passwords\": 0,\n \"enforce_mfa\": 0,\n \"sso_enabled\": 0,\n \"timezone\": \"America/New_York\",\n \"global_stats\": 1\n },\n \"subscription\": {\n \"addons\": {\n \"validation\": 0,\n \"optimizedseeds\": 0,\n \"design\": 0,\n \"vto\": 1,\n \"competitive\": 0,\n \"certification\": 1\n },\n \"products\": {\n \"certification\": {\n \"quantity\": \"N/A\"\n },\n \"design\": {\n \"quantity\": 100,\n \"usage\": 19\n },\n \"engagement\": {\n \"quantity\": 1000000,\n \"usage\": 37529\n },\n \"inbox\": {\n \"quantity\": 10000,\n \"usage\": 3769\n },\n \"reputation\": {\n \"quantity\": 10000,\n \"usage\": 37820\n },\n \"validation\": {\n \"quantity\": 1000000,\n \"usage\": 1019411\n }\n }\n }\n }\n}"},{"id":"caa5489e-2bfd-447f-bdb6-36fe152b46ad","name":"Get Account using External Id","originalRequest":{"method":"GET","header":[],"url":"{{host}}/accounts/external/abc123"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.17.6"},{"key":"Date","value":"Wed, 16 Dec 2020 17:37:21 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"517"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/7.3.20"},{"key":"Access-Control-Allow-Origin","value":"https://everest.validity.com"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Headers","value":"Authorization,Accept,Keep-Alive,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type,Content-Range,Range,x-api-key"},{"key":"Access-Control-Allow-Methods","value":"GET,POST,OPTIONS,PUT,DELETE,PATCH"}],"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"usage_vto\": \"/api/2.0/vto/usage\",\n \"volume_tiers\": [\n \"1 (< 1M)\",\n \"2 (< 3M)\",\n \"3 (3-12M)\",\n \"4 (12-36M)\",\n \"5 (36-120M)\",\n \"6 (120-240M)\",\n \"7 (240M-600M)\",\n \"8 (600M+)\"\n ]\n },\n \"results\": {\n \"id\": 30,\n \"name\": \"Everest by Validity\",\n \"owner_email\": \"sales@validity.com\",\n \"owner_firstname\": \"Everest\",\n \"owner_lastname\": \"API\",\n \"package\": \"Enterprise\",\n \"expiration\": \"2026-12-31\",\n \"volumetier\": 8,\n \"created\": \"2012-05-23T14:56:36+00:00\",\n \"updated\": \"2020-12-16T17:44:30+00:00\",\n \"descendent_of\": 0,\n \"external_id\": \"abc123\",\n \"loginslug\": \"everest-by-validity\",\n \"preferences\": {\n \"enforce_passwords\": 0,\n \"enforce_mfa\": 0,\n \"sso_enabled\": 0,\n \"timezone\": \"America/New_York\",\n \"global_stats\": 1\n },\n \"subscription\": {\n \"addons\": {\n \"validation\": 0,\n \"optimizedseeds\": 0,\n \"design\": 0,\n \"vto\": 1,\n \"competitive\": 0,\n \"certification\": 1\n },\n \"products\": {\n \"certification\": {\n \"quantity\": \"N/A\"\n },\n \"design\": {\n \"quantity\": 100,\n \"usage\": 19\n },\n \"engagement\": {\n \"quantity\": 1000000,\n \"usage\": 37529\n },\n \"inbox\": {\n \"quantity\": 10000,\n \"usage\": \"3769\"\n },\n \"reputation\": {\n \"quantity\": 10000,\n \"usage\": \"37820\"\n },\n \"validation\": {\n \"quantity\": 1000000,\n \"usage\": 1019411\n },\n \"vto\": {\n \"quantity\": \"N/A\"\n }\n }\n }\n }\n}"}],"_postman_id":"d70a8625-756a-46e0-902f-34fab002fd32"},{"name":"Create Account","id":"a09b17ce-3f93-4d02-a892-ab1b93a7c457","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"Account Name\",\n \"package\": \"Professional\",\n \"external_id\": \"external-id\",\n \"start\": \"2023-01-01\",\n \"expiration\": \"2025-12-31\",\n \"includeglobalstats\": 0,\n \"inboxseedlistgroup\": 1,\n \"inboxreset\": \"annual\",\n \"subscription\": {\n \"addons\": {\n \"competitive\": 1,\n \"optimizedseeds\": 1,\n \"design\": 1,\n \"validation\": 1,\n \"vto\": 1\n },\n \"products\": {\n \"analytics\": 100,\n \"blacklist\": 100,\n \"certification\": 100,\n \"design\": 100,\n \"dmarc\": 100,\n \"engagement\": 100,\n \"inbox\": 100,\n \"reputation\": 100,\n \"validation\": 100\n }\n },\n \"plan\": {\n \"slug\": \"plan-slug\"\n },\n \"permissions\": {\n \"reputation\": \"inactive\",\n \"design\": \"active\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/accounts/","auth":{"type":"apikey","apikey":{"value":"{{your-api-key-here}}","key":"(Required) Name of the account
\n","type":"text/plain"},"key":"name","value":"Test Account"},{"disabled":true,"description":{"content":"(Legacy) [Essentials, Professional, Enterprise] The package to determine which plan will be assigned to the user. This field is optional if the new plan field is passed.
\n","type":"text/plain"},"key":"package","value":"Enterprise"},{"disabled":true,"description":{"content":"(Required) The account's subscription start date (format: YYYY-MM-DD)
\n","type":"text/plain"},"key":"start","value":"2021-01-01"},{"disabled":true,"description":{"content":"(Required) The account's subscription expiration date (format: YYYY-MM-DD)
\n","type":"text/plain"},"key":"expiration","value":"2026-12-31"},{"disabled":true,"description":{"content":"(Legacy) The volume tier most accurately reflective of this account's sending volume
\n","type":"text/plain"},"key":"volumetier","value":"4"},{"disabled":true,"description":{"content":"(Optional) [0,1] To enforce password complexity for this account
\n","type":"text/plain"},"key":"preferences[enforce_passwords]","value":"1"},{"disabled":true,"description":{"content":"(Optional) [0,1] To enforce MFA use for this account
\n","type":"text/plain"},"key":"preferences[enforce_mfa]","value":"1"},{"disabled":true,"description":{"content":"(Optional) Valid time zone from the 2020d TZ database
\n","type":"text/plain"},"key":"preferences[timezone]","value":"America/New_York"},{"disabled":true,"description":{"content":"(Optional) [0,1] To participate in aggregated community mailbox provider statistics and health indicators. Default is 1.
\n","type":"text/plain"},"key":"preferences[global_stats]","value":"1"},{"disabled":true,"description":{"content":"[Integer] Set the maximum number of users that can access this account.
\n","type":"text/plain"},"key":"preferences[max_users]","value":"0"},{"disabled":true,"description":{"content":"[Integer] Option to customize the account's logins session duration in minutes (min: 30, max: 240)
\n","type":"text/plain"},"key":"preferences[session_timeout]","value":"240"},{"disabled":true,"description":{"content":"(Legacy) [0,1] Option to include the Competitive Intel add-on. Use the permission section instead
\n","type":"text/plain"},"key":"subscription[addons][competitive]","value":"1"},{"disabled":true,"description":{"content":"(Legacy) [0,1] Option to include the Design add-on. Use the permission section instead
\n","type":"text/plain"},"key":"subscription[addons][design]","value":"1"},{"disabled":true,"description":{"content":"(Legacy) [0,1] Option to include the Validation add-on. Use the permission section instead
\n","type":"text/plain"},"key":"subscription[addons][validation]","value":"1"},{"disabled":true,"description":{"content":"(Legacy) [0,1] Option to include the Inbox: Seed List Optimizer add-on. Use the permission section instead
\n","type":"text/plain"},"key":"subscription[addons][optimizedseeds]","value":"1"},{"disabled":true,"description":{"content":"[Integer] Include the annual Design test quantity
\n","type":"text/plain"},"key":"subscription[products][design]","value":"100"},{"disabled":true,"description":{"content":"[Integer] Include the annual Engagement event quantity (I.e. annual number of opens)
\n","type":"text/plain"},"key":"subscription[products][engagement]","value":"1000000"},{"disabled":true,"description":{"content":"[Integer] Include the annual Inbox Placement test quantity
\n","type":"text/plain"},"key":"subscription[products][inbox]","value":"10000"},{"disabled":true,"description":{"content":"[Integer] Include the annual item count (IP addresses, domain names) elligible for Reputation monitoring
\n","type":"text/plain"},"key":"subscription[products][reputation]","value":"10000"},{"disabled":true,"description":{"content":"[Integer] Include the annual List Validation quantity of credits
\n","type":"text/plain"},"key":"subscription[products][validation]","value":"1000000"},{"disabled":true,"description":{"content":"[String] External account ID associated with this Everest account
\n","type":"text/plain"},"key":"external_id","value":"9a0d9d58-4d69-40e1-9160-a4506b5d4d60"},{"disabled":true,"description":{"content":"[String] Identifier for plan you want to assign to the user
\n","type":"text/plain"},"key":"plan[slug]","value":"3664e0dcb8"},{"disabled":true,"description":{"content":"[active, inactive, unavailable] Option to include Alerts feature for the user. Default value is unavailable.
\n","type":"text/plain"},"key":"permission[alerts]","value":"unavailable"},{"disabled":true,"description":{"content":"[active, inactive, unavailable] Option to include Integration feature for the user. Default value is unavailable.
\n","type":"text/plain"},"key":"permission[integrations]","value":"unavailable"},{"disabled":true,"description":{"content":"[active, inactive, unavailable] Option to include Integration ESPs feature for the user. Default value is unavailable.
\n","type":"text/plain"},"key":"permission[integrations_esps]","value":"unavailable"},{"disabled":true,"description":{"content":"[active, inactive, unavailable] Option to include Integration Utils feature for the user. Default value is unavailable.
\n","type":"text/plain"},"key":"permission[integrations_utils]","value":"unavailable"},{"disabled":true,"description":{"content":"[active, inactive, unavailable] Option to include Integration API access for the user. Default value is unavailable.
\n","type":"text/plain"},"key":"permission[integrations_api]","value":"unavailable"},{"disabled":true,"description":{"content":"[active, inactive, unavailable] Option to include SSO access for the user account. Default value is unavailable.
\n","type":"text/plain"},"key":"permission[accountsettings_sso]","value":"unavailable"},{"disabled":true,"description":{"content":"[active, inactive, unavailable] Option to include Account API sccess for the user. Default value is unavailable.
\n","type":"text/plain"},"key":"permission[accountsettings_api]","value":"unavailable"},{"disabled":true,"description":{"content":"[active, inactive, unavailable] Option to include MFA feature for the user. Default value is unavailable.
\n","type":"text/plain"},"key":"permission[accountsettings_mfa]","value":"unavailable"},{"disabled":true,"description":{"content":"[active, inactive, unavailable] Option to include Validation feature for the user. Default value is unavailable.
\n","type":"text/plain"},"key":"permission[validation]","value":"unavailable"},{"disabled":true,"description":{"content":"[active, inactive, unavailable] Option to include Validation API access feature for the user. Default value is unavailable.
\n","type":"text/plain"},"key":"permission[validation_api]","value":"unavailable"},{"disabled":true,"description":{"content":"[active, inactive, unavailable] Option to include Design feature for the user. Default value is unavailable.
\n","type":"text/plain"},"key":"permission[design]","value":"unavailable"},{"disabled":true,"description":{"content":"[active, inactive, unavailable] Option to include Design API access for the user. Default value is unavailable.
\n","type":"text/plain"},"key":"permission[design_api]","value":"unavailable"},{"disabled":true,"description":{"content":"[active, inactive, unavailable] Option to include Competitive Intel feature for the user. Default value is unavailable.
\n","type":"text/plain"},"key":"permission[competitiveintel]","value":"unavailable"},{"disabled":true,"description":{"content":"[active, inactive, unavailable] Option to include Competitive Intel API access for the user. Default value is unavailable.
\n","type":"text/plain"},"key":"permission[competitiveintel_api]","value":"unavailable"},{"disabled":true,"description":{"content":"[active, inactive, unavailable] Option to include Inbox feature for the user. Default value is unavailable.
\n","type":"text/plain"},"key":"permission[inbox]","value":"unavailable"},{"disabled":true,"description":{"content":"[active, inactive, unavailable] Option to include Inbox API access for the user. Default value is unavailable.
\n","type":"text/plain"},"key":"permission[inbox_api]","value":"unavailable"},{"disabled":true,"description":{"content":"[active, inactive, unavailable] Option to include Certification feature for the user. Default value is unavailable.
\n","type":"text/plain"},"key":"permission[certification]","value":"unavailable"},{"disabled":true,"description":{"content":"[active, inactive, unavailable] Option to include Certification API access for the user. Default value is unavailable.
\n","type":"text/plain"},"key":"permission[certification_api]","value":"unavailable"},{"disabled":true,"description":{"content":"[active, inactive, unavailable] Option to include View Time Optimization feature for the user. Default value is unavailable.
\n","type":"text/plain"},"key":"permission[vto]","value":"unavailable"},{"disabled":true,"description":{"content":"[active, inactive, unavailable] Option to include View Time Optimization API access for the user. Default value is unavailable.
\n","type":"text/plain"},"key":"permission[vto_api]","value":"unavailable"},{"disabled":true,"description":{"content":"[active, inactive, unavailable] Option to include Reputation feature for the user. Default value is unavailable.
\n","type":"text/plain"},"key":"permission[reputation]","value":"unavailable"},{"disabled":true,"description":{"content":"[active, inactive, unavailable] Option to include Reputation API access for the user. Default value is unavailable.
\n","type":"text/plain"},"key":"permission[reputation_api]","value":"unavailable"},{"disabled":true,"description":{"content":"[active, inactive, unavailable] Option to include Reputation GPT feature for the user. Default value is unavailable.
\n","type":"text/plain"},"key":"permission[reputation_gpt]","value":"unavailable"},{"disabled":true,"description":{"content":"[active, inactive, unavailable] Option to include Reputation Signal Spam feature for the user. Default value is unavailable.
\n","type":"text/plain"},"key":"permission[reputation_signalspam]","value":"unavailable"},{"disabled":true,"description":{"content":"[active, inactive, unavailable] Option to include Reputation SNDS feature for the user. Default value is unavailable.
\n","type":"text/plain"},"key":"permission[reputation_snds]","value":"unavailable"},{"disabled":true,"description":{"content":"[active, inactive, unavailable] Option to include Reputation UFBL feature for the user. Default value is unavailable.
\n","type":"text/plain"},"key":"permission[reputation_ufbl]","value":"unavailable"},{"disabled":true,"description":{"content":"[active, inactive, unavailable] Option to include Engagement feature for the user. Default value is unavailable.
\n","type":"text/plain"},"key":"permission[engagement]","value":"unavailable"},{"disabled":true,"description":{"content":"[active, inactive, unavailable] Option to include Engagement API access for the user. Default value is unavailable.
\n","type":"text/plain"},"key":"permission[engagement_api]","value":"unavailable"},{"disabled":true,"description":{"content":"[active, inactive, unavailable] Option to include Infrastructure feature for the user. Default value is unavailable.
\n","type":"text/plain"},"key":"permission[infrastructure]","value":"unavailable"},{"disabled":true,"description":{"content":"[active, inactive, unavailable] Option to include Infrastructure API access for the user. Default value is unavailable.
\n","type":"text/plain"},"key":"permission[infrastructure_api]","value":"unavailable"}],"variable":[]}},"response":[{"id":"2d9e11d5-71cb-408d-a221-836e55cccd34","name":"Create Account","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"Account Name\",\n \"package\": \"Professional\",\n \"external_id\": \"external-id\",\n \"start\": \"2023-01-01\",\n \"expiration\": \"2025-12-31\",\n \"includeglobalstats\": 0,\n \"inboxseedlistgroup\": 1,\n \"inboxreset\": \"annual\",\n \"subscription\": {\n \"addons\": {\n \"competitive\": 1,\n \"optimizedseeds\": 1,\n \"design\": 1,\n \"validation\": 1,\n \"vto\": 1\n },\n \"products\": {\n \"analytics\": 100,\n \"blacklist\": 100,\n \"certification\": 100,\n \"design\": 100,\n \"dmarc\": 100,\n \"engagement\": 100,\n \"inbox\": 100,\n \"reputation\": 100,\n \"validation\": 100\n }\n },\n \"plan\": {\n \"slug\": \"5EH934FIOU\"\n },\n \"permissions\": {\n \"reputation\": \"inactive\",\n \"design\": \"active\"\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.everest.validity.com/api/2.0/accounts/","protocol":"https","host":["api","everest","validity","com"],"path":["api","2.0","accounts",""],"query":[{"key":"name","value":"Test Account","description":"(Required) Name of the account","disabled":true},{"key":"package","value":"Enterprise","description":"(Legacy) [Essentials, Professional, Enterprise] The package to determine which plan will be assigned to the user. This field is optional if the new plan field is passed.","disabled":true},{"key":"start","value":"2021-01-01","description":"(Required) The account's subscription start date (format: YYYY-MM-DD)","disabled":true},{"key":"expiration","value":"2026-12-31","description":"(Required) The account's subscription expiration date (format: YYYY-MM-DD)","disabled":true},{"key":"volumetier","value":"4","description":"(Legacy) The volume tier most accurately reflective of this account's sending volume","disabled":true},{"key":"preferences[enforce_passwords]","value":"1","description":"(Optional) [0,1] To enforce password complexity for this account","disabled":true},{"key":"preferences[enforce_mfa]","value":"1","description":"(Optional) [0,1] To enforce MFA use for this account","disabled":true},{"key":"preferences[timezone]","value":"America/New_York","description":"(Optional) Valid time zone from the 2020d TZ database","disabled":true},{"key":"preferences[global_stats]","value":"1","description":"(Optional) [0,1] To participate in aggregated community mailbox provider statistics and health indicators. Default is 1.","disabled":true},{"key":"preferences[max_users]","value":"0","description":"[Integer] Set the maximum number of users that can access this account.","disabled":true},{"key":"preferences[session_timeout]","value":"240","description":"[Integer] Option to customize the account's logins session duration in minutes (min: 30, max: 240)","disabled":true},{"key":"subscription[addons][competitive]","value":"1","description":"(Legacy) [0,1] Option to include the Competitive Intel add-on. Use the permission section instead","disabled":true},{"key":"subscription[addons][design]","value":"1","description":"(Legacy) [0,1] Option to include the Design add-on. Use the permission section instead","disabled":true},{"key":"subscription[addons][validation]","value":"1","description":"(Legacy) [0,1] Option to include the Validation add-on. Use the permission section instead","disabled":true},{"key":"subscription[addons][optimizedseeds]","value":"1","description":"(Legacy) [0,1] Option to include the Inbox: Seed List Optimizer add-on. Use the permission section instead","disabled":true},{"key":"subscription[products][design]","value":"100","description":"[Integer] Include the annual Design test quantity","disabled":true},{"key":"subscription[products][engagement]","value":"1000000","description":"[Integer] Include the annual Engagement event quantity (I.e. annual number of opens)","disabled":true},{"key":"subscription[products][inbox]","value":"10000","description":"[Integer] Include the annual Inbox Placement test quantity","disabled":true},{"key":"subscription[products][reputation]","value":"10000","description":"[Integer] Include the annual item count (IP addresses, domain names) elligible for Reputation monitoring","disabled":true},{"key":"subscription[products][validation]","value":"1000000","description":"[Integer] Include the annual List Validation quantity of credits","disabled":true},{"key":"external_id","value":"9a0d9d58-4d69-40e1-9160-a4506b5d4d60","description":"[String] External account ID associated with this Everest account","disabled":true},{"key":"plan[slug]","value":"3664e0dcb8","description":"[String] Identifier for plan you want to assign to the user","disabled":true},{"key":"permission[alerts]","value":"unavailable","description":"[active, inactive, unavailable] Option to include Alerts feature for the user. Default value is unavailable.","disabled":true},{"key":"permission[integrations]","value":"unavailable","description":"[active, inactive, unavailable] Option to include Integration feature for the user. Default value is unavailable.","disabled":true},{"key":"permission[integrations_esps]","value":"unavailable","description":"[active, inactive, unavailable] Option to include Integration ESPs feature for the user. Default value is unavailable.","disabled":true},{"key":"permission[integrations_utils]","value":"unavailable","description":"[active, inactive, unavailable] Option to include Integration Utils feature for the user. Default value is unavailable.","disabled":true},{"key":"permission[integrations_api]","value":"unavailable","description":"[active, inactive, unavailable] Option to include Integration API access for the user. Default value is unavailable.","disabled":true},{"key":"permission[accountsettings_sso]","value":"unavailable","description":"[active, inactive, unavailable] Option to include SSO access for the user account. Default value is unavailable.","disabled":true},{"key":"permission[accountsettings_api]","value":"unavailable","description":"[active, inactive, unavailable] Option to include Account API sccess for the user. Default value is unavailable.","disabled":true},{"key":"permission[accountsettings_mfa]","value":"unavailable","description":"[active, inactive, unavailable] Option to include MFA feature for the user. Default value is unavailable.","disabled":true},{"key":"permission[validation]","value":"unavailable","description":"[active, inactive, unavailable] Option to include Validation feature for the user. Default value is unavailable.","disabled":true},{"key":"permission[validation_api]","value":"unavailable","description":"[active, inactive, unavailable] Option to include Validation API access feature for the user. Default value is unavailable.","disabled":true},{"key":"permission[design]","value":"unavailable","description":"[active, inactive, unavailable] Option to include Design feature for the user. Default value is unavailable.","disabled":true},{"key":"permission[design_api]","value":"unavailable","description":"[active, inactive, unavailable] Option to include Design API access for the user. Default value is unavailable.","disabled":true},{"key":"permission[design_premium]","value":"unavailable","description":"[active, inactive, unavailable] Option to include Design Premium feature for the user. Default value is unavailable.","disabled":true},{"key":"permission[competitiveintel]","value":"unavailable","description":"[active, inactive, unavailable] Option to include Competitive Intel feature for the user. Default value is unavailable.","disabled":true},{"key":"permission[competitiveintel_api]","value":"unavailable","description":"[active, inactive, unavailable] Option to include Competitive Intel API access for the user. Default value is unavailable.","disabled":true},{"key":"permission[inbox]","value":"unavailable","description":"[active, inactive, unavailable] Option to include Inbox feature for the user. Default value is unavailable.","disabled":true},{"key":"permission[inbox_api]","value":"unavailable","description":"[active, inactive, unavailable] Option to include Inbox API access for the user. Default value is unavailable.","disabled":true},{"key":"permission[inbox_globalseeds]","value":"unavailable","description":"[active, inactive, unavailable] Option to include Inbox Global Seeds feature for the user. Default value is unavailable.","disabled":true},{"key":"permission[certification]","value":"unavailable","description":"[active, inactive, unavailable] Option to include Certification feature for the user. Default value is unavailable.","disabled":true},{"key":"permission[certification_api]","value":"unavailable","description":"[active, inactive, unavailable] Option to include Certification API access for the user. Default value is unavailable.","disabled":true},{"key":"permission[certification_globalallowlist]","value":"unavailable","description":"[active, inactive, unavailable] Option to include Certification Global Allow List feature for the user. Default value is unavailable.","disabled":true},{"key":"permission[vto]","value":"unavailable","description":"[active, inactive, unavailable] Option to include View Time Optimization feature for the user. Default value is unavailable.","disabled":true},{"key":"permission[vto_api]","value":"unavailable","description":"[active, inactive, unavailable] Option to include View Time Optimization API access for the user. Default value is unavailable.","disabled":true},{"key":"permission[reputation]","value":"unavailable","description":"[active, inactive, unavailable] Option to include Reputation feature for the user. Default value is unavailable.","disabled":true},{"key":"permission[reputation_api]","value":"unavailable","description":"[active, inactive, unavailable] Option to include Reputation API access for the user. Default value is unavailable.","disabled":true},{"key":"permission[reputation_spamhaus]","value":"unavailable","description":"[active, inactive, unavailable] Option to include Reputation Spamhaus feature for the user. Default value is unavailable.","disabled":true},{"key":"permission[reputation_gpt]","value":"unavailable","description":"[active, inactive, unavailable] Option to include Reputation GPT feature for the user. Default value is unavailable.","disabled":true},{"key":"permission[reputation_signalspam]","value":"unavailable","description":"[active, inactive, unavailable] Option to include Reputation Signal Spam feature for the user. Default value is unavailable.","disabled":true},{"key":"permission[reputation_snds]","value":"unavailable","description":"[active, inactive, unavailable] Option to include Reputation SNDS feature for the user. Default value is unavailable.","disabled":true},{"key":"permission[reputation_ufbl]","value":"unavailable","description":"[active, inactive, unavailable] Option to include Reputation UFBL feature for the user. Default value is unavailable.","disabled":true},{"key":"permission[engagement]","value":"unavailable","description":"[active, inactive, unavailable] Option to include Engagement feature for the user. Default value is unavailable.","disabled":true},{"key":"permission[engagement_api]","value":"unavailable","description":"[active, inactive, unavailable] Option to include Engagement API access for the user. Default value is unavailable.","disabled":true},{"key":"permission[infrastructure]","value":"unavailable","description":"[active, inactive, unavailable] Option to include Infrastructure feature for the user. Default value is unavailable.","disabled":true},{"key":"permission[infrastructure_api]","value":"unavailable","description":"[active, inactive, unavailable] Option to include Infrastructure API access for the user. Default value is unavailable.","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Headers","value":"Authorization,Accept,Keep-Alive,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type,Content-Range,Range,x-api-key,newrelic"},{"key":"Access-Control-Allow-Methods","value":"GET,POST,OPTIONS,PUT,DELETE,PATCH"},{"key":"Access-Control-Allow-Origin","value":""},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Fri, 24 Nov 2023 17:33:46 GMT"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Pragma","value":"no-cache"},{"key":"Server","value":"nginx"},{"key":"Strict-Transport-Security","value":"max-age=86400; includeSubDomains"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"meta\": {},\n \"results\": {\n \"status\": \"success\",\n \"id\": 1018853\n }\n}"}],"_postman_id":"a09b17ce-3f93-4d02-a892-ab1b93a7c457"},{"name":"Update Account","id":"20e60691-99b9-4277-b0c3-7e185d09dee9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"Account Name\",\n \"package\": \"Professional\",\n \"external_id\": \"external-id\",\n \"includeglobalstats\": 0,\n \"inboxseedlistgroup\": 1,\n \"inboxreset\": \"annual\",\n \"subscription\": {\n \"products\": {\n \"analytics\": 100,\n \"blacklist\": 100,\n \"certification\": 100,\n \"design\": 100,\n \"dmarc\": 100,\n \"engagement\": 100,\n \"inbox\": 100,\n \"reputation\": 100,\n \"validation\": 100\n }\n },\n \"plan\": {\n \"slug\": \"5EH934FIOU\"\n },\n \"permissions\": {\n \"reputation\": \"inactive\",\n \"design\": \"inactive\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/accounts/{{user_id}}","auth":{"type":"apikey","apikey":{"value":"{{your-api-key-here}}","key":"(Required) Name of the account
\n","type":"text/plain"},"key":"name","value":"Test Account"},{"disabled":true,"description":{"content":"(Legacy) [Essentials, Professional, Enterprise] The package to determine which plan will be assigned to the user. This field is optional if the new plan field is passed.
\n","type":"text/plain"},"key":"package","value":"Enterprise"},{"disabled":true,"description":{"content":"(Required) The account's subscription start date (format: YYYY-MM-DD)
\n","type":"text/plain"},"key":"start","value":"2021-01-01"},{"disabled":true,"description":{"content":"(Required) The account's subscription expiration date (format: YYYY-MM-DD)
\n","type":"text/plain"},"key":"expiration","value":"2026-12-31"},{"disabled":true,"description":{"content":"(Legacy) The volume tier most accurately reflective of this account's sending volume
\n","type":"text/plain"},"key":"volumetier","value":"4"},{"disabled":true,"description":{"content":"(Optional) [0,1] To enforce password complexity for this account
\n","type":"text/plain"},"key":"preferences[enforce_passwords]","value":"1"},{"disabled":true,"description":{"content":"(Optional) [0,1] To enforce MFA use for this account
\n","type":"text/plain"},"key":"preferences[enforce_mfa]","value":"1"},{"disabled":true,"description":{"content":"(Optional) Valid time zone from the 2020d TZ database
\n","type":"text/plain"},"key":"preferences[timezone]","value":"America/New_York"},{"disabled":true,"description":{"content":"(Optional) [0,1] To participate in aggregated community mailbox provider statistics and health indicators. Default is 1.
\n","type":"text/plain"},"key":"preferences[global_stats]","value":"1"},{"disabled":true,"description":{"content":"[Integer] Set the maximum number of users that can access this account.
\n","type":"text/plain"},"key":"preferences[max_users]","value":"0"},{"disabled":true,"description":{"content":"[Integer] Option to customize the account's logins session duration in minutes (min: 30, max: 240)
\n","type":"text/plain"},"key":"preferences[session_timeout]","value":"240"},{"disabled":true,"description":{"content":"(Legacy) [0,1] Option to include the Competitive Intel add-on. Use the permission section instead
\n","type":"text/plain"},"key":"subscription[addons][competitive]","value":"1"},{"disabled":true,"description":{"content":"(Legacy) [0,1] Option to include the Design add-on. Use the permission section instead
\n","type":"text/plain"},"key":"subscription[addons][design]","value":"1"},{"disabled":true,"description":{"content":"(Legacy) [0,1] Option to include the Validation add-on. Use the permission section instead
\n","type":"text/plain"},"key":"subscription[addons][validation]","value":"1"},{"disabled":true,"description":{"content":"(Legacy) [0,1] Option to include the Inbox: Seed List Optimizer add-on. Use the permission section instead
\n","type":"text/plain"},"key":"subscription[addons][optimizedseeds]","value":"1"},{"disabled":true,"description":{"content":"[Integer] Include the annual Design test quantity
\n","type":"text/plain"},"key":"subscription[products][design]","value":"100"},{"disabled":true,"description":{"content":"[Integer] Include the annual Engagement event quantity (I.e. annual number of opens)
\n","type":"text/plain"},"key":"subscription[products][engagement]","value":"1000000"},{"disabled":true,"description":{"content":"[Integer] Include the annual Inbox Placement test quantity
\n","type":"text/plain"},"key":"subscription[products][inbox]","value":"10000"},{"disabled":true,"description":{"content":"[Integer] Include the annual item count (IP addresses, domain names) elligible for Reputation monitoring
\n","type":"text/plain"},"key":"subscription[products][reputation]","value":"10000"},{"disabled":true,"description":{"content":"[Integer] Include the annual List Validation quantity of credits
\n","type":"text/plain"},"key":"subscription[products][validation]","value":"1000000"},{"disabled":true,"description":{"content":"[String] External account ID associated with this Everest account
\n","type":"text/plain"},"key":"external_id","value":"9a0d9d58-4d69-40e1-9160-a4506b5d4d60"},{"disabled":true,"description":{"content":"[String] Identifier for plan you want to assign to the user
\n","type":"text/plain"},"key":"plan[slug]","value":"3664e0dcb8"},{"disabled":true,"description":{"content":"[active, inactive, unavailable] Option to include Alerts feature for the user. Default value is unavailable.
\n","type":"text/plain"},"key":"permission[alerts]","value":"unavailable"},{"disabled":true,"description":{"content":"[active, inactive, unavailable] Option to include Integration feature for the user. Default value is unavailable.
\n","type":"text/plain"},"key":"permission[integrations]","value":"unavailable"},{"disabled":true,"description":{"content":"[active, inactive, unavailable] Option to include Integration ESPs feature for the user. Default value is unavailable.
\n","type":"text/plain"},"key":"permission[integrations_esps]","value":"unavailable"},{"disabled":true,"description":{"content":"[active, inactive, unavailable] Option to include Integration Utils feature for the user. Default value is unavailable.
\n","type":"text/plain"},"key":"permission[integrations_utils]","value":"unavailable"},{"disabled":true,"description":{"content":"[active, inactive, unavailable] Option to include Integration API access for the user. Default value is unavailable.
\n","type":"text/plain"},"key":"permission[integrations_api]","value":"unavailable"},{"disabled":true,"description":{"content":"[active, inactive, unavailable] Option to include SSO access for the user account. Default value is unavailable.
\n","type":"text/plain"},"key":"permission[accountsettings_sso]","value":"unavailable"},{"disabled":true,"description":{"content":"[active, inactive, unavailable] Option to include Account API sccess for the user. Default value is unavailable.
\n","type":"text/plain"},"key":"permission[accountsettings_api]","value":"unavailable"},{"disabled":true,"description":{"content":"[active, inactive, unavailable] Option to include MFA feature for the user. Default value is unavailable.
\n","type":"text/plain"},"key":"permission[accountsettings_mfa]","value":"unavailable"},{"disabled":true,"description":{"content":"[active, inactive, unavailable] Option to include Validation feature for the user. Default value is unavailable.
\n","type":"text/plain"},"key":"permission[validation]","value":"unavailable"},{"disabled":true,"description":{"content":"[active, inactive, unavailable] Option to include Validation API access feature for the user. Default value is unavailable.
\n","type":"text/plain"},"key":"permission[validation_api]","value":"unavailable"},{"disabled":true,"description":{"content":"[active, inactive, unavailable] Option to include Design feature for the user. Default value is unavailable.
\n","type":"text/plain"},"key":"permission[design]","value":"unavailable"},{"disabled":true,"description":{"content":"[active, inactive, unavailable] Option to include Design API access for the user. Default value is unavailable.
\n","type":"text/plain"},"key":"permission[design_api]","value":"unavailable"},{"disabled":true,"description":{"content":"[active, inactive, unavailable] Option to include Competitive Intel feature for the user. Default value is unavailable.
\n","type":"text/plain"},"key":"permission[competitiveintel]","value":"unavailable"},{"disabled":true,"description":{"content":"[active, inactive, unavailable] Option to include Competitive Intel API access for the user. Default value is unavailable.
\n","type":"text/plain"},"key":"permission[competitiveintel_api]","value":"unavailable"},{"disabled":true,"description":{"content":"[active, inactive, unavailable] Option to include Inbox feature for the user. Default value is unavailable.
\n","type":"text/plain"},"key":"permission[inbox]","value":"unavailable"},{"disabled":true,"description":{"content":"[active, inactive, unavailable] Option to include Inbox API access for the user. Default value is unavailable.
\n","type":"text/plain"},"key":"permission[inbox_api]","value":"unavailable"},{"disabled":true,"description":{"content":"[active, inactive, unavailable] Option to include Certification feature for the user. Default value is unavailable.
\n","type":"text/plain"},"key":"permission[certification]","value":"unavailable"},{"disabled":true,"description":{"content":"[active, inactive, unavailable] Option to include Certification API access for the user. Default value is unavailable.
\n","type":"text/plain"},"key":"permission[certification_api]","value":"unavailable"},{"disabled":true,"description":{"content":"[active, inactive, unavailable] Option to include View Time Optimization feature for the user. Default value is unavailable.
\n","type":"text/plain"},"key":"permission[vto]","value":"unavailable"},{"disabled":true,"description":{"content":"[active, inactive, unavailable] Option to include View Time Optimization API access for the user. Default value is unavailable.
\n","type":"text/plain"},"key":"permission[vto_api]","value":"unavailable"},{"disabled":true,"description":{"content":"[active, inactive, unavailable] Option to include Reputation feature for the user. Default value is unavailable.
\n","type":"text/plain"},"key":"permission[reputation]","value":"unavailable"},{"disabled":true,"description":{"content":"[active, inactive, unavailable] Option to include Reputation API access for the user. Default value is unavailable.
\n","type":"text/plain"},"key":"permission[reputation_api]","value":"unavailable"},{"disabled":true,"description":{"content":"[active, inactive, unavailable] Option to include Reputation GPT feature for the user. Default value is unavailable.
\n","type":"text/plain"},"key":"permission[reputation_gpt]","value":"unavailable"},{"disabled":true,"description":{"content":"[active, inactive, unavailable] Option to include Reputation Signal Spam feature for the user. Default value is unavailable.
\n","type":"text/plain"},"key":"permission[reputation_signalspam]","value":"unavailable"},{"disabled":true,"description":{"content":"[active, inactive, unavailable] Option to include Reputation SNDS feature for the user. Default value is unavailable.
\n","type":"text/plain"},"key":"permission[reputation_snds]","value":"unavailable"},{"disabled":true,"description":{"content":"[active, inactive, unavailable] Option to include Reputation UFBL feature for the user. Default value is unavailable.
\n","type":"text/plain"},"key":"permission[reputation_ufbl]","value":"unavailable"},{"disabled":true,"description":{"content":"[active, inactive, unavailable] Option to include Engagement feature for the user. Default value is unavailable.
\n","type":"text/plain"},"key":"permission[engagement]","value":"unavailable"},{"disabled":true,"description":{"content":"[active, inactive, unavailable] Option to include Engagement API access for the user. Default value is unavailable.
\n","type":"text/plain"},"key":"permission[engagement_api]","value":"unavailable"},{"disabled":true,"description":{"content":"[active, inactive, unavailable] Option to include Infrastructure feature for the user. Default value is unavailable.
\n","type":"text/plain"},"key":"permission[infrastructure]","value":"unavailable"},{"disabled":true,"description":{"content":"[active, inactive, unavailable] Option to include Infrastructure API access for the user. Default value is unavailable.
\n","type":"text/plain"},"key":"permission[infrastructure_api]","value":"unavailable"}],"variable":[]}},"response":[{"id":"cf3979d7-d82e-4ccc-91a0-974c5c7a79d9","name":"Update Account","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"Account Name\",\n \"package\": \"Professional\",\n \"external_id\": \"external-id\",\n \"includeglobalstats\": 0,\n \"inboxseedlistgroup\": 1,\n \"inboxreset\": \"annual\",\n \"subscription\": {\n \"products\": {\n \"analytics\": 100,\n \"blacklist\": 100,\n \"certification\": 100,\n \"design\": 100,\n \"dmarc\": 100,\n \"engagement\": 100,\n \"inbox\": 100,\n \"reputation\": 100,\n \"validation\": 100\n }\n },\n \"plan\": {\n \"slug\": \"5EH934FIOU\"\n },\n \"permissions\": {\n \"reputation\": \"inactive\",\n \"design\": \"inactive\"\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.everest.validity.com/api/2.0/accounts/{{user_id}}","protocol":"https","host":["api","everest","validity","com"],"path":["api","2.0","accounts","{{user_id}}"],"query":[{"key":"name","value":"Test Account","description":"(Required) Name of the account","disabled":true},{"key":"package","value":"Enterprise","description":"(Legacy) [Essentials, Professional, Enterprise] The package to determine which plan will be assigned to the user. This field is optional if the new plan field is passed.","disabled":true},{"key":"start","value":"2021-01-01","description":"(Required) The account's subscription start date (format: YYYY-MM-DD)","disabled":true},{"key":"expiration","value":"2026-12-31","description":"(Required) The account's subscription expiration date (format: YYYY-MM-DD)","disabled":true},{"key":"volumetier","value":"4","description":"(Legacy) The volume tier most accurately reflective of this account's sending volume","disabled":true},{"key":"preferences[enforce_passwords]","value":"1","description":"(Optional) [0,1] To enforce password complexity for this account","disabled":true},{"key":"preferences[enforce_mfa]","value":"1","description":"(Optional) [0,1] To enforce MFA use for this account","disabled":true},{"key":"preferences[timezone]","value":"America/New_York","description":"(Optional) Valid time zone from the 2020d TZ database","disabled":true},{"key":"preferences[global_stats]","value":"1","description":"(Optional) [0,1] To participate in aggregated community mailbox provider statistics and health indicators. Default is 1.","disabled":true},{"key":"preferences[max_users]","value":"0","description":"[Integer] Set the maximum number of users that can access this account.","disabled":true},{"key":"preferences[session_timeout]","value":"240","description":"[Integer] Option to customize the account's logins session duration in minutes (min: 30, max: 240)","disabled":true},{"key":"subscription[addons][competitive]","value":"1","description":"(Legacy) [0,1] Option to include the Competitive Intel add-on. Use the permission section instead","disabled":true},{"key":"subscription[addons][design]","value":"1","description":"(Legacy) [0,1] Option to include the Design add-on. Use the permission section instead","disabled":true},{"key":"subscription[addons][validation]","value":"1","description":"(Legacy) [0,1] Option to include the Validation add-on. Use the permission section instead","disabled":true},{"key":"subscription[addons][optimizedseeds]","value":"1","description":"(Legacy) [0,1] Option to include the Inbox: Seed List Optimizer add-on. Use the permission section instead","disabled":true},{"key":"subscription[products][design]","value":"100","description":"[Integer] Include the annual Design test quantity","disabled":true},{"key":"subscription[products][engagement]","value":"1000000","description":"[Integer] Include the annual Engagement event quantity (I.e. annual number of opens)","disabled":true},{"key":"subscription[products][inbox]","value":"10000","description":"[Integer] Include the annual Inbox Placement test quantity","disabled":true},{"key":"subscription[products][reputation]","value":"10000","description":"[Integer] Include the annual item count (IP addresses, domain names) elligible for Reputation monitoring","disabled":true},{"key":"subscription[products][validation]","value":"1000000","description":"[Integer] Include the annual List Validation quantity of credits","disabled":true},{"key":"external_id","value":"9a0d9d58-4d69-40e1-9160-a4506b5d4d60","description":"[String] External account ID associated with this Everest account","disabled":true},{"key":"plan[slug]","value":"3664e0dcb8","description":"[String] Identifier for plan you want to assign to the user","disabled":true},{"key":"permission[alerts]","value":"unavailable","description":"[active, inactive, unavailable] Option to include Alerts feature for the user. Default value is unavailable.","disabled":true},{"key":"permission[integrations]","value":"unavailable","description":"[active, inactive, unavailable] Option to include Integration feature for the user. Default value is unavailable.","disabled":true},{"key":"permission[integrations_esps]","value":"unavailable","description":"[active, inactive, unavailable] Option to include Integration ESPs feature for the user. Default value is unavailable.","disabled":true},{"key":"permission[integrations_utils]","value":"unavailable","description":"[active, inactive, unavailable] Option to include Integration Utils feature for the user. Default value is unavailable.","disabled":true},{"key":"permission[integrations_api]","value":"unavailable","description":"[active, inactive, unavailable] Option to include Integration API access for the user. Default value is unavailable.","disabled":true},{"key":"permission[accountsettings_sso]","value":"unavailable","description":"[active, inactive, unavailable] Option to include SSO access for the user account. Default value is unavailable.","disabled":true},{"key":"permission[accountsettings_api]","value":"unavailable","description":"[active, inactive, unavailable] Option to include Account API sccess for the user. Default value is unavailable.","disabled":true},{"key":"permission[accountsettings_mfa]","value":"unavailable","description":"[active, inactive, unavailable] Option to include MFA feature for the user. Default value is unavailable.","disabled":true},{"key":"permission[validation]","value":"unavailable","description":"[active, inactive, unavailable] Option to include Validation feature for the user. Default value is unavailable.","disabled":true},{"key":"permission[validation_api]","value":"unavailable","description":"[active, inactive, unavailable] Option to include Validation API access feature for the user. Default value is unavailable.","disabled":true},{"key":"permission[design]","value":"unavailable","description":"[active, inactive, unavailable] Option to include Design feature for the user. Default value is unavailable.","disabled":true},{"key":"permission[design_api]","value":"unavailable","description":"[active, inactive, unavailable] Option to include Design API access for the user. Default value is unavailable.","disabled":true},{"key":"permission[design_premium]","value":"unavailable","description":"[active, inactive, unavailable] Option to include Design Premium feature for the user. Default value is unavailable.","disabled":true},{"key":"permission[competitiveintel]","value":"unavailable","description":"[active, inactive, unavailable] Option to include Competitive Intel feature for the user. Default value is unavailable.","disabled":true},{"key":"permission[competitiveintel_api]","value":"unavailable","description":"[active, inactive, unavailable] Option to include Competitive Intel API access for the user. Default value is unavailable.","disabled":true},{"key":"permission[inbox]","value":"unavailable","description":"[active, inactive, unavailable] Option to include Inbox feature for the user. Default value is unavailable.","disabled":true},{"key":"permission[inbox_api]","value":"unavailable","description":"[active, inactive, unavailable] Option to include Inbox API access for the user. Default value is unavailable.","disabled":true},{"key":"permission[inbox_globalseeds]","value":"unavailable","description":"[active, inactive, unavailable] Option to include Inbox Global Seeds feature for the user. Default value is unavailable.","disabled":true},{"key":"permission[certification]","value":"unavailable","description":"[active, inactive, unavailable] Option to include Certification feature for the user. Default value is unavailable.","disabled":true},{"key":"permission[certification_api]","value":"unavailable","description":"[active, inactive, unavailable] Option to include Certification API access for the user. Default value is unavailable.","disabled":true},{"key":"permission[certification_globalallowlist]","value":"unavailable","description":"[active, inactive, unavailable] Option to include Certification Global Allow List feature for the user. Default value is unavailable.","disabled":true},{"key":"permission[vto]","value":"unavailable","description":"[active, inactive, unavailable] Option to include View Time Optimization feature for the user. Default value is unavailable.","disabled":true},{"key":"permission[vto_api]","value":"unavailable","description":"[active, inactive, unavailable] Option to include View Time Optimization API access for the user. Default value is unavailable.","disabled":true},{"key":"permission[reputation]","value":"unavailable","description":"[active, inactive, unavailable] Option to include Reputation feature for the user. Default value is unavailable.","disabled":true},{"key":"permission[reputation_api]","value":"unavailable","description":"[active, inactive, unavailable] Option to include Reputation API access for the user. Default value is unavailable.","disabled":true},{"key":"permission[reputation_spamhaus]","value":"unavailable","description":"[active, inactive, unavailable] Option to include Reputation Spamhaus feature for the user. Default value is unavailable.","disabled":true},{"key":"permission[reputation_gpt]","value":"unavailable","description":"[active, inactive, unavailable] Option to include Reputation GPT feature for the user. Default value is unavailable.","disabled":true},{"key":"permission[reputation_signalspam]","value":"unavailable","description":"[active, inactive, unavailable] Option to include Reputation Signal Spam feature for the user. Default value is unavailable.","disabled":true},{"key":"permission[reputation_snds]","value":"unavailable","description":"[active, inactive, unavailable] Option to include Reputation SNDS feature for the user. Default value is unavailable.","disabled":true},{"key":"permission[reputation_ufbl]","value":"unavailable","description":"[active, inactive, unavailable] Option to include Reputation UFBL feature for the user. Default value is unavailable.","disabled":true},{"key":"permission[engagement]","value":"unavailable","description":"[active, inactive, unavailable] Option to include Engagement feature for the user. Default value is unavailable.","disabled":true},{"key":"permission[engagement_api]","value":"unavailable","description":"[active, inactive, unavailable] Option to include Engagement API access for the user. Default value is unavailable.","disabled":true},{"key":"permission[infrastructure]","value":"unavailable","description":"[active, inactive, unavailable] Option to include Infrastructure feature for the user. Default value is unavailable.","disabled":true},{"key":"permission[infrastructure_api]","value":"unavailable","description":"[active, inactive, unavailable] Option to include Infrastructure API access for the user. Default value is unavailable.","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Headers","value":"Authorization,Accept,Keep-Alive,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type,Content-Range,Range,x-api-key,newrelic"},{"key":"Access-Control-Allow-Methods","value":"GET,POST,OPTIONS,PUT,DELETE,PATCH"},{"key":"Access-Control-Allow-Origin","value":""},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Fri, 24 Nov 2023 17:46:28 GMT"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Pragma","value":"no-cache"},{"key":"Server","value":"nginx"},{"key":"Set-Cookie","value":"vfe_session=mnf326phga8un9vnf5fo6np94r4bf5ek; expires=Fri, 24-Nov-2023 21:45:31 GMT; Max-Age=14400; path=/; domain=.api.everest.validity.dcom; secure; HttpOnly; SameSite=None"},{"key":"Strict-Transport-Security","value":"max-age=86400; includeSubDomains"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"meta\": {},\n \"results\": {\n \"status\": \"success\"\n }\n}"}],"_postman_id":"20e60691-99b9-4277-b0c3-7e185d09dee9"},{"name":"Plan","id":"b480ed7f-8442-4787-bf31-9da306867c73","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{host}}/accounts/plans","description":"GET Plans will return all plans your account owns as well as detailed information about each plan. This endpoint is intended to be used by Resellers to manage their child accounts. Other account types are not supported in this endpoint.
\n","auth":{"type":"apikey","apikey":{"value":"{{your-api-key-here}}","key":"(Required) Unique email address of the user
\n","type":"text"},{"key":"first","value":"John","description":"(Required) First name
\n","type":"text"},{"key":"last","value":"Smith","description":"(Required) Last name
\n","type":"text"},{"key":"title","value":"VP Engineering","description":"(Optional) Job title
\n","type":"text"},{"key":"password","value":"pass1234","description":"(Optional) If you use SSO/SAML, we will generate a randomly hashed password for you. If you leave the password field blank, a random password will be generated and the user will be forced to change their password on first login.
\n","type":"text"},{"key":"phone","value":"1112223333","description":"(Optional) Phone number
\n","type":"text"},{"key":"forcepasswordreset","value":"0","description":"[0, 1] Option to force a password reset on first login.
\n","type":"text"},{"key":"emailcredentials","value":"1","description":"[0, 1] Option to email the new user their login Instructions.
\n","type":"text"},{"key":"admin","value":"0","description":"[0, 1] Option to add the new user as an account admin.
\n","type":"text"}]},"url":"{{host}}/accounts/{{account_id}}/users","auth":{"type":"apikey","apikey":{"value":"{{your-api-key-here}}","key":"Pass 1 to promote the user to an admin of the account.
\n"},{"key":"unlock","value":"1","type":"text","description":"Pass 1 to unlock a user's account after too many failed login attempts.
\n"}]},"url":"{{host}}/accounts/{{account_id}}/users/{{alias_id}}","description":"This endpoint is specifically for promoting users to account administrators, or unlocking users after too many failed login attempts. Since users can belong to multiple accounts, editing functionality is limited to protect their privacy.
\n","auth":{"type":"apikey","apikey":{"value":"{{your-api-key-here}}","key":"This endpoint will return a token that can be appended to any Everest URL using a ?sso= parameter. The token expires every 2 minutes and you’ll need to retrieve a new one.
\nSample Response:\n\"22aaa33bb1188ff5522dba\"
\nAccessing Everest via Single Sign On:\nhttps://everest.validity.com/account?sso=22aaa33bb1188ff5522dba
\n","auth":{"type":"apikey","apikey":{"value":"{{your-api-key-here}}","key":"Optional email address to be Included for the SSO login. If the 'email' parameter Is blank, it will log In using the default user on the account.
\n","type":"text/plain"},"key":"email","value":"john.smith@domain.com"}],"variable":[]}},"response":[{"id":"aeee44f7-9777-4a5d-aa1b-d2151e0f2bff","name":"Retrieve SSO Token","originalRequest":{"method":"GET","header":[],"url":"{{host}}/accounts/{{account_id}}/sso"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.17.6"},{"key":"Date","value":"Thu, 17 Dec 2020 19:53:58 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"34"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/7.3.20"},{"key":"Access-Control-Allow-Origin","value":"https://everest.validity.com"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Headers","value":"Authorization,Accept,Keep-Alive,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type,Content-Range,Range,x-api-key"},{"key":"Access-Control-Allow-Methods","value":"GET,POST,OPTIONS,PUT,DELETE,PATCH"}],"cookie":[],"responseTime":null,"body":"\"22aaa33bb1188ff5522dba\""}],"_postman_id":"9243f6ff-5943-42be-b3ff-c11787744d17"}],"id":"3195d595-2df7-486d-9bc6-cd69fc01a065","description":"Common Errors:
\n- \n
- 400: Invalid ../accounts/:account_id parameter. \n
- 400: Invalid ../users/:user_id parameter. \n
- 404: User does not exist \n
- 500: An unknown error occurred. \n
(Optional) A description of the key
\n","type":"text"},{"key":"expiration","value":"2021-12-31 23:59:59","description":"(Optional) The key's expiration date and time (format: YYYY-MM-DD HH:MM:SS)
\n","type":"text"}]},"url":"{{host}}/accounts/{{account_id}}/keys","auth":{"type":"apikey","apikey":{"value":"{{your-api-key-here}}","key":"(Optional) A description of the key
\n"},{"key":"expiration","value":"2021-12-31 23:59:59","description":"(Optional) The key's expiration date and time (format: YYYY-MM-DD HH:MM:SS)
\n","type":"text"}]},"url":"{{host}}/accounts/{{account_id}}/keys/aaaassssddddffff1234","auth":{"type":"apikey","apikey":{"value":"{{your-api-key-here}}","key":"[0, 1] Optionally require API key authentication for Inbound webhook events
\n","type":"text"}]},"url":"{{host}}/accounts/{{account_id}}/webhooks","auth":{"type":"apikey","apikey":{"value":"{{your-api-key-here}}","key":"This API collection is to programatically manage the Universal Webhook Endpoints within your account. Use these webhook integrations to push messaging and engagement data directly into Everest.
\nAcceptable events include volume, deliveries, bounces, deferrals, opens, clicks, and unsubsribes.
\nFor more information please visit: https://www.validity.com/knowledge-base/developer-guide-universal-endpoint/
\n","event":[{"listen":"prerequest","script":{"id":"9ba025e6-5c7c-4d53-b5ea-5c189e9869ab","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"bfd21911-1c53-4f84-b8ac-e88d66c335d9","type":"text/javascript","exec":[""]}}],"_postman_id":"5b1b5b36-9e9b-4b07-965b-67dc3b3d12c0","auth":{"type":"apikey","apikey":{"value":"{{your-api-key-here}}","key":"Accounts & Users Workflow
\n- \n
- Your API key will be associated with your default (parent) account. Subsequent POST calls to Create Account will create new child accounts (descendents) of your primary account. \n
- After creating an account through the Create Account endpoint, the response will include the new account ID. \n
- A.) The next step is to send a POST request to Create User with your account ID. If it's the first user you create, it will be set as the default administrative owner of the account. \n
- B.) If the user you are attemtping to add already exists, you'll receive the following error: \"This email address is already in use by another user, but you can still add them to your account.\" This error will return the user identifier (user.id) so you can still add them to the account using the Add User to Account endpoint. \n
- After the creation of your account and users, please refer to the API Keys, Privacy Requests, and Webhook Endpoints collections for addditional functionality. \n
Common Errors
\n- \n
- 400: Invalid inputs/parameters \n
- 401: Unauthorized (or invalid API key) \n
- 404: Account does not exist \n
- 500: An unknown error occurred. \n
Returns single day data for all the IPs belonging to your account, including status at each receiver. Because of a 2-day lag for receiving and rolling up the data, data is limited to the past 2-547 days.
\n","auth":{"type":"apikey","apikey":{"value":"{{your-api-key-here}}","key":"Format: YYYY-MM-DD. Must be within the last 1.5 years. Use of start_date requires defining an end_date. Default value: today. Data Type: string.
\n","type":"text/plain"},"key":"start_date","value":"2022-12-01"},{"disabled":true,"description":{"content":"Format: YYYY-MM-DD. Must be within the last 1.5 years. Default value: today. Data Type: string.
\n","type":"text/plain"},"key":"end_date","value":"2022-12-17"},{"disabled":true,"description":{"content":"Number of rows in your result. Default value: 25. Data Type: integer.
\n","type":"text/plain"},"key":"group_length","value":""},{"disabled":true,"description":{"content":"Group number you want returned. Default value:1. Data Type: integer.
\n","type":"text/plain"},"key":"group_num","value":""}],"variable":[]}},"response":[{"id":"c598a76b-8110-4922-aa8e-74808c49e46d","name":"Performance Daily","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/cert/performance/daily/","host":["{{host}}"],"path":["cert","performance","daily",""],"query":[{"key":"start_date","value":"","description":"Format: YYYY-MM-DD. Must be within the last 1.5 years. Deault value: today. Data Type: string.","disabled":true},{"key":"end_date","value":"","description":"Format: YYYY-MM-DD. Must be within the last 1.5 years. Deault value: today. Data Type: string.","disabled":true},{"key":"group_length","value":"","description":"Number of rows in your result. Default value: 25. Data Type: integer.","disabled":true},{"key":"group_num","value":null,"description":"Group number you want returned. Default value:1. Data Type: integer.","disabled":true}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"results\": [\r\n {\r\n \"report_date\": \"2022-08-21\",\r\n \"ip_address\": \"{IP ADDRESS}\",\r\n \"status\": {\r\n \"microsoft\": \"enabled\",\r\n \"yahoo\": \"enabled\",\r\n \"global\": \"enabled\",\r\n \"safelist\": \"enabled\",\r\n \"aol\": \"enabled\"\r\n },\r\n \"microsoft_srd\": {\r\n \"volume\": 0,\r\n \"complaints\": 0,\r\n \"complaint_rate\": 0\r\n },\r\n \"microsoft_total\": {\r\n \"volume\": 212,\r\n \"complaints\": 0,\r\n \"complaint_rate\": 0\r\n },\r\n \"microsoft_inbox\": {\r\n \"volume\": 212,\r\n \"complaints\": 0,\r\n \"complaint_rate\": 0\r\n },\r\n \"yahoo_total\": {\r\n \"volume\": 700,\r\n \"complaints\": 0,\r\n \"complaint_rate\": 0,\r\n \"tins\": 0\r\n },\r\n \"yahoo_inbox\": {\r\n \"volume\": 635,\r\n \"complaints\": 0,\r\n \"complaint_rate\": 0\r\n },\r\n \"rp_network1_traps\": {\r\n \"count\": 0\r\n },\r\n \"cloudmark_traps\": {\r\n \"count\": 0\r\n },\r\n \"critical_traps\": {\r\n \"count\": 0\r\n },\r\n \"significant_traps\": {\r\n \"count\": 0\r\n },\r\n \"comcast_total\": {\r\n \"volume\": 20\r\n },\r\n \"comcast\": {\r\n \"volume\": 20,\r\n \"complaints\": 0,\r\n \"complaint_rate\": 0\r\n },\r\n \"unknown_users\": {\r\n \"volume\": 32,\r\n \"complaints\": 0,\r\n \"complaint_rate\": 0\r\n },\r\n \"orange\": {\r\n \"complaints\": 0\r\n },\r\n \"sfr\": {\r\n \"complaints\": 0\r\n },\r\n \"spamcop\": {\r\n \"volume\": 0\r\n },\r\n \"vade_secure\": {\r\n \"volume\": 40,\r\n \"complaints\": 0,\r\n \"spam_count\": 0\r\n },\r\n \"aol_delivered\": {\r\n \"volume\": 0,\r\n \"complaints\": 0,\r\n \"complaint_rate\": 0\r\n }\r\n },\r\n {\r\n \"report_date\": \"2022-08-21\",\r\n \"ip_address\": \"{IP ADDRESS}\",\r\n \"status\": {\r\n \"microsoft\": \"enabled\",\r\n \"yahoo\": \"enabled\",\r\n \"global\": \"enabled\",\r\n \"safelist\": \"enabled\",\r\n \"aol\": \"enabled\"\r\n },\r\n \"microsoft_srd\": {\r\n \"volume\": 0,\r\n \"complaints\": 0,\r\n \"complaint_rate\": 0\r\n },\r\n \"microsoft_total\": {\r\n \"volume\": 175,\r\n \"complaints\": 0,\r\n \"complaint_rate\": 0\r\n },\r\n \"microsoft_inbox\": {\r\n \"volume\": 175,\r\n \"complaints\": 0,\r\n \"complaint_rate\": 0\r\n },\r\n \"yahoo_total\": {\r\n \"volume\": 656,\r\n \"complaints\": 0,\r\n \"complaint_rate\": 0,\r\n \"tins\": 0\r\n },\r\n \"yahoo_inbox\": {\r\n \"volume\": 591,\r\n \"complaints\": 0,\r\n \"complaint_rate\": 0\r\n },\r\n \"rp_network1_traps\": {\r\n \"count\": 0\r\n },\r\n \"cloudmark_traps\": {\r\n \"count\": 0\r\n },\r\n \"critical_traps\": {\r\n \"count\": 0\r\n },\r\n \"significant_traps\": {\r\n \"count\": 0\r\n },\r\n \"comcast_total\": {\r\n \"volume\": 66\r\n },\r\n \"comcast\": {\r\n \"volume\": 66,\r\n \"complaints\": 0,\r\n \"complaint_rate\": 0\r\n },\r\n \"unknown_users\": {\r\n \"volume\": 87,\r\n \"complaints\": 0,\r\n \"complaint_rate\": 0\r\n },\r\n \"orange\": {\r\n \"complaints\": 0\r\n },\r\n \"sfr\": {\r\n \"complaints\": 0\r\n },\r\n \"spamcop\": {\r\n \"volume\": 0\r\n },\r\n \"vade_secure\": {\r\n \"volume\": 60,\r\n \"complaints\": 0,\r\n \"spam_count\": 0\r\n },\r\n \"aol_delivered\": {\r\n \"volume\": 0,\r\n \"complaints\": 0,\r\n \"complaint_rate\": 0\r\n }\r\n }\r\n ],\r\n \"info\": []\r\n}\r\n"}],"_postman_id":"d7d03a55-cf19-43dd-8d97-e98edbb3f9cf"},{"name":"Performance Rollup","id":"981ac271-04c4-4c6a-bc4c-54d11907514d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{host}}/cert/performance/rollup/","description":"Returns performance data for all the IPs belonging to your account for the last 30 days, including status at each receiver. Data is limited to the last 1.5 years.
\n","auth":{"type":"apikey","apikey":{"value":"{{your-api-key-here}}","key":"REQUIRED INPUT. \nFormat: YYYY-MM-DD. Must be within the last 1.5 years. Data Type: string.
\n","type":"text/plain"},"key":"start_date","value":""},{"disabled":true,"description":{"content":"Format: YYYY-MM-DD. Must be within the last 1.5 years. Data Type: string.
\n","type":"text/plain"},"key":"end_date","value":""},{"disabled":true,"description":{"content":"Number of rows in your result. Default value: 25. Data Type: integer.
\n","type":"text/plain"},"key":"group_length","value":""},{"disabled":true,"description":{"content":"Group number you want returned. Default value:1. Data Type: integer.
\n","type":"text/plain"},"key":"group_num","value":""}],"variable":[]}},"response":[{"id":"fbb12a73-0fdf-47e0-8be6-acf57b1a1995","name":"Performance Rollup","originalRequest":{"method":"GET","header":[],"url":"{{host}}/cert/performance/rollup/"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"results\": [\r\n {\r\n \"report_date\": \"2022-08-01\",\r\n \"ip_address\": \"{IP_ADDRESS}\",\r\n \"microsoft_srd\": {\r\n \"volume\": 1,\r\n \"complaints\": 1,\r\n \"complaint_rate\": 100,\r\n \"exceeds_rate_threshold\": false\r\n },\r\n \"microsoft_total\": {\r\n \"volume\": 88320,\r\n \"complaints\": 61,\r\n \"complaint_rate\": 0.07,\r\n \"exceeds_rate_threshold\": false\r\n },\r\n \"yahoo_inbox\": {\r\n \"volume\": 67273,\r\n \"complaints\": 121,\r\n \"complaint_rate\": 0.18,\r\n \"exceeds_rate_threshold\": false\r\n },\r\n \"rp_network_traps\": {\r\n \"count\": 5,\r\n \"exceeds_count_threshold\": false\r\n },\r\n \"cloudmark_traps\": {\r\n \"count\": 4,\r\n \"exceeds_count_threshold\": false\r\n },\r\n \"critical_traps\": {\r\n \"count\": 0,\r\n \"exceeds_count_threshold\": false\r\n },\r\n \"significant_traps\": {\r\n \"count\": 0,\r\n \"exceeds_count_threshold\": false\r\n },\r\n \"comcast\": {\r\n \"volume\": 5018,\r\n \"complaints\": 18,\r\n \"complaint_rate\": 0.36,\r\n \"exceeds_rate_threshold\": true\r\n },\r\n \"cloudmark\": {\r\n \"volume\": 9571,\r\n \"complaints\": 10,\r\n \"complaint_rate\": 0.1,\r\n \"exceeds_rate_threshold\": false\r\n },\r\n \"status\": {\r\n \"microsoft\": \"enabled\",\r\n \"yahoo\": \"enabled\",\r\n \"global\": \"enabled\",\r\n \"safelist\": \"enabled\"\r\n }\r\n },\r\n {\r\n \"report_date\": \"2022-08-01\",\r\n \"ip_address\": \"{IP_ADDRESS}\",\r\n \"microsoft_srd\": {\r\n \"volume\": 0,\r\n \"complaints\": 0,\r\n \"complaint_rate\": 0,\r\n \"exceeds_rate_threshold\": false\r\n },\r\n \"microsoft_total\": {\r\n \"volume\": 87771,\r\n \"complaints\": 62,\r\n \"complaint_rate\": 0.07,\r\n \"exceeds_rate_threshold\": false\r\n },\r\n \"yahoo_inbox\": {\r\n \"volume\": 66316,\r\n \"complaints\": 132,\r\n \"complaint_rate\": 0.2,\r\n \"exceeds_rate_threshold\": true\r\n },\r\n \"rp_network_traps\": {\r\n \"count\": 2,\r\n \"exceeds_count_threshold\": false\r\n },\r\n \"cloudmark_traps\": {\r\n \"count\": 7,\r\n \"exceeds_count_threshold\": false\r\n },\r\n \"critical_traps\": {\r\n \"count\": 0,\r\n \"exceeds_count_threshold\": false\r\n },\r\n \"significant_traps\": {\r\n \"count\": 0,\r\n \"exceeds_count_threshold\": false\r\n },\r\n \"comcast\": {\r\n \"volume\": 1854,\r\n \"complaints\": 6,\r\n \"complaint_rate\": 0.32,\r\n \"exceeds_rate_threshold\": true\r\n },\r\n \"cloudmark\": {\r\n \"volume\": 8567,\r\n \"complaints\": 10,\r\n \"complaint_rate\": 0.12,\r\n \"exceeds_rate_threshold\": false\r\n },\r\n \"status\": {\r\n \"microsoft\": \"enabled\",\r\n \"yahoo\": \"enabled\",\r\n \"global\": \"enabled\",\r\n \"safelist\": \"enabled\"\r\n }\r\n },\r\n {\r\n \"report_date\": \"2022-08-02\",\r\n \"ip_address\": \"{IP_ADDRESS}\",\r\n \"microsoft_srd\": {\r\n \"volume\": 1,\r\n \"complaints\": 1,\r\n \"complaint_rate\": 100,\r\n \"exceeds_rate_threshold\": false\r\n },\r\n \"microsoft_total\": {\r\n \"volume\": 88000,\r\n \"complaints\": 64,\r\n \"complaint_rate\": 0.07,\r\n \"exceeds_rate_threshold\": false\r\n },\r\n \"yahoo_inbox\": {\r\n \"volume\": 64651,\r\n \"complaints\": 120,\r\n \"complaint_rate\": 0.19,\r\n \"exceeds_rate_threshold\": false\r\n },\r\n \"rp_network_traps\": {\r\n \"count\": 5,\r\n \"exceeds_count_threshold\": false\r\n },\r\n \"cloudmark_traps\": {\r\n \"count\": 4,\r\n \"exceeds_count_threshold\": false\r\n },\r\n \"critical_traps\": {\r\n \"count\": 0,\r\n \"exceeds_count_threshold\": false\r\n },\r\n \"significant_traps\": {\r\n \"count\": 0,\r\n \"exceeds_count_threshold\": false\r\n },\r\n \"comcast\": {\r\n \"volume\": 4989,\r\n \"complaints\": 18,\r\n \"complaint_rate\": 0.36,\r\n \"exceeds_rate_threshold\": true\r\n },\r\n \"cloudmark\": {\r\n \"volume\": 9557,\r\n \"complaints\": 10,\r\n \"complaint_rate\": 0.1,\r\n \"exceeds_rate_threshold\": false\r\n },\r\n \"status\": {\r\n \"microsoft\": \"enabled\",\r\n \"yahoo\": \"enabled\",\r\n \"global\": \"enabled\",\r\n \"safelist\": \"enabled\"\r\n }\r\n },\r\n {\r\n \"report_date\": \"2022-08-02\",\r\n \"ip_address\": \"{IP_ADDRESS}\",\r\n \"microsoft_srd\": {\r\n \"volume\": 0,\r\n \"complaints\": 0,\r\n \"complaint_rate\": 0,\r\n \"exceeds_rate_threshold\": false\r\n },\r\n \"microsoft_total\": {\r\n \"volume\": 87457,\r\n \"complaints\": 62,\r\n \"complaint_rate\": 0.07,\r\n \"exceeds_rate_threshold\": false\r\n },\r\n \"yahoo_inbox\": {\r\n \"volume\": 63487,\r\n \"complaints\": 131,\r\n \"complaint_rate\": 0.21,\r\n \"exceeds_rate_threshold\": true\r\n },\r\n \"rp_network_traps\": {\r\n \"count\": 2,\r\n \"exceeds_count_threshold\": false\r\n },\r\n \"cloudmark_traps\": {\r\n \"count\": 7,\r\n \"exceeds_count_threshold\": false\r\n },\r\n \"critical_traps\": {\r\n \"count\": 0,\r\n \"exceeds_count_threshold\": false\r\n },\r\n \"significant_traps\": {\r\n \"count\": 0,\r\n \"exceeds_count_threshold\": false\r\n },\r\n \"comcast\": {\r\n \"volume\": 1843,\r\n \"complaints\": 6,\r\n \"complaint_rate\": 0.33,\r\n \"exceeds_rate_threshold\": true\r\n },\r\n \"cloudmark\": {\r\n \"volume\": 8552,\r\n \"complaints\": 10,\r\n \"complaint_rate\": 0.12,\r\n \"exceeds_rate_threshold\": false\r\n },\r\n \"status\": {\r\n \"microsoft\": \"enabled\",\r\n \"yahoo\": \"enabled\",\r\n \"global\": \"enabled\",\r\n \"safelist\": \"enabled\"\r\n }\r\n }\r\n ]\r\n}\r\n"}],"_postman_id":"981ac271-04c4-4c6a-bc4c-54d11907514d"}],"id":"fc4948c8-4f7b-47a8-8694-137c40b16069","description":"Throughout the Certification documentation you'll see the use of variables like {{apikey}} that can be swapped out using your real API key. If you use Postman, this collection is available for download along with a shared variable template to define your host and apikey variables.
\n","_postman_id":"fc4948c8-4f7b-47a8-8694-137c40b16069","auth":{"type":"apikey","apikey":{"value":"{{your-api-key-here}}","key":"